Constructor Detail

Method Detail

• id

   final BetaMessage.Builder id(String id)

  Unique object identifier.

  The format and length of IDs may change over time.

• id

   final BetaMessage.Builder id(JsonField<String> id)

  Sets Builder.id to an arbitrary JSON value.

  You should usually call Builder.id with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• container

   final BetaMessage.Builder container(BetaContainer container)

  Information about the container used in the request (for the code execution tool)

• container

   final BetaMessage.Builder container(Optional<BetaContainer> container)

  Alias for calling Builder.container with container.orElse(null).

• container

   final BetaMessage.Builder container(JsonField<BetaContainer> container)

  Sets Builder.container to an arbitrary JSON value.

  You should usually call Builder.container with a well-typed BetaContainer value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• content

   final BetaMessage.Builder content(List<BetaContentBlock> content)

  Content generated by the model.

  This is an array of content blocks, each of which has a type that determines its shape.

  Example:

  [{ "type": "text", "text": "Hi, I'm Claude." }]

  If the request input messages ended with an assistant turn, then the response content will continue directly from that last turn. You can use this to constrain the model's output.

  For example, if the input messages were:

  [
    {
      "role": "user",
      "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"
    },
    { "role": "assistant", "content": "The best answer is (" }
  ]

  Then the response content might be:

  [{ "type": "text", "text": "B)" }]

• content

   final BetaMessage.Builder content(JsonField<List<BetaContentBlock>> content)

  Sets Builder.content to an arbitrary JSON value.

  You should usually call Builder.content with a well-typed List<BetaContentBlock> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• addContent

   final BetaMessage.Builder addContent(BetaContentBlock content)

  Adds a single BetaContentBlock to Builder.content.

• addContent

   final BetaMessage.Builder addContent(BetaTextBlock text)

  Alias for calling addContent with BetaContentBlock.ofText(text).

• addContent

   final BetaMessage.Builder addContent(BetaToolUseBlock toolUse)

  Alias for calling addContent with BetaContentBlock.ofToolUse(toolUse).

• addContent

   final BetaMessage.Builder addContent(BetaServerToolUseBlock serverToolUse)

  Alias for calling addContent with BetaContentBlock.ofServerToolUse(serverToolUse).

• addContent

   final BetaMessage.Builder addContent(BetaWebSearchToolResultBlock webSearchToolResult)

  Alias for calling addContent with BetaContentBlock.ofWebSearchToolResult(webSearchToolResult).

• addContent

   final BetaMessage.Builder addContent(BetaCodeExecutionToolResultBlock codeExecutionToolResult)

  Alias for calling addContent with BetaContentBlock.ofCodeExecutionToolResult(codeExecutionToolResult).

• addContent

   final BetaMessage.Builder addContent(BetaMcpToolUseBlock mcpToolUse)

  Alias for calling addContent with BetaContentBlock.ofMcpToolUse(mcpToolUse).

• addContent

   final BetaMessage.Builder addContent(BetaMcpToolResultBlock mcpToolResult)

  Alias for calling addContent with BetaContentBlock.ofMcpToolResult(mcpToolResult).

• addContent

   final BetaMessage.Builder addContent(BetaContainerUploadBlock containerUpload)

  Alias for calling addContent with BetaContentBlock.ofContainerUpload(containerUpload).

• addContent

   final BetaMessage.Builder addContent(BetaThinkingBlock thinking)

  Alias for calling addContent with BetaContentBlock.ofThinking(thinking).

• addContent

   final BetaMessage.Builder addContent(BetaRedactedThinkingBlock redactedThinking)

  Alias for calling addContent with BetaContentBlock.ofRedactedThinking(redactedThinking).

• addContainerUploadContent

   final BetaMessage.Builder addContainerUploadContent(String fileId)

  Alias for calling addContent with the following:

  BetaContainerUploadBlock.builder()
      .fileId(fileId)
      .build()

• addRedactedThinkingContent

   final BetaMessage.Builder addRedactedThinkingContent(String data)

  Alias for calling addContent with the following:

  BetaRedactedThinkingBlock.builder()
      .data(data)
      .build()

• model

   final BetaMessage.Builder model(Model model)

  The model that will complete your prompt.\n\nSee models for additional details and options.

• model

   final BetaMessage.Builder model(JsonField<Model> model)

  Sets Builder.model to an arbitrary JSON value.

  You should usually call Builder.model with a well-typed Model value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• model

   final BetaMessage.Builder model(String value)

  Sets model to an arbitrary String.

  You should usually call model with a well-typed Model constant instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• role

   final BetaMessage.Builder role(JsonValue role)

  Sets the field to an arbitrary JSON value.

  It is usually unnecessary to call this method because the field defaults to the following:

  JsonValue.from("assistant")

  This method is primarily for setting the field to an undocumented or not yet supported value.

• stopReason

   final BetaMessage.Builder stopReason(BetaStopReason stopReason)

  The reason that we stopped.

  This may be one the following values:

  • "end_turn": the model reached a natural stopping point

  • "max_tokens": we exceeded the requested max_tokens or the model's maximum

  • "stop_sequence": one of your provided custom stop_sequences was generated

  • "tool_use": the model invoked one or more tools

  In non-streaming mode this value is always non-null. In streaming mode, it is null in the message_start event and non-null otherwise.

• stopReason

   final BetaMessage.Builder stopReason(Optional<BetaStopReason> stopReason)

  Alias for calling Builder.stopReason with stopReason.orElse(null).

• stopReason

   final BetaMessage.Builder stopReason(JsonField<BetaStopReason> stopReason)

  Sets Builder.stopReason to an arbitrary JSON value.

  You should usually call Builder.stopReason with a well-typed BetaStopReason value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• stopSequence

   final BetaMessage.Builder stopSequence(String stopSequence)

  Which custom stop sequence was generated, if any.

  This value will be a non-null string if one of your custom stop sequences was generated.

• stopSequence

   final BetaMessage.Builder stopSequence(Optional<String> stopSequence)

  Alias for calling Builder.stopSequence with stopSequence.orElse(null).

• stopSequence

   final BetaMessage.Builder stopSequence(JsonField<String> stopSequence)

  Sets Builder.stopSequence to an arbitrary JSON value.

  You should usually call Builder.stopSequence with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• type

   final BetaMessage.Builder type(JsonValue type)

  Sets the field to an arbitrary JSON value.

  It is usually unnecessary to call this method because the field defaults to the following:

  JsonValue.from("message")

  This method is primarily for setting the field to an undocumented or not yet supported value.

• usage

   final BetaMessage.Builder usage(BetaUsage usage)

  Billing and rate-limit usage.

  Anthropic's API bills and rate-limits by token counts, as tokens represent the underlying cost to our systems.

  Under the hood, the API transforms requests into a format suitable for the model. The model's output then goes through a parsing stage before becoming an API response. As a result, the token counts in usage will not match one-to-one with the exact visible content of an API request or response.

  For example, output_tokens will be non-zero, even for an empty string response from Claude.

  Total input tokens in a request is the summation of input_tokens, cache_creation_input_tokens, and cache_read_input_tokens.

• usage

   final BetaMessage.Builder usage(JsonField<BetaUsage> usage)

  Sets Builder.usage to an arbitrary JSON value.

  You should usually call Builder.usage with a well-typed BetaUsage value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalProperties

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

• putAdditionalProperty

   final BetaMessage.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

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

• removeAdditionalProperty

   final BetaMessage.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final BetaMessage.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final BetaMessage build()

  Returns an immutable instance of BetaMessage.

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

  The following fields are required:

  .id()
  .container()
  .content()
  .model()
  .stopReason()
  .stopSequence()
  .usage()