FacturaScripts

OpenAi extends OpenAi
in package

Class created by Core/Internal/PluginsDeploy

Table of Contents

Constants

ASSISTANTS_URL  : mixed = 'https://api.openai.com/v1/assistants'
AUDIO_SPEECH_URL  : mixed = 'https://api.openai.com/v1/audio/speech'
AUDIO_TRANSCRIPT_URL  : mixed = 'https://api.openai.com/v1/audio/transcriptions'
CHAT_URL  : mixed = 'https://api.openai.com/v1/chat/completions'
FILES_URL  : mixed = 'https://api.openai.com/v1/files'
IMAGES_URL  : mixed = 'https://api.openai.com/v1/images/generations'
THREADS_URL  : mixed = 'https://api.openai.com/v1/threads'
VECTOR_URL  : mixed = 'https://api.openai.com/v1/vector_stores'

Properties

$api_key  : string
$timeout  : int
$total_tokens  : int

Methods

__construct()  : mixed
Inicializa el cliente con la API Key de OpenAI.
assistantCreate()  : array<string|int, mixed>
Crea un nuevo asistente con los parámetros indicados.
assistantRead()  : array<string|int, mixed>
Devuelve los datos del asistente indicado.
assistantUpdate()  : mixed
Actualiza el asistente indicado con los parámetros recibidos.
audio()  : string
Convierte texto en audio (texto a voz) y guarda el archivo en MyFiles, devolviendo su ruta.
audioHD()  : string
Convierte texto en audio. Se mantiene por compatibilidad.
audioTranscript()  : string
Transcribe a texto el archivo de audio indicado.
chat()  : string
Envía una conversación al modelo de chat y devuelve la respuesta como texto.
chatJson()  : array<string|int, mixed>
Envía una conversación al modelo de chat forzando un formato de respuesta y la devuelve como array.
fileDelete()  : bool
Elimina el archivo indicado de OpenAI.
fileList()  : array<string|int, mixed>
Devuelve la lista de archivos subidos a OpenAI.
fileRead()  : array<string|int, mixed>
Devuelve los datos del archivo indicado.
fileUpload()  : array<string|int, mixed>
Sube un archivo a OpenAI para el propósito indicado.
getTotalTokens()  : int
Devuelve el total de tokens consumidos en la última petición de chat.
image()  : string
Genera una imagen a partir del prompt, la guarda en MyFiles y devuelve su ruta.
init()  : self
Crea y devuelve una nueva instancia del cliente.
setSystemMessage()  : self
Añade un mensaje de sistema a la conversación.
setTimeout()  : self
Establece el tiempo máximo de espera (en segundos) de las peticiones.
setUserMessage()  : self
Añade un mensaje de usuario a la conversación.
threadCreate()  : array<string|int, mixed>
Crea un nuevo hilo de conversación.
threadMessageCreate()  : array<string|int, mixed>
Añade un mensaje al hilo indicado.
threadMessages()  : array<string|int, mixed>
Devuelve los mensajes del hilo indicado.
threadRead()  : array<string|int, mixed>
Devuelve los datos del hilo indicado.
threadRun()  : array<string|int, mixed>
Ejecuta el asistente indicado sobre el hilo.
threadRunRead()  : array<string|int, mixed>
Devuelve el estado de la ejecución indicada del hilo.
threadRunSubmitToolOutputs()  : array<string|int, mixed>
Envía los resultados de las herramientas requeridas por una ejecución en curso.
vectorCreate()  : array<string|int, mixed>
Crea un nuevo almacén de vectores (vector store).
vectorFile()  : array<string|int, mixed>
Añade un archivo al almacén de vectores indicado.
vectorFileDelete()  : bool
Elimina un archivo del almacén de vectores indicado.
vectorFiles()  : array<string|int, mixed>
Devuelve los archivos del almacén de vectores indicado.
vectorRead()  : array<string|int, mixed>
Devuelve los datos del almacén de vectores indicado.

Constants

ASSISTANTS_URL

public mixed ASSISTANTS_URL = 'https://api.openai.com/v1/assistants'

AUDIO_SPEECH_URL

public mixed AUDIO_SPEECH_URL = 'https://api.openai.com/v1/audio/speech'

AUDIO_TRANSCRIPT_URL

public mixed AUDIO_TRANSCRIPT_URL = 'https://api.openai.com/v1/audio/transcriptions'

CHAT_URL

public mixed CHAT_URL = 'https://api.openai.com/v1/chat/completions'

FILES_URL

public mixed FILES_URL = 'https://api.openai.com/v1/files'

IMAGES_URL

public mixed IMAGES_URL = 'https://api.openai.com/v1/images/generations'

THREADS_URL

public mixed THREADS_URL = 'https://api.openai.com/v1/threads'

VECTOR_URL

public mixed VECTOR_URL = 'https://api.openai.com/v1/vector_stores'

Properties

$api_key

protected string $api_key

$timeout

protected int $timeout = 60

$total_tokens

protected int $total_tokens = 0

Methods

__construct()

Inicializa el cliente con la API Key de OpenAI.

public __construct(string $api_key) : mixed
Parameters
$api_key : string

assistantCreate()

Crea un nuevo asistente con los parámetros indicados.

public assistantCreate(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Return values
array<string|int, mixed>

assistantRead()

Devuelve los datos del asistente indicado.

public assistantRead(string $idAssistant) : array<string|int, mixed>
Parameters
$idAssistant : string
Return values
array<string|int, mixed>

assistantUpdate()

Actualiza el asistente indicado con los parámetros recibidos.

public assistantUpdate(string $idAssistant, array<string|int, mixed> $params) : mixed
Parameters
$idAssistant : string
$params : array<string|int, mixed>

audio()

Convierte texto en audio (texto a voz) y guarda el archivo en MyFiles, devolviendo su ruta.

public audio(string $input[, string $voice = 'alloy' ][, string $format = 'mp3' ][, string $model = 'gpt-4o-mini-tts' ]) : string
Parameters
$input : string
$voice : string = 'alloy'
$format : string = 'mp3'
$model : string = 'gpt-4o-mini-tts'
Return values
string

audioHD()

Convierte texto en audio. Se mantiene por compatibilidad.

public audioHD(string $input[, string $voice = 'alloy' ][, string $format = 'mp3' ]) : string

since 2026, gpt-4o-mini-tts no tiene variante HD. Usar audio() en su lugar.

Parameters
$input : string
$voice : string = 'alloy'
$format : string = 'mp3'
Return values
string

audioTranscript()

Transcribe a texto el archivo de audio indicado.

public audioTranscript(CURLFile $file[, string $model = 'gpt-4o-transcribe' ]) : string
Parameters
$file : CURLFile
$model : string = 'gpt-4o-transcribe'
Return values
string

chat()

Envía una conversación al modelo de chat y devuelve la respuesta como texto.

public chat(array<string|int, mixed> $messages[, string $user = '' ][, string $model = 'gpt-5.4-mini' ]) : string
Parameters
$messages : array<string|int, mixed>
$user : string = ''
$model : string = 'gpt-5.4-mini'
Return values
string

chatJson()

Envía una conversación al modelo de chat forzando un formato de respuesta y la devuelve como array.

public chatJson(array<string|int, mixed> $messages, array<string|int, mixed> $response_format[, string $user = '' ][, string $model = 'gpt-5.4-mini' ]) : array<string|int, mixed>
Parameters
$messages : array<string|int, mixed>
$response_format : array<string|int, mixed>
$user : string = ''
$model : string = 'gpt-5.4-mini'
Return values
array<string|int, mixed>

fileDelete()

Elimina el archivo indicado de OpenAI.

public fileDelete(string $id_file) : bool
Parameters
$id_file : string
Return values
bool

fileList()

Devuelve la lista de archivos subidos a OpenAI.

public fileList() : array<string|int, mixed>
Return values
array<string|int, mixed>

fileRead()

Devuelve los datos del archivo indicado.

public fileRead(string $id_file) : array<string|int, mixed>
Parameters
$id_file : string
Return values
array<string|int, mixed>

fileUpload()

Sube un archivo a OpenAI para el propósito indicado.

public fileUpload(CURLFile $file[, string $purpose = 'assistants' ]) : array<string|int, mixed>
Parameters
$file : CURLFile
$purpose : string = 'assistants'
Return values
array<string|int, mixed>

getTotalTokens()

Devuelve el total de tokens consumidos en la última petición de chat.

public getTotalTokens() : int
Return values
int

image()

Genera una imagen a partir del prompt, la guarda en MyFiles y devuelve su ruta.

public image(string $prompt[, int $width = 1024 ][, int $height = 1024 ][, int $count = 1 ][, string $model = 'gpt-image-2-mini' ][, array<string|int, mixed> $options = [] ]) : string
Parameters
$prompt : string
$width : int = 1024
$height : int = 1024
$count : int = 1
$model : string = 'gpt-image-2-mini'
$options : array<string|int, mixed> = []
Return values
string

init()

Crea y devuelve una nueva instancia del cliente.

public static init(string $api_key) : self
Parameters
$api_key : string
Return values
self

setSystemMessage()

Añade un mensaje de sistema a la conversación.

public setSystemMessage(array<string|int, mixed> &$messages, string $message) : self
Parameters
$messages : array<string|int, mixed>
$message : string
Return values
self

setTimeout()

Establece el tiempo máximo de espera (en segundos) de las peticiones.

public setTimeout(int $timeout) : self
Parameters
$timeout : int
Return values
self

setUserMessage()

Añade un mensaje de usuario a la conversación.

public setUserMessage(array<string|int, mixed> &$messages, string $message) : self
Parameters
$messages : array<string|int, mixed>
$message : string
Return values
self

threadCreate()

Crea un nuevo hilo de conversación.

public threadCreate() : array<string|int, mixed>
Return values
array<string|int, mixed>

threadMessageCreate()

Añade un mensaje al hilo indicado.

public threadMessageCreate(array<string|int, mixed> $message, string $id_thread) : array<string|int, mixed>
Parameters
$message : array<string|int, mixed>
$id_thread : string
Return values
array<string|int, mixed>

threadMessages()

Devuelve los mensajes del hilo indicado.

public threadMessages(string $id_thread[, string $id_run = '' ]) : array<string|int, mixed>
Parameters
$id_thread : string
$id_run : string = ''
Return values
array<string|int, mixed>

threadRead()

Devuelve los datos del hilo indicado.

public threadRead(string $id_thread) : array<string|int, mixed>
Parameters
$id_thread : string
Return values
array<string|int, mixed>

threadRun()

Ejecuta el asistente indicado sobre el hilo.

public threadRun(string $id_thread, string $id_assistant) : array<string|int, mixed>
Parameters
$id_thread : string
$id_assistant : string
Return values
array<string|int, mixed>

threadRunRead()

Devuelve el estado de la ejecución indicada del hilo.

public threadRunRead(string $id_thread, string $id_run) : array<string|int, mixed>
Parameters
$id_thread : string
$id_run : string
Return values
array<string|int, mixed>

threadRunSubmitToolOutputs()

Envía los resultados de las herramientas requeridas por una ejecución en curso.

public threadRunSubmitToolOutputs(string $id_thread, string $id_run, array<string|int, mixed> $outputs) : array<string|int, mixed>
Parameters
$id_thread : string
$id_run : string
$outputs : array<string|int, mixed>
Return values
array<string|int, mixed>

vectorCreate()

Crea un nuevo almacén de vectores (vector store).

public vectorCreate(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
Return values
array<string|int, mixed>

vectorFile()

Añade un archivo al almacén de vectores indicado.

public vectorFile(string $id_vector, string $id_file) : array<string|int, mixed>
Parameters
$id_vector : string
$id_file : string
Return values
array<string|int, mixed>

vectorFileDelete()

Elimina un archivo del almacén de vectores indicado.

public vectorFileDelete(string $idVector, string $idFile) : bool
Parameters
$idVector : string
$idFile : string
Return values
bool

vectorFiles()

Devuelve los archivos del almacén de vectores indicado.

public vectorFiles(string $idVector[, array<string|int, mixed> $data = [] ]) : array<string|int, mixed>
Parameters
$idVector : string
$data : array<string|int, mixed> = []
Return values
array<string|int, mixed>

vectorRead()

Devuelve los datos del almacén de vectores indicado.

public vectorRead(string $idVector) : array<string|int, mixed>
Parameters
$idVector : string
Return values
array<string|int, mixed>
On this page

Search results