Class Completions

constructor

• new Completions(client): OpenAIClient.Chat.Completions

• Parameters

  • client: OpenAI

  Returns OpenAIClient.Chat.Completions

messages

create

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

• Starting a new project? We recommend trying Responses to take advantage of the latest OpenAI platform features. Compare Chat Completions with Responses.

  ---

  Creates a model response for the given chat conversation. Learn more in the text generation, vision, and audio guides.

  Parameter support can differ depending on the model used to generate the response, particularly for newer reasoning models. Parameters that are only supported for reasoning models are noted below. For the current state of unsupported parameters in reasoning models, refer to the reasoning guide.

  Parameters

  • body: OpenAIClient.Chat.Completions.ChatCompletionCreateParamsNonStreaming
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<ChatCompletion>
• create(body, options?): APIPromise<Stream<ChatCompletionChunk>>

• Parameters

  • body: OpenAIClient.Chat.Completions.ChatCompletionCreateParamsStreaming
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<Stream<ChatCompletionChunk>>

• create(body, options?): APIPromise<ChatCompletion | Stream<ChatCompletionChunk>>

• Parameters

  • body: ChatCompletionCreateParamsBase
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<ChatCompletion | Stream<ChatCompletionChunk>>

del

• del(completionId, options?): APIPromise<ChatCompletionDeleted>

• Delete a stored chat completion. Only Chat Completions that have been created with the store parameter set to true can be deleted.

  Parameters

  • completionId: string
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<ChatCompletionDeleted>

list

• list(query?, options?): PagePromise<ChatCompletionsPage, ChatCompletion>

• List stored Chat Completions. Only Chat Completions that have been stored with the store parameter set to true will be returned.

  Parameters

  • Optionalquery: ChatCompletionListParams
  • Optionaloptions: RequestOptions<unknown>

  Returns PagePromise<ChatCompletionsPage, ChatCompletion>
• list(options?): PagePromise<ChatCompletionsPage, ChatCompletion>

• Parameters

  • Optionaloptions: RequestOptions<unknown>

  Returns PagePromise<ChatCompletionsPage, ChatCompletion>

retrieve

• retrieve(completionId, options?): APIPromise<ChatCompletion>

• Get a stored chat completion. Only Chat Completions that have been created with the store parameter set to true will be returned.

  Parameters

  • completionId: string
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<ChatCompletion>

update

• update(completionId, body, options?): APIPromise<ChatCompletion>

• Modify a stored chat completion. Only Chat Completions that have been created with the store parameter set to true can be modified. Currently, the only supported modification is to update the metadata field.

  Parameters

  • completionId: string
  • body: ChatCompletionUpdateParams
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<ChatCompletion>