Skip to content
Primary navigation

Suggested
API Dashboard
Try ChatGPT
API Reference
Chat
Completions

Update chat completion

chat.completions.update(completion_id, **kwargs) -> ChatCompletion { id, choices, created, 6 more }
POST/chat/completions/{completion_id}

Update chat completion

ParametersExpand Collapse
completion_id: String
metadata: Metadata

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

ReturnsExpand Collapse
class ChatCompletion { id, choices, created, 6 more }

Represents a chat completion response returned by model, based on the provided input.

id: String

A unique identifier for the chat completion.

choices: Array[Choice{ finish_reason, index, logprobs, message}]

A list of chat completion choices. Can be more than one if n is greater than 1.

finish_reason: :stop | :length | :tool_calls | 2 more

The reason the model stopped generating tokens. This will be stop if the model hit a natural stop point or a provided stop sequence, length if the maximum number of tokens specified in the request was reached, content_filter if content was omitted due to a flag from our content filters, tool_calls if the model called a tool, or function_call (deprecated) if the model called a function. Read the Model Spec for more.

One of the following:
:stop
:length
:tool_calls
:content_filter
:function_call
index: Integer

The index of the choice in the list of choices.

logprobs: Logprobs{ content, refusal}

Log probability information for the choice.

content: Array[ChatCompletionTokenLogprob { token, bytes, logprob, top_logprobs } ]

A list of message content tokens with log probability information.

token: String

The token.

bytes: Array[Integer]

A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token.

logprob: Float

The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely.

top_logprobs: Array[TopLogprob{ token, bytes, logprob}]

List of the most likely tokens and their log probability, at this token position. The number of entries may be fewer than the requested top_logprobs.

token: String

The token.

bytes: Array[Integer]

A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token.

logprob: Float

The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely.

refusal: Array[ChatCompletionTokenLogprob { token, bytes, logprob, top_logprobs } ]

A list of message refusal tokens with log probability information.

token: String

The token.

bytes: Array[Integer]

A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token.

logprob: Float

The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely.

top_logprobs: Array[TopLogprob{ token, bytes, logprob}]

List of the most likely tokens and their log probability, at this token position. The number of entries may be fewer than the requested top_logprobs.

token: String

The token.

bytes: Array[Integer]

A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be null if there is no bytes representation for the token.

logprob: Float

The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely.

message: ChatCompletionMessage { content, refusal, role, 4 more }

A chat completion message generated by the model.

content: String

The contents of the message.

refusal: String

The refusal message generated by the model.

role: :assistant

The role of the author of this message.

annotations: Array[Annotation{ type, url_citation}]

Annotations for the message, when applicable, as when using the web search tool.

type: :url_citation

The type of the URL citation. Always url_citation.

url_citation: URLCitation{ end_index, start_index, title, url}

A URL citation when using web search.

end_index: Integer

The index of the last character of the URL citation in the message.

start_index: Integer

The index of the first character of the URL citation in the message.

title: String

The title of the web resource.

url: String

The URL of the web resource.

formaturi
audio: ChatCompletionAudio { id, data, expires_at, transcript }

If the audio output modality is requested, this object contains data about the audio response from the model. Learn more.

id: String

Unique identifier for this audio response.

data: String

Base64 encoded audio bytes generated by the model, in the format specified in the request.

expires_at: Integer

The Unix timestamp (in seconds) for when this audio response will no longer be accessible on the server for use in multi-turn conversations.

formatunixtime
transcript: String

Transcript of the audio generated by the model.

Deprecatedfunction_call: FunctionCall{ arguments, name}

Deprecated and replaced by tool_calls. The name and arguments of a function that should be called, as generated by the model.

arguments: String

The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.

name: String

The name of the function to call.

tool_calls: Array[ChatCompletionMessageToolCall]

The tool calls generated by the model, such as function calls.

One of the following:
class ChatCompletionMessageFunctionToolCall { id, function, type }

A call to a function tool created by the model.

id: String

The ID of the tool call.

function: Function{ arguments, name}

The function that the model called.

arguments: String

The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.

name: String

The name of the function to call.

type: :function

The type of the tool. Currently, only function is supported.

class ChatCompletionMessageCustomToolCall { id, custom, type }

A call to a custom tool created by the model.

id: String

The ID of the tool call.

custom: Custom{ input, name}

The custom tool that the model called.

input: String

The input for the custom tool call generated by the model.

name: String

The name of the custom tool to call.

type: :custom

The type of the tool. Always custom.

created: Integer

The Unix timestamp (in seconds) of when the chat completion was created.

formatunixtime
model: String

The model used for the chat completion.

object: :"chat.completion"

The object type, which is always chat.completion.

moderation: Moderation{ input, output}

Moderation results for the request input and generated output, if moderated completions were requested.

input: ModerationResults{ model, results, type} | Error{ code, message, type}

Moderation for the request input.

One of the following:
class ModerationResults { model, results, type }

Successful moderation results for the request input or generated output.

model: String

The moderation model used to generate the results.

results: Array[Result{ categories, category_applied_input_types, category_scores, 3 more}]

A list of moderation results.

categories: Hash[Symbol, bool]

A dictionary of moderation categories to booleans, True if the input is flagged under this category.

category_applied_input_types: Hash[Symbol, Array[:text | :image]]

Which modalities of input are reflected by the score for each category.

One of the following:
:text
:image
category_scores: Hash[Symbol, Float]

A dictionary of moderation categories to scores.

flagged: bool

A boolean indicating whether the content was flagged by any category.

model: String

The moderation model that produced this result.

type: :moderation_result

The object type, which was always moderation_result for successful moderation results.

type: :moderation_results

The object type, which is always moderation_results.

class Error { code, message, type }

An error produced while attempting moderation.

code: String

The error code.

message: String

The error message.

type: :error

The object type, which is always error.

output: ModerationResults{ model, results, type} | Error{ code, message, type}

Moderation for the generated output.

One of the following:
class ModerationResults { model, results, type }

Successful moderation results for the request input or generated output.

model: String

The moderation model used to generate the results.

results: Array[Result{ categories, category_applied_input_types, category_scores, 3 more}]

A list of moderation results.

categories: Hash[Symbol, bool]

A dictionary of moderation categories to booleans, True if the input is flagged under this category.

category_applied_input_types: Hash[Symbol, Array[:text | :image]]

Which modalities of input are reflected by the score for each category.

One of the following:
:text
:image
category_scores: Hash[Symbol, Float]

A dictionary of moderation categories to scores.

flagged: bool

A boolean indicating whether the content was flagged by any category.

model: String

The moderation model that produced this result.

type: :moderation_result

The object type, which was always moderation_result for successful moderation results.

type: :moderation_results

The object type, which is always moderation_results.

class Error { code, message, type }

An error produced while attempting moderation.

code: String

The error code.

message: String

The error message.

type: :error

The object type, which is always error.

service_tier: :auto | :default | :flex | 2 more

Specifies the processing type used for serving the request.

  • If set to ‘auto’, then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use ‘default’.
  • If set to ‘default’, then the request will be processed with the standard pricing and performance for the selected model.
  • If set to ‘flex’ or ‘priority’, then the request will be processed with the corresponding service tier.
  • When not set, the default behavior is ‘auto’.

When the service_tier parameter is set, the response body will include the service_tier value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.

One of the following:
:auto
:default
:flex
:scale
:priority
Deprecatedsystem_fingerprint: String

This fingerprint represents the backend configuration that the model runs with.

Can be used in conjunction with the seed request parameter to understand when backend changes have been made that might impact determinism.

usage: CompletionUsage { completion_tokens, prompt_tokens, total_tokens, 2 more }

Usage statistics for the completion request.

completion_tokens: Integer

Number of tokens in the generated completion.

prompt_tokens: Integer

Number of tokens in the prompt.

total_tokens: Integer

Total number of tokens used in the request (prompt + completion).

completion_tokens_details: CompletionTokensDetails{ accepted_prediction_tokens, audio_tokens, reasoning_tokens, rejected_prediction_tokens}

Breakdown of tokens used in a completion.

accepted_prediction_tokens: Integer

When using Predicted Outputs, the number of tokens in the prediction that appeared in the completion.

audio_tokens: Integer

Audio input tokens generated by the model.

reasoning_tokens: Integer

Tokens generated by the model for reasoning.

rejected_prediction_tokens: Integer

When using Predicted Outputs, the number of tokens in the prediction that did not appear in the completion. However, like reasoning tokens, these tokens are still counted in the total completion tokens for purposes of billing, output, and context window limits.

prompt_tokens_details: PromptTokensDetails{ audio_tokens, cache_write_tokens, cached_tokens}

Breakdown of tokens used in the prompt.

audio_tokens: Integer

Audio input tokens present in the prompt.

cache_write_tokens: Integer

The unadjusted number of prompt tokens written to cache.

cached_tokens: Integer

Cached tokens present in the prompt.

Update chat completion

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

chat_completion = openai.chat.completions.update("completion_id", metadata: {foo: "string"})

puts(chat_completion)
{
  "object": "chat.completion",
  "id": "chatcmpl-AyPNinnUqUDYo9SAdA52NobMflmj2",
  "model": "gpt-4o-2024-08-06",
  "created": 1738960610,
  "request_id": "req_ded8ab984ec4bf840f37566c1011c417",
  "tool_choice": null,
  "usage": {
    "total_tokens": 31,
    "completion_tokens": 18,
    "prompt_tokens": 13
  },
  "seed": 4944116822809979520,
  "top_p": 1.0,
  "temperature": 1.0,
  "presence_penalty": 0.0,
  "frequency_penalty": 0.0,
  "system_fingerprint": "fp_50cad350e4",
  "input_user": null,
  "service_tier": "default",
  "tools": null,
  "metadata": {
    "foo": "bar"
  },
  "choices": [
    {
      "index": 0,
      "message": {
        "content": "Mind of circuits hum,  \nLearning patterns in silence—  \nFuture's quiet spark.",
        "role": "assistant",
        "tool_calls": null,
        "function_call": null
      },
      "finish_reason": "stop",
      "logprobs": null
    }
  ],
  "response_format": null
}
Returns Examples
{
  "object": "chat.completion",
  "id": "chatcmpl-AyPNinnUqUDYo9SAdA52NobMflmj2",
  "model": "gpt-4o-2024-08-06",
  "created": 1738960610,
  "request_id": "req_ded8ab984ec4bf840f37566c1011c417",
  "tool_choice": null,
  "usage": {
    "total_tokens": 31,
    "completion_tokens": 18,
    "prompt_tokens": 13
  },
  "seed": 4944116822809979520,
  "top_p": 1.0,
  "temperature": 1.0,
  "presence_penalty": 0.0,
  "frequency_penalty": 0.0,
  "system_fingerprint": "fp_50cad350e4",
  "input_user": null,
  "service_tier": "default",
  "tools": null,
  "metadata": {
    "foo": "bar"
  },
  "choices": [
    {
      "index": 0,
      "message": {
        "content": "Mind of circuits hum,  \nLearning patterns in silence—  \nFuture's quiet spark.",
        "role": "assistant",
        "tool_calls": null,
        "function_call": null
      },
      "finish_reason": "stop",
      "logprobs": null
    }
  ],
  "response_format": null
}