Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork620
⚡️ OpenAI PHP is a supercharged community-maintained PHP API client that allows you to interact with OpenAI API.
License
NotificationsYou must be signed in to change notification settings
openai-php/client
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
OpenAI PHP is a community-maintained PHP API client that allows you to interact with theOpen AI API.
- Follow the creator Nuno Maduro:
- YouTube:youtube.com/@nunomaduro — Videos every weekday
- Twitch:twitch.tv/enunomaduro — Streams (almost) every weekday
- Twitter / X:x.com/enunomaduro
- LinkedIn:linkedin.com/in/nunomaduro
- Instagram:instagram.com/enunomaduro
- Tiktok:tiktok.com/@enunomaduro
If you or your business relies on this package, it's important to support the developers who have contributed their time and effort to create and maintain this valuable tool:
- Nuno Maduro:github.com/sponsors/nunomaduro
- Sandro Gehri:github.com/sponsors/gehrisandro
- Get Started
- Usage
- Models Resource
- Responses Resource
- Chat Resource
- Audio Resource
- Embeddings Resource
- Files Resource
- FineTuning Resource
- Moderations Resource
- Images Resource
- Vector Stores Resource
- Vector Stores Files Resource
- Vector Stores File Batches Resource
- Batches Resource
- Realtime Ephemeral Keys
- Completions Resource (legacy)
- Assistants Resource (deprecated)
- Thread Resource (deprecated)
- Thread Messages Resource (deprecated)
- Thread Runs Resource (deprecated)
- Thread Runs Steps Resource (deprecated)
- FineTunes Resource (deprecated)
- Edits Resource (deprecated)
- Meta Information
- Troubleshooting
- Testing
- Services
RequiresPHP 8.2+
First, install OpenAI via theComposer package manager:
composer require openai-php/client
Ensure that thephp-http/discovery composer plugin is allowed to run or install a client manually if your project does not already have a PSR-18 client integrated.
composer require guzzlehttp/guzzle
Then, interact with OpenAI's API:
$yourApiKey =getenv('YOUR_API_KEY');$client = OpenAI::client($yourApiKey);$result =$client->chat()->create(['model' =>'gpt-4o','messages' => [ ['role' =>'user','content' =>'Hello!'], ],]);echo$result->choices[0]->message->content;// Hello! How can I assist you today?
If necessary, it is possible to configure and create a separate client.
$yourApiKey =getenv('YOUR_API_KEY');$client = OpenAI::factory() ->withApiKey($yourApiKey) ->withOrganization('your-organization')// default: null ->withProject('Your Project')// default: null ->withBaseUri('openai.example.com/v1')// default: api.openai.com/v1 ->withHttpClient($httpClient =new \GuzzleHttp\Client([]))// default: HTTP client found using PSR-18 HTTP Client Discovery ->withHttpHeader('X-My-Header','foo') ->withQueryParam('my-param','bar') ->withStreamHandler(fn (RequestInterface$request):ResponseInterface =>$httpClient->send($request, ['stream' =>true// Allows to provide a custom stream handler for the http client. ])) ->make();
Lists the currently available models, and provides basic information about each one such as the owner and availability.
$response =$client->models()->list();$response->object;// 'list'foreach ($response->dataas$result) {$result->id;// 'gpt-3.5-turbo-instruct'$result->object;// 'model'// ...}$response->toArray();// ['object' => 'list', 'data' => [...]]
Retrieves a model instance, providing basic information about the model such as the owner and permissioning.
$response =$client->models()->retrieve('gpt-3.5-turbo-instruct');$response->id;// 'gpt-3.5-turbo-instruct'$response->object;// 'model'$response->created;// 1642018370$response->ownedBy;// 'openai'$response->toArray();// ['id' => 'gpt-3.5-turbo-instruct', ...]
Delete a fine-tuned model.
$response =$client->models()->delete('curie:ft-acmeco-2021-03-03-21-44-20');$response->id;// 'curie:ft-acmeco-2021-03-03-21-44-20'$response->object;// 'model'$response->deleted;// true$response->toArray();// ['id' => 'curie:ft-acmeco-2021-03-03-21-44-20', ...]
Creates a model response. Provide text or image inputs to generate text or JSON outputs. Have the model call your own custom code or use built-in tools like web search or file search to use your own data as input for the model's response.
$response =$client->responses()->create(['model' =>'gpt-4o-mini','tools' => [ ['type' =>'web_search_preview' ] ],'input' =>"what was a positive news story from today?",'temperature' =>0.7,'max_output_tokens' =>150,'tool_choice' =>'auto','parallel_tool_calls' =>true,'store' =>true,'metadata' => ['user_id' =>'123','session_id' =>'abc456' ]]);$response->id;// 'resp_67ccd2bed1ec8190b14f964abc054267'$response->object;// 'response'$response->createdAt;// 1741476542$response->status;// 'completed'$response->model;// 'gpt-4o-mini'foreach ($response->outputas$output) {$output->type;// 'message'$output->id;// 'msg_67ccd2bf17f0819081ff3bb2cf6508e6'$output->status;// 'completed'$output->role;// 'assistant'foreach ($output->contentas$content) {$content->type;// 'output_text'$content->text;// The response text$content->annotations;// Any annotations in the response }}$response->usage->inputTokens;// 36$response->usage->outputTokens;// 87$response->usage->totalTokens;// 123$response->toArray();// ['id' => 'resp_67ccd2bed1ec8190b14f964abc054267', ...]
When you create a Response with stream set to true, the server will emit server-sent events to the client as the Response is generated. All events and their payloads can be found inOpenAI docs.
$stream =$client->responses()->createStreamed(['model' =>'gpt-4o-mini','tools' => [ ['type' =>'web_search_preview' ] ],'input' =>"what was a positive news story from today?",]);foreach ($streamas$response) {$response->event;// 'response.created'}
Retrieves a model response with the given ID.
$response =$client->responses()->retrieve('resp_67ccd2bed1ec8190b14f964abc054267');$response->id;// 'resp_67ccd2bed1ec8190b14f964abc054267'$response->object;// 'response'$response->createdAt;// 1741476542$response->status;// 'completed'$response->error;// null$response->incompleteDetails;// null$response->instructions;// null$response->maxOutputTokens;// null$response->model;// 'gpt-4o-mini-2024-07-18"'$response->parallelToolCalls;// true$response->previousResponseId;// null$response->store;// true$response->temperature;// 1.0$response->toolChoice;// 'auto'$response->topP;// 1.0$response->truncation;// 'disabled'$response->toArray();// ['id' => 'resp_67ccd2bed1ec8190b14f964abc054267', ...]
Cancel a model response (background request) with the given ID.
$response =$client->responses()->cancel('resp_67ccd2bed1ec8190b14f964abc054267');$response->id;// 'resp_67ccd2bed1ec8190b14f964abc054267'$response->status;// 'canceled'$response->toArray();// ['id' => 'resp_67ccd2bed1ec8190b14f964abc054267', 'status' => 'canceled', ...]
Deletes a model response with the given ID.
$response =$client->responses()->delete('resp_67ccd2bed1ec8190b14f964abc054267');$response->id;// 'resp_67ccd2bed1ec8190b14f964abc054267'$response->object;// 'response'$response->deleted;// true$response->toArray();// ['id' => 'resp_67ccd2bed1ec8190b14f964abc054267', 'deleted' => true, ...]
Lists input items for a response with the given ID. All events and their payloads can be found inOpenAI docs.
$response =$client->responses()->list('resp_67ccd2bed1ec8190b14f964abc054267', ['limit' =>10,'order' =>'desc']);$response->object;// 'list'foreach ($response->dataas$item) {$item->type;// 'message'$item->id;// 'msg_680bf4e8c1948192b64abf0bad54b30806e0834f49400fc3'$item->status;// 'completed'$item->role;// 'user'}$response->firstId;// 'msg_680bf4e8c1948192b64abf0bad54b30806e0834f49400fc3'$response->lastId;// 'msg_680bf4e8c1948192b64abf0bad54b30806e0834f49400fc3'$response->hasMore;// false$response->toArray();// ['object' => 'list', 'data' => [...], ...]
Creates a completion for the provided prompt and parameters.
$response =$client->completions()->create(['model' =>'gpt-3.5-turbo-instruct','prompt' =>'Say this is a test','max_tokens' =>6,'temperature' =>0]);$response->id;// 'cmpl-uqkvlQyYK7bGYrRHQ0eXlWi7'$response->object;// 'text_completion'$response->created;// 1589478378$response->model;// 'gpt-3.5-turbo-instruct'foreach ($response->choicesas$choice) {$choice->text;// '\n\nThis is a test'$choice->index;// 0$choice->logprobs;// null$choice->finishReason;// 'length' or null}$response->usage->promptTokens;// 5,$response->usage->completionTokens;// 6,$response->usage->totalTokens;// 11$response->toArray();// ['id' => 'cmpl-uqkvlQyYK7bGYrRHQ0eXlWi7', ...]
Creates a streamed completion for the provided prompt and parameters.
$stream =$client->completions()->createStreamed(['model' =>'gpt-3.5-turbo-instruct','prompt' =>'Hi','max_tokens' =>10, ]);foreach($streamas$response){$response->choices[0]->text;}// 1. iteration => 'I'// 2. iteration => ' am'// 3. iteration => ' very'// 4. iteration => ' excited'// ...
Creates a completion for the chat message.
$response =$client->chat()->create(['model' =>'gpt-3.5-turbo','messages' => [ ['role' =>'user','content' =>'Hello!'], ],]);$response->id;// 'chatcmpl-6pMyfj1HF4QXnfvjtfzvufZSQq6Eq'$response->object;// 'chat.completion'$response->created;// 1677701073$response->model;// 'gpt-3.5-turbo-0301'foreach ($response->choicesas$choice) {$choice->index;// 0$choice->message->role;// 'assistant'$choice->message->content;// '\n\nHello there! How can I assist you today?'$choice->logprobs;// null$choice->finishReason;// 'stop'}$response->usage->promptTokens;// 9,$response->usage->completionTokens;// 12,$response->usage->totalTokens;// 21$response->toArray();// ['id' => 'chatcmpl-6pMyfj1HF4QXnfvjtfzvufZSQq6Eq', ...]
Creates a completion for the chat message with a tool call.
$response =$client->chat()->create(['model' =>'gpt-3.5-turbo-0613','messages' => [ ['role' =>'user','content' =>'What\'s the weather like in Boston?'], ],'tools' => [ ['type' =>'function','function' => ['name' =>'get_current_weather','description' =>'Get the current weather in a given location','parameters' => ['type' =>'object','properties' => ['location' => ['type' =>'string','description' =>'The city and state, e.g. San Francisco, CA', ],'unit' => ['type' =>'string','enum' => ['celsius','fahrenheit'] ], ],'required' => ['location'], ], ], ] ]]);$response->id;// 'chatcmpl-6pMyfj1HF4QXnfvjtfzvufZSQq6Eq'$response->object;// 'chat.completion'$response->created;// 1677701073$response->model;// 'gpt-3.5-turbo-0613'foreach ($response->choicesas$choice) {$choice->index;// 0$choice->message->role;// 'assistant'$choice->message->content;// null$choice->message->toolCalls[0]->id;// 'call_123'$choice->message->toolCalls[0]->type;// 'function'$choice->message->toolCalls[0]->function->name;// 'get_current_weather'$choice->message->toolCalls[0]->function->arguments;// "{\n \"location\": \"Boston, MA\"\n}"$choice->finishReason;// 'tool_calls'}$response->usage->promptTokens;// 82,$response->usage->completionTokens;// 18,$response->usage->totalTokens;// 100
Creates a completion for the chat message with a function call.
$response =$client->chat()->create(['model' =>'gpt-3.5-turbo-0613','messages' => [ ['role' =>'user','content' =>'What\'s the weather like in Boston?'], ],'functions' => [ ['name' =>'get_current_weather','description' =>'Get the current weather in a given location','parameters' => ['type' =>'object','properties' => ['location' => ['type' =>'string','description' =>'The city and state, e.g. San Francisco, CA', ],'unit' => ['type' =>'string','enum' => ['celsius','fahrenheit'] ], ],'required' => ['location'], ], ] ]]);$response->id;// 'chatcmpl-6pMyfj1HF4QXnfvjtfzvufZSQq6Eq'$response->object;// 'chat.completion'$response->created;// 1677701073$response->model;// 'gpt-3.5-turbo-0613'foreach ($response->choicesas$choice) {$choice->index;// 0$choice->message->role;// 'assistant'$choice->message->content;// null$choice->message->functionCall->name;// 'get_current_weather'$choice->message->functionCall->arguments;// "{\n \"location\": \"Boston, MA\"\n}"$choice->finishReason;// 'function_call'}$response->usage->promptTokens;// 82,$response->usage->completionTokens;// 18,$response->usage->totalTokens;// 100
Creates a chat completion with image input viaimage_url.
Useful for describing and analyzing visual content.
$response =$client->chat()->create(['model' =>'gpt-4o','messages' => [ ['role' =>'user','content' => [ ['type' =>'text','text' =>'What is in this image?'],// Replace with a real, accessible image ['type' =>'image_url','image_url' => ['url' =>'https://example.com/image.jpg']], ] ] ]]);
Creates a streamed completion for the chat message.
$stream =$client->chat()->createStreamed(['model' =>'gpt-4o','messages' => [ ['role' =>'user','content' =>'Hello!'], ],]);foreach($streamas$response){$response->choices[0]->toArray();}// 1. iteration => ['index' => 0, 'delta' => ['role' => 'assistant'], 'finish_reason' => null]// 2. iteration => ['index' => 0, 'delta' => ['content' => 'Hello'], 'finish_reason' => null]// 3. iteration => ['index' => 0, 'delta' => ['content' => '!'], 'finish_reason' => null]// ...
To get usage report when using stream you can useinclude_usage instream_options .
$stream =$client->chat()->createStreamed(['model' =>'gpt-4','messages' => [ ['role' =>'user','content' =>'Hello!'], ],'stream_options'=>['include_usage' =>true, ]]);foreach($streamas$response){if($response->usage !==null){$response->usage->promptTokens;// 9,$response->usage->completionTokens;// 12,$response->usage->totalTokens;// 21 }}
usage is alwaysnull except for the last chunk which contains the token usage statistics for the entire request.
Generates audio from the input text.
$client->audio()->speech(['model' =>'tts-1','input' =>'The quick brown fox jumped over the lazy dog.','voice' =>'alloy',]);// audio file content as string
Generates streamed audio from the input text.
$stream =$client->audio()->speechStreamed(['model' =>'tts-1','input' =>'The quick brown fox jumped over the lazy dog.','voice' =>'alloy',]);foreach($streamas$chunk){$chunk;// chunk of audio file content as string}
Transcribes audio into the input language.
$response =$client->audio()->transcribe(['model' =>'whisper-1','file' =>fopen('audio.mp3','r'),'response_format' =>'verbose_json','timestamp_granularities' => ['segment','word']]);$response->task;// 'transcribe'$response->language;// 'english'$response->duration;// 2.95$response->text;// 'Hello, how are you?'foreach ($response->segmentsas$segment) {$segment->index;// 0$segment->seek;// 0$segment->start;// 0.0$segment->end;// 4.0$segment->text;// 'Hello, how are you?'$segment->tokens;// [50364, 2425, 11, 577, 366, 291, 30, 50564]$segment->temperature;// 0.0$segment->avgLogprob;// -0.45045216878255206$segment->compressionRatio;// 0.7037037037037037$segment->noSpeechProb;// 0.1076972484588623$segment->transient;// false}foreach ($response->wordsas$word) {$word->word;// 'Hello'$word->start;// 0.31$word->end;// 0.92}$response->toArray();// ['task' => 'transcribe', ...]
Transcribes audio into the input language with streaming.
$stream =$client->audio()->transcribeStreamed(['model' =>'gpt-4o-transcribe','file' =>fopen('audio.mp3','r'),]);foreach ($streamas$event) {echojson_encode($event->toArray());// {"event":"transcript.text.delta","data":{"delta":"The"}}}
Translates audio into English.
$response =$client->audio()->translate(['model' =>'whisper-1','file' =>fopen('german.mp3','r'),'response_format' =>'verbose_json',]);$response->task;// 'translate'$response->language;// 'english'$response->duration;// 2.95$response->text;// 'Hello, how are you?'foreach ($response->segmentsas$segment) {$segment->index;// 0$segment->seek;// 0$segment->start;// 0.0$segment->end;// 4.0$segment->text;// 'Hello, how are you?'$segment->tokens;// [50364, 2425, 11, 577, 366, 291, 30, 50564]$segment->temperature;// 0.0$segment->avgLogprob;// -0.45045216878255206$segment->compressionRatio;// 0.7037037037037037$segment->noSpeechProb;// 0.1076972484588623$segment->transient;// false}$response->toArray();// ['task' => 'translate', ...]
Creates an embedding vector representing the input text.
$response =$client->embeddings()->create(['model' =>'text-similarity-babbage-001','input' =>'The food was delicious and the waiter...',]);$response->object;// 'list'foreach ($response->embeddingsas$embedding) {$embedding->object;// 'embedding'$embedding->embedding;// [0.018990106880664825, -0.0073809814639389515, ...]$embedding->index;// 0}$response->usage->promptTokens;// 8,$response->usage->totalTokens;// 8$response->toArray();// ['data' => [...], ...]
Returns a list of files that belong to the user's organization.
$response =$client->files()->list();$response->object;// 'list'foreach ($response->dataas$result) {$result->id;// 'file-XjGxS3KTG0uNmNOK362iJua3'$result->object;// 'file'// ...}$response->toArray();// ['object' => 'list', 'data' => [...]]
Delete a file.
$response =$client->files()->delete($file);$response->id;// 'file-XjGxS3KTG0uNmNOK362iJua3'$response->object;// 'file'$response->deleted;// true$response->toArray();// ['id' => 'file-XjGxS3KTG0uNmNOK362iJua3', ...]
Returns information about a specific file.
$response =$client->files()->retrieve('file-XjGxS3KTG0uNmNOK362iJua3');$response->id;// 'file-XjGxS3KTG0uNmNOK362iJua3'$response->object;// 'file'$response->bytes;// 140$response->createdAt;// 1613779657$response->filename;// 'mydata.jsonl'$response->purpose;// 'fine-tune'$response->status;// 'succeeded'$response->status_details;// null$response->toArray();// ['id' => 'file-XjGxS3KTG0uNmNOK362iJua3', ...]
Upload a file that contains document(s) to be used across various endpoints/features.
$response =$client->files()->upload(['purpose' =>'fine-tune','file' =>fopen('my-file.jsonl','r'), ]);$response->id;// 'file-XjGxS3KTG0uNmNOK362iJua3'$response->object;// 'file'$response->bytes;// 140$response->createdAt;// 1613779657$response->filename;// 'mydata.jsonl'$response->purpose;// 'fine-tune'$response->status;// 'succeeded'$response->status_details;// null$response->toArray();// ['id' => 'file-XjGxS3KTG0uNmNOK362iJua3', ...]
Returns the contents of the specified file.
$client->files()->download($file);// '{"prompt": "<prompt text>", ...'
Creates a job that fine-tunes a specified model from a given dataset.
$response =$client->fineTuning()->createJob(['training_file' =>'file-abc123','validation_file' =>null,'model' =>'gpt-3.5-turbo','hyperparameters' => ['n_epochs' =>4, ],'suffix' =>null,]);$response->id;// 'ftjob-AF1WoRqd3aJAHsqc9NY7iL8F'$response->object;// 'fine_tuning.job'$response->model;// 'gpt-3.5-turbo-0613'$response->fineTunedModel;// null// ...$response->toArray();// ['id' => 'ftjob-AF1WoRqd3aJAHsqc9NY7iL8F', ...]
List your organization's fine-tuning jobs.
$response =$client->fineTuning()->listJobs();$response->object;// 'list'foreach ($response->dataas$result) {$result->id;// 'ftjob-AF1WoRqd3aJAHsqc9NY7iL8F'$result->object;// 'fine_tuning.job'// ...}$response->toArray();// ['object' => 'list', 'data' => [...]]
You can pass additional parameters to thelistJobs method to narrow down the results.
$response =$client->fineTuning()->listJobs(['limit' =>3,// Number of jobs to retrieve (Default: 20)'after' =>'ftjob-AF1WoRqd3aJAHsqc9NY7iL8F',// Identifier for the last job from the previous pagination request.]);
Get info about a fine-tuning job.
$response =$client->fineTuning()->retrieveJob('ftjob-AF1WoRqd3aJAHsqc9NY7iL8F');$response->id;// 'ftjob-AF1WoRqd3aJAHsqc9NY7iL8F'$response->object;// 'fine_tuning.job'$response->model;// 'gpt-3.5-turbo-0613'$response->createdAt;// 1614807352$response->finishedAt;// 1692819450$response->fineTunedModel;// 'ft:gpt-3.5-turbo-0613:jwe-dev::7qnxQ0sQ'$response->organizationId;// 'org-jwe45798ASN82s'$response->resultFiles[0];// 'file-1bl05WrhsKDDEdg8XSP617QF'$response->status;// 'succeeded'$response->validationFile;// null$response->trainingFile;// 'file-abc123'$response->trainedTokens;// 5049$response->hyperparameters->nEpochs;// 9$response->toArray();// ['id' => 'ftjob-AF1WoRqd3aJAHsqc9NY7iL8F', ...]
Immediately cancel a fine-tune job.
$response =$client->fineTuning()->cancelJob('ftjob-AF1WoRqd3aJAHsqc9NY7iL8F');$response->id;// 'ftjob-AF1WoRqd3aJAHsqc9NY7iL8F'$response->object;// 'fine_tuning.job'// ...$response->status;// 'cancelled'// ...$response->toArray();// ['id' => 'ftjob-AF1WoRqd3aJAHsqc9NY7iL8F', ...]
Get status updates for a fine-tuning job.
$response =$client->fineTuning()->listJobEvents('ftjob-AF1WoRqd3aJAHsqc9NY7iL8F');$response->object;// 'list'foreach ($response->dataas$result) {$result->object;// 'fine_tuning.job.event'$result->createdAt;// 1614807352// ...}$response->toArray();// ['object' => 'list', 'data' => [...]]
You can pass additional parameters to thelistJobEvents method to narrow down the results.
$response =$client->fineTuning()->listJobEvents('ftjob-AF1WoRqd3aJAHsqc9NY7iL8F', ['limit' =>3,// Number of events to retrieve (Default: 20)'after' =>'ftevent-kLPSMIcsqshEUEJVOVBVcHlP',// Identifier for the last event from the previous pagination request.]);
Classifies if text violates OpenAI's Content Policy.
$response =$client->moderations()->create(['model' =>'text-moderation-latest','input' =>'I want to k*** them.',]);$response->id;// modr-5xOyuS$response->model;// text-moderation-003foreach ($response->resultsas$result) {$result->flagged;// trueforeach ($result->categoriesas$category) {$category->category->value;// 'violence'$category->violated;// true$category->score;// 0.97431367635727 }}$response->toArray();// ['id' => 'modr-5xOyuS', ...]
Creates an image given a prompt.
$response =$client->images()->create(['model' =>'dall-e-3','prompt' =>'A cute baby sea otter','n' =>1,'size' =>'1024x1024','response_format' =>'url',]);$response->created;// 1589478378foreach ($response->dataas$data) {$data->url;// 'https://oaidalleapiprodscus.blob.core.windows.net/private/...'$data->b64_json;// null}$response->toArray();// ['created' => 1589478378, data => ['url' => 'https://oaidalleapiprodscus...', ...]]
Creates an edited or extended image given an original image and a prompt.
$response =$client->images()->edit(['image' =>fopen('image_edit_original.png','r'),'mask' =>fopen('image_edit_mask.png','r'),'prompt' =>'A sunlit indoor lounge area with a pool containing a flamingo','n' =>1,'size' =>'256x256','response_format' =>'url',]);$response->created;// 1589478378foreach ($response->dataas$data) {$data->url;// 'https://oaidalleapiprodscus.blob.core.windows.net/private/...'$data->b64_json;// null}$response->toArray();// ['created' => 1589478378, data => ['url' => 'https://oaidalleapiprodscus...', ...]]
Creates a variation of a given image.
$response =$client->images()->variation(['image' =>fopen('image_edit_original.png','r'),'n' =>1,'size' =>'256x256','response_format' =>'url',]);$response->created;// 1589478378foreach ($response->dataas$data) {$data->url;// 'https://oaidalleapiprodscus.blob.core.windows.net/private/...'$data->b64_json;// null}$response->toArray();// ['created' => 1589478378, data => ['url' => 'https://oaidalleapiprodscus...', ...]]
Creates a batch.
$fileResponse =$client->files()->upload( parameters: ['purpose' =>'batch','file' =>fopen('commands.jsonl','r'), ]);$fileId =$fileResponse->id;$response =$client->batches()->create( parameters: ['input_file_id' =>$fileId,'endpoint' =>'/v1/chat/completions','completion_window' =>'24h' ] );$response->id;// 'batch_abc123'$response->object;// 'batch'$response->endpoint;// /v1/chat/completions$response->errors;// null$response->completionWindow;// '24h'$response->status;// 'validating'$response->outputFileId;// null$response->errorFileId;// null$response->createdAt;// 1714508499$response->inProgressAt;// null$response->expiresAt;// 1714536634$response->completedAt;// null$response->failedAt;// null$response->expiredAt;// null$response->requestCounts;// null$response->metadata;// ['name' => 'My batch name']$response->toArray();// ['id' => 'batch_abc123', ...]
Retrieves a batch.
$response =$client->batches()->retrieve(id:'batch_abc123');$response->id;// 'batch_abc123'$response->object;// 'batch'$response->endpoint;// /v1/chat/completions$response->errors;// null$response->completionWindow;// '24h'$response->status;// 'validating'$response->outputFileId;// null$response->errorFileId;// null$response->createdAt;// 1714508499$response->inProgressAt;// null$response->expiresAt;// 1714536634$response->completedAt;// null$response->failedAt;// null$response->expiredAt;// null$response->requestCounts->total;// 100$response->requestCounts->completed;// 95$response->requestCounts->failed;// 5$response->metadata;// ['name' => 'My batch name']$response->toArray();// ['id' => 'batch_abc123', ...]
Cancels a batch.
$response =$client->batches()->cancel(id:'batch_abc123');$response->id;// 'batch_abc123'$response->object;// 'batch'$response->endpoint;// /v1/chat/completions$response->errors;// null$response->completionWindow;// '24h'$response->status;// 'cancelling'$response->outputFileId;// null$response->errorFileId;// null$response->createdAt;// 1711471533$response->inProgressAt;// 1711471538$response->expiresAt;// 1711557933$response->cancellingAt;// 1711475133$response->cancelledAt;// null$response->requestCounts->total;// 100$response->requestCounts->completed;// 23$response->requestCounts->failed;// 1$response->metadata;// ['name' => 'My batch name']$response->toArray();// ['id' => 'batch_abc123', ...]
Returns a list of batches.
$response =$client->batches()->list( parameters: ['limit' =>10, ],);$response->object;// 'list'$response->firstId;// 'batch_abc123'$response->lastId;// 'batch_abc456'$response->hasMore;// trueforeach ($response->dataas$result) {$result->id;// 'batch_abc123'// ...}$response->toArray();// ['object' => 'list', ...]]
Create a vector store.
$response =$client->vectorStores()->create(['file_ids' => ['file-fUU0hFRuQ1GzhOweTNeJlCXG', ],'name' =>'My first Vector Store',]);$response->id;// 'vs_vzfQhlTWVUl38QGqQAoQjeDF'$response->object;// 'vector_store'$response->createdAt;// 1717703267$response->name;// 'My first Vector Store'$response->usageBytes;// 0$response->fileCounts->inProgress;// 1$response->fileCounts->completed;// 0$response->fileCounts->failed;// 0$response->fileCounts->cancelled;// 0$response->fileCounts->total;// 1$response->status;// 'in_progress'$response->expiresAfter;// null$response->expiresAt;// null$response->lastActiveAt;// 1717703267$response->toArray();// ['id' => 'vs_vzfQhlTWVUl38QGqQAoQjeDF', ...]
Retrieves a vector store.
$response =$client->vectorStores()->retrieve( vectorStoreId:'vs_vzfQhlTWVUl38QGqQAoQjeDF',);$response->id;// 'vs_vzfQhlTWVUl38QGqQAoQjeDF'$response->object;// 'vector_store'$response->createdAt;// 1717703267$response->name;// 'My first Vector Store'$response->usageBytes;// 0$response->fileCounts->inProgress;// 1$response->fileCounts->completed;// 0$response->fileCounts->failed;// 0$response->fileCounts->cancelled;// 0$response->fileCounts->total;// 1$response->status;// 'in_progress'$response->expiresAfter;// null$response->expiresAt;// null$response->lastActiveAt;// 1717703267$response->toArray();// ['id' => 'vs_vzfQhlTWVUl38QGqQAoQjeDF', ...]
Modifies a vector store.
$response =$client->vectorStores()->modify( vectorStoreId:'vs_vzfQhlTWVUl38QGqQAoQjeDF', parameters: ['name' =>'New name', ],);$response->id;// 'vs_vzfQhlTWVUl38QGqQAoQjeDF'$response->object;// 'vector_store'$response->createdAt;// 1717703267$response->name;// 'New name'$response->usageBytes;// 0$response->fileCounts->inProgress;// 1$response->fileCounts->completed;// 0$response->fileCounts->failed;// 0$response->fileCounts->cancelled;// 0$response->fileCounts->total;// 1$response->status;// 'in_progress'$response->expiresAfter;// null$response->expiresAt;// null$response->lastActiveAt;// 1717703267$response->toArray();// ['id' => 'vs_vzfQhlTWVUl38QGqQAoQjeDF', ...]
Delete a vector store.
$response =$client->vectorStores()->delete( vectorStoreId:'vs_vzfQhlTWVUl38QGqQAoQjeDF',);$response->id;// 'vs_vzfQhlTWVUl38QGqQAoQjeDF'$response->object;// 'vector_store.deleted'$response->deleted;// true$response->toArray();// ['id' => 'vs_vzfQhlTWVUl38QGqQAoQjeDF', ...]
Returns a list of vector stores.
$response =$client->vectorStores()->list( parameters: ['limit' =>10, ],);$response->object;// 'list'$response->firstId;// 'vs_vzfQhlTWVUl38QGqQAoQjeDF'$response->lastId;// 'vs_D5DPOgBxSoEBTmYBgUESdPpa'$response->hasMore;// trueforeach ($response->dataas$result) {$result->id;// 'vs_vzfQhlTWVUl38QGqQAoQjeDF'// ...}$response->toArray();// ['object' => 'list', ...]]
Create a vector store file by attaching a File to a vector store.
$response =$client->vectorStores()->files()->create( vectorStoreId:'vs_vzfQhlTWVUl38QGqQAoQjeDF', parameters: ['file_id' =>'file-fUU0hFRuQ1GzhOweTNeJlCXG', ]);$response->id;// 'file-fUU0hFRuQ1GzhOweTNeJlCXG'$response->object;// 'vector_store.file'$response->usageBytes;// 4553$response->createdAt;// 1717703267$response->vectorStoreId;// 'vs_vzfQhlTWVUl38QGqQAoQjeDF'$response->status;// 'completed'$response->lastError;// null$response->chunkingStrategy->type;// 'static'$response->chunkingStrategy->maxChunkSizeTokens;// 800$response->chunkingStrategy->chunkOverlapTokens;// 400$response->toArray();// ['id' => 'file-fUU0hFRuQ1GzhOweTNeJlCXG', ...]
Retrieves a vector store file.
$response =$client->vectorStores()->files()->retrieve( vectorStoreId:'vs_vzfQhlTWVUl38QGqQAoQjeDF', fileId:'file-fUU0hFRuQ1GzhOweTNeJlCXG',);$response->id;// 'file-fUU0hFRuQ1GzhOweTNeJlCXG'$response->object;// 'vector_store.file'$response->usageBytes;// 4553$response->createdAt;// 1717703267$response->vectorStoreId;// 'vs_vzfQhlTWVUl38QGqQAoQjeDF'$response->status;// 'completed'$response->lastError;// null$response->chunkingStrategy->type;// 'static'$response->chunkingStrategy->maxChunkSizeTokens;// 800$response->chunkingStrategy->chunkOverlapTokens;// 400$response->toArray();// ['id' => 'file-fUU0hFRuQ1GzhOweTNeJlCXG', ...]
Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the delete file endpoint.
$response =$client->vectorStores()->files()->delete( vectorStoreId:'vs_vzfQhlTWVUl38QGqQAoQjeDF', fileId:'file-fUU0hFRuQ1GzhOweTNeJlCXG',);$response->id;// 'file-fUU0hFRuQ1GzhOweTNeJlCXG'$response->object;// 'vector_store.file.deleted'$response->deleted;// true$response->toArray();// ['id' => 'file-fUU0hFRuQ1GzhOweTNeJlCXG', ...]
Returns a list of vector store files.
$response =$client->vectorStores()->files()->list( vectorStoreId:'vs_vzfQhlTWVUl38QGqQAoQjeDF', parameters: ['limit' =>10, ],);$response->object;// 'list'$response->firstId;// 'file-fUU0hFRuQ1GzhOweTNeJlCXG'$response->lastId;// 'file-D5DPOgBxSoEBTmYBgUESdPpa'$response->hasMore;// trueforeach ($response->dataas$result) {$result->id;// 'file-fUU0hFRuQ1GzhOweTNeJlCXG'// ...}$response->toArray();// ['object' => 'list', ...]]
Search a vector store for relevant chunks based on a query and file attributes filter.
$response =$client->vectorStores()->search( vectorStoreId:'vs_vzfQhlTWVUl38QGqQAoQjeDF', parameters: ['query' =>'What is the return policy?','max_num_results' =>5,'filters' => [],'rewrite_query' =>false ]);$response->object;// 'vector_store.search_results.page'$response->searchQuery;// 'What is the return policy?'$response->hasMore;// false$response->nextPage;// nullforeach ($response->dataas$file) {$result->fileId;// 'file-fUU0hFRuQ1GzhOweTNeJlCXG'$result->filename;// 'return_policy.pdf'$result->score;// 0.95$result->attributes;// ['category' => 'customer_service']foreach ($result->contentas$content) {$content->type;// 'text'$content->text;// 'Our return policy allows customers to return items within 30 days...' }}$response->toArray();// ['object' => 'vector_store.search_results.page', ...]
Create a vector store file batch.
$response =$client->vectorStores()->batches()->create( vectorStoreId:'vs_vzfQhlTWVUl38QGqQAoQjeDF', parameters: ['file_ids' => ['file-fUU0hFRuQ1GzhOweTNeJlCXG', ], ]);$response->id;// 'vsfb_123'$response->object;// 'vector_store.files_batch'$response->createdAt;// 1698107661$response->vectorStoreId;// 'vs_vzfQhlTWVUl38QGqQAoQjeDF'$response->status;// 'completed'$response->fileCounts->inProgress;// 1$response->fileCounts->completed;// 0$response->fileCounts->failed;// 0$response->fileCounts->cancelled;// 0$response->fileCounts->total;// 1$response->toArray();// ['id' => 'vsfb_123', ...]
Retrieves a vector store file batch.
$response =$client->vectorStores()->batches()->retrieve( vectorStoreId:'vs_vzfQhlTWVUl38QGqQAoQjeDF', fileBatchId:'vsfb_123',);$response->id;// 'vsfb_123'$response->object;// 'vector_store.files_batch'$response->createdAt;// 1698107661$response->vectorStoreId;// 'vs_vzfQhlTWVUl38QGqQAoQjeDF'$response->status;// 'completed'$response->fileCounts->inProgress;// 1$response->fileCounts->completed;// 0$response->fileCounts->failed;// 0$response->fileCounts->cancelled;// 0$response->fileCounts->total;// 1$response->toArray();// ['id' => 'vsfb_123', ...]
Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.
$response =$client->vectorStores()->batches()->cancel( vectorStoreId:'vs_vzfQhlTWVUl38QGqQAoQjeDF', fileBatchId:'vsfb_123',);$response->id;// 'vsfb_123'$response->object;// 'vector_store.files_batch'$response->createdAt;// 1698107661$response->vectorStoreId;// 'vs_vzfQhlTWVUl38QGqQAoQjeDF'$response->status;// 'cancelling'$response->fileCounts->inProgress;// 1$response->fileCounts->completed;// 0$response->fileCounts->failed;// 0$response->fileCounts->cancelled;// 0$response->fileCounts->total;// 1$response->toArray();// ['id' => 'vsfb_123', ...]
Returns a list of vector store files.
$response =$client->vectorStores()->batches()->listFiles( vectorStoreId:'vs_vzfQhlTWVUl38QGqQAoQjeDF', fileBatchId:'vsfb_123', parameters: ['limit' =>10, ],);$response->object;// 'list'$response->firstId;// 'file-fUU0hFRuQ1GzhOweTNeJlCXG'$response->lastId;// 'file-D5DPOgBxSoEBTmYBgUESdPpa'$response->hasMore;// trueforeach ($response->dataas$result) {$result->id;// 'file-fUU0hFRuQ1GzhOweTNeJlCXG'// ...}$response->toArray();// ['object' => 'list', ...]]
Create an ephemeral API token for real time sessions.
$response =$client->realtime()->token();$response->clientSecret->value// 'ek-1234567890abcdefg'$response->clientSecret->expiresAt// 1717703267
Create an ephemeral API token for real time transcription sessions.
$response =$client->realtime()->transcribeToken();$response->clientSecret->value// 'et-1234567890abcdefg'$response->clientSecret->expiresAt// 1717703267
Warning
TheCompletions resource was marked "Legacy" by OpenAI in July 2023. Please use theChat resource instead.
Completion API Information
Creates a completion for the provided prompt and parameters.
$response =$client->completions()->create(['model' =>'gpt-3.5-turbo-instruct','prompt' =>'Say this is a test','max_tokens' =>6,'temperature' =>0]);$response->id;// 'cmpl-uqkvlQyYK7bGYrRHQ0eXlWi7'$response->object;// 'text_completion'$response->created;// 1589478378$response->model;// 'gpt-3.5-turbo-instruct'foreach ($response->choicesas$choice) {$choice->text;// '\n\nThis is a test'$choice->index;// 0$choice->logprobs;// null$choice->finishReason;// 'length' or null}$response->usage->promptTokens;// 5,$response->usage->completionTokens;// 6,$response->usage->totalTokens;// 11$response->toArray();// ['id' => 'cmpl-uqkvlQyYK7bGYrRHQ0eXlWi7', ...]
Creates a streamed completion for the provided prompt and parameters.
$stream =$client->completions()->createStreamed(['model' =>'gpt-3.5-turbo-instruct','prompt' =>'Hi','max_tokens' =>10, ]);foreach($streamas$response){$response->choices[0]->text;}// 1. iteration => 'I'// 2. iteration => ' am'// 3. iteration => ' very'// 4. iteration => ' excited'// ...
Warning
OpenAI has deprecated the Assistants API and will stop working by first half of 2026.https://platform.openai.com/docs/guides/responses-vs-chat-completions#assistants
Assistants API Information
Note - If you are creating the client manually from the factory. Make sure you provide the necessary header:
$factory->withHttpHeader('OpenAI-Beta','assistants=v2')
Create an assistant with a model and instructions.
$response =$client->assistants()->create(['instructions' =>'You are a personal math tutor. When asked a question, write and run Python code to answer the question.','name' =>'Math Tutor','tools' => [ ['type' =>'code_interpreter', ], ],'model' =>'gpt-4o',]);$response->id;// 'asst_gxzBkD1wkKEloYqZ410pT5pd'$response->object;// 'assistant'$response->createdAt;// 1623936000$response->name;// 'Math Tutor'$response->instructions;// 'You are a personal math tutor. When asked a question, write and run Python code to answer the question.'$response->model;// 'gpt-4o'$response->description;// null$response->tools[0]->type;// 'code_interpreter'$response->toolResources;// []$response->metadata;// []$response->temperature:// null$response->topP:// null$response->format:// 'auto'$response->toArray();// ['id' => 'asst_gxzBkD1wkKEloYqZ410pT5pd', ...]
Retrieves an assistant.
$response =$client->assistants()->retrieve('asst_gxzBkD1wkKEloYqZ410pT5pd');$response->id;// 'asst_gxzBkD1wkKEloYqZ410pT5pd'$response->object;// 'assistant'$response->createdAt;// 1623936000$response->name;// 'Math Tutor'$response->instructions;// 'You are a personal math tutor. When asked a question, write and run Python code to answer the question.'$response->model;// 'gpt-4o'$response->description;// null$response->tools[0]->type;// 'code_interpreter'$response->toolResources;// []$response->metadata;// []$response->temperature:// null$response->topP:// null$response->format:// 'auto'$response->toArray();// ['id' => 'asst_gxzBkD1wkKEloYqZ410pT5pd', ...]
Modifies an assistant.
$response =$client->assistants()->modify('asst_gxzBkD1wkKEloYqZ410pT5pd', ['name' =>'New Math Tutor', ]);$response->id;// 'asst_gxzBkD1wkKEloYqZ410pT5pd'$response->object;// 'assistant'$response->createdAt;// 1623936000$response->name;// 'New Math Tutor'$response->instructions;// 'You are a personal math tutor. When asked a question, write and run Python code to answer the question.'$response->model;// 'gpt-4o'$response->description;// null$response->tools[0]->type;// 'code_interpreter'$response->toolResources;// []$response->metadata;// []$response->temperature:// null$response->topP:// null$response->format:// 'auto'$response->toArray();// ['id' => 'asst_gxzBkD1wkKEloYqZ410pT5pd', ...]
Delete an assistant.
$response =$client->assistants()->delete('asst_gxzBkD1wkKEloYqZ410pT5pd');$response->id;// 'asst_gxzBkD1wkKEloYqZ410pT5pd'$response->object;// 'assistant.deleted'$response->deleted;// true$response->toArray();// ['id' => 'asst_gxzBkD1wkKEloYqZ410pT5pd', ...]
Returns a list of assistants.
$response =$client->assistants()->list(['limit' =>10,]);$response->object;// 'list'$response->firstId;// 'asst_gxzBkD1wkKEloYqZ410pT5pd'$response->lastId;// 'asst_reHHtAM0jKLDIxanM6gP6DaR'$response->hasMore;// trueforeach ($response->dataas$result) {$result->id;// 'asst_gxzBkD1wkKEloYqZ410pT5pd'// ...}$response->toArray();// ['object' => 'list', ...]]
Warning
OpenAI has deprecated the Assistants API and will stop working by first half of 2026.https://platform.openai.com/docs/guides/responses-vs-chat-completions#assistants
Threads API Information
Create a thread.
$response =$client->threads()->create([]);$response->id;// 'thread_tKFLqzRN9n7MnyKKvc1Q7868'$response->object;// 'thread'$response->createdAt;// 1623936000$response->toolResources;// null$response->metadata;// []$response->toArray();// ['id' => 'thread_tKFLqzRN9n7MnyKKvc1Q7868', ...]
Create a thread and run it in one request.
$response =$client->threads()->createAndRun( ['assistant_id' =>'asst_gxzBkD1wkKEloYqZ410pT5pd','thread' => ['messages' => [ ['role' =>'user','content' =>'Explain deep learning to a 5 year old.', ], ], ], ],);$response->id;// 'run_4RCYyYzX9m41WQicoJtUQAb8'$response->object;// 'thread.run'$response->createdAt;// 1623936000$response->assistantId;// 'asst_gxzBkD1wkKEloYqZ410pT5pd'$response->threadId;// 'thread_tKFLqzRN9n7MnyKKvc1Q7868'$response->status;// 'queued'$response->requiredAction;// null$response->lastError;// null$response->startedAt;// null$response->expiresAt;// 1699622335$response->cancelledAt;// null$response->failedAt;// null$response->completedAt;// null$response->incompleteDetails;// null$response->lastError;// null$response->model;// 'gpt-4o'$response->instructions;// null$response->tools;// []$response->metadata;// []$response->usage->total_tokens;// 579$response->temperature;// null$response->topP;// null$response->maxPromptTokens;// 1000$response->maxCompletionTokens;// 1000$response->truncationStrategy->type;// 'auto'$response->responseFormat;// 'auto'$response->toolChoice;// 'auto'$response->toArray();// ['id' => 'run_4RCYyYzX9m41WQicoJtUQAb8', ...]
Retrieves a thread.
$response =$client->threads()->retrieve('thread_tKFLqzRN9n7MnyKKvc1Q7868');$response->id;// 'thread_tKFLqzRN9n7MnyKKvc1Q7868'$response->object;// 'thread'$response->createdAt;// 1623936000$response->toolResources;// null$response->metadata;// []$response->toArray();// ['id' => 'thread_tKFLqzRN9n7MnyKKvc1Q7868', ...]
Modifies a thread.
$response =$client->threads()->modify('thread_tKFLqzRN9n7MnyKKvc1Q7868', ['metadata' => ['name' =>'My new thread name', ], ]);$response->id;// 'thread_tKFLqzRN9n7MnyKKvc1Q7868'$response->object;// 'thread'$response->createdAt;// 1623936000$response->toolResources;// null$response->metadata;// ['name' => 'My new thread name']$response->toArray();// ['id' => 'thread_tKFLqzRN9n7MnyKKvc1Q7868', ...]
Delete a thread.
$response =$client->threads()->delete('thread_tKFLqzRN9n7MnyKKvc1Q7868');$response->id;// 'thread_tKFLqzRN9n7MnyKKvc1Q7868'$response->object;// 'thread.deleted'$response->deleted;// true$response->toArray();// ['id' => 'thread_tKFLqzRN9n7MnyKKvc1Q7868', ...]
Warning
OpenAI has deprecated the Assistants API and will stop working by first half of 2026.https://platform.openai.com/docs/guides/responses-vs-chat-completions#assistants
Thread Messages API Information
Create a message.
$response =$client->threads()->messages()->create('thread_tKFLqzRN9n7MnyKKvc1Q7868', ['role' =>'user','content' =>'What is the sum of 5 and 7?',]);$response->id;// 'msg_SKYwvF3zcigxthfn6F4hnpdU'$response->object;// 'thread.message'$response->createdAt;// 1623936000$response->threadId;// 'thread_tKFLqzRN9n7MnyKKvc1Q7868'$response->status;// 'in_progress$response->incompleteDetails;// null$response->completedAt;// null$response->incompleteAt;// null$response->role;// 'user'$response->content[0]->type;// 'text'$response->content[0]->text->value;// 'What is the sum of 5 and 7?'$response->content[0]->text->annotations;// []$response->assistantId;// null$response->runId;// null$response->attachments;// []$response->metadata;// []$response->toArray();// ['id' => 'msg_SKYwvF3zcigxthfn6F4hnpdU', ...]
Retrieve a message.
$response =$client->threads()->messages()->retrieve( threadId:'thread_tKFLqzRN9n7MnyKKvc1Q7868', messageId:'msg_SKYwvF3zcigxthfn6F4hnpdU',);$response->id;// 'msg_SKYwvF3zcigxthfn6F4hnpdU'$response->object;// 'thread.message'$response->createdAt;// 1623936000$response->threadId;// 'thread_tKFLqzRN9n7MnyKKvc1Q7868'$response->status;// 'in_progress$response->incompleteDetails;// null$response->completedAt;// null$response->incompleteAt;// null$response->role;// 'user'$response->content[0]->type;// 'text'$response->content[0]->text->value;// 'What is the sum of 5 and 7?'$response->content[0]->text->annotations;// []$response->assistantId;// null$response->runId;// null$response->attachments;// []$response->metadata;// []$response->toArray();// ['id' => 'msg_SKYwvF3zcigxthfn6F4hnpdU', ...]
Modifies a message.
$response =$client->threads()->messages()->modify( threadId:'thread_tKFLqzRN9n7MnyKKvc1Q7868', messageId:'msg_SKYwvF3zcigxthfn6F4hnpdU', parameters: ['metadata' => ['name' =>'My new message name', ], ],);$response->id;// 'msg_SKYwvF3zcigxthfn6F4hnpdU'$response->object;// 'thread.message'$response->createdAt;// 1623936000$response->threadId;// 'thread_tKFLqzRN9n7MnyKKvc1Q7868'$response->status;// 'in_progress$response->incompleteDetails;// null$response->completedAt;// null$response->incompleteAt;// null$response->role;// 'user'$response->content[0]->type;// 'text'$response->content[0]->text->value;// 'What is the sum of 5 and 7?'$response->content[0]->text->annotations;// []$response->assistantId;// null$response->runId;// null$response->attachments;// []$response->metadata;// ['name' => 'My new message name']$response->toArray();// ['id' => 'msg_SKYwvF3zcigxthfn6F4hnpdU', ...]
Deletes a message.
$response =$client->threads()->messages()->delete( threadId:'thread_tKFLqzRN9n7MnyKKvc1Q7868', messageId:'msg_SKYwvF3zcigxthfn6F4hnpdU');$response->id;// 'msg_SKYwvF3zcigxthfn6F4hnpdU'$response->object;// 'thread.message.deleted'$response->deleted;// true$response->toArray();// ['id' => 'msg_SKYwvF3zcigxthfn6F4hnpdU', ...]
Returns a list of messages for a given thread.
$response =$client->threads()->messages()->list('thread_tKFLqzRN9n7MnyKKvc1Q7868', ['limit' =>10,]);$response->object;// 'list'$response->firstId;// 'msg_SKYwvF3zcigxthfn6F4hnpdU'$response->lastId;// 'msg_SKYwvF3zcigxthfn6F4hnpdU'$response->hasMore;// falseforeach ($response->dataas$result) {$result->id;// 'msg_SKYwvF3zcigxthfn6F4hnpdU'// ...}$response->toArray();// ['object' => 'list', ...]]
Warning
OpenAI has deprecated the Assistants API and will stop working by first half of 2026.https://platform.openai.com/docs/guides/responses-vs-chat-completions#assistants
Thread Runs API Information
Create a run.
$response =$client->threads()->runs()->create( threadId:'thread_tKFLqzRN9n7MnyKKvc1Q7868', parameters: ['assistant_id' =>'asst_gxzBkD1wkKEloYqZ410pT5pd', ],);$response->id;// 'run_4RCYyYzX9m41WQicoJtUQAb8'$response->object;// 'thread.run'$response->createdAt;// 1623936000$response->assistantId;// 'asst_gxzBkD1wkKEloYqZ410pT5pd'$response->threadId;// 'thread_tKFLqzRN9n7MnyKKvc1Q7868'$response->status;// 'queued'$response->startedAt;// null$response->expiresAt;// 1699622335$response->cancelledAt;// null$response->failedAt;// null$response->completedAt;// null$response->incompleteDetails;// null$response->lastError;// null$response->model;// 'gpt-4o'$response->instructions;// null$response->tools;// []$response->metadata;// []$response->usage->total_tokens;// 579$response->temperature;// null$response->topP;// null$response->maxPromptTokens;// 1000$response->maxCompletionTokens;// 1000$response->truncationStrategy->type;// 'auto'$response->toolChoice;// 'auto'$response->responseFormat;// 'auto'$response->toArray();// ['id' => 'run_4RCYyYzX9m41WQicoJtUQAb8', ...]
Creates a streamed run.
$stream =$client->threads()->runs()->createStreamed( threadId:'thread_tKFLqzRN9n7MnyKKvc1Q7868', parameters: ['assistant_id' =>'asst_gxzBkD1wkKEloYqZ410pT5pd', ],);foreach($streamas$response){$response->event// 'thread.run.created' | 'thread.run.in_progress' | .....$response->response// ThreadResponse | ThreadRunResponse | ThreadRunStepResponse | ThreadRunStepDeltaResponse | ThreadMessageResponse | ThreadMessageDeltaResponse}// ...
Creates a streamed run with function calls
$stream =$client->threads()->runs()->createStreamed( threadId:'thread_tKFLqzRN9n7MnyKKvc1Q7868', parameters: ['assistant_id' =>'asst_gxzBkD1wkKEloYqZ410pT5pd', ],);do{foreach($streamas$response){$response->event// 'thread.run.created' | 'thread.run.in_progress' | .....$response->response// ThreadResponse | ThreadRunResponse | ThreadRunStepResponse | ThreadRunStepDeltaResponse | ThreadMessageResponse | ThreadMessageDeltaResponseswitch($response->event){ case'thread.run.created':case'thread.run.queued':case'thread.run.completed':case'thread.run.cancelling':$run =$response->response;break; case'thread.run.expired':case'thread.run.cancelled':case'thread.run.failed':$run =$response->response;break3; case'thread.run.requires_action':// Overwrite the stream with the new stream started by submitting the tool outputs$stream =$client->threads()->runs()->submitToolOutputsStreamed( threadId:$run->threadId, runId:$run->id, parameters: ['tool_outputs' => [ ['tool_call_id' =>'call_KSg14X7kZF2WDzlPhpQ168Mj','output' =>'12', ] ], ] );break; } }}while ($run->status !="completed")// ...
Retrieves a run.
$response =$client->threads()->runs()->retrieve( threadId:'thread_tKFLqzRN9n7MnyKKvc1Q7868', runId:'run_4RCYyYzX9m41WQicoJtUQAb8',);$response->id;// 'run_4RCYyYzX9m41WQicoJtUQAb8'$response->object;// 'thread.run'$response->createdAt;// 1623936000$response->assistantId;// 'asst_gxzBkD1wkKEloYqZ410pT5pd'$response->threadId;// 'thread_tKFLqzRN9n7MnyKKvc1Q7868'$response->status;// 'queued'$response->startedAt;// null$response->expiresAt;// 1699622335$response->cancelledAt;// null$response->failedAt;// null$response->completedAt;// null$response->incompleteDetails;// null$response->lastError;// null$response->model;// 'gpt-4o'$response->instructions;// null$response->tools;// []$response->metadata;// []$response->usage->promptTokens;// 25,$response->usage->completionTokens;// 32,$response->usage->totalTokens;// 57$response->temperature;// null$response->topP;// null$response->maxPromptTokens;// 1000$response->maxCompletionTokens;// 1000$response->truncationStrategy->type;// 'auto'$response->toolChoice;// 'auto'$response->responseFormat;// 'auto'$response->toArray();// ['id' => 'run_4RCYyYzX9m41WQicoJtUQAb8', ...]
Modifies a run.
$response =$client->threads()->runs()->modify( threadId:'thread_tKFLqzRN9n7MnyKKvc1Q7868', runId:'run_4RCYyYzX9m41WQicoJtUQAb8', parameters: ['metadata' => ['name' =>'My new run name', ], ],);$response->id;// 'run_4RCYyYzX9m41WQicoJtUQAb8'$response->object;// 'thread.run'$response->createdAt;// 1623936000$response->assistantId;// 'asst_gxzBkD1wkKEloYqZ410pT5pd'$response->threadId;// 'thread_tKFLqzRN9n7MnyKKvc1Q7868'$response->status;// 'queued'$response->startedAt;// null$response->expiresAt;// 1699622335$response->cancelledAt;// null$response->failedAt;// null$response->completedAt;// null$response->incompleteDetails;// null$response->lastError;// null$response->model;// 'gpt-4o'$response->instructions;// null$response->tools;// []$response->usage->total_tokens;// 579$response->temperature;// null$response->topP;// null$response->maxPromptTokens;// 1000$response->maxCompletionTokens;// 1000$response->truncationStrategy->type;// 'auto'$response->toolChoice;// 'auto'$response->responseFormat;// 'auto'$response->metadata;// ['name' => 'My new run name']$response->toArray();// ['id' => 'run_4RCYyYzX9m41WQicoJtUQAb8', ...]
Cancels a run that isin_progress.
$response =$client->threads()->runs()->cancel( threadId:'thread_tKFLqzRN9n7MnyKKvc1Q7868', runId:'run_4RCYyYzX9m41WQicoJtUQAb8',);$response->id;// 'run_4RCYyYzX9m41WQicoJtUQAb8'$response->object;// 'thread.run'$response->createdAt;// 1623936000$response->assistantId;// 'asst_gxzBkD1wkKEloYqZ410pT5pd'$response->threadId;// 'thread_tKFLqzRN9n7MnyKKvc1Q7868'$response->status;// 'cancelling'$response->startedAt;// null$response->expiresAt;// 1699622335$response->cancelledAt;// null$response->failedAt;// null$response->completedAt;// null$response->incompleteDetails;// null$response->lastError;// null$response->model;// 'gpt-4o'$response->instructions;// null$response->tools;// []$response->usage?->total_tokens;// 579$response->temperature;// null$response->topP;// null$response->maxPromptTokens;// 1000$response->maxCompletionTokens;// 1000$response->truncationStrategy->type;// 'auto'$response->toolChoice;// 'auto'$response->responseFormat;// 'auto'$response->metadata;// []$response->toArray();// ['id' => 'run_4RCYyYzX9m41WQicoJtUQAb8', ...]
When a run has the status:requires_action andrequired_action.type issubmit_tool_outputs, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.
$response =$client->threads()->runs()->submitToolOutputs( threadId:'thread_tKFLqzRN9n7MnyKKvc1Q7868', runId:'run_4RCYyYzX9m41WQicoJtUQAb8', parameters: ['tool_outputs' => [ ['tool_call_id' =>'call_KSg14X7kZF2WDzlPhpQ168Mj','output' =>'12', ], ], ]);$response->id;// 'run_4RCYyYzX9m41WQicoJtUQAb8'$response->object;// 'thread.run'$response->createdAt;// 1623936000$response->assistantId;// 'asst_gxzBkD1wkKEloYqZ410pT5pd'$response->threadId;// 'thread_tKFLqzRN9n7MnyKKvc1Q7868'$response->status;// 'in_progress'$response->startedAt;// null$response->expiresAt;// 1699622335$response->cancelledAt;// null$response->failedAt;// null$response->completedAt;// null$response->incompleteDetails;// null$response->lastError;// null$response->model;// 'gpt-4o'$response->instructions;// null$response->usage->total_tokens;// 579$response->temperature;// null$response->topP;// null$response->maxPromptTokens;// 1000$response->maxCompletionTokens;// 1000$response->truncationStrategy->type;// 'auto'$response->responseFormat;// 'auto'$response->tools[0]->type;// 'function'$response->toolChoice;// 'auto'$response->metadata;// []$response->toArray();// ['id' => 'run_4RCYyYzX9m41WQicoJtUQAb8', ...]
Returns a list of runs belonging to a thread.
$response =$client->threads()->runs()->list( threadId:'thread_tKFLqzRN9n7MnyKKvc1Q7868', parameters: ['limit' =>10, ],);$response->object;// 'list'$response->firstId;// 'run_4RCYyYzX9m41WQicoJtUQAb8'$response->lastId;// 'run_4RCYyYzX9m41WQicoJtUQAb8'$response->hasMore;// falseforeach ($response->dataas$result) {$result->id;// 'run_4RCYyYzX9m41WQicoJtUQAb8'// ...}$response->toArray();// ['object' => 'list', ...]]
Warning
OpenAI has deprecated the Assistants API and will stop working by first half of 2026.https://platform.openai.com/docs/guides/responses-vs-chat-completions#assistants
Thread Run Steps API Information
Retrieves a run step.
$response =$client->threads()->runs()->steps()->retrieve( threadId:'thread_tKFLqzRN9n7MnyKKvc1Q7868', runId:'run_4RCYyYzX9m41WQicoJtUQAb8', stepId:'step_1spQXgbAabXFm1YXrwiGIMUz',);$response->id;// 'step_1spQXgbAabXFm1YXrwiGIMUz'$response->object;// 'thread.run.step'$response->createdAt;// 1699564106$response->runId;// 'run_4RCYyYzX9m41WQicoJtUQAb8'$response->assistantId;// 'asst_gxzBkD1wkKEloYqZ410pT5pd'$response->threadId;// 'thread_tKFLqzRN9n7MnyKKvc1Q7868'$response->type;// 'message_creation'$response->status;// 'completed'$response->cancelledAt;// null$response->completedAt;// 1699564119$response->expiresAt;// null$response->failedAt;// null$response->lastError;// null$response->stepDetails->type;// 'message_creation'$response->stepDetails->messageCreation->messageId;// 'msg_i404PxKbB92d0JAmdOIcX7vA'$response->toArray();// ['id' => 'step_1spQXgbAabXFm1YXrwiGIMUz', ...]
Returns a list of run steps belonging to a run.
$response =$client->threads()->runs()->steps()->list( threadId:'thread_tKFLqzRN9n7MnyKKvc1Q7868', runId:'run_4RCYyYzX9m41WQicoJtUQAb8', parameters: ['limit' =>10, ],);$response->object;// 'list'$response->firstId;// 'step_1spQXgbAabXFm1YXrwiGIMUz'$response->lastId;// 'step_1spQXgbAabXFm1YXrwiGIMUz'$response->hasMore;// falseforeach ($response->dataas$result) {$result->id;// 'step_1spQXgbAabXFm1YXrwiGIMUz'// ...}$response->toArray();// ['object' => 'list', ...]]
Warning
OpenAI has deprecated the Edits API and will stop working by January 4, 2024.https://openai.com/blog/gpt-4-api-general-availability#deprecation-of-the-edits-api
Edits API Information
Creates a new edit for the provided input, instruction, and parameters.
$response =$client->edits()->create(['model' =>'text-davinci-edit-001','input' =>'What day of the wek is it?','instruction' =>'Fix the spelling mistakes',]);$response->object;// 'edit'$response->created;// 1589478378foreach ($response->choicesas$choice) {$choice->text;// 'What day of the week is it?'$choice->index;// 0}$response->usage->promptTokens;// 25,$response->usage->completionTokens;// 32,$response->usage->totalTokens;// 57$response->toArray();// ['object' => 'edit', ...]
Warning
OpenAI has deprecated the FineTunes API and will stop working by January 4, 2024https://platform.openai.com/docs/deprecations#2023-08-22-fine-tunes-endpoint
FineTunes API Information
Creates a job that fine-tunes a specified model from a given dataset.
$response =$client->fineTunes()->create(['training_file' =>'file-ajSREls59WBbvgSzJSVWxMCB','validation_file' =>'file-XjSREls59WBbvgSzJSVWxMCa','model' =>'curie','n_epochs' =>4,'batch_size' =>null,'learning_rate_multiplier' =>null,'prompt_loss_weight' =>0.01,'compute_classification_metrics' =>false,'classification_n_classes' =>null,'classification_positive_class' =>null,'classification_betas' => [],'suffix' =>null,]);$response->id;// 'ft-AF1WoRqd3aJAHsqc9NY7iL8F'$response->object;// 'fine-tune'// ...$response->toArray();// ['id' => 'ft-AF1WoRqd3aJAHsqc9NY7iL8F', ...]
List your organization's fine-tuning jobs.
$response =$client->fineTunes()->list();$response->object;// 'list'foreach ($response->dataas$result) {$result->id;// 'ft-AF1WoRqd3aJAHsqc9NY7iL8F'$result->object;// 'fine-tune'// ...}$response->toArray();// ['object' => 'list', 'data' => [...]]
Gets info about the fine-tune job.
$response =$client->fineTunes()->retrieve('ft-AF1WoRqd3aJAHsqc9NY7iL8F');$response->id;// 'ft-AF1WoRqd3aJAHsqc9NY7iL8F'$response->object;// 'fine-tune'$response->model;// 'curie'$response->createdAt;// 1614807352$response->fineTunedModel;// 'curie => ft-acmeco-2021-03-03-21-44-20'$response->organizationId;// 'org-jwe45798ASN82s'$response->resultFiles;// [$response->status;// 'succeeded'$response->validationFiles;// [$response->trainingFiles;// [$response->updatedAt;// 1614807865foreach ($response->eventsas$result) {$result->object;// 'fine-tune-event'$result->createdAt;// 1614807352$result->level;// 'info'$result->message;// 'Job enqueued. Waiting for jobs ahead to complete. Queue number => 0.'}$response->hyperparams->batchSize;// 4$response->hyperparams->learningRateMultiplier;// 0.1$response->hyperparams->nEpochs;// 4$response->hyperparams->promptLossWeight;// 0.1foreach ($response->resultFilesas$result) {$result->id;// 'file-XjGxS3KTG0uNmNOK362iJua3'$result->object;// 'file'$result->bytes;// 140$result->createdAt;// 1613779657$result->filename;// 'mydata.jsonl'$result->purpose;// 'fine-tune'$result->status;// 'succeeded'$result->status_details;// null}foreach ($response->validationFilesas$result) {$result->id;// 'file-XjGxS3KTG0uNmNOK362iJua3'// ...}foreach ($response->trainingFilesas$result) {$result->id;// 'file-XjGxS3KTG0uNmNOK362iJua3'// ...}$response->toArray();// ['id' => 'ft-AF1WoRqd3aJAHsqc9NY7iL8F', ...]
Immediately cancel a fine-tune job.
$response =$client->fineTunes()->cancel('ft-AF1WoRqd3aJAHsqc9NY7iL8F');$response->id;// 'ft-AF1WoRqd3aJAHsqc9NY7iL8F'$response->object;// 'fine-tune'// ...$response->status;// 'cancelled'// ...$response->toArray();// ['id' => 'ft-AF1WoRqd3aJAHsqc9NY7iL8F', ...]
Get fine-grained status updates for a fine-tune job.
$response =$client->fineTunes()->listEvents('ft-AF1WoRqd3aJAHsqc9NY7iL8F');$response->object;// 'list'foreach ($response->dataas$result) {$result->object;// 'fine-tune-event'$result->createdAt;// 1614807352// ...}$response->toArray();// ['object' => 'list', 'data' => [...]]
Get streamed fine-grained status updates for a fine-tune job.
$stream =$client->fineTunes()->listEventsStreamed('ft-y3OpNlc8B5qBVGCCVsLZsDST');foreach($streamas$response){$response->message;}// 1. iteration => 'Created fine-tune: ft-y3OpNlc8B5qBVGCCVsLZsDST'// 2. iteration => 'Fine-tune costs $0.00'// ...// xx. iteration => 'Uploaded result file: file-ajLKUCMsFPrT633zqwr0eI4l'// xx. iteration => 'Fine-tune succeeded'
On all response objects you can access the meta information returned by the API via themeta() method.
$response =$client->completions()->create(['model' =>'gpt-3.5-turbo-instruct','prompt' =>'Say this is a test',]);$meta =$response->meta();$meta->requestId;// '574a03e2faaf4e9fd703958e4ddc66f5'$meta->openai->model;// 'gpt-3.5-turbo-instruct'$meta->openai->organization;// 'org-jwe45798ASN82s'$meta->openai->version;// '2020-10-01'$meta->openai->processingMs;// 425$meta->requestLimit->limit;// 3000$meta->requestLimit->remaining;// 2999$meta->requestLimit->reset;// '20ms'$meta->tokenLimit->limit;// 250000$meta->tokenLimit->remaining;// 249984$meta->tokenLimit->reset;// '3ms'
ThetoArray() method returns the meta information in the form originally returned by the API.
$meta->toArray();// [// 'x-request-id' => '574a03e2faaf4e9fd703958e4ddc66f5',// 'openai-model' => 'gpt-3.5-turbo-instruct',// 'openai-organization' => 'org-jwe45798ASN82s',// 'openai-processing-ms' => 402,// 'openai-version' => '2020-10-01',// 'x-ratelimit-limit-requests' => 3000,// 'x-ratelimit-remaining-requests' => 2999,// 'x-ratelimit-reset-requests' => '20ms',// 'x-ratelimit-limit-tokens' => 250000,// 'x-ratelimit-remaining-tokens' => 249983,// 'x-ratelimit-reset-tokens' => '3ms',// ]
On streaming responses you can access the meta information on the reponse stream object.
$stream =$client->completions()->createStreamed(['model' =>'gpt-3.5-turbo-instruct','prompt' =>'Say this is a test',]);$stream->meta();
For further details about the rates limits and what to do if you hit them visit theOpenAI documentation.
You may run into a timeout when sending requests to the API. The default timeout depends on the HTTP client used.
You can increase the timeout by configuring the HTTP client and passing in to the factory.
This example illustrates how to increase the timeout using Guzzle.
OpenAI::factory() ->withApiKey($apiKey) ->withOrganization($organization) ->withHttpClient(new \GuzzleHttp\Client(['timeout' =>$timeout])) ->make();
The package provides a fake implementation of theOpenAI\Client class that allows you to fake the API responses.
To test your code ensure you swap theOpenAI\Client class with theOpenAI\Testing\ClientFake class in your test case.
The fake responses are returned in the order they are provided while creating the fake client.
All responses are having afake() method that allows you to easily create a response object by only providing the parameters relevant for your test case.
useOpenAI\Testing\ClientFake;useOpenAI\Responses\Completions\CreateResponse;$client =newClientFake([ CreateResponse::fake(['choices' => [ ['text' =>'awesome!', ], ], ]),]);$completion =$client->completions()->create(['model' =>'gpt-3.5-turbo-instruct','prompt' =>'PHP is',]);expect($completion['choices'][0]['text'])->toBe('awesome!');
In case of a streamed response you can optionally provide a resource holding the fake response data.
useOpenAI\Testing\ClientFake;useOpenAI\Responses\Chat\CreateStreamedResponse;$client =newClientFake([ CreateStreamedResponse::fake(fopen('file.txt','r'););]);$completion =$client->chat()->createStreamed(['model' =>'gpt-3.5-turbo','messages' => [ ['role' =>'user','content' =>'Hello!'], ],]);expect($response->getIterator()->current()) ->id->toBe('chatcmpl-6yo21W6LVo8Tw2yBf7aGf2g17IeIl');
After the requests have been sent there are various methods to ensure that the expected requests were sent:
// assert completion create request was sent$client->assertSent(Completions::class,function (string$method,array$parameters):bool {return$method ==='create' &&$parameters['model'] ==='gpt-3.5-turbo-instruct' &&$parameters['prompt'] ==='PHP is';});// or$client->completions()->assertSent(function (string$method,array$parameters):bool {// ...});// assert 2 completion create requests were sent$client->assertSent(Completions::class,2);// assert no completion create requests were sent$client->assertNotSent(Completions::class);// or$client->completions()->assertNotSent();// assert no requests were sent$client->assertNothingSent();
To write tests expecting the API request to fail you can provide aThrowable object as the response.
$client =newClientFake([new \OpenAI\Exceptions\ErrorException(['message' =>'The model `gpt-1` does not exist','type' =>'invalid_request_error','code' =>null, ],404)]);// the `ErrorException` will be thrown$completion =$client->completions()->create(['model' =>'gpt-3.5-turbo-instruct','prompt' =>'PHP is',]);
In order to use the Azure OpenAI Service, it is necessary to construct the client manually using the factory.
$client = OpenAI::factory() ->withBaseUri('{your-resource-name}.openai.azure.com/openai/deployments/{deployment-id}') ->withHttpHeader('api-key','{your-api-key}') ->withQueryParam('api-version','{version}') ->make();
To use Azure, you must deploy a model, identified by the {deployment-id}, which is already incorporated into the API calls. As a result, you do not have to provide the model during the calls since it is included in theBaseUri.
Therefore, a basic sample completion call would be:
$result =$client->completions()->create(['prompt' =>'PHP is']);
OpenAI PHP is an open-sourced software licensed under theMIT license.
About
⚡️ OpenAI PHP is a supercharged community-maintained PHP API client that allows you to interact with OpenAI API.
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Sponsor this project
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.