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

Funciones

create()

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

Parámetros	Tipo	Descripción
messages	Colección de OpenAIMessage	The chat messages to include in the request.
parámetros	OpenAIChatCompletionsParameters	The parameters for the chat completion request.
Resultado	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

Ejemplo de Uso

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" })

Obtener la respuesta como texto

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

Parámetros	Tipo	Descripción
completionID	Text	The ID of the chat completion to retrieve.
parámetros	OpenAIParameters	Additional parameters for the request.
Resultado	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

Parámetros	Tipo	Descripción
completionID	Text	The ID of the chat completion to update.
metadata	Object	Metadata to update the completion with.
parámetros	OpenAIParameters	Additional parameters for the request.
Resultado	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

Parámetros	Tipo	Descripción
completionID	Text	The ID of the chat completion to delete.
parámetros	OpenAIParameters	Additional parameters for the request.
Resultado	Boolean	Whether the deletion was successful.

Delete a stored chat compltions.

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

lista()

list(parameters : OpenAIChatCompletionsListParameters) : Collection

Parámetros	Tipo	Descripción
parámetros	OpenAIChatCompletionsListParameters	Parameters for listing chat completions.
Resultado	Collection	A collection of stored chat completions.

List stored chat completions.

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