Class: Anthropic::Models::Beta::BetaMessageParam

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/anthropic/models/beta/beta_message_param.rb,
sig/anthropic/models/beta/beta_message_param.rbs

Defined Under Namespace

Modules: ClearAt, Content, Role

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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(content:, role:, clear_at: nil, output_config: nil) ⇒ Object

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

Parameters:

  • (defaults to: nil)

    How long this system message's text stays in front of the model. "never" (the

  • (defaults to: nil)

    Per-message output configuration on a role:"system" input message.




# File 'lib/anthropic/models/beta/beta_message_param.rb', line 38

Instance Attribute Details

#clear_at ⇒ Symbol, ...

How long this system message's text stays in front of the model. "never" (the default) renders it on every request that includes it. "next_user_message" renders it only for the user turn it follows: once a later role: "user" message exists in messages the message stays in the array (send it unchanged) but is no longer shown to the model. Only permitted on role: "system" messages.

Parameters:

Returns:



26
 
# File 'lib/anthropic/models/beta/beta_message_param.rb', line 26

optional :clear_at, enum: -> { Anthropic::Beta::BetaMessageParam::ClearAt }, nil?: true

#content ⇒ String, Array<Anthropic::Models::Beta::BetaTextBlockParam, Anthropic::Models::Beta::BetaImageBlockParam, Anthropic::Models::Beta::BetaRequestDocumentBlock, Anthropic::Models::Beta::BetaSearchResultBlockParam, Anthropic::Models::Beta::BetaThinkingBlockParam, Anthropic::Models::Beta::BetaRedactedThinkingBlockParam, Anthropic::Models::Beta::BetaToolUseBlockParam, Anthropic::Models::Beta::BetaToolResultBlockParam, Anthropic::Models::Beta::BetaServerToolUseBlockParam, Anthropic::Models::Beta::BetaWebSearchToolResultBlockParam, Anthropic::Models::Beta::BetaWebFetchToolResultBlockParam, Anthropic::Models::Beta::BetaAdvisorToolResultBlockParam, Anthropic::Models::Beta::BetaCodeExecutionToolResultBlockParam, Anthropic::Models::Beta::BetaBashCodeExecutionToolResultBlockParam, Anthropic::Models::Beta::BetaTextEditorCodeExecutionToolResultBlockParam, Anthropic::Models::Beta::BetaToolSearchToolResultBlockParam, Anthropic::Models::Beta::BetaMCPToolUseBlockParam, Anthropic::Models::Beta::BetaRequestMCPToolResultBlockParam, Anthropic::Models::Beta::BetaContainerUploadBlockParam, Anthropic::Models::Beta::BetaCompactionBlockParam, Anthropic::Models::Beta::BetaRequestToolAdditionBlock, Anthropic::Models::Beta::BetaRequestToolRemovalBlock, Anthropic::Models::Beta::BetaFallbackBlockParam>

Parameters:

Returns:



10
 
# File 'lib/anthropic/models/beta/beta_message_param.rb', line 10

required :content, union: -> { Anthropic::Beta::BetaMessageParam::Content }

#output_config ⇒ Anthropic::Models::Beta::BetaSystemMessageOutputConfig?

Per-message output configuration on a role:"system" input message.

Fields here apply per-turn; format remains top-level only. An empty {} is accepted on a message that carries content; a message with neither content nor output_config fields is rejected.

Parameters:

Returns:



36
 
# File 'lib/anthropic/models/beta/beta_message_param.rb', line 36

optional :output_config, -> { Anthropic::Beta::BetaSystemMessageOutputConfig }, nil?: true

#role ⇒ Symbol, Anthropic::Models::Beta::BetaMessageParam::Role

Parameters:

Returns:



15
 
# File 'lib/anthropic/models/beta/beta_message_param.rb', line 15

required :role, enum: -> { Anthropic::Beta::BetaMessageParam::Role }

Class Method Details

.values ⇒ Array<Symbol>

Returns:




# File 'lib/anthropic/models/beta/beta_message_param.rb', line 74

Instance Method Details

#to_hash ⇒ {

Returns:



30
 
# File 'sig/anthropic/models/beta/beta_message_param.rbs', line 30

def to_hash: -> {