Constructor Detail

Method Detail

• body

   final StructuredMessageCreateParams.Builder<T> body(MessageCreateParams.Body body)

• maxTokens

   final StructuredMessageCreateParams.Builder<T> maxTokens(Long maxTokens)

• maxTokens

   final StructuredMessageCreateParams.Builder<T> maxTokens(JsonField<Long> maxTokens)

• messages

   final StructuredMessageCreateParams.Builder<T> messages(List<MessageParam> messages)

• messages

   final StructuredMessageCreateParams.Builder<T> messages(JsonField<List<MessageParam>> messages)

• addMessage

   final StructuredMessageCreateParams.Builder<T> addMessage(MessageParam message)

• addMessage

   final StructuredMessageCreateParams.Builder<T> addMessage(Message message)

• addUserMessage

   final StructuredMessageCreateParams.Builder<T> addUserMessage(MessageParam.Content content)

• addUserMessage

   final StructuredMessageCreateParams.Builder<T> addUserMessage(String string)

• addUserMessageOfBlockParams

   final StructuredMessageCreateParams.Builder<T> addUserMessageOfBlockParams(List<ContentBlockParam> blockParams)

• addAssistantMessage

   final StructuredMessageCreateParams.Builder<T> addAssistantMessage(MessageParam.Content content)

• addAssistantMessage

   final StructuredMessageCreateParams.Builder<T> addAssistantMessage(String string)

• addAssistantMessageOfBlockParams

   final StructuredMessageCreateParams.Builder<T> addAssistantMessageOfBlockParams(List<ContentBlockParam> blockParams)

• model

   final StructuredMessageCreateParams.Builder<T> model(Model model)

• model

   final StructuredMessageCreateParams.Builder<T> model(JsonField<Model> model)

• model

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

• cacheControl

   final StructuredMessageCreateParams.Builder<T> cacheControl(CacheControlEphemeral cacheControl)

• cacheControl

   final StructuredMessageCreateParams.Builder<T> cacheControl(Optional<CacheControlEphemeral> cacheControl)

• cacheControl

   final StructuredMessageCreateParams.Builder<T> cacheControl(JsonField<CacheControlEphemeral> cacheControl)

• inferenceGeo

   final StructuredMessageCreateParams.Builder<T> inferenceGeo(String inferenceGeo)

• inferenceGeo

   final StructuredMessageCreateParams.Builder<T> inferenceGeo(Optional<String> inferenceGeo)

• inferenceGeo

   final StructuredMessageCreateParams.Builder<T> inferenceGeo(JsonField<String> inferenceGeo)

• metadata

   final StructuredMessageCreateParams.Builder<T> metadata(Metadata metadata)

• metadata

   final StructuredMessageCreateParams.Builder<T> metadata(JsonField<Metadata> metadata)

• outputConfig

   final StructuredMessageCreateParams.Builder<T> outputConfig(OutputConfig outputConfig)

• outputConfig

   final StructuredMessageCreateParams.Builder<T> outputConfig(JsonField<OutputConfig> outputConfig)

• outputConfig

  @JvmOverloads() final StructuredMessageCreateParams.Builder<T> outputConfig(Class<T> outputType, JsonSchemaLocalValidation localValidation)

  Sets the output configuration with a JSON schema format derived from the structure of the given class. This is the recommended way to specify structured outputs.

  Unlike the beta version, this GA version does NOT auto-inject any beta header.

• outputConfig

  @JvmOverloads() final StructuredMessageCreateParams.Builder<T> outputConfig(Class<T> outputType)

  Sets the output configuration with a JSON schema format derived from the structure of the given class. This is the recommended way to specify structured outputs.

  Unlike the beta version, this GA version does NOT auto-inject any beta header.

• serviceTier

   final StructuredMessageCreateParams.Builder<T> serviceTier(MessageCreateParams.ServiceTier serviceTier)

• serviceTier

   final StructuredMessageCreateParams.Builder<T> serviceTier(JsonField<MessageCreateParams.ServiceTier> serviceTier)

• stopSequences

   final StructuredMessageCreateParams.Builder<T> stopSequences(List<String> stopSequences)

• stopSequences

   final StructuredMessageCreateParams.Builder<T> stopSequences(JsonField<List<String>> stopSequences)

• addStopSequence

   final StructuredMessageCreateParams.Builder<T> addStopSequence(String stopSequence)

• system

   final StructuredMessageCreateParams.Builder<T> system(MessageCreateParams.System system)

• system

   final StructuredMessageCreateParams.Builder<T> system(JsonField<MessageCreateParams.System> system)

• system

   final StructuredMessageCreateParams.Builder<T> system(String string)

• systemOfTextBlockParams

   final StructuredMessageCreateParams.Builder<T> systemOfTextBlockParams(List<TextBlockParam> textBlockParams)

• temperature

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

• temperature

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

• thinking

   final StructuredMessageCreateParams.Builder<T> thinking(ThinkingConfigParam thinking)

• thinking

   final StructuredMessageCreateParams.Builder<T> thinking(JsonField<ThinkingConfigParam> thinking)

• thinking

   final StructuredMessageCreateParams.Builder<T> thinking(ThinkingConfigEnabled enabled)

• thinking

   final StructuredMessageCreateParams.Builder<T> thinking(ThinkingConfigDisabled disabled)

• thinking

   final StructuredMessageCreateParams.Builder<T> thinking(ThinkingConfigAdaptive adaptive)

• enabledThinking

   final StructuredMessageCreateParams.Builder<T> enabledThinking(Long budgetTokens)

• toolChoice

   final StructuredMessageCreateParams.Builder<T> toolChoice(ToolChoice toolChoice)

• toolChoice

   final StructuredMessageCreateParams.Builder<T> toolChoice(JsonField<ToolChoice> toolChoice)

• toolChoice

   final StructuredMessageCreateParams.Builder<T> toolChoice(ToolChoiceAuto auto)

• toolChoice

   final StructuredMessageCreateParams.Builder<T> toolChoice(ToolChoiceAny any)

• toolChoice

   final StructuredMessageCreateParams.Builder<T> toolChoice(ToolChoiceTool tool)

• toolChoice

   final StructuredMessageCreateParams.Builder<T> toolChoice(ToolChoiceNone none)

• toolToolChoice

   final StructuredMessageCreateParams.Builder<T> toolToolChoice(String name)

• tools

   final StructuredMessageCreateParams.Builder<T> tools(List<ToolUnion> tools)

• tools

   final StructuredMessageCreateParams.Builder<T> tools(JsonField<List<ToolUnion>> tools)

• addTool

   final StructuredMessageCreateParams.Builder<T> addTool(ToolUnion tool)

• addTool

   final StructuredMessageCreateParams.Builder<T> addTool(Tool tool)

• addTool

   final StructuredMessageCreateParams.Builder<T> addTool(ToolBash20250124 bash20250124)

• addTool

   final StructuredMessageCreateParams.Builder<T> addTool(ToolTextEditor20250124 textEditor20250124)

• addTool

   final StructuredMessageCreateParams.Builder<T> addTool(ToolTextEditor20250429 textEditor20250429)

• addTool

   final StructuredMessageCreateParams.Builder<T> addTool(ToolTextEditor20250728 textEditor20250728)

• addTool

   final StructuredMessageCreateParams.Builder<T> addTool(WebSearchTool20250305 webSearchTool20250305)

• addTool

   final StructuredMessageCreateParams.Builder<T> addTool(WebFetchTool20250910 webFetchTool20250910)

• addTool

   final StructuredMessageCreateParams.Builder<T> addTool(CodeExecutionTool20250522 codeExecutionTool20250522)

• addTool

   final StructuredMessageCreateParams.Builder<T> addTool(CodeExecutionTool20250825 codeExecutionTool20250825)

• addTool

   final StructuredMessageCreateParams.Builder<T> addTool(CodeExecutionTool20260120 codeExecutionTool20260120)

• addTool

   final StructuredMessageCreateParams.Builder<T> addTool(MemoryTool20250818 memoryTool20250818)

• addTool

   final StructuredMessageCreateParams.Builder<T> addTool(WebSearchTool20260209 webSearchTool20260209)

• addTool

   final StructuredMessageCreateParams.Builder<T> addTool(WebFetchTool20260209 webFetchTool20260209)

• addTool

   final StructuredMessageCreateParams.Builder<T> addTool(WebFetchTool20260309 webFetchTool20260309)

• addTool

   final StructuredMessageCreateParams.Builder<T> addTool(ToolSearchToolBm25_20251119 searchToolBm25_20251119)

• addTool

   final StructuredMessageCreateParams.Builder<T> addTool(ToolSearchToolRegex20251119 searchToolRegex20251119)

• container

   final StructuredMessageCreateParams.Builder<T> container(String container)

• container

   final StructuredMessageCreateParams.Builder<T> container(Optional<String> container)

• container

   final StructuredMessageCreateParams.Builder<T> container(JsonField<String> container)

• topK

   final StructuredMessageCreateParams.Builder<T> topK(Long topK)

• topK

   final StructuredMessageCreateParams.Builder<T> topK(JsonField<Long> topK)

• topP

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

• topP

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

• additionalBodyProperties

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

• putAdditionalBodyProperty

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

• putAllAdditionalBodyProperties

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

• removeAdditionalBodyProperty

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

• removeAllAdditionalBodyProperties

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

• additionalHeaders

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

• additionalHeaders

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

• putAdditionalHeader

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

• putAdditionalHeaders

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

• putAllAdditionalHeaders

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

• putAllAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAllAdditionalHeaders

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

• replaceAllAdditionalHeaders

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

• removeAdditionalHeaders

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

• removeAllAdditionalHeaders

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

• additionalQueryParams

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

• additionalQueryParams

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

• putAdditionalQueryParam

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

• putAdditionalQueryParams

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

• putAllAdditionalQueryParams

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

• putAllAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAllAdditionalQueryParams

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

• replaceAllAdditionalQueryParams

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

• removeAdditionalQueryParams

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

• removeAllAdditionalQueryParams

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

• build

   final StructuredMessageCreateParams<T> build()

  Returns an immutable instance of StructuredMessageCreateParams.

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

  The following fields are required:

  .maxTokens()
  .messages()
  .model()