Constructor Detail

Method Detail

• messages

   final ChatCompletionCreateParams.Body.Builder messages(List<ChatCompletionMessageParam> messages)

  A list of messages comprising the conversation so far. Depending on the model you use, different message types (modalities) are supported, like text, images, and audio.

• messages

   final ChatCompletionCreateParams.Body.Builder messages(JsonField<List<ChatCompletionMessageParam>> messages)

  A list of messages comprising the conversation so far. Depending on the model you use, different message types (modalities) are supported, like text, images, and audio.

• addMessage

   final ChatCompletionCreateParams.Body.Builder addMessage(ChatCompletionMessageParam message)

  A list of messages comprising the conversation so far. Depending on the model you use, different message types (modalities) are supported, like text, images, and audio.

• addMessage

   final ChatCompletionCreateParams.Body.Builder addMessage(ChatCompletionDeveloperMessageParam developer)

  Developer-provided instructions that the model should follow, regardless of messages sent by the user. With o1 models and newer, developer messages replace the previous system messages.

• addMessage

   final ChatCompletionCreateParams.Body.Builder addMessage(ChatCompletionSystemMessageParam system)

  Developer-provided instructions that the model should follow, regardless of messages sent by the user. With o1 models and newer, use developer messages for this purpose instead.

• addMessage

   final ChatCompletionCreateParams.Body.Builder addMessage(ChatCompletionUserMessageParam user)

  Messages sent by an end user, containing prompts or additional context information.

• addMessage

   final ChatCompletionCreateParams.Body.Builder addMessage(ChatCompletionAssistantMessageParam assistant)

  Messages sent by the model in response to user messages.

• addMessage

   final ChatCompletionCreateParams.Body.Builder addMessage(ChatCompletionMessage assistant)

  Messages sent by the model in response to user messages.

• addMessage

   final ChatCompletionCreateParams.Body.Builder addMessage(ChatCompletionToolMessageParam tool)

  A list of messages comprising the conversation so far. Depending on the model you use, different message types (modalities) are supported, like text, images, and audio.

• addMessage

  @Deprecated(message = "deprecated") final ChatCompletionCreateParams.Body.Builder addMessage(ChatCompletionFunctionMessageParam function)

  A list of messages comprising the conversation so far. Depending on the model you use, different message types (modalities) are supported, like text, images, and audio.

• addDeveloperMessage

   final ChatCompletionCreateParams.Body.Builder addDeveloperMessage(ChatCompletionDeveloperMessageParam.Content content)

  Developer-provided instructions that the model should follow, regardless of messages sent by the user. With o1 models and newer, developer messages replace the previous system messages.

• addDeveloperMessage

   final ChatCompletionCreateParams.Body.Builder addDeveloperMessage(String text)

  The contents of the developer message.

• addDeveloperMessageOfArrayOfContentParts

   final ChatCompletionCreateParams.Body.Builder addDeveloperMessageOfArrayOfContentParts(List<ChatCompletionContentPartText> arrayOfContentParts)

  An array of content parts with a defined type. For developer messages, only type text is supported.

• addSystemMessage

   final ChatCompletionCreateParams.Body.Builder addSystemMessage(ChatCompletionSystemMessageParam.Content content)

  Developer-provided instructions that the model should follow, regardless of messages sent by the user. With o1 models and newer, use developer messages for this purpose instead.

• addSystemMessage

   final ChatCompletionCreateParams.Body.Builder addSystemMessage(String text)

  The contents of the system message.

• addSystemMessageOfArrayOfContentParts

   final ChatCompletionCreateParams.Body.Builder addSystemMessageOfArrayOfContentParts(List<ChatCompletionContentPartText> arrayOfContentParts)

  An array of content parts with a defined type. For system messages, only type text is supported.

• addUserMessage

   final ChatCompletionCreateParams.Body.Builder addUserMessage(ChatCompletionUserMessageParam.Content content)

  Messages sent by an end user, containing prompts or additional context information.

• addUserMessage

   final ChatCompletionCreateParams.Body.Builder addUserMessage(String text)

  The text contents of the message.

• addUserMessageOfArrayOfContentParts

   final ChatCompletionCreateParams.Body.Builder addUserMessageOfArrayOfContentParts(List<ChatCompletionContentPart> arrayOfContentParts)

  An array of content parts with a defined type. Supported options differ based on the model being used to generate the response. Can contain text, image, or audio inputs.

• model

   final ChatCompletionCreateParams.Body.Builder model(ChatModel model)

  ID of the model to use. See the model endpoint compatibility table for details on which models work with the Chat API.

• model

   final ChatCompletionCreateParams.Body.Builder model(JsonField<ChatModel> model)

  ID of the model to use. See the model endpoint compatibility table for details on which models work with the Chat API.

• model

   final ChatCompletionCreateParams.Body.Builder model(String value)

  ID of the model to use. See the model endpoint compatibility table for details on which models work with the Chat API.

• audio

   final ChatCompletionCreateParams.Body.Builder audio(ChatCompletionAudioParam audio)

  Parameters for audio output. Required when audio output is requested with modalities: ["audio"]. Learn more.

• audio

   final ChatCompletionCreateParams.Body.Builder audio(Optional<ChatCompletionAudioParam> audio)

  Parameters for audio output. Required when audio output is requested with modalities: ["audio"]. Learn more.

• audio

   final ChatCompletionCreateParams.Body.Builder audio(JsonField<ChatCompletionAudioParam> audio)

  Parameters for audio output. Required when audio output is requested with modalities: ["audio"]. Learn more.

• frequencyPenalty

   final ChatCompletionCreateParams.Body.Builder frequencyPenalty(Double frequencyPenalty)

  Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.

• frequencyPenalty

   final ChatCompletionCreateParams.Body.Builder frequencyPenalty(Double frequencyPenalty)

  Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.

• frequencyPenalty

   final ChatCompletionCreateParams.Body.Builder frequencyPenalty(Optional<Double> frequencyPenalty)

  Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.

• frequencyPenalty

   final ChatCompletionCreateParams.Body.Builder frequencyPenalty(JsonField<Double> frequencyPenalty)

  Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.

• functionCall

  @Deprecated(message = "deprecated") final ChatCompletionCreateParams.Body.Builder functionCall(ChatCompletionCreateParams.FunctionCall functionCall)

  Deprecated in favor of tool_choice.

  Controls which (if any) function is called by the model.

  none means the model will not call a function and instead generates a message.

  auto means the model can pick between generating a message or calling a function.

  Specifying a particular function via {"name": "my_function"} forces the model to call that function.

  none is the default when no functions are present. auto is the default if functions are present.

• functionCall

  @Deprecated(message = "deprecated") final ChatCompletionCreateParams.Body.Builder functionCall(JsonField<ChatCompletionCreateParams.FunctionCall> functionCall)

  Deprecated in favor of tool_choice.

  Controls which (if any) function is called by the model.

  none means the model will not call a function and instead generates a message.

  auto means the model can pick between generating a message or calling a function.

  Specifying a particular function via {"name": "my_function"} forces the model to call that function.

  none is the default when no functions are present. auto is the default if functions are present.

• functionCall

  @Deprecated(message = "deprecated") final ChatCompletionCreateParams.Body.Builder functionCall(ChatCompletionCreateParams.FunctionCall.Auto auto)

  none means the model will not call a function and instead generates a message. auto means the model can pick between generating a message or calling a function.

• functionCall

  @Deprecated(message = "deprecated") final ChatCompletionCreateParams.Body.Builder functionCall(ChatCompletionFunctionCallOption functionCallOption)

  Specifying a particular function via {"name": "my_function"} forces the model to call that function.

• functions

  @Deprecated(message = "deprecated") final ChatCompletionCreateParams.Body.Builder functions(List<ChatCompletionCreateParams.Function> functions)

  Deprecated in favor of tools.

  A list of functions the model may generate JSON inputs for.

• functions

  @Deprecated(message = "deprecated") final ChatCompletionCreateParams.Body.Builder functions(JsonField<List<ChatCompletionCreateParams.Function>> functions)

  Deprecated in favor of tools.

  A list of functions the model may generate JSON inputs for.

• addFunction

  @Deprecated(message = "deprecated") final ChatCompletionCreateParams.Body.Builder addFunction(ChatCompletionCreateParams.Function function)

  Deprecated in favor of tools.

  A list of functions the model may generate JSON inputs for.

• logitBias

   final ChatCompletionCreateParams.Body.Builder logitBias(ChatCompletionCreateParams.LogitBias logitBias)

  Modify the likelihood of specified tokens appearing in the completion.

  Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.

• logitBias

   final ChatCompletionCreateParams.Body.Builder logitBias(Optional<ChatCompletionCreateParams.LogitBias> logitBias)

  Modify the likelihood of specified tokens appearing in the completion.

  Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.

• logitBias

   final ChatCompletionCreateParams.Body.Builder logitBias(JsonField<ChatCompletionCreateParams.LogitBias> logitBias)

  Modify the likelihood of specified tokens appearing in the completion.

  Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.

• logprobs

   final ChatCompletionCreateParams.Body.Builder logprobs(Boolean logprobs)

  Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message.

• logprobs

   final ChatCompletionCreateParams.Body.Builder logprobs(Boolean logprobs)

  Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message.

• logprobs

   final ChatCompletionCreateParams.Body.Builder logprobs(Optional<Boolean> logprobs)

  Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message.

• logprobs

   final ChatCompletionCreateParams.Body.Builder logprobs(JsonField<Boolean> logprobs)

  Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message.

• maxCompletionTokens

   final ChatCompletionCreateParams.Body.Builder maxCompletionTokens(Long maxCompletionTokens)

  An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.

• maxCompletionTokens

   final ChatCompletionCreateParams.Body.Builder maxCompletionTokens(Long maxCompletionTokens)

  An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.

• maxCompletionTokens

   final ChatCompletionCreateParams.Body.Builder maxCompletionTokens(Optional<Long> maxCompletionTokens)

  An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.

• maxCompletionTokens

   final ChatCompletionCreateParams.Body.Builder maxCompletionTokens(JsonField<Long> maxCompletionTokens)

  An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.

• maxTokens

  @Deprecated(message = "deprecated") final ChatCompletionCreateParams.Body.Builder maxTokens(Long maxTokens)

  The maximum number of /tokenizer that can be generated in the chat completion. This value can be used to control costs for text generated via API.

  This value is now deprecated in favor of max_completion_tokens, and is not compatible with o1 series models.

• maxTokens

  @Deprecated(message = "deprecated") final ChatCompletionCreateParams.Body.Builder maxTokens(Long maxTokens)

  The maximum number of /tokenizer that can be generated in the chat completion. This value can be used to control costs for text generated via API.

  This value is now deprecated in favor of max_completion_tokens, and is not compatible with o1 series models.

• maxTokens

  @Deprecated(message = "deprecated") final ChatCompletionCreateParams.Body.Builder maxTokens(Optional<Long> maxTokens)

  The maximum number of /tokenizer that can be generated in the chat completion. This value can be used to control costs for text generated via API.

  This value is now deprecated in favor of max_completion_tokens, and is not compatible with o1 series models.

• maxTokens

  @Deprecated(message = "deprecated") final ChatCompletionCreateParams.Body.Builder maxTokens(JsonField<Long> maxTokens)

  The maximum number of /tokenizer that can be generated in the chat completion. This value can be used to control costs for text generated via API.

  This value is now deprecated in favor of max_completion_tokens, and is not compatible with o1 series models.

• metadata

   final ChatCompletionCreateParams.Body.Builder metadata(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.

• metadata

   final ChatCompletionCreateParams.Body.Builder metadata(Optional<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.

• metadata

   final ChatCompletionCreateParams.Body.Builder metadata(JsonField<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.

• modalities

   final ChatCompletionCreateParams.Body.Builder modalities(List<ChatCompletionModality> modalities)

  Output types that you would like the model to generate for this request. Most models are capable of generating text, which is the default:

  ["text"]

  The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use:

  ["text", "audio"]

• modalities

   final ChatCompletionCreateParams.Body.Builder modalities(Optional<List<ChatCompletionModality>> modalities)

  Output types that you would like the model to generate for this request. Most models are capable of generating text, which is the default:

  ["text"]

  The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use:

  ["text", "audio"]

• modalities

   final ChatCompletionCreateParams.Body.Builder modalities(JsonField<List<ChatCompletionModality>> modalities)

  Output types that you would like the model to generate for this request. Most models are capable of generating text, which is the default:

  ["text"]

  The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use:

  ["text", "audio"]

• addModality

   final ChatCompletionCreateParams.Body.Builder addModality(ChatCompletionModality modality)

  Output types that you would like the model to generate for this request. Most models are capable of generating text, which is the default:

  ["text"]

  The gpt-4o-audio-preview model can also be used to generate audio. To request that this model generate both text and audio responses, you can use:

  ["text", "audio"]

• n

   final ChatCompletionCreateParams.Body.Builder n(Long n)

  How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs.

• n

   final ChatCompletionCreateParams.Body.Builder n(Long n)

  How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs.

• n

   final ChatCompletionCreateParams.Body.Builder n(Optional<Long> n)

  How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs.

• n

   final ChatCompletionCreateParams.Body.Builder n(JsonField<Long> n)

  How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs.

• parallelToolCalls

   final ChatCompletionCreateParams.Body.Builder parallelToolCalls(Boolean parallelToolCalls)

  Whether to enable parallel function calling during tool use.

• parallelToolCalls

   final ChatCompletionCreateParams.Body.Builder parallelToolCalls(JsonField<Boolean> parallelToolCalls)

  Whether to enable parallel function calling during tool use.

• prediction

   final ChatCompletionCreateParams.Body.Builder prediction(ChatCompletionPredictionContent prediction)

  Static predicted output content, such as the content of a text file that is being regenerated.

• prediction

   final ChatCompletionCreateParams.Body.Builder prediction(Optional<ChatCompletionPredictionContent> prediction)

  Static predicted output content, such as the content of a text file that is being regenerated.

• prediction

   final ChatCompletionCreateParams.Body.Builder prediction(JsonField<ChatCompletionPredictionContent> prediction)

  Static predicted output content, such as the content of a text file that is being regenerated.

• presencePenalty

   final ChatCompletionCreateParams.Body.Builder presencePenalty(Double presencePenalty)

  Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.

• presencePenalty

   final ChatCompletionCreateParams.Body.Builder presencePenalty(Double presencePenalty)

  Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.

• presencePenalty

   final ChatCompletionCreateParams.Body.Builder presencePenalty(Optional<Double> presencePenalty)

  Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.

• presencePenalty

   final ChatCompletionCreateParams.Body.Builder presencePenalty(JsonField<Double> presencePenalty)

  Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.

• reasoningEffort

   final ChatCompletionCreateParams.Body.Builder reasoningEffort(ChatCompletionReasoningEffort reasoningEffort)

  o1 and o3-mini models only

  Constrains effort on reasoning for reasoning models. Currently supported values are low, medium, and high. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.

• reasoningEffort

   final ChatCompletionCreateParams.Body.Builder reasoningEffort(Optional<ChatCompletionReasoningEffort> reasoningEffort)

  o1 and o3-mini models only

  Constrains effort on reasoning for reasoning models. Currently supported values are low, medium, and high. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.

• reasoningEffort

   final ChatCompletionCreateParams.Body.Builder reasoningEffort(JsonField<ChatCompletionReasoningEffort> reasoningEffort)

  o1 and o3-mini models only

  Constrains effort on reasoning for reasoning models. Currently supported values are low, medium, and high. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.

• responseFormat

   final ChatCompletionCreateParams.Body.Builder responseFormat(ChatCompletionCreateParams.ResponseFormat responseFormat)

  An object specifying the format that the model must output.

  Setting to { "type": "json_schema", "json_schema": {...} } enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the Structured Outputs guide.

  Setting to { "type": "json_object" } enables JSON mode, which ensures the message the model generates is valid JSON.

  Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.

• responseFormat

   final ChatCompletionCreateParams.Body.Builder responseFormat(JsonField<ChatCompletionCreateParams.ResponseFormat> responseFormat)

  An object specifying the format that the model must output.

  Setting to { "type": "json_schema", "json_schema": {...} } enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the Structured Outputs guide.

  Setting to { "type": "json_object" } enables JSON mode, which ensures the message the model generates is valid JSON.

  Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.

• responseFormat

   final ChatCompletionCreateParams.Body.Builder responseFormat(ResponseFormatText text)

  An object specifying the format that the model must output.

  Setting to { "type": "json_schema", "json_schema": {...} } enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the Structured Outputs guide.

  Setting to { "type": "json_object" } enables JSON mode, which ensures the message the model generates is valid JSON.

  Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.

• responseFormat

   final ChatCompletionCreateParams.Body.Builder responseFormat(ResponseFormatJsonObject jsonObject)

  An object specifying the format that the model must output.

  Setting to { "type": "json_schema", "json_schema": {...} } enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the Structured Outputs guide.

  Setting to { "type": "json_object" } enables JSON mode, which ensures the message the model generates is valid JSON.

  Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.

• responseFormat

   final ChatCompletionCreateParams.Body.Builder responseFormat(ResponseFormatJsonSchema jsonSchema)

  An object specifying the format that the model must output.

  Setting to { "type": "json_schema", "json_schema": {...} } enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the Structured Outputs guide.

  Setting to { "type": "json_object" } enables JSON mode, which ensures the message the model generates is valid JSON.

  Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.

• seed

   final ChatCompletionCreateParams.Body.Builder seed(Long seed)

  This feature is in Beta. If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the system_fingerprint response parameter to monitor changes in the backend.

• seed

   final ChatCompletionCreateParams.Body.Builder seed(Long seed)

  This feature is in Beta. If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the system_fingerprint response parameter to monitor changes in the backend.

• seed

   final ChatCompletionCreateParams.Body.Builder seed(Optional<Long> seed)

  This feature is in Beta. If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the system_fingerprint response parameter to monitor changes in the backend.

• seed

   final ChatCompletionCreateParams.Body.Builder seed(JsonField<Long> seed)

  This feature is in Beta. If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the system_fingerprint response parameter to monitor changes in the backend.

• serviceTier

   final ChatCompletionCreateParams.Body.Builder serviceTier(ChatCompletionCreateParams.ServiceTier serviceTier)

  Specifies the latency tier to use for processing the request. This parameter is relevant for customers subscribed to the scale tier service:

  • If set to 'auto', and the Project is Scale tier enabled, the system will utilize scale tier credits until they are exhausted.

  • If set to 'auto', and the Project is not Scale tier enabled, the request will be processed using the default service tier with a lower uptime SLA and no latency guarantee.

  • If set to 'default', the request will be processed using the default service tier with a lower uptime SLA and no latency guarantee.

  • When not set, the default behavior is 'auto'.

• serviceTier

   final ChatCompletionCreateParams.Body.Builder serviceTier(Optional<ChatCompletionCreateParams.ServiceTier> serviceTier)

  Specifies the latency tier to use for processing the request. This parameter is relevant for customers subscribed to the scale tier service:

  • If set to 'auto', and the Project is Scale tier enabled, the system will utilize scale tier credits until they are exhausted.

  • If set to 'auto', and the Project is not Scale tier enabled, the request will be processed using the default service tier with a lower uptime SLA and no latency guarantee.

  • If set to 'default', the request will be processed using the default service tier with a lower uptime SLA and no latency guarantee.

  • When not set, the default behavior is 'auto'.

• serviceTier

   final ChatCompletionCreateParams.Body.Builder serviceTier(JsonField<ChatCompletionCreateParams.ServiceTier> serviceTier)

  Specifies the latency tier to use for processing the request. This parameter is relevant for customers subscribed to the scale tier service:

  • If set to 'auto', and the Project is Scale tier enabled, the system will utilize scale tier credits until they are exhausted.

  • If set to 'auto', and the Project is not Scale tier enabled, the request will be processed using the default service tier with a lower uptime SLA and no latency guarantee.

  • If set to 'default', the request will be processed using the default service tier with a lower uptime SLA and no latency guarantee.

  • When not set, the default behavior is 'auto'.

• stop

   final ChatCompletionCreateParams.Body.Builder stop(ChatCompletionCreateParams.Stop stop)

  Up to 4 sequences where the API will stop generating further tokens.

• stop

   final ChatCompletionCreateParams.Body.Builder stop(JsonField<ChatCompletionCreateParams.Stop> stop)

  Up to 4 sequences where the API will stop generating further tokens.

• stop

   final ChatCompletionCreateParams.Body.Builder stop(String string)

  Up to 4 sequences where the API will stop generating further tokens.

• stopOfStrings

   final ChatCompletionCreateParams.Body.Builder stopOfStrings(List<String> strings)

  Up to 4 sequences where the API will stop generating further tokens.

• store

   final ChatCompletionCreateParams.Body.Builder store(Boolean store)

  Whether or not to store the output of this chat completion request for use in our model distillation or evals products.

• store

   final ChatCompletionCreateParams.Body.Builder store(Boolean store)

  Whether or not to store the output of this chat completion request for use in our model distillation or evals products.

• store

   final ChatCompletionCreateParams.Body.Builder store(Optional<Boolean> store)

  Whether or not to store the output of this chat completion request for use in our model distillation or evals products.

• store

   final ChatCompletionCreateParams.Body.Builder store(JsonField<Boolean> store)

  Whether or not to store the output of this chat completion request for use in our model distillation or evals products.

• streamOptions

   final ChatCompletionCreateParams.Body.Builder streamOptions(ChatCompletionStreamOptions streamOptions)

  Options for streaming response. Only set this when you set stream: true.

• streamOptions

   final ChatCompletionCreateParams.Body.Builder streamOptions(Optional<ChatCompletionStreamOptions> streamOptions)

  Options for streaming response. Only set this when you set stream: true.

• streamOptions

   final ChatCompletionCreateParams.Body.Builder streamOptions(JsonField<ChatCompletionStreamOptions> streamOptions)

  Options for streaming response. Only set this when you set stream: true.

• temperature

   final ChatCompletionCreateParams.Body.Builder temperature(Double temperature)

  What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or top_p but not both.

• temperature

   final ChatCompletionCreateParams.Body.Builder temperature(Double temperature)

  What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or top_p but not both.

• temperature

   final ChatCompletionCreateParams.Body.Builder temperature(Optional<Double> temperature)

  What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or top_p but not both.

• temperature

   final ChatCompletionCreateParams.Body.Builder temperature(JsonField<Double> temperature)

  What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or top_p but not both.

• toolChoice

   final ChatCompletionCreateParams.Body.Builder toolChoice(ChatCompletionToolChoiceOption toolChoice)

  Controls which (if any) tool is called by the model. none means the model will not call any tool and instead generates a message. auto means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools. Specifying a particular tool via {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool.

  none is the default when no tools are present. auto is the default if tools are present.

• toolChoice

   final ChatCompletionCreateParams.Body.Builder toolChoice(JsonField<ChatCompletionToolChoiceOption> toolChoice)

  Controls which (if any) tool is called by the model. none means the model will not call any tool and instead generates a message. auto means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools. Specifying a particular tool via {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool.

  none is the default when no tools are present. auto is the default if tools are present.

• toolChoice

   final ChatCompletionCreateParams.Body.Builder toolChoice(ChatCompletionToolChoiceOption.Auto auto)

  none means the model will not call any tool and instead generates a message. auto means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools.

• toolChoice

   final ChatCompletionCreateParams.Body.Builder toolChoice(ChatCompletionNamedToolChoice namedToolChoice)

  Specifies a tool the model should use. Use to force the model to call a specific function.

• tools

   final ChatCompletionCreateParams.Body.Builder tools(List<ChatCompletionTool> tools)

  A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported.

• tools

   final ChatCompletionCreateParams.Body.Builder tools(JsonField<List<ChatCompletionTool>> tools)

  A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported.

• addTool

   final ChatCompletionCreateParams.Body.Builder addTool(ChatCompletionTool tool)

  A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported.

• topLogprobs

   final ChatCompletionCreateParams.Body.Builder topLogprobs(Long topLogprobs)

  An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used.

• topLogprobs

   final ChatCompletionCreateParams.Body.Builder topLogprobs(Long topLogprobs)

  An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used.

• topLogprobs

   final ChatCompletionCreateParams.Body.Builder topLogprobs(Optional<Long> topLogprobs)

  An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used.

• topLogprobs

   final ChatCompletionCreateParams.Body.Builder topLogprobs(JsonField<Long> topLogprobs)

  An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used.

• topP

   final ChatCompletionCreateParams.Body.Builder topP(Double topP)

  An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.

  We generally recommend altering this or temperature but not both.

• topP

   final ChatCompletionCreateParams.Body.Builder topP(Double topP)

  An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.

  We generally recommend altering this or temperature but not both.

• topP

   final ChatCompletionCreateParams.Body.Builder topP(Optional<Double> topP)

  An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.

  We generally recommend altering this or temperature but not both.

• topP

   final ChatCompletionCreateParams.Body.Builder topP(JsonField<Double> topP)

  An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.

  We generally recommend altering this or temperature but not both.

• user

   final ChatCompletionCreateParams.Body.Builder user(String user)

  A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.

• user

   final ChatCompletionCreateParams.Body.Builder user(JsonField<String> user)

  A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.

• additionalProperties

   final ChatCompletionCreateParams.Body.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final ChatCompletionCreateParams.Body.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final ChatCompletionCreateParams.Body.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final ChatCompletionCreateParams.Body.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final ChatCompletionCreateParams.Body.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final ChatCompletionCreateParams.Body build()