Class Responses

constructor

• new Responses(client): OpenAIClient.Responses

• Parameters

  • client: OpenAIClient

  Returns OpenAIClient.Responses

inputItems

cancel

• cancel(responseID, options?): APIPromise<OpenAIClient.Responses.Response>

• Cancels a model response with the given ID. Only responses created with the background parameter set to true can be cancelled. Learn more.

  Parameters

  • responseID: string
  • Optionaloptions: RequestOptions

  Returns APIPromise<OpenAIClient.Responses.Response>

  Example

  const response = await client.responses.cancel(
    'resp_677efb5139a88190b512bc3fef8e535d',
  );
  Copy

create

• create(body, options?): APIPromise<OpenAIClient.Responses.Response>

• Creates a model response. Provide text or image inputs to generate text or JSON outputs. Have the model call your own custom code or use built-in tools like web search or file search to use your own data as input for the model's response.

  Parameters

  • body: OpenAIClient.Responses.ResponseCreateParamsNonStreaming
  • Optionaloptions: RequestOptions

  Returns APIPromise<OpenAIClient.Responses.Response>

  Example

  const response = await client.responses.create({
    input: 'string',
    model: 'gpt-4o',
  });
  Copy

• create(body, options?): APIPromise<Stream<ResponseStreamEvent>>

• Parameters

  • body: OpenAIClient.Responses.ResponseCreateParamsStreaming
  • Optionaloptions: RequestOptions

  Returns APIPromise<Stream<ResponseStreamEvent>>

• create(body, options?): APIPromise<Stream<ResponseStreamEvent> | OpenAIClient.Responses.Response>

• Parameters

  • body: ResponseCreateParamsBase
  • Optionaloptions: RequestOptions

  Returns APIPromise<Stream<ResponseStreamEvent> | OpenAIClient.Responses.Response>

delete

• delete(responseID, options?): APIPromise<void>

• Deletes a model response with the given ID.

  Parameters

  • responseID: string
  • Optionaloptions: RequestOptions

  Returns APIPromise<void>

  Example

  await client.responses.delete(
    'resp_677efb5139a88190b512bc3fef8e535d',
  );
  Copy

parse

• parse<Params, ParsedT>(body, options?): APIPromise<ParsedResponse<ParsedT>>

• Type Parameters

  • Params extends ResponseCreateParamsWithTools
  • ParsedT = ExtractParsedContentFromParams<Params>

  Parameters

  • body: Params
  • Optionaloptions: RequestOptions

  Returns APIPromise<ParsedResponse<ParsedT>>

retrieve

• retrieve(responseID, query?, options?): APIPromise<OpenAIClient.Responses.Response>

• Retrieves a model response with the given ID.

  Parameters

  • responseID: string
  • Optionalquery: OpenAIClient.Responses.ResponseRetrieveParamsNonStreaming
  • Optionaloptions: RequestOptions

  Returns APIPromise<OpenAIClient.Responses.Response>

  Example

  const response = await client.responses.retrieve(
    'resp_677efb5139a88190b512bc3fef8e535d',
  );
  Copy

• retrieve(responseID, query, options?): APIPromise<Stream<ResponseStreamEvent>>

• Parameters

  • responseID: string
  • query: OpenAIClient.Responses.ResponseRetrieveParamsStreaming
  • Optionaloptions: RequestOptions

  Returns APIPromise<Stream<ResponseStreamEvent>>

• retrieve(responseID, query?, options?): APIPromise<Stream<ResponseStreamEvent> | OpenAIClient.Responses.Response>

• Parameters

  • responseID: string
  • Optionalquery: ResponseRetrieveParamsBase
  • Optionaloptions: RequestOptions

  Returns APIPromise<Stream<ResponseStreamEvent> | OpenAIClient.Responses.Response>

stream

• stream<Params, ParsedT>(body, options?): ResponseStream<ParsedT>

• Creates a model response stream

  Type Parameters

  • Params extends ResponseStreamParams
  • ParsedT = ExtractParsedContentFromParams<Params>

  Parameters

  • body: Params
  • Optionaloptions: RequestOptions

  Returns ResponseStream<ParsedT>