FacturaScripts

OpenAi extends OpenAi
in package

Class created by Core/Internal/PluginsDeploy

Table of Contents

Constants

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

Properties

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

Methods

__construct()  : mixed
assistantCreate()  : array<string|int, mixed>
assistantRead()  : array<string|int, mixed>
assistantUpdate()  : mixed
audio()  : string
audioHD()  : string
audioTranscript()  : string
chat()  : string
chatJson()  : array<string|int, mixed>
dalle2()  : string
dalle3()  : string
fileDelete()  : bool
fileList()  : array<string|int, mixed>
fileRead()  : array<string|int, mixed>
fileUpload()  : array<string|int, mixed>
getTotalTokens()  : int
image()  : string
init()  : self
setSystemMessage()  : self
setTimeout()  : self
setUserMessage()  : self
threadCreate()  : array<string|int, mixed>
threadMessageCreate()  : array<string|int, mixed>
threadMessages()  : array<string|int, mixed>
threadRead()  : array<string|int, mixed>
threadRun()  : array<string|int, mixed>
threadRunRead()  : array<string|int, mixed>
threadRunSubmitToolOutputs()  : array<string|int, mixed>
vectorCreate()  : array<string|int, mixed>
vectorFile()  : array<string|int, mixed>
vectorFileDelete()  : bool
vectorFiles()  : array<string|int, mixed>
vectorRead()  : array<string|int, mixed>

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()

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

assistantCreate()

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

assistantRead()

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

assistantUpdate()

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

audio()

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

audioHD()

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

audioTranscript()

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

chat()

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

chatJson()

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

dalle2()

public dalle2(string $prompt[, int $width = 256 ][, int $height = 256 ][, mixed $count = 1 ]) : string
Parameters
$prompt : string
$width : int = 256
$height : int = 256
$count : mixed = 1
Return values
string

dalle3()

public dalle3(string $prompt[, int $width = 1024 ][, int $height = 1024 ][, mixed $count = 1 ]) : string
Parameters
$prompt : string
$width : int = 1024
$height : int = 1024
$count : mixed = 1
Return values
string

fileDelete()

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

fileList()

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

fileRead()

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

fileUpload()

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

getTotalTokens()

public getTotalTokens() : int
Return values
int

image()

public image(string $prompt[, int $width = 256 ][, int $height = 256 ][, mixed $count = 1 ][, string $model = 'dall-e-2' ]) : string
Parameters
$prompt : string
$width : int = 256
$height : int = 256
$count : mixed = 1
$model : string = 'dall-e-2'
Return values
string

init()

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

setSystemMessage()

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

setTimeout()

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

setUserMessage()

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

threadCreate()

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

threadMessageCreate()

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()

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()

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

threadRun()

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()

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()

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()

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

vectorFile()

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()

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

vectorFiles()

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()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results