Saltar al contenido principal
Versión: 20 R9 BETA

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ámetrosTipoDescripción
messagesColección de OpenAIMessageLos mensajes de chat que se incluirán en la solicitud.
parámetrosOpenAIChatCompletionsParametersLos parámetros para la solicitud de finalización del chat.
ResultadoObjectThe 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

Ofrece la lista completa de mensajes

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ámetrosTipoDescripción
completionIDTextThe ID of the chat completion to retrieve.
parámetrosOpenAIParametersAdditional parameters for the request.
ResultadoObjectThe 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ámetrosTipoDescripción
completionIDTextThe ID of the chat completion to update.
metadataObjectMetadata to update the completion with.
parámetrosOpenAIParametersAdditional parameters for the request.
ResultadoObjectEl objeto de finalización del chat actualizado.

Modify a stored chat completion.

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

delete()

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

ParámetrosTipoDescripción
completionIDTextThe ID of the chat completion to delete.
parámetrosOpenAIParametersAdditional parameters for the request.
ResultadoBooleanWhether the deletion was successful.

Delete a stored chat compltions.

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

lista()

list(parameters : OpenAIChatCompletionsListParameters) : Collection

ParámetrosTipoDescripción
parámetrosOpenAIChatCompletionsListParametersParameters for listing chat completions.
ResultadoCollectionA collection of stored chat completions.

List stored chat completions.

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