Constructor Detail

Method Detail

• betas

   final StructuredMessageCreateParams.Builder<T> betas(List<AnthropicBeta> betas)

• betas

   final StructuredMessageCreateParams.Builder<T> betas(Optional<List<AnthropicBeta>> betas)

• addBeta

   final StructuredMessageCreateParams.Builder<T> addBeta(AnthropicBeta beta)

• addBeta

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

• 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<BetaMessageParam> messages)

• messages

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

• addMessage

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

• addMessage

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

• addUserMessage

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

• addUserMessage

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

• addUserMessageOfBetaContentBlockParams

   final StructuredMessageCreateParams.Builder<T> addUserMessageOfBetaContentBlockParams(List<BetaContentBlockParam> betaContentBlockParams)

• addAssistantMessage

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

• addAssistantMessage

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

• addAssistantMessageOfBetaContentBlockParams

   final StructuredMessageCreateParams.Builder<T> addAssistantMessageOfBetaContentBlockParams(List<BetaContentBlockParam> betaContentBlockParams)

• 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(BetaCacheControlEphemeral cacheControl)

• cacheControl

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

• cacheControl

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

• container

   final StructuredMessageCreateParams.Builder<T> container(MessageCreateParams.Container container)

• container

   final StructuredMessageCreateParams.Builder<T> container(Optional<MessageCreateParams.Container> container)

• container

   final StructuredMessageCreateParams.Builder<T> container(JsonField<MessageCreateParams.Container> container)

• container

   final StructuredMessageCreateParams.Builder<T> container(BetaContainerParams betaContainerParams)

• container

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

• contextManagement

   final StructuredMessageCreateParams.Builder<T> contextManagement(BetaContextManagementConfig contextManagement)

• contextManagement

   final StructuredMessageCreateParams.Builder<T> contextManagement(Optional<BetaContextManagementConfig> contextManagement)

• contextManagement

   final StructuredMessageCreateParams.Builder<T> contextManagement(JsonField<BetaContextManagementConfig> contextManagement)

• mcpServers

   final StructuredMessageCreateParams.Builder<T> mcpServers(List<BetaRequestMcpServerUrlDefinition> mcpServers)

• mcpServers

   final StructuredMessageCreateParams.Builder<T> mcpServers(JsonField<List<BetaRequestMcpServerUrlDefinition>> mcpServers)

• addMcpServer

   final StructuredMessageCreateParams.Builder<T> addMcpServer(BetaRequestMcpServerUrlDefinition mcpServer)

• 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(BetaMetadata metadata)

• metadata

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

• outputConfig

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

• outputConfig

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

• outputConfig

  @JvmOverloads() final StructuredMessageCreateParams.Builder<T> outputConfig(Class<T> outputType, BetaOutputConfig.Effort effort, 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.

• outputConfig

  @JvmOverloads() final StructuredMessageCreateParams.Builder<T> outputConfig(Class<T> outputType, BetaOutputConfig.Effort effort)

  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.

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

• outputFormat

  @JvmOverloads()@Deprecated(message = "output_format is deprecated. Use outputConfig instead which sets output_config.format.", replaceWith = @ReplaceWith(imports = {}, expression = "outputConfig(outputType, localValidation)")) final StructuredMessageCreateParams.Builder<T> outputFormat(Class<T> outputType, JsonSchemaLocalValidation localValidation)

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

  Deprecated: Use outputConfig instead. This method will be removed in a future release.

• outputFormat

  @JvmOverloads()@Deprecated(message = "output_format is deprecated. Use outputConfig instead which sets output_config.format.", replaceWith = @ReplaceWith(imports = {}, expression = "outputConfig(outputType, localValidation)")) final StructuredMessageCreateParams.Builder<T> outputFormat(Class<T> outputType)

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

  Deprecated: Use outputConfig instead. This method will be removed in a future release.

• serviceTier

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

• serviceTier

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

• speed

   final StructuredMessageCreateParams.Builder<T> speed(MessageCreateParams.Speed speed)

• speed

   final StructuredMessageCreateParams.Builder<T> speed(Optional<MessageCreateParams.Speed> speed)

• speed

   final StructuredMessageCreateParams.Builder<T> speed(JsonField<MessageCreateParams.Speed> speed)

• 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)

• systemOfBetaTextBlockParams

   final StructuredMessageCreateParams.Builder<T> systemOfBetaTextBlockParams(List<BetaTextBlockParam> betaTextBlockParams)

• temperature

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

• temperature

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

• thinking

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

• thinking

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

• thinking

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

• thinking

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

• thinking

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

• enabledThinking

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

• toolChoice

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

• toolChoice

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

• toolChoice

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

• toolChoice

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

• toolChoice

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

• toolChoice

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

• toolToolChoice

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

• tools

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

• tools

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

• addTool

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

• addTool

   final StructuredMessageCreateParams.Builder<T> addTool(BetaTool betaTool)

• addTool

   final StructuredMessageCreateParams.Builder<T> addTool(BetaToolBash20241022 bash20241022)

• addTool

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

• addTool

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

• addTool

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

• addTool

   final StructuredMessageCreateParams.Builder<T> addTool(BetaToolComputerUse20241022 computerUse20241022)

• addTool

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

• addTool

   final StructuredMessageCreateParams.Builder<T> addTool(BetaToolComputerUse20250124 computerUse20250124)

• addTool

   final StructuredMessageCreateParams.Builder<T> addTool(BetaToolComputerUse20251124 computerUse20251124)

• addTool

   final StructuredMessageCreateParams.Builder<T> addTool(BetaToolTextEditor20241022 textEditor20241022)

• addTool

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

• addTool

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

• addTool

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

• addTool

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

• addTool

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

• addTool

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

• addTool

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

• addTool

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

• addTool

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

• addTool

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

• addTool

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

• addTool

   final StructuredMessageCreateParams.Builder<T> addTool(BetaMcpToolset mcpToolset)

• addTool

  @JvmOverloads() final StructuredMessageCreateParams.Builder<T> addTool(Class<?> toolParametersType, JsonSchemaLocalValidation localValidation)

• addTool

  @JvmOverloads() final StructuredMessageCreateParams.Builder<T> addTool(Class<?> toolParametersType)

• 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()