ChatCompletionsAPIEvents
Add the following line to your scenario code to use the events:
require(Modules.OpenAI);
Constants
Contains Chat Completions API error.
Parameters
client:
The OpenAI.ChatCompletionsAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Represents a streamed chunk of a chat completion response returned by the model, based on the provided input. https://developers.openai.com/api/reference/resources/chat/subresources/completions#(resource)%20chat.completions%20%3E%20(model)%20chat_completion_chunk%20%3E%20(schema)%20chat_completion_chunk%20%3E%20(schema))
Parameters
client:
The OpenAI.ChatCompletionsAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Contains information about connector.
Parameters
client:
The OpenAI.ChatCompletionsAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
The chat completion content event.
Parameters
client:
The OpenAI.ChatCompletionsAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
The chat completion content delta event.
Parameters
client:
The OpenAI.ChatCompletionsAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
The chat completion content done event.
Parameters
client:
The OpenAI.ChatCompletionsAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
The chat completion function tool call arguments delta event.
Parameters
client:
The OpenAI.ChatCompletionsAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
The chat completion function tool call arguments done event.
Parameters
client:
The OpenAI.ChatCompletionsAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
The chat completion log probs content delta event.
Parameters
client:
The OpenAI.ChatCompletionsAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
The chat completion log probs content done event.
Parameters
client:
The OpenAI.ChatCompletionsAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
The chat completion log probs refusal delta event.
Parameters
client:
The OpenAI.ChatCompletionsAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
The chat completion log probs refusal done event.
Parameters
client:
The OpenAI.ChatCompletionsAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
The chat completion refusal delta event.
Parameters
client:
The OpenAI.ChatCompletionsAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
The chat completion refusal done event.
Parameters
client:
The OpenAI.ChatCompletionsAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
The unknown event.
Parameters
client:
The OpenAI.ChatCompletionsAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.