This package supports some API Methods, which are grouped into 16 API Handlers.<\/p>\n\n\n\n
See the table below for a full list of API Handlers and Methods.<\/p>\n\n\n\n <\/p>\n\n\n\n Audio Resource<\/strong><\/p>\n\n\n\n method may accept the following parameters:<\/strong><\/p>\n\n\n\n Transcribes audio into the input language.<\/p>\n\n\n\n Url :<\/strong> POST https:\/\/api.openai.com\/v1\/audio\/transcriptions<\/p>\n\n\n\n <\/p>\n\n\n\n Translate<\/strong><\/p>\n\n\n\n Translates audio into English.<\/p>\n\n\n\n The method accepts the following parameters:<\/p>\n\n\n\n lists the currently available models, and provides basic information about each one such as the owner and availability.<\/p>\n\n\n\n The method accepts the following parameters:<\/p>\n\n\n\n Url:<\/strong> GET https:\/\/api.openai.com\/v1\/models<\/p>\n\n\n\n Retrieves a model instance, providing basic information about the model such as the owner and permissioning.<\/p>\n\n\n\n The method accepts the following parameters:<\/p>\n\n\n\n Url:<\/strong> GET https:\/\/api.openai.com\/v1\/models\/{model}<\/p>\n\n\n\n Images Resource<\/strong><\/p>\n\n\n\n create<\/strong><\/p>\n\n\n\n The method may accept the following parameters:<\/strong><\/p>\n\n\n\n <\/p>\n\n\n\n Edit<\/strong><\/p>\n\n\n\n Creates an edited or extended image given an original image and a prompt.<\/p>\n\n\n\n The method may accept the following parameters:<\/strong><\/p>\n\n\n\n Method<\/strong> : ImagesVariations::createImage()<\/strong><\/p>\n\n\n\n Variation<\/strong><\/p>\n\n\n\n Creates a variation of a given image.<\/p>\n\n\n\n The method may accept the following parameters:<\/strong><\/p>\n\n\n\n This package supports some API Methods, which are grouped into 16 API Handlers. See the table below for a full list of API Handlers and Methods. API… <\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-199","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"yoast_head":"\nAPI Handler Class and Method Name<\/strong><\/td> Description<\/strong><\/td> API Verb and URL<\/strong><\/td><\/tr> AudioTranscriptions::create()<\/td> Transcribes audio into the input language.<\/td> POST<\/code> \/audio\/transcriptions<\/code><\/td><\/tr>AudioTranslations::create()<\/td> Translates audio into into English.<\/td> POST<\/code> \/audio\/translations<\/code><\/td><\/tr>ChatCompletions::create()<\/td> Creates a completion for the chat message<\/td> POST<\/code> \/chat\/completions<\/code><\/td><\/tr>Completions::create()<\/td> Creates a completion for the provided prompt and parameters<\/td> POST<\/code> \/completions<\/code><\/td><\/tr>Edits::create()<\/td> Creates a new edit for the provided input, instruction, and parameters.<\/td> POST<\/code> \/edits<\/code><\/td><\/tr>Embeddings::create()<\/td> Creates an embedding vector representing the input text.<\/td> POST<\/code> \/embeddings<\/code><\/td><\/tr>Files::list()<\/td> Returns a list of files that belong to the user’s organization.<\/td> GET<\/code> \/files<\/code><\/td><\/tr>Files::create()<\/td> Upload a file that contains document(s) to be used across various endpoints\/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.<\/td> POST<\/code> \/files<\/code><\/td><\/tr>Files::retrieve()<\/td>
Returns information about a specific file.<\/td>GET<\/code> \/files\/{file_id}<\/code><\/td><\/tr>Files::delete()<\/td> Delete a file.<\/td> DELETE<\/code> \/files\/{file_id}<\/code><\/td><\/tr>FilesContent::download()<\/td> Returns the contents of the specified file<\/td> GET<\/code> \/files\/{file_id}\/content<\/code><\/td><\/tr>FineTunes::list()<\/td> List your organization’s fine-tuning jobs<\/td> GET<\/code> \/fine-tunes<\/code><\/td><\/tr>FineTunes::create()<\/td> Creates a job that fine-tunes a specified model from a given dataset.
Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete.
Learn more about Fine-tuning<\/td>POST<\/code> \/fine-tunes<\/code><\/td><\/tr>FineTunes::retrieve()<\/td> Gets info about the fine-tune job.
Learn more about Fine-tuning<\/td>GET<\/code> \/fine-tunes\/{fine_tune_id}<\/code><\/td><\/tr>FineTunesCancel::cancelFineTune()<\/td> Immediately cancel a fine-tune job<\/td> POST<\/code> \/fine-tunes\/{fine_tune_id}\/cancel<\/code><\/td><\/tr>FineTunesEvents::listFineTune()<\/td> Get fine-grained status updates for a fine-tune job.<\/td> GET<\/code> \/fine-tunes\/{fine_tune_id}\/events<\/code><\/td><\/tr>ImagesEdits::createImage()<\/td>
Creates an edited or extended image given an original image and a prompt.<\/td>POST<\/code> \/images\/edits<\/code><\/td><\/tr>ImagesGenerations::create()<\/td> Creates an image given a prompt<\/td> POST<\/code> \/images\/generations<\/code><\/td><\/tr>ImagesVariations::createImage()<\/td> Creates a variation of a given image.<\/td> POST<\/code> \/images\/variations<\/code><\/td><\/tr>Models::list()<\/td> Lists the currently available models, and provides basic information about each one such as the owner and availability.<\/td> GET<\/code> \/models<\/code><\/td><\/tr>Models::retrieve()<\/td> Retrieves a model instance, providing basic information about the model such as the owner and permissioning<\/td> GET<\/code> \/models\/{model}<\/code><\/td><\/tr>Models::delete()<\/td> Delete a fine-tuned model. You must have the Owner role in your organization.<\/td> DELETE<\/code> \/models\/{model}<\/code><\/td><\/tr>Moderations::create()<\/td> Classifies if text violates OpenAI’s Content Policy<\/td> POST<\/code> \/moderations<\/code><\/td><\/tr><\/td> <\/td> <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n Method:<\/strong> AudioTranscriptions::create()<\/strong><\/h3>\n\n\n\n
\n
$response = $client->audio()->transcribe([\n'model' => 'whisper-1', \/\/ parameters \n'file' => fopen('audio.mp3', 'r'), \/\/ parameters \n'response_format' => 'verbose_json', \/\/ parameters \n]);\n\nParameters\n{\n\"file\": \"audio.mp3\",\n\"model\": \"whisper-1\"\n}\n<\/code><\/pre>\n\n\n\nMethod: AudioTranslations::create()<\/strong><\/h3>\n\n\n\n
\n
$response = $client->audio()->translate([\n 'model' => 'whisper-1', \/\/ parameters \n 'file' => fopen('german.mp3', 'r'), \/\/ parameters \n 'response_format' => 'verbose_json', \/\/ parameters \n]);\n\nUrl:<\/strong> POST\n https://api.openai.com\/v1\/audio\/translations\n<\/code><\/pre>\n\n\n\nMethod=Models::list()<\/strong><\/h3>\n\n\n\n
\n
$response->object; \/\/ 'list'\n\nforeach ($response->data as $result) {\n $result->id; \/\/ 'text-davinci-003' \/\/ parameters \n $result->object; \/\/ 'model' \/\/ parameters \n \n}\n\n$response->toArray(); \/\/ ['object' => 'list', 'data' => [...]]<\/code><\/pre>\n\n\n\nMethod=Models::retrieve()<\/strong><\/h3>\n\n\n\n
\n
$modelId<\/code>:<\/strong> The ID of the model to retrieve details about. This parameter is required.<\/li>\n\n\n\n$apiKey<\/code>:<\/strong> The API key or token required to access the OpenAI API. (Optional)<\/li>\n<\/ul>\n\n\n\n$response = $client->models()->retrieve('text-davinci-003');<\/code><\/pre>\n\n\n\nMethod : ImagesGenerations::create()<\/strong><\/h3>\n\n\n\n
\n
$response = $client->images()->create([\n 'prompt' => 'A cute baby sea otter',\n 'n' => 1,\n 'size' => '256x256',\n 'response_format' => 'url',\n]);\nparameter\n\n{\n \"prompt\": \"A cute baby sea otter\",\n \"n\": 2,\n \"size\": \"1024x1024\"\n}\n\nUrl=POST https:\/\/api.openai.com\/v1\/images\/generations<\/code><\/pre>\n\n\n\nMethod:<\/strong> ImagesEdits::createImage()<\/strong><\/h3>\n\n\n\n
\n
$response = $client->images()->edit([\n 'image' => fopen('image_edit_original.png', 'r'), \/\/ parameter 1\n 'mask' => fopen('image_edit_mask.png', 'r'), \/\/ parameter 2\n 'prompt' => 'A sunlit indoor lounge area with a pool', \/\/ parameter 3\n 'n' => 1, \/\/ parameter 4\n 'size' => '256x256', \/\/ parameter 5\n 'response_format' => 'url', \/\/ parameter 6\n]);\n\n$response->created; \n\nforeach ($response->data as $data) {\n $data->url; \n $data->b64_json; \n}\n$response->toArray(); <\/code><\/pre>\n\n\n\n\n
$response = $client->images()->variation([\n 'image' => fopen('image_edit_original.png', 'r'), \/\/parameter 1\n 'n' => 1, \/\/parameter 2\n 'size' => '256x256', \/\/parameter 3\n 'response_format' => 'url', \/\/parameter 4\n]);\n\nurl = POST https:\/\/api.openai.com\/v1\/images\/variations\n<\/code><\/pre>\n","protected":false},"excerpt":{"rendered":"