Class ChatCompletionCreateParams.Body

    • Constructor Detail

    • Method Detail

      • frequencyPenalty

         final 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.

      • functionCall

        @Deprecated(message = "deprecated") final Optional<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.

      • logitBias

         final 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.

      • logprobs

         final 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.

      • maxTokens

        @Deprecated(message = "deprecated") final 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.

      • metadata

         final 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.

      • modalities

         final 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"]

      • n

         final 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.

      • presencePenalty

         final 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.

      • responseFormat

         final Optional<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.

      • seed

         final 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.

      • serviceTier

         final 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'.

      • temperature

         final 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.

      • toolChoice

         final Optional<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.

      • tools

         final Optional<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.

      • topLogprobs

         final 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.

      • topP

         final 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.

      • user

         final Optional<String> user()

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

      • _frequencyPenalty

         final 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 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.

      • _logitBias

         final 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 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.

      • _maxTokens

        @Deprecated(message = "deprecated") final 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 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 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"]

      • _n

         final 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.

      • _presencePenalty

         final 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.

      • _responseFormat

         final 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.

      • _seed

         final 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 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'.

      • _temperature

         final 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 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.

      • _tools

         final 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.

      • _topLogprobs

         final 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 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 JsonField<String> _user()

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