Class MessageCountTokensParams.Body.Builder
-
- All Implemented Interfaces:
public final class MessageCountTokensParams.Body.BuilderA builder for Body.
-
-
Method Summary
-
-
Method Detail
-
messages
final MessageCountTokensParams.Body.Builder messages(List<BetaMessageParam> messages)
Input messages.
Our models are trained to operate on alternating
userandassistantconversational turns. When creating a newMessage, you specify the prior conversational turns with themessagesparameter, and the model then generates the nextMessagein the conversation. Consecutiveuserorassistantturns in your request will be combined into a single turn.Each input message must be an object with a
roleandcontent. You can specify a singleuser-role message, or you can include multipleuserandassistantmessages.If the final message uses the
assistantrole, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response.Example with a single
usermessage:[{ "role": "user", "content": "Hello, Claude" }]Example with multiple conversational turns:
[ { "role": "user", "content": "Hello there." }, { "role": "assistant", "content": "Hi, I'm Claude. How can I help you?" }, { "role": "user", "content": "Can you explain LLMs in plain English?" } ]Example with a partially-filled response from Claude:
[ { "role": "user", "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun" }, { "role": "assistant", "content": "The best answer is (" } ]Each input message
contentmay be either a singlestringor an array of content blocks, where each block has a specifictype. Using astringforcontentis shorthand for an array of one content block of type"text". The following input messages are equivalent:{ "role": "user", "content": "Hello, Claude" }{ "role": "user", "content": [{ "type": "text", "text": "Hello, Claude" }] }Starting with Claude 3 models, you can also send image content blocks:
{ "role": "user", "content": [ { "type": "image", "source": { "type": "base64", "media_type": "image/jpeg", "data": "/9j/4AAQSkZJRg..." } }, { "type": "text", "text": "What is in this image?" } ] }We currently support the
base64source type for images, and theimage/jpeg,image/png,image/gif, andimage/webpmedia types.See examples for more input examples.
Note that if you want to include a system prompt, you can use the top-level
systemparameter — there is no"system"role for input messages in the Messages API.There is a limit of 100000 messages in a single request.
-
messages
final MessageCountTokensParams.Body.Builder messages(JsonField<List<BetaMessageParam>> messages)
Sets Builder.messages to an arbitrary JSON value.
You should usually call Builder.messages with a well-typed
List<BetaMessageParam>value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
addMessage
final MessageCountTokensParams.Body.Builder addMessage(BetaMessageParam message)
Adds a single BetaMessageParam to messages.
-
addMessage
final MessageCountTokensParams.Body.Builder addMessage(BetaMessage message)
Alias for calling addMessage with
message.toParam().
-
addUserMessage
final MessageCountTokensParams.Body.Builder addUserMessage(BetaMessageParam.Content content)
Alias for calling addMessage with the following:
BetaMessageParam.builder() .role(BetaMessageParam.Role.USER) .content(content) .build()
-
addUserMessage
final MessageCountTokensParams.Body.Builder addUserMessage(String string)
Alias for calling addUserMessage with
BetaMessageParam.Content.ofString(string).
-
addUserMessageOfBetaContentBlockParams
final MessageCountTokensParams.Body.Builder addUserMessageOfBetaContentBlockParams(List<BetaContentBlockParam> betaContentBlockParams)
Alias for calling addUserMessage with
BetaMessageParam.Content.ofBetaContentBlockParams(betaContentBlockParams).
-
addAssistantMessage
final MessageCountTokensParams.Body.Builder addAssistantMessage(BetaMessageParam.Content content)
Alias for calling addMessage with the following:
BetaMessageParam.builder() .role(BetaMessageParam.Role.ASSISTANT) .content(content) .build()
-
addAssistantMessage
final MessageCountTokensParams.Body.Builder addAssistantMessage(String string)
Alias for calling addAssistantMessage with
BetaMessageParam.Content.ofString(string).
-
addAssistantMessageOfBetaContentBlockParams
final MessageCountTokensParams.Body.Builder addAssistantMessageOfBetaContentBlockParams(List<BetaContentBlockParam> betaContentBlockParams)
Alias for calling addAssistantMessage with
BetaMessageParam.Content.ofBetaContentBlockParams(betaContentBlockParams).
-
model
final MessageCountTokensParams.Body.Builder model(Model model)
The model that will complete your prompt.\n\nSee models for additional details and options.
-
model
final MessageCountTokensParams.Body.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 MessageCountTokensParams.Body.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.
-
mcpServers
final MessageCountTokensParams.Body.Builder mcpServers(List<BetaRequestMcpServerUrlDefinition> mcpServers)
MCP servers to be utilized in this request
-
mcpServers
final MessageCountTokensParams.Body.Builder mcpServers(JsonField<List<BetaRequestMcpServerUrlDefinition>> mcpServers)
Sets Builder.mcpServers to an arbitrary JSON value.
You should usually call Builder.mcpServers with a well-typed
List<BetaRequestMcpServerUrlDefinition>value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
addMcpServer
final MessageCountTokensParams.Body.Builder addMcpServer(BetaRequestMcpServerUrlDefinition mcpServer)
Adds a single BetaRequestMcpServerUrlDefinition to mcpServers.
-
system
final MessageCountTokensParams.Body.Builder system(MessageCountTokensParams.System system)
System prompt.
A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our guide to system prompts.
-
system
final MessageCountTokensParams.Body.Builder system(JsonField<MessageCountTokensParams.System> system)
Sets Builder.system to an arbitrary JSON value.
You should usually call Builder.system with a well-typed System value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
system
final MessageCountTokensParams.Body.Builder system(String string)
Alias for calling system with
System.ofString(string).
-
systemOfBetaTextBlockParams
final MessageCountTokensParams.Body.Builder systemOfBetaTextBlockParams(List<BetaTextBlockParam> betaTextBlockParams)
Alias for calling system with
System.ofBetaTextBlockParams(betaTextBlockParams).
-
thinking
final MessageCountTokensParams.Body.Builder thinking(BetaThinkingConfigParam thinking)
Configuration for enabling Claude's extended thinking.
When enabled, responses include
thinkingcontent blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards yourmax_tokenslimit.See extended thinking for details.
-
thinking
final MessageCountTokensParams.Body.Builder thinking(JsonField<BetaThinkingConfigParam> thinking)
Sets Builder.thinking to an arbitrary JSON value.
You should usually call Builder.thinking with a well-typed BetaThinkingConfigParam value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
thinking
final MessageCountTokensParams.Body.Builder thinking(BetaThinkingConfigEnabled enabled)
Alias for calling thinking with
BetaThinkingConfigParam.ofEnabled(enabled).
-
thinking
final MessageCountTokensParams.Body.Builder thinking(BetaThinkingConfigDisabled disabled)
Alias for calling thinking with
BetaThinkingConfigParam.ofDisabled(disabled).
-
enabledThinking
final MessageCountTokensParams.Body.Builder enabledThinking(Long budgetTokens)
Alias for calling thinking with the following:
BetaThinkingConfigEnabled.builder() .budgetTokens(budgetTokens) .build()
-
toolChoice
final MessageCountTokensParams.Body.Builder toolChoice(BetaToolChoice toolChoice)
How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all.
-
toolChoice
final MessageCountTokensParams.Body.Builder toolChoice(JsonField<BetaToolChoice> toolChoice)
Sets Builder.toolChoice to an arbitrary JSON value.
You should usually call Builder.toolChoice with a well-typed BetaToolChoice value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
toolChoice
final MessageCountTokensParams.Body.Builder toolChoice(BetaToolChoiceAuto auto)
Alias for calling toolChoice with
BetaToolChoice.ofAuto(auto).
-
toolChoice
final MessageCountTokensParams.Body.Builder toolChoice(BetaToolChoiceAny any)
Alias for calling toolChoice with
BetaToolChoice.ofAny(any).
-
toolChoice
final MessageCountTokensParams.Body.Builder toolChoice(BetaToolChoiceTool tool)
Alias for calling toolChoice with
BetaToolChoice.ofTool(tool).
-
toolChoice
final MessageCountTokensParams.Body.Builder toolChoice(BetaToolChoiceNone none)
Alias for calling toolChoice with
BetaToolChoice.ofNone(none).
-
toolToolChoice
final MessageCountTokensParams.Body.Builder toolToolChoice(String name)
Alias for calling toolChoice with the following:
BetaToolChoiceTool.builder() .name(name) .build()
-
tools
final MessageCountTokensParams.Body.Builder tools(List<MessageCountTokensParams.Tool> tools)
Definitions of tools that the model may use.
If you include
toolsin your API request, the model may returntool_usecontent blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model usingtool_resultcontent blocks.Each tool definition includes:
name: Name of the tool.description: Optional, but strongly-recommended description of the tool.input_schema: JSON schema for the toolinputshape that the model will produce intool_useoutput content blocks.
For example, if you defined
toolsas:[ { "name": "get_stock_price", "description": "Get the current stock price for a given ticker symbol.", "input_schema": { "type": "object", "properties": { "ticker": { "type": "string", "description": "The stock ticker symbol, e.g. AAPL for Apple Inc." } }, "required": ["ticker"] } } ]And then asked the model "What's the S&P 500 at today?", the model might produce
tool_usecontent blocks in the response like this:[ { "type": "tool_use", "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "name": "get_stock_price", "input": { "ticker": "^GSPC" } } ]You might then run your
get_stock_pricetool with{"ticker": "^GSPC"}as an input, and return the following back to the model in a subsequentusermessage:[ { "type": "tool_result", "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV", "content": "259.75 USD" } ]Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output.
See our guide for more details.
-
tools
final MessageCountTokensParams.Body.Builder tools(JsonField<List<MessageCountTokensParams.Tool>> tools)
Sets Builder.tools to an arbitrary JSON value.
You should usually call Builder.tools with a well-typed
List<Tool>value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
addTool
final MessageCountTokensParams.Body.Builder addTool(MessageCountTokensParams.Tool tool)
-
addTool
final MessageCountTokensParams.Body.Builder addTool(BetaTool beta)
Alias for calling addTool with
Tool.ofBeta(beta).
-
addTool
final MessageCountTokensParams.Body.Builder addTool(BetaToolComputerUse20241022 betaToolComputerUse20241022)
Alias for calling addTool with
Tool.ofBetaToolComputerUse20241022(betaToolComputerUse20241022).
-
addTool
final MessageCountTokensParams.Body.Builder addTool(BetaToolBash20241022 betaToolBash20241022)
Alias for calling addTool with
Tool.ofBetaToolBash20241022(betaToolBash20241022).
-
addTool
final MessageCountTokensParams.Body.Builder addTool(BetaToolTextEditor20241022 betaToolTextEditor20241022)
Alias for calling addTool with
Tool.ofBetaToolTextEditor20241022(betaToolTextEditor20241022).
-
addTool
final MessageCountTokensParams.Body.Builder addTool(BetaToolComputerUse20250124 betaToolComputerUse20250124)
Alias for calling addTool with
Tool.ofBetaToolComputerUse20250124(betaToolComputerUse20250124).
-
addTool
final MessageCountTokensParams.Body.Builder addTool(BetaToolBash20250124 betaToolBash20250124)
Alias for calling addTool with
Tool.ofBetaToolBash20250124(betaToolBash20250124).
-
addTool
final MessageCountTokensParams.Body.Builder addTool(BetaToolTextEditor20250124 betaToolTextEditor20250124)
Alias for calling addTool with
Tool.ofBetaToolTextEditor20250124(betaToolTextEditor20250124).
-
addTool
final MessageCountTokensParams.Body.Builder addTool(BetaToolTextEditor20250429 betaToolTextEditor20250429)
Alias for calling addTool with
Tool.ofBetaToolTextEditor20250429(betaToolTextEditor20250429).
-
addTool
final MessageCountTokensParams.Body.Builder addTool(BetaWebSearchTool20250305 betaWebSearchTool20250305)
Alias for calling addTool with
Tool.ofBetaWebSearchTool20250305(betaWebSearchTool20250305).
-
addTool
final MessageCountTokensParams.Body.Builder addTool(BetaCodeExecutionTool20250522 betaCodeExecutionTool20250522)
Alias for calling addTool with
Tool.ofBetaCodeExecutionTool20250522(betaCodeExecutionTool20250522).
-
additionalProperties
final MessageCountTokensParams.Body.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
-
putAdditionalProperty
final MessageCountTokensParams.Body.Builder putAdditionalProperty(String key, JsonValue value)
-
putAllAdditionalProperties
final MessageCountTokensParams.Body.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
-
removeAdditionalProperty
final MessageCountTokensParams.Body.Builder removeAdditionalProperty(String key)
-
removeAllAdditionalProperties
final MessageCountTokensParams.Body.Builder removeAllAdditionalProperties(Set<String> keys)
-
build
final MessageCountTokensParams.Body build()
Returns an immutable instance of Body.
Further updates to this Builder will not mutate the returned instance.
The following fields are required:
.messages() .model()
-
-
-
-