Class: Anthropic::Models::Beta::DreamCreateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

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

Overview

See Also:

• Anthropic::Resources::Beta::Dreams#create

Defined Under Namespace

Modules: Model

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::Anthropic

Instance Attribute Summary

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

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

• #inputs ⇒ Array<Anthropic::Models::Beta::BetaDreamMemoryStoreInput, Anthropic::Models::Beta::BetaDreamSessionsInput>

  The memory store and sessions for the dream to read, as exactly one memory_store entry and exactly one sessions entry.

• #instructions ⇒ String^?

  Guidance that steers how the dream reads the sessions and organizes the output memory store, from 1 to 4,096 characters.

• #model ⇒ Anthropic::Models::Beta::BetaDreamModelConfigParam, String

  The model that runs a dream, given as a model ID or as an object with id and speed.

• #output_behavior ⇒ Anthropic::Models::Beta::BetaOutputBehaviorCreateNew, ...

  Which memory store a dream writes its result to.

• #workspace_id ⇒ String^?

  Optional header to select the Workspace for this request.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(inputs:, model:, instructions: nil, output_behavior: nil, betas: nil, workspace_id: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see DreamCreateParams 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(inputs:, model:, instructions: nil, output_behavior: nil, betas: nil, workspace_id: nil, request_options: {}) ⇒ Object

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

Parameters:

• inputs (Array<Anthropic::Models::Beta::BetaDreamMemoryStoreInput, Anthropic::Models::Beta::BetaDreamSessionsInput>) —

  The memory store and sessions for the dream to read, as exactly one `memory_stor

• model (Anthropic::Models::Beta::BetaDreamModelConfigParam, String) —

  The model that runs a dream, given as a model ID or as an object with id and `

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

  Guidance that steers how the dream reads the sessions and organizes the output m

• output_behavior (Anthropic::Models::Beta::BetaOutputBehaviorCreateNew, Anthropic::Models::Beta::BetaOutputBehaviorUpdateExisting) (defaults to: nil) —

  Which memory store a dream writes its result to. Defaults to create_new when l

• 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/dream_create_params.rb', line 66

Instance Attribute Details

#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/dream_create_params.rb', line 53

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

#inputs ⇒ Array<Anthropic::Models::Beta::BetaDreamMemoryStoreInput, Anthropic::Models::Beta::BetaDreamSessionsInput>

The memory store and sessions for the dream to read, as exactly one memory_store entry and exactly one sessions entry.

Parameters:

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

Returns:

• (Array<Anthropic::Models::Beta::BetaDreamMemoryStoreInput, Anthropic::Models::Beta::BetaDreamSessionsInput>)

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

required :inputs, -> { Anthropic::Internal::Type::ArrayOf[union: Anthropic::Beta::BetaDreamInput] }

#instructions ⇒ String^?

Guidance that steers how the dream reads the sessions and organizes the output memory store, from 1 to 4,096 characters.

See the Dreams guide for what kinds of instructions work well.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/anthropic/models/beta/dream_create_params.rb', line 40

optional :instructions, String, nil?: true

#model ⇒ Anthropic::Models::Beta::BetaDreamModelConfigParam, String

The model that runs a dream, given as a model ID or as an object with id and speed.

In the object form, speed can only be standard.

The limits table in the Dreams guide lists the supported models.

Parameters:

• value (Anthropic::Models::Beta::DreamCreateParams::model)

Returns:

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

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

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

#output_behavior ⇒ Anthropic::Models::Beta::BetaOutputBehaviorCreateNew, ...

Which memory store a dream writes its result to. Defaults to create_new when left out of a create request.

Returns:

• (Anthropic::Models::Beta::BetaOutputBehaviorCreateNew, Anthropic::Models::Beta::BetaOutputBehaviorUpdateExisting, nil)

# File 'lib/anthropic/models/beta/dream_create_params.rb', line 47

optional :output_behavior, union: -> { Anthropic::Beta::BetaOutputBehavior }

#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/dream_create_params.rb', line 64

optional :workspace_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/anthropic/models/beta/dream_create_params.rbs', line 51

def to_hash: -> {