Class Completions

constructor

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

• Parameters

  • client: OpenAIClient

  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

  Returns APIPromise<ChatCompletion>

  Example

  const chatCompletion = await client.chat.completions.create(
    {
      messages: [{ content: 'string', role: 'developer' }],
      model: 'gpt-4o',
    },
  );
  Copy

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

• Parameters

  • body: OpenAIClient.Chat.Completions.ChatCompletionCreateParamsStreaming
  • Optionaloptions: RequestOptions

  Returns APIPromise<Stream<ChatCompletionChunk>>

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

• Parameters

  • body: ChatCompletionCreateParamsBase
  • Optionaloptions: RequestOptions

  Returns APIPromise<ChatCompletion | Stream<ChatCompletionChunk>>

delete

• delete(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

  Returns APIPromise<ChatCompletionDeleted>

  Example

  const chatCompletionDeleted =
    await client.chat.completions.delete('completion_id');
  Copy

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: null | ChatCompletionListParams
  • Optionaloptions: RequestOptions

  Returns PagePromise<ChatCompletionsPage, ChatCompletion>

  Example

  // Automatically fetches more pages as needed.
  for await (const chatCompletion of client.chat.completions.list()) {
    // ...
  }
  Copy

parse

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

• Type Parameters

  • Params extends OpenAIClient.Chat.Completions.ChatCompletionCreateParamsNonStreaming
  • ParsedT = ExtractParsedContentFromParams<Params>

  Parameters

  • body: Params
  • Optionaloptions: RequestOptions

  Returns APIPromise<ParsedChatCompletion<ParsedT>>

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

  Returns APIPromise<ChatCompletion>

  Example

  const chatCompletion =
    await client.chat.completions.retrieve('completion_id');
  Copy

runTools

• runTools<Params, ParsedT>(body, options?): ChatCompletionRunner<ParsedT>

• A convenience helper for using tool calls with the /chat/completions endpoint which automatically calls the JavaScript functions you provide and sends their results back to the /chat/completions endpoint, looping as long as the model requests function calls.

  For more details and examples, see the docs

  Type Parameters

  • Params extends ChatCompletionToolRunnerParams<any>
  • ParsedT = ExtractParsedContentFromParams<Params>

  Parameters

  • body: Params
  • Optionaloptions: RunnerOptions

  Returns ChatCompletionRunner<ParsedT>
• runTools<Params, ParsedT>(body, options?): ChatCompletionStreamingRunner<ParsedT>

• Type Parameters

  • Params extends ChatCompletionStreamingToolRunnerParams<any>
  • ParsedT = ExtractParsedContentFromParams<Params>

  Parameters

  • body: Params
  • Optionaloptions: RunnerOptions

  Returns ChatCompletionStreamingRunner<ParsedT>

stream

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

• Creates a chat completion stream

  Type Parameters

  • Params extends ChatCompletionStreamParams
  • ParsedT = ExtractParsedContentFromParams<Params>

  Parameters

  • body: Params
  • Optionaloptions: RequestOptions

  Returns ChatCompletionStream<ParsedT>

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

  Returns APIPromise<ChatCompletion>

  Example

  const chatCompletion = await client.chat.completions.update(
    'completion_id',
    { metadata: { foo: 'string' } },
  );
  Copy