OpenAIChatCompletionsAPI

The OpenAIChatCompletionsAPI class is designed for managing chat completions with OpenAI's API. It provides methods to create, retrieve, update, delete, and list chat completions.

https://platform.openai.com/docs/api-reference/chat

関数

create()

create(messages : Collection of OpenAIMessage ; parameters : OpenAIChatCompletionsParameters) : Object

引数	型	説明
messages	Collection of OpenAIMessage	The chat messages to include in the request.
引数	OpenAIChatCompletionsParameters	The parameters for the chat completion request.
戻り値	Object	The result of the chat completion request.

Creates a model response for the given chat conversation.

https://platform.openai.com/docs/api-reference/chat/create

Example Usage

Provide the full messages list

var $messages:=[]
$messages.push({role: "system"; content: "You are a helpful assistant."})
$messages.push({"role":"user"; "content": "Hello, how are you?"})
// ...

var $result:=$client.chat.completions.create($messages; {model: "gpt-4o-mini" })

Get the response as text

var $text:=$result.choice.text

Append assistant response for next completion request

$messages.push($result.choice.message) // {"role":"assistant"; "content": "xxx" }

retrieve()

retrieve(completionID : Text; parameters : OpenAIParameters) : Object

引数	型	説明
completionID	Text	The ID of the chat completion to retrieve.
引数	OpenAIParameters	Additional parameters for the request.
戻り値	Object	The retrieved chat completion object.

Get a stored chat completion.

https://platform.openai.com/docs/api-reference/chat/get

update()

update(completionID : Text; metadata : Object, parameters : OpenAIParameters) : Object

引数	型	説明
completionID	Text	The ID of the chat completion to update.
metadata	Object	Metadata to update the completion with.
引数	OpenAIParameters	Additional parameters for the request.
戻り値	Object	The updated chat completion object.

Modify a stored chat completion.

https://platform.openai.com/docs/api-reference/chat/update

delete()

delete(completionID : Text; parameters : OpenAIParameters) : Object

引数	型	説明
completionID	Text	The ID of the chat completion to delete.
引数	OpenAIParameters	Additional parameters for the request.
戻り値	Boolean	Whether the deletion was successful.

Delete a stored chat compltions.

https://platform.openai.com/docs/api-reference/chat/delete

リスト()

list(parameters : OpenAIChatCompletionsListParameters) : Collection

引数	型	説明
引数	OpenAIChatCompletionsListParameters	Parameters for listing chat completions.
戻り値	Collection	A collection of stored chat completions.

List stored chat completions.

https://platform.openai.com/docs/api-reference/chat/list