Class: Anthropic::Models::Beta::DeploymentCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Anthropic::Models::Beta::DeploymentCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/anthropic/models/beta/deployment_create_params.rb,
sig/anthropic/models/beta/deployment_create_params.rbs

Overview

See Also:

• Anthropic::Resources::Beta::Deployments#create

Defined Under Namespace

Modules: Agent, Resource

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::Anthropic

Instance Attribute Summary

• #agent ⇒ Anthropic::Models::Beta::BetaManagedAgentsAgentParams, String

  Agent to deploy.

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

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

• #budget ⇒ Anthropic::Models::Beta::BetaManagedAgentsBudgetLimit^?

  Enforced spend ceiling stamped onto each session created from this deployment, copied at session-creation time.

• #description ⇒ String^?

  Description of what the deployment does.

• #environment_id ⇒ String

  ID of the environment defining the container configuration for sessions created from this deployment.

• #initial_events ⇒ Array<Anthropic::Models::Beta::Sessions::BetaManagedAgentsUserMessageEventParams, Anthropic::Models::Beta::Sessions::BetaManagedAgentsUserDefineOutcomeEventParams, Anthropic::Models::Beta::Sessions::BetaManagedAgentsSystemMessageEventParams>

  Events to send to each session immediately after creation.

• #metadata ⇒ Hash{Symbol=>String}^?

  Arbitrary key-value metadata.

• #name ⇒ String

  Human-readable name for the deployment.

• #resources ⇒ Array<Anthropic::Models::Beta::BetaManagedAgentsGitHubRepositoryResourceParams, Anthropic::Models::Beta::BetaManagedAgentsFileResourceParams, Anthropic::Models::Beta::BetaManagedAgentsMemoryStoreResourceParam>^?

  Resources (e.g. repositories, files) to mount into each session's container.

• #schedule ⇒ Anthropic::Models::Beta::BetaManagedAgentsScheduleParams^?

  Optional recurring cron schedule.

• #vault_ids ⇒ Array<String>^?

  Vault IDs for stored credentials the agent can use during sessions created from this deployment.

• #workspace_id ⇒ String^?

  Optional header to select the Workspace for this request.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .variants ⇒ Array(Anthropic::Models::Beta::BetaManagedAgentsAgentParams, String)

Instance Method Summary

• #initialize(agent:, environment_id:, initial_events:, name:, budget: nil, description: nil, metadata: nil, resources: nil, schedule: nil, vault_ids: nil, betas: nil, workspace_id: nil, request_options: {}) ⇒ void constructor

  Some parameter documentations has been truncated, see DeploymentCreateParams for more details.

• #to_hash ⇒ {

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:, environment_id:, initial_events:, name:, budget: nil, description: nil, metadata: nil, resources: nil, schedule: nil, vault_ids: nil, betas: nil, workspace_id: nil, request_options: {}) ⇒ void

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

Parameters:

• agent (Anthropic::Models::Beta::BetaManagedAgentsAgentParams, String) —

  Agent to deploy. Accepts the agent ID string, which pins the latest version, o

• environment_id (String) —

  ID of the environment defining the container configuration for sessions create

• initial_events (Array<Anthropic::Models::Beta::Sessions::BetaManagedAgentsUserMessageEventParams, Anthropic::Models::Beta::Sessions::BetaManagedAgentsUserDefineOutcomeEventParams, Anthropic::Models::Beta::Sessions::BetaManagedAgentsSystemMessageEventParams>) —

  Events to send to each session immediately after creation. At least 1, maximum 5

• name (String) —

  Human-readable name for the deployment.

• budget (Anthropic::Models::Beta::BetaManagedAgentsBudgetLimit, nil) (defaults to: nil) —

  Enforced spend ceiling stamped onto each session created from this deployment, c

• description (String, nil) (defaults to: nil) —

  Description of what the deployment does.

• metadata (Hash{Symbol=>String}) (defaults to: nil) —

  Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up t

• resources (Array<Anthropic::Models::Beta::BetaManagedAgentsGitHubRepositoryResourceParams, Anthropic::Models::Beta::BetaManagedAgentsFileResourceParams, Anthropic::Models::Beta::BetaManagedAgentsMemoryStoreResourceParam>) (defaults to: nil) —

  Resources (e.g. repositories, files) to mount into each session's container. Max

• schedule (Anthropic::Models::Beta::BetaManagedAgentsScheduleParams, nil) (defaults to: nil) —

  Optional recurring cron schedule. When present, the deployment fires automatical

• vault_ids (Array<String>) (defaults to: nil) —

  Vault IDs for stored credentials the agent can use during sessions created from

• betas (Array<Symbol, String, Anthropic::Models::AnthropicBeta>) (defaults to: nil) —

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

• workspace_id (String) (defaults to: nil) —

  Optional header to select the Workspace for this request. The value is a Workspa

• request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/anthropic/models/beta/deployment_create_params.rb', line 102

Instance Attribute Details

#agent ⇒ Anthropic::Models::Beta::BetaManagedAgentsAgentParams, String

Agent to deploy. Accepts the agent ID string, which pins the latest version, or an agent object with both id and version specified. The agent must exist and not be archived.

Parameters:

• value (Anthropic::Models::Beta::DeploymentCreateParams::agent)

Returns:

• (Anthropic::Models::Beta::BetaManagedAgentsAgentParams, String)

# File 'lib/anthropic/models/beta/deployment_create_params.rb', line 17

required :agent, union: -> { Anthropic::Beta::DeploymentCreateParams::Agent }

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

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

Returns:

• (Array<Symbol, String, Anthropic::Models::AnthropicBeta>, nil)

# File 'lib/anthropic/models/beta/deployment_create_params.rb', line 89

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

#budget ⇒ Anthropic::Models::Beta::BetaManagedAgentsBudgetLimit^?

Enforced spend ceiling stamped onto each session created from this deployment, copied at session-creation time. Omit to leave sessions uncapped. The deployment agent's model must have a public list price, or the request is rejected; a multiagent roster is re-validated in full when each fire copies the cap, which fails closed the same way.

Parameters:

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

Returns:

• (Anthropic::Models::Beta::BetaManagedAgentsBudgetLimit, nil)

# File 'lib/anthropic/models/beta/deployment_create_params.rb', line 48

optional :budget, -> { Anthropic::Beta::BetaManagedAgentsBudgetLimit }, nil?: true

#description ⇒ String^?

Description of what the deployment does.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/anthropic/models/beta/deployment_create_params.rb', line 54

optional :description, String, nil?: true

#environment_id ⇒ String

ID of the environment defining the container configuration for sessions created from this deployment.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/anthropic/models/beta/deployment_create_params.rb', line 24

required :environment_id, String

#initial_events ⇒ Array<Anthropic::Models::Beta::Sessions::BetaManagedAgentsUserMessageEventParams, Anthropic::Models::Beta::Sessions::BetaManagedAgentsUserDefineOutcomeEventParams, Anthropic::Models::Beta::Sessions::BetaManagedAgentsSystemMessageEventParams>

Events to send to each session immediately after creation. At least 1, maximum 50.

Parameters:

• value (::Array[Anthropic::Models::Beta::beta_managed_agents_deployment_initial_event_params])

Returns:

• (Array<Anthropic::Models::Beta::Sessions::BetaManagedAgentsUserMessageEventParams, Anthropic::Models::Beta::Sessions::BetaManagedAgentsUserDefineOutcomeEventParams, Anthropic::Models::Beta::Sessions::BetaManagedAgentsSystemMessageEventParams>)

# File 'lib/anthropic/models/beta/deployment_create_params.rb', line 31

required :initial_events,
-> { Anthropic::Internal::Type::ArrayOf[union: Anthropic::Beta::BetaManagedAgentsDeploymentInitialEventParams] }

#metadata ⇒ Hash{Symbol=>String}^?

Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.

Parameters:

• (::Hash[Symbol, String])

Returns:

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

# File 'lib/anthropic/models/beta/deployment_create_params.rb', line 61

optional :metadata, Anthropic::Internal::Type::HashOf[String]

#name ⇒ String

Human-readable name for the deployment.

Parameters:

• value (String)

Returns:

• (String)

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

required :name, String

#resources ⇒ Array<Anthropic::Models::Beta::BetaManagedAgentsGitHubRepositoryResourceParams, Anthropic::Models::Beta::BetaManagedAgentsFileResourceParams, Anthropic::Models::Beta::BetaManagedAgentsMemoryStoreResourceParam>^?

Resources (e.g. repositories, files) to mount into each session's container. Maximum 500.

Returns:

• (Array<Anthropic::Models::Beta::BetaManagedAgentsGitHubRepositoryResourceParams, Anthropic::Models::Beta::BetaManagedAgentsFileResourceParams, Anthropic::Models::Beta::BetaManagedAgentsMemoryStoreResourceParam>, nil)

# File 'lib/anthropic/models/beta/deployment_create_params.rb', line 68

optional :resources,
-> { Anthropic::Internal::Type::ArrayOf[union: Anthropic::Beta::DeploymentCreateParams::Resource] }

#schedule ⇒ Anthropic::Models::Beta::BetaManagedAgentsScheduleParams^?

Optional recurring cron schedule. When present, the deployment fires automatically. Both expression and timezone are required when schedule is set.

Parameters:

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

Returns:

• (Anthropic::Models::Beta::BetaManagedAgentsScheduleParams, nil)

# File 'lib/anthropic/models/beta/deployment_create_params.rb', line 76

optional :schedule, -> { Anthropic::Beta::BetaManagedAgentsScheduleParams }, nil?: true

#vault_ids ⇒ Array<String>^?

Vault IDs for stored credentials the agent can use during sessions created from this deployment. Maximum 50.

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

# File 'lib/anthropic/models/beta/deployment_create_params.rb', line 83

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

#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)

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

optional :workspace_id, String

Class Method Details

.variants ⇒ Array(Anthropic::Models::Beta::BetaManagedAgentsAgentParams, String)

Returns:

• (Array(Anthropic::Models::Beta::BetaManagedAgentsAgentParams, String))

# File 'lib/anthropic/models/beta/deployment_create_params.rb', line 143

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/anthropic/models/beta/deployment_create_params.rbs', line 79

def to_hash: -> {