Class: Anthropic::Models::Beta::AgentUpdateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/anthropic/models/beta/agent_update_params.rb,
sig/anthropic/models/beta/agent_update_params.rbs

Overview

See Also:

  • Anthropic::Resources::Beta::Agents#update

Defined Under Namespace

Modules: Model, Tool

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::Anthropic

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(agent_id:, description: nil, mcp_servers: nil, metadata: nil, model: nil, multiagent: nil, name: nil, skills: nil, system_: nil, tools: nil, version: nil, betas: nil, workspace_id: nil, request_options: {}) ⇒ void

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

Parameters:




# File 'lib/anthropic/models/beta/agent_update_params.rb', line 119

Instance Attribute Details

#agent_id ⇒ String

Unique identifier of the agent to update.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :agent_id, String

#betas ⇒ Array<Symbol, String, Anthropic::Models::AnthropicBeta>?

Optional header to specify the beta version(s) you want to use.

Returns:



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

optional :betas, -> { Anthropic::Internal::Type::ArrayOf[union: Anthropic::AnthropicBeta] }

#description ⇒ String?

Description. Omit to preserve; send empty string or null to clear.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


21
 
# File 'lib/anthropic/models/beta/agent_update_params.rb', line 21

optional :description, String, nil?: true

#mcp_servers ⇒ Array<Anthropic::Models::Beta::BetaManagedAgentsURLMCPServerParams>?

MCP servers. Full replacement. Omit to preserve; send empty array or null to clear. Names must be unique. Maximum 20. Every server must be referenced by an mcp_toolset in the agent's resulting tools; unreferenced servers are rejected. See the MCP connector guide.

Parameters:

  • value (::Array[Anthropic::Beta::BetaManagedAgentsURLMCPServerParams], nil)

Returns:



31
32
33
34
35
 
# File 'lib/anthropic/models/beta/agent_update_params.rb', line 31

optional :mcp_servers,
-> {
  Anthropic::Internal::Type::ArrayOf[Anthropic::Beta::BetaManagedAgentsURLMCPServerParams]
},
nil?: true

#metadata ⇒ Hash{Symbol=>String, nil}?

Metadata patch. Set a key to a string to upsert it, or to null to delete it. Omit the field to preserve. The stored bag is limited to 16 keys (up to 64 chars each) with values up to 512 chars.

Parameters:

  • value (::Hash[Symbol, String?], nil)

Returns:

  • (Hash{Symbol=>String, nil}, nil) 


43
 
# File 'lib/anthropic/models/beta/agent_update_params.rb', line 43

optional :metadata, Anthropic::Internal::Type::HashOf[String, nil?: true], nil?: true

#model ⇒ Anthropic::Models::Beta::BetaManagedAgentsModelConfigParams, ...

Model identifier. Accepts the model string, e.g. claude-opus-5, or a model_config object for additional configuration control. Omit to preserve. Cannot be cleared.

Returns:



52
 
# File 'lib/anthropic/models/beta/agent_update_params.rb', line 52

optional :model, union: -> { Anthropic::Beta::AgentUpdateParams::Model }

#multiagent ⇒ Anthropic::Models::Beta::BetaManagedAgentsMultiagentParams?

A coordinator topology: the session's primary thread orchestrates work by spawning session threads, each running an agent drawn from the agents roster.

Parameters:

  • value (Anthropic::Beta::BetaManagedAgentsMultiagentParams, nil)

Returns:



59
 
# File 'lib/anthropic/models/beta/agent_update_params.rb', line 59

optional :multiagent, -> { Anthropic::Beta::BetaManagedAgentsMultiagentParams }, nil?: true

#name ⇒ String?

Human-readable name. Must be non-empty. Omit to preserve. Cannot be cleared.

Parameters:

  • (String)

Returns:

  • (String, nil) 


65
 
# File 'lib/anthropic/models/beta/agent_update_params.rb', line 65

optional :name, String

#skills ⇒ Array<Anthropic::Models::Beta::BetaManagedAgentsAnthropicSkillParams, Anthropic::Models::Beta::BetaManagedAgentsCustomSkillParams>?

Skills. Full replacement. Omit to preserve; send empty array or null to clear.

Parameters:

  • value (::Array[Anthropic::Models::Beta::beta_managed_agents_skill_params], nil)

Returns:



71
72
73
74
75
 
# File 'lib/anthropic/models/beta/agent_update_params.rb', line 71

optional :skills,
-> {
  Anthropic::Internal::Type::ArrayOf[union: Anthropic::Beta::BetaManagedAgentsSkillParams]
},
nil?: true

#system_ ⇒ String?

System prompt. Omit to preserve; send empty string or null to clear.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


81
 
# File 'lib/anthropic/models/beta/agent_update_params.rb', line 81

optional :system_, String, api_name: :system, nil?: true

#tools ⇒ Array<Anthropic::Models::Beta::BetaManagedAgentsAgentToolset20260401Params, Anthropic::Models::Beta::BetaManagedAgentsMCPToolsetParams, Anthropic::Models::Beta::BetaManagedAgentsCustomToolParams>?

Tool configurations available to the agent. Full replacement. Omit to preserve; send empty array or null to clear. Maximum of 128 tools across all toolsets allowed.

Parameters:

  • value (::Array[Anthropic::Models::Beta::AgentUpdateParams::tool], nil)

Returns:



89
90
91
 
# File 'lib/anthropic/models/beta/agent_update_params.rb', line 89

optional :tools,
-> { Anthropic::Internal::Type::ArrayOf[union: Anthropic::Beta::AgentUpdateParams::Tool] },
nil?: true

#version ⇒ Integer?

The agent's current version, used to prevent concurrent overwrites. Obtain this value from a create or retrieve response. Must be at least 1 if specified. When supplied, the request fails if it does not match the server's current version; omit to apply the update unconditionally.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :version, Integer

#workspace_id ⇒ String?

Optional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy).

Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

Parameters:

  • (String)

Returns:

  • (String, nil) 


117
 
# File 'lib/anthropic/models/beta/agent_update_params.rb', line 117

optional :workspace_id, String

Class Method Details

.variants ⇒ Array(Anthropic::Models::Beta::BetaManagedAgentsModelConfigParams, Symbol, String, Anthropic::Models::Beta::BetaManagedAgentsModel)

Returns:




# File 'lib/anthropic/models/beta/agent_update_params.rb', line 166

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


83
 
# File 'sig/anthropic/models/beta/agent_update_params.rbs', line 83

def to_hash: -> {