Class Responses

constructor

• new Responses(client): Responses

• Parameters

  • client: OpenAI

  Returns Responses

inputItems

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<unknown>

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

• Parameters

  • body: OpenAIClient.Responses.ResponseCreateParamsStreaming
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<Stream<ResponseStreamEvent>>

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

• Parameters

  • body: ResponseCreateParamsBase
  • Optionaloptions: RequestOptions<unknown>

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

del

• del(responseId, options?): APIPromise<void>

• Deletes a model response with the given ID.

  Parameters

  • responseId: string
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<void>

parse

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

• Type Parameters

  • Params extends ResponseCreateParamsWithTools
  • ParsedT = ExtractParsedContentFromParams<Params>

  Parameters

  • body: Params
  • Optionaloptions: RequestOptions<unknown>

  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: ResponseRetrieveParams
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<OpenAIClient.Responses.Response>
• retrieve(responseId, options?): APIPromise<OpenAIClient.Responses.Response>

• Parameters

  • responseId: string
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<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<unknown>

  Returns ResponseStream<ParsedT>