ResponsesAPIClient
Constructors
Methods
addEventListener(event: | , callback: Function
): void
Adds a handler for the specified OpenAI.ResponsesAPIEvents or OpenAI.Events event. Use only functions as handlers; anything except a function leads to the error and scenario termination when a handler is called.
Parameters
event:
Event class (i.e., OpenAI.ResponsesAPIEvents.ResponseCompleted)
callback:
Function
Handler function. A single parameter is passed - object with event information
Returns
type:
void
close(): void
Closes the OpenAI connection (over WebSocket) or connection attempt.
Returns
type:
void
createResponses(parameters: Object
): void
Creates a model response. https://developers.openai.com/api/reference/resources/responses/methods/create
Parameters
parameters:
Object
Response parameters
Returns
type:
void
id(): string
Returns the ResponsesAPIClient id.
Returns
type:
string
removeEventListener(event: | , callback: Function
): void
Removes a handler for the specified OpenAI.ResponsesAPIEvents or OpenAI.Events event.
Parameters
event:
Event class (i.e., OpenAI.ResponsesAPIEvents.ResponseCompleted)
callback:
Function
OptionalOptional. Handler function. If not specified, all handler functions are removed
Returns
type:
void
webSocketId(): string
Returns the OpenAI WebSocket id.
Returns
type:
string