Class: Anthropic::Models::MessageCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/anthropic/models/message_create_params.rb

Overview

See Also:

Defined Under Namespace

Modules: ServiceTier, System

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(max_tokens: , messages: , model: , metadata: nil, service_tier: nil, stop_sequences: nil, system_: nil, temperature: nil, thinking: nil, tool_choice: nil, tools: nil, top_k: nil, top_p: nil, request_options: {}) ⇒ void

Some parameter documentations has been truncated, see Anthropic::Models::MessageCreateParams for more details.

Parameters:




# File 'lib/anthropic/models/message_create_params.rb', line 282

Instance Attribute Details

#max_tokens ⇒ Integer

The maximum number of tokens to generate before stopping.

Note that our models may stop before reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate.

Different models have different maximum values for this parameter. See models for details.

Returns:

  • (Integer) 


22
 
# File 'lib/anthropic/models/message_create_params.rb', line 22

required :max_tokens, Integer

#messages ⇒ Array<Anthropic::Models::MessageParam>

Input messages.

Our models are trained to operate on alternating user and assistant conversational turns. When creating a new Message, you specify the prior conversational turns with the messages parameter, and the model then generates the next Message in the conversation. Consecutive user or assistant turns in your request will be combined into a single turn.

Each input message must be an object with a role and content. You can specify a single user-role message, or you can include multiple user and assistant messages.

If the final message uses the assistant role, 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 user message:

[{ "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 content may be either a single string or an array of content blocks, where each block has a specific type. Using a string for content is 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" }] }

See input examples.

Note that if you want to include a system prompt, you can use the top-level system parameter — there is no "system" role for input messages in the Messages API.

There is a limit of 100,000 messages in a single request.

Returns:



92
 
# File 'lib/anthropic/models/message_create_params.rb', line 92

required :messages, -> { Anthropic::Internal::Type::ArrayOf[Anthropic::MessageParam] }

#metadata ⇒ Anthropic::Models::Metadata?

An object describing metadata about the request.

Returns:



106
 
# File 'lib/anthropic/models/message_create_params.rb', line 106

optional :metadata, -> { Anthropic::Metadata }

#model ⇒ Symbol, ...

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

Returns:



100
 
# File 'lib/anthropic/models/message_create_params.rb', line 100

required :model, union: -> { Anthropic::Model }

#service_tier ⇒ Symbol, ...

Determines whether to use priority capacity (if available) or standard capacity for this request.

Anthropic offers different levels of service for your API requests. See service-tiers for details.

Returns:



116
 
# File 'lib/anthropic/models/message_create_params.rb', line 116

optional :service_tier, enum: -> { Anthropic::MessageCreateParams::ServiceTier }

#stop_sequences ⇒ Array<String>?

Custom text sequences that will cause the model to stop generating.

Our models will normally stop when they have naturally completed their turn, which will result in a response stop_reason of "end_turn".

If you want the model to stop generating when it encounters custom strings of text, you can use the stop_sequences parameter. If the model encounters one of the custom sequences, the response stop_reason value will be "stop_sequence" and the response stop_sequence value will contain the matched stop sequence.

Returns:

  • (Array<String>, nil) 


130
 
# File 'lib/anthropic/models/message_create_params.rb', line 130

optional :stop_sequences, Anthropic::Internal::Type::ArrayOf[String]

#system_ ⇒ String, ...

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.

Returns:



140
 
# File 'lib/anthropic/models/message_create_params.rb', line 140

optional :system_, union: -> { Anthropic::MessageCreateParams::System }, api_name: :system

#temperature ⇒ Float?

Amount of randomness injected into the response.

Defaults to 1.0. Ranges from 0.0 to 1.0. Use temperature closer to 0.0 for analytical / multiple choice, and closer to 1.0 for creative and generative tasks.

Note that even with temperature of 0.0, the results will not be fully deterministic.

Returns:

  • (Float, nil) 


153
 
# File 'lib/anthropic/models/message_create_params.rb', line 153

optional :temperature, Float

#thinking ⇒ Anthropic::Models::ThinkingConfigEnabled, ...

Configuration for enabling Claude's extended thinking.

When enabled, responses include thinking content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your max_tokens limit.

See extended thinking for details.

Returns:



167
 
# File 'lib/anthropic/models/message_create_params.rb', line 167

optional :thinking, union: -> { Anthropic::ThinkingConfigParam }

#tool_choice ⇒ Anthropic::Models::ToolChoiceAuto, ...

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.

Returns:



174
 
# File 'lib/anthropic/models/message_create_params.rb', line 174

optional :tool_choice, union: -> { Anthropic::ToolChoice }

#tools ⇒ Array<Anthropic::Models::Tool, Anthropic::Models::ToolBash20250124, Anthropic::Models::ToolTextEditor20250124, Anthropic::Models::ToolTextEditor20250429, Anthropic::Models::ToolTextEditor20250728, Anthropic::Models::WebSearchTool20250305>?

Definitions of tools that the model may use.

If you include tools in your API request, the model may return tool_use content 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 using tool_result content blocks.

There are two types of tools: client tools and server tools. The behavior described below applies to client tools. For server tools, see their individual documentation as each has its own behavior (e.g., the web search tool).

Each tool definition includes:

  • name: Name of the tool.
  • description: Optional, but strongly-recommended description of the tool.
  • input_schema: JSON schema for the tool input shape that the model will produce in tool_use output content blocks.

For example, if you defined tools as:

[
  {
    "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_use content 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_price tool with {"ticker": "^GSPC"} as an input, and return the following back to the model in a subsequent user message:

[
  {
    "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.

Returns:



254
 
# File 'lib/anthropic/models/message_create_params.rb', line 254

optional :tools, -> { Anthropic::Internal::Type::ArrayOf[union: Anthropic::ToolUnion] }

#top_k ⇒ Integer?

Only sample from the top K options for each subsequent token.

Used to remove "long tail" low probability responses. Learn more technical details here.

Recommended for advanced use cases only. You usually only need to use temperature.

Returns:

  • (Integer, nil) 


266
 
# File 'lib/anthropic/models/message_create_params.rb', line 266

optional :top_k, Integer

#top_p ⇒ Float?

Use nucleus sampling.

In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by top_p. You should either alter temperature or top_p, but not both.

Recommended for advanced use cases only. You usually only need to use temperature.

Returns:

  • (Float, nil) 


280
 
# File 'lib/anthropic/models/message_create_params.rb', line 280

optional :top_p, Float

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/anthropic/models/message_create_params.rb', line 325