Class: Anthropic::Models::Beta::SessionCreateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/anthropic/models/beta/session_create_params.rb

Overview

See Also:

• Resources::Beta::Sessions#create

Defined Under Namespace

Modules: Agent, Resource

Instance Attribute Summary

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

  Agent identifier.

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

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

• #environment_id ⇒ String

  ID of the environment defining the container configuration for this session.

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

  Arbitrary key-value metadata attached to the session.

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

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

• #title ⇒ String^?

  Human-readable session title.

• #vault_ids ⇒ Array<String>^?

  Vault IDs for stored credentials the agent can use during the session.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

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

Instance Method Summary

• #initialize(agent:, environment_id:, metadata: nil, resources: nil, title: nil, vault_ids: nil, betas: nil, request_options: {}) ⇒ void constructor

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

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:, metadata: nil, resources: nil, title: nil, vault_ids: nil, betas: nil, request_options: {}) ⇒ void

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

Parameters:

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

  Agent identifier. Accepts the agent ID string, which pins the latest version f

• environment_id (String) —

  ID of the environment defining the container configuration for this session.

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

  Arbitrary key-value metadata attached to the session. Maximum 16 pairs, keys up

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

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

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

  Human-readable session title.

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

  Vault IDs for stored credentials the agent can use during the session.

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

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

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

# File 'lib/anthropic/models/beta/session_create_params.rb', line 56

Instance Attribute Details

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

Agent identifier. Accepts the agent ID string, which pins the latest version for the session, or an agent object with both id and version specified.

Returns:

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

# File 'lib/anthropic/models/beta/session_create_params.rb', line 16

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

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

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

Returns:

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

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

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

#environment_id ⇒ String

ID of the environment defining the container configuration for this session.

Returns:

• (String)

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

required :environment_id, String

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

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

Returns:

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

# File 'lib/anthropic/models/beta/session_create_params.rb', line 29

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

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

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

Returns:

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

# File 'lib/anthropic/models/beta/session_create_params.rb', line 35

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

#title ⇒ String^?

Human-readable session title.

Returns:

• (String, nil)

# File 'lib/anthropic/models/beta/session_create_params.rb', line 42

optional :title, String, nil?: true

#vault_ids ⇒ Array<String>^?

Vault IDs for stored credentials the agent can use during the session.

Returns:

• (Array<String>, nil)

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

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

Class Method Details

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

Returns:

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

# File 'lib/anthropic/models/beta/session_create_params.rb', line 86