anthropic 1.68.0 → 1.76.0

data/lib/anthropic/models/beta/beta_dream.rb

@@ -6,71 +6,105 @@ module Anthropic
       # @see Anthropic::Resources::Beta::Dreams#create
       class BetaDream < Anthropic::Internal::Type::BaseModel
         # @!attribute id
+        #   The unique ID of the dream (`drm_...`).
         #
         #   @return [String]
         required :id, String
 
         # @!attribute archived_at
-        #   A timestamp in RFC 3339 format
+        #   When the dream was archived, in RFC 3339, or `null` if it hasn't been archived.
         #
         #   @return [Time, nil]
         required :archived_at, Time, nil?: true
 
         # @!attribute created_at
-        #   A timestamp in RFC 3339 format
+        #   When the dream was created, in RFC 3339.
+        #
+        #   Lists of dreams are sorted by this time, newest first.
         #
         #   @return [Time]
         required :created_at, Time
 
         # @!attribute ended_at
-        #   A timestamp in RFC 3339 format
+        #   When the dream reached `completed`, `failed`, or `canceled`, in RFC 3339, or
+        #   `null` if it is still `pending` or `running`.
         #
         #   @return [Time, nil]
         required :ended_at, Time, nil?: true
 
         # @!attribute error
-        #   Failure detail for a Dream whose `status` is `failed`.
+        #   Why the dream failed, or `null` if `status` isn't `failed`.
         #
         #   @return [Anthropic::Models::Beta::BetaDreamError, nil]
         required :error, -> { Anthropic::Beta::BetaDreamError }, nil?: true
 
         # @!attribute inputs
+        #   The sources that the dream reads, from the request that created it.
         #
         #   @return [Array<Anthropic::Models::Beta::BetaDreamMemoryStoreInput, Anthropic::Models::Beta::BetaDreamSessionsInput>]
         required :inputs, -> { Anthropic::Internal::Type::ArrayOf[union: Anthropic::Beta::BetaDreamInput] }
 
         # @!attribute instructions
+        #   The guidance given when the dream was created, or `null` if none was given.
         #
         #   @return [String, nil]
         required :instructions, String, nil?: true
 
         # @!attribute model
-        #   Model identifier and configuration applied to every pipeline stage. Same wire
-        #   shape as the Agents API ModelConfig.
+        #   The model that runs a dream, from the request that created it.
+        #
+        #   The dream uses this model for all of its work. The response always gives the
+        #   model as an object, even if the request gave only a model ID.
         #
         #   @return [Anthropic::Models::Beta::BetaDreamModelConfig]
         required :model, -> { Anthropic::Beta::BetaDreamModelConfig }
 
         # @!attribute output_behavior
-        #   The default destination: the job creates a new output memory store as a clone of
-        #   the memory_store input and writes the consolidated memories into it. The input
-        #   store is never mutated.
+        #   Where the dream writes its result, as set in the request that created the dream.
+        #   If that request left out `output_behavior`, the dream used the `create_new`
+        #   behavior.
         #
         #   @return [Anthropic::Models::Beta::BetaOutputBehaviorCreateNew, Anthropic::Models::Beta::BetaOutputBehaviorUpdateExisting]
         required :output_behavior, union: -> { Anthropic::Beta::BetaOutputBehavior }
 
         # @!attribute outputs
+        #   The memory store that holds the dream's result, as a one-item array, or an empty
+        #   array until the dream records that memory store.
+        #
+        #   The array is empty while the dream is `pending` and for a short time after it
+        #   starts `running`. It can stay empty if the dream fails or is canceled before
+        #   then. The memory store holds the complete result only once `status` is
+        #   `completed`.
+        #
+        #   See the
+        #   [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#use-the-output)
+        #   for how to review and use the result.
         #
         #   @return [Array<Anthropic::Models::Beta::BetaDreamOutput>]
         required :outputs, -> { Anthropic::Internal::Type::ArrayOf[Anthropic::Beta::BetaDreamOutput] }
 
         # @!attribute session_id
+        #   The ID of the session that runs the dream (`sesn_...`), or `null` if that
+        #   session hasn't started.
+        #
+        #   Stream that session's events to follow what the dream reads and writes.
+        #
+        #   See the
+        #   [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#watch-the-pipeline-run)
+        #   for how to watch a running dream.
         #
         #   @return [String, nil]
         required :session_id, String, nil?: true
 
         # @!attribute status
-        #   Lifecycle status of a Dream.
+        #   Where a dream is in its lifecycle.
+        #
+        #   `completed`, `failed`, and `canceled` are final: once a dream has one of these
+        #   statuses, its status doesn't change again.
+        #
+        #   See the
+        #   [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#lifecycle)
+        #   for what each status means.
         #
         #   @return [Symbol, Anthropic::Models::Beta::BetaDreamStatus]
         required :status, enum: -> { Anthropic::Beta::BetaDreamStatus }
@@ -81,49 +115,58 @@ module Anthropic
         required :type, enum: -> { Anthropic::Beta::BetaDream::Type }
 
         # @!attribute usage
-        #   Cumulative token usage for the dream across every pipeline stage.
+        #   The dream's token counts, which stop changing once its `status` is `completed`
+        #   or `failed`. After a cancel, they can keep changing.
         #
         #   @return [Anthropic::Models::Beta::BetaDreamUsage]
         required :usage, -> { Anthropic::Beta::BetaDreamUsage }
 
         # @!method initialize(id:, archived_at:, created_at:, ended_at:, error:, inputs:, instructions:, model:, output_behavior:, outputs:, session_id:, status:, type:, usage:)
-        #   An asynchronous memory-consolidation job that reads a memory store plus a set of
-        #   session transcripts and writes consolidated memories into an output memory store
-        #   — a new store by default, or an existing store chosen via output_behavior. The
-        #   Dreams API is in research preview: the request and response shapes are volatile
-        #   and may change without the deprecation period that applies to
+        #   An asynchronous job that reads a memory store and past sessions, then writes a
+        #   reorganized version of that memory store.
+        #
+        #   By default the dream writes its result to a new memory store and doesn't change
+        #   the input memory store. With `output_behavior` set to `update_existing`, it
+        #   writes its result into the input memory store instead.
+        #
+        #   The Dreams API is in research preview: the request and response shapes are
+        #   volatile and may change without the deprecation period that applies to
         #   generally-available endpoints.
         #
+        #   See the
+        #   [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#how-it-works)
+        #   for what a dream reads and produces.
+        #
         #   Some parameter documentations has been truncated, see
         #   {Anthropic::Models::Beta::BetaDream} for more details.
         #
-        #   @param id [String]
+        #   @param id [String] The unique ID of the dream (`drm_...`).
         #
-        #   @param archived_at [Time, nil] A timestamp in RFC 3339 format
+        #   @param archived_at [Time, nil] When the dream was archived, in RFC 3339, or `null` if it hasn't been archived.
         #
-        #   @param created_at [Time] A timestamp in RFC 3339 format
+        #   @param created_at [Time] When the dream was created, in RFC 3339.
         #
-        #   @param ended_at [Time, nil] A timestamp in RFC 3339 format
+        #   @param ended_at [Time, nil] When the dream reached `completed`, `failed`, or `canceled`, in RFC 3339, or `nu
         #
-        #   @param error [Anthropic::Models::Beta::BetaDreamError, nil] Failure detail for a Dream whose `status` is `failed`.
+        #   @param error [Anthropic::Models::Beta::BetaDreamError, nil] Why the dream failed, or `null` if `status` isn't `failed`.
         #
-        #   @param inputs [Array<Anthropic::Models::Beta::BetaDreamMemoryStoreInput, Anthropic::Models::Beta::BetaDreamSessionsInput>]
+        #   @param inputs [Array<Anthropic::Models::Beta::BetaDreamMemoryStoreInput, Anthropic::Models::Beta::BetaDreamSessionsInput>] The sources that the dream reads, from the request that created it.
         #
-        #   @param instructions [String, nil]
+        #   @param instructions [String, nil] The guidance given when the dream was created, or `null` if none was given.
         #
-        #   @param model [Anthropic::Models::Beta::BetaDreamModelConfig] Model identifier and configuration applied to every pipeline stage. Same wire sh
+        #   @param model [Anthropic::Models::Beta::BetaDreamModelConfig] The model that runs a dream, from the request that created it.
         #
-        #   @param output_behavior [Anthropic::Models::Beta::BetaOutputBehaviorCreateNew, Anthropic::Models::Beta::BetaOutputBehaviorUpdateExisting] The default destination: the job creates a new output memory store as a clone of
+        #   @param output_behavior [Anthropic::Models::Beta::BetaOutputBehaviorCreateNew, Anthropic::Models::Beta::BetaOutputBehaviorUpdateExisting] Where the dream writes its result, as set in the request that created the dream.
         #
-        #   @param outputs [Array<Anthropic::Models::Beta::BetaDreamOutput>]
+        #   @param outputs [Array<Anthropic::Models::Beta::BetaDreamOutput>] The memory store that holds the dream's result, as a one-item array, or an empty
         #
-        #   @param session_id [String, nil]
+        #   @param session_id [String, nil] The ID of the session that runs the dream (`sesn_...`), or `null` if that sessio
         #
-        #   @param status [Symbol, Anthropic::Models::Beta::BetaDreamStatus] Lifecycle status of a Dream.
+        #   @param status [Symbol, Anthropic::Models::Beta::BetaDreamStatus] Where a dream is in its lifecycle.
         #
         #   @param type [Symbol, Anthropic::Models::Beta::BetaDream::Type]
         #
-        #   @param usage [Anthropic::Models::Beta::BetaDreamUsage] Cumulative token usage for the dream across every pipeline stage.
+        #   @param usage [Anthropic::Models::Beta::BetaDreamUsage] The dream's token counts, which stop changing once its `status` is `completed` o
 
         # @see Anthropic::Models::Beta::BetaDream#type
         module Type

data/lib/anthropic/models/beta/beta_dream_error.rb

@@ -5,11 +5,17 @@ module Anthropic
     module Beta
       class BetaDreamError < Anthropic::Internal::Type::BaseModel
         # @!attribute message
+        #   A human-readable explanation of why the dream failed.
         #
         #   @return [String]
         required :message, String
 
         # @!attribute type
+        #   A code for why the dream failed, such as `timeout` or `internal_error`.
+        #
+        #   The
+        #   [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#errors)
+        #   lists common error codes and when they occur.
         #
         #   @return [String]
         required :type, String
@@ -17,8 +23,12 @@ module Anthropic
         # @!method initialize(message:, type:)
         #   Failure detail for a Dream whose `status` is `failed`.
         #
-        #   @param message [String]
-        #   @param type [String]
+        #   Some parameter documentations has been truncated, see
+        #   {Anthropic::Models::Beta::BetaDreamError} for more details.
+        #
+        #   @param message [String] A human-readable explanation of why the dream failed.
+        #
+        #   @param type [String] A code for why the dream failed, such as `timeout` or `internal_error`.
       end
     end
 

data/lib/anthropic/models/beta/beta_dream_input.rb

@@ -3,18 +3,18 @@
 module Anthropic
   module Models
     module Beta
-      # An input memory store the dream reads from. The dream never mutates this store
-      # unless it is also the destination: with output_behavior {type:
-      # "update_existing"} the job consolidates this store in place.
+      # A source that a dream reads, such as a memory store or a set of sessions.
       module BetaDreamInput
         extend Anthropic::Internal::Type::Union
 
         discriminator :type
 
-        # An input memory store the dream reads from. The dream never mutates this store unless it is also the destination: with output_behavior {type: "update_existing"} the job consolidates this store in place.
+        # The memory store that a dream reads, given as an entry in `inputs`.
+        #
+        # With `output_behavior` set to `update_existing`, the dream writes its result into this memory store. Otherwise the dream doesn't change it.
         variant :memory_store, -> { Anthropic::Beta::BetaDreamMemoryStoreInput }
 
-        # Input session transcripts the dream reads.
+        # The sessions that a dream reads, given as an entry in `inputs`.
         variant :sessions, -> { Anthropic::Beta::BetaDreamSessionsInput }
 
         module Type
@@ -33,13 +33,16 @@ module Anthropic
         # Creates a new instance of the variant class whose `type` matches the given
         # value, passing the remaining arguments to its constructor.
         #
-        # @param type [Symbol, String]
+        # Some parameter documentations has been truncated, see
+        # {Anthropic::Models::Beta::BetaDreamInput} for more details.
+        #
+        # @param type [Symbol, Anthropic::Models::Beta::BetaDreamInput::Type, String]
         #
         # @param args [Hash{Symbol=>Object}] Attributes for the chosen variant.
         #
-        #   @option args [String] :memory_store_id
+        #   @option args [String] :memory_store_id The ID of the memory store for the dream to read (`memstore_...`).
         #
-        #   @option args [Array<String>] :session_ids
+        #   @option args [Array<String>] :session_ids The IDs of the sessions whose transcripts the dream reads (`sesn_...`).
         #
         # @raise [ArgumentError]
         # @return [Anthropic::Models::Beta::BetaDreamMemoryStoreInput, Anthropic::Models::Beta::BetaDreamSessionsInput]

data/lib/anthropic/models/beta/beta_dream_memory_store_input.rb

@@ -5,6 +5,10 @@ module Anthropic
     module Beta
       class BetaDreamMemoryStoreInput < Anthropic::Internal::Type::BaseModel
         # @!attribute memory_store_id
+        #   The ID of the memory store for the dream to read (`memstore_...`).
+        #
+        #   The memory store must be in the same workspace as the dream and must not be
+        #   archived.
         #
         #   @return [String]
         required :memory_store_id, String
@@ -15,11 +19,16 @@ module Anthropic
         required :type, enum: -> { Anthropic::Beta::BetaDreamMemoryStoreInput::Type }
 
         # @!method initialize(memory_store_id:, type:)
-        #   An input memory store the dream reads from. The dream never mutates this store
-        #   unless it is also the destination: with output_behavior {type:
-        #   "update_existing"} the job consolidates this store in place.
+        #   The memory store that a dream reads, given as an entry in `inputs`.
+        #
+        #   With `output_behavior` set to `update_existing`, the dream writes its result
+        #   into this memory store. Otherwise the dream doesn't change it.
+        #
+        #   Some parameter documentations has been truncated, see
+        #   {Anthropic::Models::Beta::BetaDreamMemoryStoreInput} for more details.
+        #
+        #   @param memory_store_id [String] The ID of the memory store for the dream to read (`memstore_...`).
         #
-        #   @param memory_store_id [String]
         #   @param type [Symbol, Anthropic::Models::Beta::BetaDreamMemoryStoreInput::Type]
 
         # @see Anthropic::Models::Beta::BetaDreamMemoryStoreInput#type

data/lib/anthropic/models/beta/beta_dream_memory_store_output.rb

@@ -5,6 +5,10 @@ module Anthropic
     module Beta
       class BetaDreamMemoryStoreOutput < Anthropic::Internal::Type::BaseModel
         # @!attribute memory_store_id
+        #   The ID of the memory store that the dream writes its result to (`memstore_...`).
+        #
+        #   With `output_behavior` set to `create_new`, this is a new memory store. With
+        #   `update_existing`, it is the input memory store.
         #
         #   @return [String]
         required :memory_store_id, String
@@ -15,9 +19,13 @@ module Anthropic
         required :type, enum: -> { Anthropic::Beta::BetaDreamMemoryStoreOutput::Type }
 
         # @!method initialize(memory_store_id:, type:)
-        #   An output memory store the dream writes consolidated memories into.
+        #   The memory store that holds a dream's result, as an entry in `outputs`.
+        #
+        #   Some parameter documentations has been truncated, see
+        #   {Anthropic::Models::Beta::BetaDreamMemoryStoreOutput} for more details.
+        #
+        #   @param memory_store_id [String] The ID of the memory store that the dream writes its result to (`memstore_...`).
         #
-        #   @param memory_store_id [String]
         #   @param type [Symbol, Anthropic::Models::Beta::BetaDreamMemoryStoreOutput::Type]
 
         # @see Anthropic::Models::Beta::BetaDreamMemoryStoreOutput#type

data/lib/anthropic/models/beta/beta_dream_model_config.rb

@@ -5,33 +5,32 @@ module Anthropic
     module Beta
       class BetaDreamModelConfig < Anthropic::Internal::Type::BaseModel
         # @!attribute id
-        #   Model identifier, e.g. "claude-opus-5". 1-256 characters.
+        #   The ID of the model that runs the dream, as given in the request that created
+        #   it.
         #
         #   @return [String]
         required :id, String
 
         # @!attribute speed
-        #   Inference speed mode. `fast` provides significantly faster output token
-        #   generation at premium pricing. Not all models support `fast`; invalid
-        #   combinations are rejected at create time.
+        #   How fast the model generates output for the dream. Always `standard`.
         #
         #   @return [Symbol, Anthropic::Models::Beta::BetaDreamModelConfig::Speed, nil]
         optional :speed, enum: -> { Anthropic::Beta::BetaDreamModelConfig::Speed }
 
         # @!method initialize(id:, speed: nil)
-        #   Model identifier and configuration applied to every pipeline stage. Same wire
-        #   shape as the Agents API ModelConfig.
+        #   The model that runs a dream, from the request that created it.
+        #
+        #   The dream uses this model for all of its work. The response always gives the
+        #   model as an object, even if the request gave only a model ID.
         #
         #   Some parameter documentations has been truncated, see
         #   {Anthropic::Models::Beta::BetaDreamModelConfig} for more details.
         #
-        #   @param id [String] Model identifier, e.g. "claude-opus-5". 1-256 characters.
+        #   @param id [String] The ID of the model that runs the dream, as given in the request that created it
         #
-        #   @param speed [Symbol, Anthropic::Models::Beta::BetaDreamModelConfig::Speed] Inference speed mode. `fast` provides significantly faster output token generati
+        #   @param speed [Symbol, Anthropic::Models::Beta::BetaDreamModelConfig::Speed] How fast the model generates output for the dream. Always `standard`.
 
-        # Inference speed mode. `fast` provides significantly faster output token
-        # generation at premium pricing. Not all models support `fast`; invalid
-        # combinations are rejected at create time.
+        # How fast the model generates output for the dream. Always `standard`.
         #
         # @see Anthropic::Models::Beta::BetaDreamModelConfig#speed
         module Speed

data/lib/anthropic/models/beta/beta_dream_model_config_param.rb

@@ -5,32 +5,38 @@ module Anthropic
     module Beta
       class BetaDreamModelConfigParam < Anthropic::Internal::Type::BaseModel
         # @!attribute id
-        #   Model identifier, e.g. "claude-opus-5". 1-256 characters.
+        #   The ID of the model to run the dream with.
+        #
+        #   The ID can be 1 to 256 characters long.
+        #
+        #   The
+        #   [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#limits)
+        #   lists the supported models.
         #
         #   @return [String]
         required :id, String
 
         # @!attribute speed
-        #   Inference speed mode. `fast` provides significantly faster output token
-        #   generation at premium pricing. Not all models support `fast`; invalid
-        #   combinations are rejected at create time.
+        #   How fast the model generates output for the dream. Defaults to `standard`.
+        #
+        #   Dreams accept only `standard`.
         #
         #   @return [Symbol, Anthropic::Models::Beta::BetaDreamModelConfigParam::Speed, nil]
         optional :speed, enum: -> { Anthropic::Beta::BetaDreamModelConfigParam::Speed }, nil?: true
 
         # @!method initialize(id:, speed: nil)
-        #   Model identifier and configuration applied to every pipeline stage.
+        #   The object form of `model` in a request to create a dream.
         #
         #   Some parameter documentations has been truncated, see
         #   {Anthropic::Models::Beta::BetaDreamModelConfigParam} for more details.
         #
-        #   @param id [String] Model identifier, e.g. "claude-opus-5". 1-256 characters.
+        #   @param id [String] The ID of the model to run the dream with.
         #
-        #   @param speed [Symbol, Anthropic::Models::Beta::BetaDreamModelConfigParam::Speed, nil] Inference speed mode. `fast` provides significantly faster output token generati
+        #   @param speed [Symbol, Anthropic::Models::Beta::BetaDreamModelConfigParam::Speed, nil] How fast the model generates output for the dream. Defaults to `standard`.
 
-        # Inference speed mode. `fast` provides significantly faster output token
-        # generation at premium pricing. Not all models support `fast`; invalid
-        # combinations are rejected at create time.
+        # How fast the model generates output for the dream. Defaults to `standard`.
+        #
+        # Dreams accept only `standard`.
         #
         # @see Anthropic::Models::Beta::BetaDreamModelConfigParam#speed
         module Speed

data/lib/anthropic/models/beta/beta_dream_output.rb

@@ -5,6 +5,10 @@ module Anthropic
     module Beta
       class BetaDreamOutput < Anthropic::Internal::Type::BaseModel
         # @!attribute memory_store_id
+        #   The ID of the memory store that the dream writes its result to (`memstore_...`).
+        #
+        #   With `output_behavior` set to `create_new`, this is a new memory store. With
+        #   `update_existing`, it is the input memory store.
         #
         #   @return [String]
         required :memory_store_id, String
@@ -15,9 +19,14 @@ module Anthropic
         required :type, enum: -> { Anthropic::Beta::BetaDreamOutput::Type }
 
         # @!method initialize(memory_store_id:, type:)
-        #   An output memory store the dream writes consolidated memories into.
+        #   An entry in a dream's `outputs` that references the memory store holding its
+        #   result.
+        #
+        #   Some parameter documentations has been truncated, see
+        #   {Anthropic::Models::Beta::BetaDreamOutput} for more details.
+        #
+        #   @param memory_store_id [String] The ID of the memory store that the dream writes its result to (`memstore_...`).
         #
-        #   @param memory_store_id [String]
         #   @param type [Symbol, Anthropic::Models::Beta::BetaDreamOutput::Type]
 
         # @see Anthropic::Models::Beta::BetaDreamOutput#type

data/lib/anthropic/models/beta/beta_dream_sessions_input.rb

@@ -5,6 +5,14 @@ module Anthropic
     module Beta
       class BetaDreamSessionsInput < Anthropic::Internal::Type::BaseModel
         # @!attribute session_ids
+        #   The IDs of the sessions whose transcripts the dream reads (`sesn_...`).
+        #
+        #   Give 1 to 100 IDs, with no duplicates. Each session must be in the same
+        #   workspace as the dream. Responses list the IDs in sorted order.
+        #
+        #   The
+        #   [limits table in the Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#limits)
+        #   lists all the limits on a dream.
         #
         #   @return [Array<String>]
         required :session_ids, Anthropic::Internal::Type::ArrayOf[String]
@@ -15,9 +23,13 @@ module Anthropic
         required :type, enum: -> { Anthropic::Beta::BetaDreamSessionsInput::Type }
 
         # @!method initialize(session_ids:, type:)
-        #   Input session transcripts the dream reads.
+        #   The sessions that a dream reads, given as an entry in `inputs`.
+        #
+        #   Some parameter documentations has been truncated, see
+        #   {Anthropic::Models::Beta::BetaDreamSessionsInput} for more details.
+        #
+        #   @param session_ids [Array<String>] The IDs of the sessions whose transcripts the dream reads (`sesn_...`).
         #
-        #   @param session_ids [Array<String>]
         #   @param type [Symbol, Anthropic::Models::Beta::BetaDreamSessionsInput::Type]
 
         # @see Anthropic::Models::Beta::BetaDreamSessionsInput#type

data/lib/anthropic/models/beta/beta_dream_status.rb

@@ -3,14 +3,38 @@
 module Anthropic
   module Models
     module Beta
-      # Lifecycle status of a Dream.
+      # Where a dream is in its lifecycle.
+      #
+      # `completed`, `failed`, and `canceled` are final: once a dream has one of these
+      # statuses, its status doesn't change again.
+      #
+      # See the
+      # [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#lifecycle)
+      # for what each status means.
       module BetaDreamStatus
         extend Anthropic::Internal::Type::Enum
 
+        # The dream is waiting to start and hasn't read its inputs yet.
+        #
+        # `outputs` is empty and every `usage` count is zero.
         PENDING = :pending
+
+        # The dream is reading its inputs and writing its result.
+        #
+        # `usage` updates while the dream has this status.
         RUNNING = :running
+
+        # The dream finished and its output memory store holds the complete result.
         COMPLETED = :completed
+
+        # The dream stopped with an error, which `error` describes.
+        #
+        # If `outputs` references a memory store, that memory store keeps what the dream wrote before it stopped.
         FAILED = :failed
+
+        # A cancel request stopped the dream before it reached `completed` or `failed`.
+        #
+        # If `outputs` references a memory store, that memory store keeps what the dream wrote. `usage` can keep changing after the cancel.
         CANCELED = :canceled
 
         # @!method self.values

data/lib/anthropic/models/beta/beta_dream_usage.rb

@@ -5,39 +5,52 @@ module Anthropic
     module Beta
       class BetaDreamUsage < Anthropic::Internal::Type::BaseModel
         # @!attribute cache_creation_input_tokens
-        #   Total tokens used to create prompt-cache entries (sum of all TTL tiers).
+        #   The dream's input tokens that were written to the prompt cache, for both the
+        #   5-minute and 1-hour cache durations.
         #
         #   @return [Integer]
         required :cache_creation_input_tokens, Integer
 
         # @!attribute cache_read_input_tokens
-        #   Total tokens read from prompt cache.
+        #   The dream's input tokens that were read from the prompt cache.
         #
         #   @return [Integer]
         required :cache_read_input_tokens, Integer
 
         # @!attribute input_tokens
-        #   Total uncached input tokens consumed across every pipeline stage.
+        #   The dream's input tokens that weren't read from or written to the prompt cache.
         #
         #   @return [Integer]
         required :input_tokens, Integer
 
         # @!attribute output_tokens
-        #   Total output tokens generated across every pipeline stage.
+        #   The tokens that the model generated for the dream.
         #
         #   @return [Integer]
         required :output_tokens, Integer
 
         # @!method initialize(cache_creation_input_tokens:, cache_read_input_tokens:, input_tokens:, output_tokens:)
-        #   Cumulative token usage for the dream across every pipeline stage.
+        #   The tokens that a dream has used so far.
         #
-        #   @param cache_creation_input_tokens [Integer] Total tokens used to create prompt-cache entries (sum of all TTL tiers).
+        #   The counts are zero while the dream is `pending` and update while it is
+        #   `running`. They can keep changing after a cancel.
         #
-        #   @param cache_read_input_tokens [Integer] Total tokens read from prompt cache.
+        #   See the
+        #   [Dreams guide](https://platform.claude.com/docs/en/managed-agents/dreams#billing)
+        #   for how dreams are billed. See the
+        #   [prompt caching guide](https://platform.claude.com/docs/en/build-with-claude/prompt-caching#tracking-cache-performance)
+        #   for how the input token counts add up.
         #
-        #   @param input_tokens [Integer] Total uncached input tokens consumed across every pipeline stage.
+        #   Some parameter documentations has been truncated, see
+        #   {Anthropic::Models::Beta::BetaDreamUsage} for more details.
         #
-        #   @param output_tokens [Integer] Total output tokens generated across every pipeline stage.
+        #   @param cache_creation_input_tokens [Integer] The dream's input tokens that were written to the prompt cache, for both the 5-m
+        #
+        #   @param cache_read_input_tokens [Integer] The dream's input tokens that were read from the prompt cache.
+        #
+        #   @param input_tokens [Integer] The dream's input tokens that weren't read from or written to the prompt cache.
+        #
+        #   @param output_tokens [Integer] The tokens that the model generated for the dream.
       end
     end
 

data/lib/anthropic/models/beta/beta_dreaming_error.rb

@@ -3,13 +3,6 @@
 module Anthropic
   module Models
     module Beta
-      # The `output_behavior.memory_store_id` target is still held by a prior
-      # `{type: "update_existing"}` dream — one that is `pending` or `running`, or was
-      # canceled with its final writes still landing. Rarely the named dream has just
-      # finished (`completed`/`failed`) and its execution is still closing; an immediate
-      # retry then almost always succeeds. The message names the holding dream when the
-      # server can identify it (rarely omitted); poll it to a terminal state or cancel
-      # it, then retry. Carried with `x-should-retry: false`.
       module BetaDreamingError
         extend Anthropic::Internal::Type::Union
 
@@ -33,7 +26,9 @@ module Anthropic
 
         variant :overloaded_error, -> { Anthropic::BetaOverloadedError }
 
-        # The `output_behavior.memory_store_id` target is still held by a prior `{type: "update_existing"}` dream — one that is `pending` or `running`, or was canceled with its final writes still landing. Rarely the named dream has just finished (`completed`/`failed`) and its execution is still closing; an immediate retry then almost always succeeds. The message names the holding dream when the server can identify it (rarely omitted); poll it to a terminal state or cancel it, then retry. Carried with `x-should-retry: false`.
+        # Returned with status 409 when a request to create a dream sets `output_behavior` to `update_existing` and another dream that writes into the same memory store hasn't fully stopped.
+        #
+        # The other dream is `pending` or `running`, or it has just stopped and is still finishing its last writes. `message` gives the ID of the other dream when the server can identify it. If that dream has already reached `completed`, `failed`, or `canceled`, retry after a short wait. Otherwise, wait for the other dream to end or cancel it, then retry. The response sets the `x-should-retry` header to `false`.
         variant :conflict_error, -> { Anthropic::Beta::BetaTargetStoreHeldError }
 
         module Type
@@ -63,11 +58,11 @@ module Anthropic
         # Some parameter documentations has been truncated, see
         # {Anthropic::Models::Beta::BetaDreamingError} for more details.
         #
-        # @param type [Symbol, String]
+        # @param type [Symbol, Anthropic::Models::Beta::BetaDreamingError::Type, String]
         #
         # @param args [Hash{Symbol=>Object}] Attributes for the chosen variant.
         #
-        #   @option args [String] :message Human-readable description of the conflict, naming the dream that holds the targ
+        #   @option args [String] :message A human-readable explanation of why the memory store can't be used yet, with the
         #
         # @raise [ArgumentError]
         # @return [Anthropic::Models::BetaInvalidRequestError, Anthropic::Models::BetaAuthenticationError, Anthropic::Models::BetaBillingError, Anthropic::Models::BetaPermissionError, Anthropic::Models::BetaNotFoundError, Anthropic::Models::BetaRateLimitError, Anthropic::Models::BetaGatewayTimeoutError, Anthropic::Models::BetaAPIError, Anthropic::Models::BetaOverloadedError, Anthropic::Models::Beta::BetaTargetStoreHeldError]