Constructor Detail

Method Detail

• body

   final StructuredChatCompletionCreateParams.Builder<T> body(ChatCompletionCreateParams.Body body)

• messages

   final StructuredChatCompletionCreateParams.Builder<T> messages(List<ChatCompletionMessageParam> messages)

• messages

   final StructuredChatCompletionCreateParams.Builder<T> messages(JsonField<List<ChatCompletionMessageParam>> messages)

• addMessage

   final StructuredChatCompletionCreateParams.Builder<T> addMessage(ChatCompletionMessageParam message)

• addMessage

   final StructuredChatCompletionCreateParams.Builder<T> addMessage(ChatCompletionDeveloperMessageParam developer)

• addMessage

   final StructuredChatCompletionCreateParams.Builder<T> addMessage(ChatCompletionSystemMessageParam system)

• addMessage

   final StructuredChatCompletionCreateParams.Builder<T> addMessage(ChatCompletionUserMessageParam user)

• addMessage

   final StructuredChatCompletionCreateParams.Builder<T> addMessage(ChatCompletionAssistantMessageParam assistant)

• addMessage

   final StructuredChatCompletionCreateParams.Builder<T> addMessage(ChatCompletionMessage assistant)

• addMessage

   final StructuredChatCompletionCreateParams.Builder<T> addMessage(ChatCompletionToolMessageParam tool)

• addMessage

  @Deprecated(message = "deprecated") final StructuredChatCompletionCreateParams.Builder<T> addMessage(ChatCompletionFunctionMessageParam function)

• addDeveloperMessage

   final StructuredChatCompletionCreateParams.Builder<T> addDeveloperMessage(ChatCompletionDeveloperMessageParam.Content content)

• addDeveloperMessage

   final StructuredChatCompletionCreateParams.Builder<T> addDeveloperMessage(String text)

• addDeveloperMessageOfArrayOfContentParts

   final StructuredChatCompletionCreateParams.Builder<T> addDeveloperMessageOfArrayOfContentParts(List<ChatCompletionContentPartText> arrayOfContentParts)

• addSystemMessage

   final StructuredChatCompletionCreateParams.Builder<T> addSystemMessage(ChatCompletionSystemMessageParam.Content content)

• addSystemMessage

   final StructuredChatCompletionCreateParams.Builder<T> addSystemMessage(String text)

• addSystemMessageOfArrayOfContentParts

   final StructuredChatCompletionCreateParams.Builder<T> addSystemMessageOfArrayOfContentParts(List<ChatCompletionContentPartText> arrayOfContentParts)

• addUserMessage

   final StructuredChatCompletionCreateParams.Builder<T> addUserMessage(ChatCompletionUserMessageParam.Content content)

• addUserMessage

   final StructuredChatCompletionCreateParams.Builder<T> addUserMessage(String text)

• addUserMessageOfArrayOfContentParts

   final StructuredChatCompletionCreateParams.Builder<T> addUserMessageOfArrayOfContentParts(List<ChatCompletionContentPart> arrayOfContentParts)

• model

   final StructuredChatCompletionCreateParams.Builder<T> model(ChatModel model)

• model

   final StructuredChatCompletionCreateParams.Builder<T> model(JsonField<ChatModel> model)

• model

   final StructuredChatCompletionCreateParams.Builder<T> model(String value)

• audio

   final StructuredChatCompletionCreateParams.Builder<T> audio(ChatCompletionAudioParam audio)

• audio

   final StructuredChatCompletionCreateParams.Builder<T> audio(Optional<ChatCompletionAudioParam> audio)

• audio

   final StructuredChatCompletionCreateParams.Builder<T> audio(JsonField<ChatCompletionAudioParam> audio)

• frequencyPenalty

   final StructuredChatCompletionCreateParams.Builder<T> frequencyPenalty(Double frequencyPenalty)

• frequencyPenalty

   final StructuredChatCompletionCreateParams.Builder<T> frequencyPenalty(Double frequencyPenalty)

• frequencyPenalty

   final StructuredChatCompletionCreateParams.Builder<T> frequencyPenalty(Optional<Double> frequencyPenalty)

• frequencyPenalty

   final StructuredChatCompletionCreateParams.Builder<T> frequencyPenalty(JsonField<Double> frequencyPenalty)

• functionCall

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

• functionCall

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

• functionCall

  @Deprecated(message = "deprecated") final StructuredChatCompletionCreateParams.Builder<T> functionCall(ChatCompletionCreateParams.FunctionCall.FunctionCallMode mode)

• functionCall

  @Deprecated(message = "deprecated") final StructuredChatCompletionCreateParams.Builder<T> functionCall(ChatCompletionFunctionCallOption functionCallOption)

• functions

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

• functions

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

• addFunction

  @Deprecated(message = "deprecated") final StructuredChatCompletionCreateParams.Builder<T> addFunction(ChatCompletionCreateParams.Function function)

• logitBias

   final StructuredChatCompletionCreateParams.Builder<T> logitBias(ChatCompletionCreateParams.LogitBias logitBias)

• logitBias

   final StructuredChatCompletionCreateParams.Builder<T> logitBias(Optional<ChatCompletionCreateParams.LogitBias> logitBias)

• logitBias

   final StructuredChatCompletionCreateParams.Builder<T> logitBias(JsonField<ChatCompletionCreateParams.LogitBias> logitBias)

• logprobs

   final StructuredChatCompletionCreateParams.Builder<T> logprobs(Boolean logprobs)

• logprobs

   final StructuredChatCompletionCreateParams.Builder<T> logprobs(Boolean logprobs)

• logprobs

   final StructuredChatCompletionCreateParams.Builder<T> logprobs(Optional<Boolean> logprobs)

• logprobs

   final StructuredChatCompletionCreateParams.Builder<T> logprobs(JsonField<Boolean> logprobs)

• maxCompletionTokens

   final StructuredChatCompletionCreateParams.Builder<T> maxCompletionTokens(Long maxCompletionTokens)

• maxCompletionTokens

   final StructuredChatCompletionCreateParams.Builder<T> maxCompletionTokens(Long maxCompletionTokens)

• maxCompletionTokens

   final StructuredChatCompletionCreateParams.Builder<T> maxCompletionTokens(Optional<Long> maxCompletionTokens)

• maxCompletionTokens

   final StructuredChatCompletionCreateParams.Builder<T> maxCompletionTokens(JsonField<Long> maxCompletionTokens)

• maxTokens

  @Deprecated(message = "deprecated") final StructuredChatCompletionCreateParams.Builder<T> maxTokens(Long maxTokens)

• maxTokens

  @Deprecated(message = "deprecated") final StructuredChatCompletionCreateParams.Builder<T> maxTokens(Long maxTokens)

• maxTokens

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

• maxTokens

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

• metadata

   final StructuredChatCompletionCreateParams.Builder<T> metadata(ChatCompletionCreateParams.Metadata metadata)

• metadata

   final StructuredChatCompletionCreateParams.Builder<T> metadata(Optional<ChatCompletionCreateParams.Metadata> metadata)

• metadata

   final StructuredChatCompletionCreateParams.Builder<T> metadata(JsonField<ChatCompletionCreateParams.Metadata> metadata)

• modalities

   final StructuredChatCompletionCreateParams.Builder<T> modalities(List<ChatCompletionCreateParams.Modality> modalities)

• modalities

   final StructuredChatCompletionCreateParams.Builder<T> modalities(Optional<List<ChatCompletionCreateParams.Modality>> modalities)

• modalities

   final StructuredChatCompletionCreateParams.Builder<T> modalities(JsonField<List<ChatCompletionCreateParams.Modality>> modalities)

• addModality

   final StructuredChatCompletionCreateParams.Builder<T> addModality(ChatCompletionCreateParams.Modality modality)

• n

   final StructuredChatCompletionCreateParams.Builder<T> n(Long n)

• n

   final StructuredChatCompletionCreateParams.Builder<T> n(Long n)

• n

   final StructuredChatCompletionCreateParams.Builder<T> n(Optional<Long> n)

• n

   final StructuredChatCompletionCreateParams.Builder<T> n(JsonField<Long> n)

• parallelToolCalls

   final StructuredChatCompletionCreateParams.Builder<T> parallelToolCalls(Boolean parallelToolCalls)

• parallelToolCalls

   final StructuredChatCompletionCreateParams.Builder<T> parallelToolCalls(JsonField<Boolean> parallelToolCalls)

• prediction

   final StructuredChatCompletionCreateParams.Builder<T> prediction(ChatCompletionPredictionContent prediction)

• prediction

   final StructuredChatCompletionCreateParams.Builder<T> prediction(Optional<ChatCompletionPredictionContent> prediction)

• prediction

   final StructuredChatCompletionCreateParams.Builder<T> prediction(JsonField<ChatCompletionPredictionContent> prediction)

• presencePenalty

   final StructuredChatCompletionCreateParams.Builder<T> presencePenalty(Double presencePenalty)

• presencePenalty

   final StructuredChatCompletionCreateParams.Builder<T> presencePenalty(Double presencePenalty)

• presencePenalty

   final StructuredChatCompletionCreateParams.Builder<T> presencePenalty(Optional<Double> presencePenalty)

• presencePenalty

   final StructuredChatCompletionCreateParams.Builder<T> presencePenalty(JsonField<Double> presencePenalty)

• reasoningEffort

   final StructuredChatCompletionCreateParams.Builder<T> reasoningEffort(ReasoningEffort reasoningEffort)

• reasoningEffort

   final StructuredChatCompletionCreateParams.Builder<T> reasoningEffort(Optional<ReasoningEffort> reasoningEffort)

• reasoningEffort

   final StructuredChatCompletionCreateParams.Builder<T> reasoningEffort(JsonField<ReasoningEffort> reasoningEffort)

• responseFormat

  @JvmOverloads() final StructuredChatCompletionCreateParams.Builder<T> responseFormat(Class<T> responseType, JsonSchemaLocalValidation localValidation)

  Sets the response format to a JSON schema derived from the structure of the given class.

• responseFormat

  @JvmOverloads() final StructuredChatCompletionCreateParams.Builder<T> responseFormat(Class<T> responseType)

  Sets the response format to a JSON schema derived from the structure of the given class.

• seed

   final StructuredChatCompletionCreateParams.Builder<T> seed(Long seed)

• seed

   final StructuredChatCompletionCreateParams.Builder<T> seed(Long seed)

• seed

   final StructuredChatCompletionCreateParams.Builder<T> seed(Optional<Long> seed)

• seed

   final StructuredChatCompletionCreateParams.Builder<T> seed(JsonField<Long> seed)

• serviceTier

   final StructuredChatCompletionCreateParams.Builder<T> serviceTier(ChatCompletionCreateParams.ServiceTier serviceTier)

• serviceTier

   final StructuredChatCompletionCreateParams.Builder<T> serviceTier(Optional<ChatCompletionCreateParams.ServiceTier> serviceTier)

• serviceTier

   final StructuredChatCompletionCreateParams.Builder<T> serviceTier(JsonField<ChatCompletionCreateParams.ServiceTier> serviceTier)

• stop

   final StructuredChatCompletionCreateParams.Builder<T> stop(ChatCompletionCreateParams.Stop stop)

• stop

   final StructuredChatCompletionCreateParams.Builder<T> stop(Optional<ChatCompletionCreateParams.Stop> stop)

• stop

   final StructuredChatCompletionCreateParams.Builder<T> stop(JsonField<ChatCompletionCreateParams.Stop> stop)

• stop

   final StructuredChatCompletionCreateParams.Builder<T> stop(String string)

• stopOfStrings

   final StructuredChatCompletionCreateParams.Builder<T> stopOfStrings(List<String> strings)

• store

   final StructuredChatCompletionCreateParams.Builder<T> store(Boolean store)

• store

   final StructuredChatCompletionCreateParams.Builder<T> store(Boolean store)

• store

   final StructuredChatCompletionCreateParams.Builder<T> store(Optional<Boolean> store)

• store

   final StructuredChatCompletionCreateParams.Builder<T> store(JsonField<Boolean> store)

• streamOptions

   final StructuredChatCompletionCreateParams.Builder<T> streamOptions(ChatCompletionStreamOptions streamOptions)

• streamOptions

   final StructuredChatCompletionCreateParams.Builder<T> streamOptions(Optional<ChatCompletionStreamOptions> streamOptions)

• streamOptions

   final StructuredChatCompletionCreateParams.Builder<T> streamOptions(JsonField<ChatCompletionStreamOptions> streamOptions)

• temperature

   final StructuredChatCompletionCreateParams.Builder<T> temperature(Double temperature)

• temperature

   final StructuredChatCompletionCreateParams.Builder<T> temperature(Double temperature)

• temperature

   final StructuredChatCompletionCreateParams.Builder<T> temperature(Optional<Double> temperature)

• temperature

   final StructuredChatCompletionCreateParams.Builder<T> temperature(JsonField<Double> temperature)

• toolChoice

   final StructuredChatCompletionCreateParams.Builder<T> toolChoice(ChatCompletionToolChoiceOption toolChoice)

• toolChoice

   final StructuredChatCompletionCreateParams.Builder<T> toolChoice(JsonField<ChatCompletionToolChoiceOption> toolChoice)

• toolChoice

   final StructuredChatCompletionCreateParams.Builder<T> toolChoice(ChatCompletionToolChoiceOption.Auto auto)

• toolChoice

   final StructuredChatCompletionCreateParams.Builder<T> toolChoice(ChatCompletionNamedToolChoice namedToolChoice)

• tools

   final StructuredChatCompletionCreateParams.Builder<T> tools(List<ChatCompletionTool> tools)

• tools

   final StructuredChatCompletionCreateParams.Builder<T> tools(JsonField<List<ChatCompletionTool>> tools)

• addTool

   final StructuredChatCompletionCreateParams.Builder<T> addTool(ChatCompletionTool tool)

• topLogprobs

   final StructuredChatCompletionCreateParams.Builder<T> topLogprobs(Long topLogprobs)

• topLogprobs

   final StructuredChatCompletionCreateParams.Builder<T> topLogprobs(Long topLogprobs)

• topLogprobs

   final StructuredChatCompletionCreateParams.Builder<T> topLogprobs(Optional<Long> topLogprobs)

• topLogprobs

   final StructuredChatCompletionCreateParams.Builder<T> topLogprobs(JsonField<Long> topLogprobs)

• topP

   final StructuredChatCompletionCreateParams.Builder<T> topP(Double topP)

• topP

   final StructuredChatCompletionCreateParams.Builder<T> topP(Double topP)

• topP

   final StructuredChatCompletionCreateParams.Builder<T> topP(Optional<Double> topP)

• topP

   final StructuredChatCompletionCreateParams.Builder<T> topP(JsonField<Double> topP)

• user

   final StructuredChatCompletionCreateParams.Builder<T> user(String user)

• user

   final StructuredChatCompletionCreateParams.Builder<T> user(JsonField<String> user)

• webSearchOptions

   final StructuredChatCompletionCreateParams.Builder<T> webSearchOptions(ChatCompletionCreateParams.WebSearchOptions webSearchOptions)

• webSearchOptions

   final StructuredChatCompletionCreateParams.Builder<T> webSearchOptions(JsonField<ChatCompletionCreateParams.WebSearchOptions> webSearchOptions)

• additionalBodyProperties

   final StructuredChatCompletionCreateParams.Builder<T> additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

   final StructuredChatCompletionCreateParams.Builder<T> putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final StructuredChatCompletionCreateParams.Builder<T> putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final StructuredChatCompletionCreateParams.Builder<T> removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final StructuredChatCompletionCreateParams.Builder<T> removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final StructuredChatCompletionCreateParams.Builder<T> additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final StructuredChatCompletionCreateParams.Builder<T> additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final StructuredChatCompletionCreateParams.Builder<T> putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final StructuredChatCompletionCreateParams.Builder<T> putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final StructuredChatCompletionCreateParams.Builder<T> putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final StructuredChatCompletionCreateParams.Builder<T> putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final StructuredChatCompletionCreateParams.Builder<T> replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final StructuredChatCompletionCreateParams.Builder<T> replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final StructuredChatCompletionCreateParams.Builder<T> replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final StructuredChatCompletionCreateParams.Builder<T> replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final StructuredChatCompletionCreateParams.Builder<T> removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final StructuredChatCompletionCreateParams.Builder<T> removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final StructuredChatCompletionCreateParams.Builder<T> additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final StructuredChatCompletionCreateParams.Builder<T> additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final StructuredChatCompletionCreateParams.Builder<T> putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final StructuredChatCompletionCreateParams.Builder<T> putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final StructuredChatCompletionCreateParams.Builder<T> putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final StructuredChatCompletionCreateParams.Builder<T> putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final StructuredChatCompletionCreateParams.Builder<T> replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final StructuredChatCompletionCreateParams.Builder<T> replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final StructuredChatCompletionCreateParams.Builder<T> replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final StructuredChatCompletionCreateParams.Builder<T> replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final StructuredChatCompletionCreateParams.Builder<T> removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final StructuredChatCompletionCreateParams.Builder<T> removeAllAdditionalQueryParams(Set<String> keys)

• build

   final StructuredChatCompletionCreateParams<T> build()

  Returns an immutable instance of StructuredChatCompletionCreateParams.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .messages()
  .model()
  .responseFormat()