anthropic 0.0.0 → 0.1.0.pre.beta.9

data/rbi/anthropic/models/beta/beta_message.rbi

@@ -0,0 +1,245 @@
+# typed: strong
+
+module Anthropic
+  module Models
+    BetaMessage = Beta::BetaMessage
+
+    module Beta
+      class BetaMessage < Anthropic::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Anthropic::Beta::BetaMessage, Anthropic::Internal::AnyHash)
+          end
+
+        # Unique object identifier.
+        #
+        # The format and length of IDs may change over time.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Content generated by the model.
+        #
+        # This is an array of content blocks, each of which has a `type` that determines
+        # its shape.
+        #
+        # Example:
+        #
+        # ```json
+        # [{ "type": "text", "text": "Hi, I'm Claude." }]
+        # ```
+        #
+        # If the request input `messages` ended with an `assistant` turn, then the
+        # response `content` will continue directly from that last turn. You can use this
+        # to constrain the model's output.
+        #
+        # For example, if the input `messages` were:
+        #
+        # ```json
+        # [
+        #   {
+        #     "role": "user",
+        #     "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"
+        #   },
+        #   { "role": "assistant", "content": "The best answer is (" }
+        # ]
+        # ```
+        #
+        # Then the response `content` might be:
+        #
+        # ```json
+        # [{ "type": "text", "text": "B)" }]
+        # ```
+        sig { returns(T::Array[Anthropic::Beta::BetaContentBlock::Variants]) }
+        attr_accessor :content
+
+        # The model that will complete your prompt.\n\nSee
+        # [models](https://docs.anthropic.com/en/docs/models-overview) for additional
+        # details and options.
+        sig { returns(Anthropic::Model::Variants) }
+        attr_accessor :model
+
+        # Conversational role of the generated message.
+        #
+        # This will always be `"assistant"`.
+        sig { returns(Symbol) }
+        attr_accessor :role
+
+        # The reason that we stopped.
+        #
+        # This may be one the following values:
+        #
+        # - `"end_turn"`: the model reached a natural stopping point
+        # - `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum
+        # - `"stop_sequence"`: one of your provided custom `stop_sequences` was generated
+        # - `"tool_use"`: the model invoked one or more tools
+        #
+        # In non-streaming mode this value is always non-null. In streaming mode, it is
+        # null in the `message_start` event and non-null otherwise.
+        sig do
+          returns(T.nilable(Anthropic::Beta::BetaStopReason::TaggedSymbol))
+        end
+        attr_accessor :stop_reason
+
+        # Which custom stop sequence was generated, if any.
+        #
+        # This value will be a non-null string if one of your custom stop sequences was
+        # generated.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :stop_sequence
+
+        # Object type.
+        #
+        # For Messages, this is always `"message"`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # Billing and rate-limit usage.
+        #
+        # Anthropic's API bills and rate-limits by token counts, as tokens represent the
+        # underlying cost to our systems.
+        #
+        # Under the hood, the API transforms requests into a format suitable for the
+        # model. The model's output then goes through a parsing stage before becoming an
+        # API response. As a result, the token counts in `usage` will not match one-to-one
+        # with the exact visible content of an API request or response.
+        #
+        # For example, `output_tokens` will be non-zero, even for an empty string response
+        # from Claude.
+        #
+        # Total input tokens in a request is the summation of `input_tokens`,
+        # `cache_creation_input_tokens`, and `cache_read_input_tokens`.
+        sig { returns(Anthropic::Beta::BetaUsage) }
+        attr_reader :usage
+
+        sig { params(usage: Anthropic::Beta::BetaUsage::OrHash).void }
+        attr_writer :usage
+
+        sig do
+          params(
+            id: String,
+            content:
+              T::Array[
+                T.any(
+                  Anthropic::Beta::BetaTextBlock::OrHash,
+                  Anthropic::Beta::BetaToolUseBlock::OrHash,
+                  Anthropic::Beta::BetaServerToolUseBlock::OrHash,
+                  Anthropic::Beta::BetaWebSearchToolResultBlock::OrHash,
+                  Anthropic::Beta::BetaThinkingBlock::OrHash,
+                  Anthropic::Beta::BetaRedactedThinkingBlock::OrHash
+                )
+              ],
+            model: T.any(Anthropic::Model::OrSymbol, String),
+            stop_reason: T.nilable(Anthropic::Beta::BetaStopReason::OrSymbol),
+            stop_sequence: T.nilable(String),
+            usage: Anthropic::Beta::BetaUsage::OrHash,
+            role: Symbol,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Unique object identifier.
+          #
+          # The format and length of IDs may change over time.
+          id:,
+          # Content generated by the model.
+          #
+          # This is an array of content blocks, each of which has a `type` that determines
+          # its shape.
+          #
+          # Example:
+          #
+          # ```json
+          # [{ "type": "text", "text": "Hi, I'm Claude." }]
+          # ```
+          #
+          # If the request input `messages` ended with an `assistant` turn, then the
+          # response `content` will continue directly from that last turn. You can use this
+          # to constrain the model's output.
+          #
+          # For example, if the input `messages` were:
+          #
+          # ```json
+          # [
+          #   {
+          #     "role": "user",
+          #     "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"
+          #   },
+          #   { "role": "assistant", "content": "The best answer is (" }
+          # ]
+          # ```
+          #
+          # Then the response `content` might be:
+          #
+          # ```json
+          # [{ "type": "text", "text": "B)" }]
+          # ```
+          content:,
+          # The model that will complete your prompt.\n\nSee
+          # [models](https://docs.anthropic.com/en/docs/models-overview) for additional
+          # details and options.
+          model:,
+          # The reason that we stopped.
+          #
+          # This may be one the following values:
+          #
+          # - `"end_turn"`: the model reached a natural stopping point
+          # - `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum
+          # - `"stop_sequence"`: one of your provided custom `stop_sequences` was generated
+          # - `"tool_use"`: the model invoked one or more tools
+          #
+          # In non-streaming mode this value is always non-null. In streaming mode, it is
+          # null in the `message_start` event and non-null otherwise.
+          stop_reason:,
+          # Which custom stop sequence was generated, if any.
+          #
+          # This value will be a non-null string if one of your custom stop sequences was
+          # generated.
+          stop_sequence:,
+          # Billing and rate-limit usage.
+          #
+          # Anthropic's API bills and rate-limits by token counts, as tokens represent the
+          # underlying cost to our systems.
+          #
+          # Under the hood, the API transforms requests into a format suitable for the
+          # model. The model's output then goes through a parsing stage before becoming an
+          # API response. As a result, the token counts in `usage` will not match one-to-one
+          # with the exact visible content of an API request or response.
+          #
+          # For example, `output_tokens` will be non-zero, even for an empty string response
+          # from Claude.
+          #
+          # Total input tokens in a request is the summation of `input_tokens`,
+          # `cache_creation_input_tokens`, and `cache_read_input_tokens`.
+          usage:,
+          # Conversational role of the generated message.
+          #
+          # This will always be `"assistant"`.
+          role: :assistant,
+          # Object type.
+          #
+          # For Messages, this is always `"message"`.
+          type: :message
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              content: T::Array[Anthropic::Beta::BetaContentBlock::Variants],
+              model: Anthropic::Model::Variants,
+              role: Symbol,
+              stop_reason:
+                T.nilable(Anthropic::Beta::BetaStopReason::TaggedSymbol),
+              stop_sequence: T.nilable(String),
+              type: Symbol,
+              usage: Anthropic::Beta::BetaUsage
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/anthropic/models/beta/beta_message_delta_usage.rbi

@@ -0,0 +1,85 @@
+# typed: strong
+
+module Anthropic
+  module Models
+    BetaMessageDeltaUsage = Beta::BetaMessageDeltaUsage
+
+    module Beta
+      class BetaMessageDeltaUsage < Anthropic::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Anthropic::Beta::BetaMessageDeltaUsage,
+              Anthropic::Internal::AnyHash
+            )
+          end
+
+        # The cumulative number of input tokens used to create the cache entry.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :cache_creation_input_tokens
+
+        # The cumulative number of input tokens read from the cache.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :cache_read_input_tokens
+
+        # The cumulative number of input tokens which were used.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :input_tokens
+
+        # The cumulative number of output tokens which were used.
+        sig { returns(Integer) }
+        attr_accessor :output_tokens
+
+        # The number of server tool requests.
+        sig { returns(T.nilable(Anthropic::Beta::BetaServerToolUsage)) }
+        attr_reader :server_tool_use
+
+        sig do
+          params(
+            server_tool_use:
+              T.nilable(Anthropic::Beta::BetaServerToolUsage::OrHash)
+          ).void
+        end
+        attr_writer :server_tool_use
+
+        sig do
+          params(
+            cache_creation_input_tokens: T.nilable(Integer),
+            cache_read_input_tokens: T.nilable(Integer),
+            input_tokens: T.nilable(Integer),
+            output_tokens: Integer,
+            server_tool_use:
+              T.nilable(Anthropic::Beta::BetaServerToolUsage::OrHash)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The cumulative number of input tokens used to create the cache entry.
+          cache_creation_input_tokens:,
+          # The cumulative number of input tokens read from the cache.
+          cache_read_input_tokens:,
+          # The cumulative number of input tokens which were used.
+          input_tokens:,
+          # The cumulative number of output tokens which were used.
+          output_tokens:,
+          # The number of server tool requests.
+          server_tool_use:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              cache_creation_input_tokens: T.nilable(Integer),
+              cache_read_input_tokens: T.nilable(Integer),
+              input_tokens: T.nilable(Integer),
+              output_tokens: Integer,
+              server_tool_use: T.nilable(Anthropic::Beta::BetaServerToolUsage)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/anthropic/models/beta/beta_message_param.rbi

@@ -0,0 +1,99 @@
+# typed: strong
+
+module Anthropic
+  module Models
+    BetaMessageParam = Beta::BetaMessageParam
+
+    module Beta
+      class BetaMessageParam < Anthropic::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Anthropic::Beta::BetaMessageParam,
+              Anthropic::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Anthropic::Beta::BetaMessageParam::Content::Variants) }
+        attr_accessor :content
+
+        sig { returns(Anthropic::Beta::BetaMessageParam::Role::OrSymbol) }
+        attr_accessor :role
+
+        sig do
+          params(
+            content: Anthropic::Beta::BetaMessageParam::Content::Variants,
+            role: Anthropic::Beta::BetaMessageParam::Role::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(content:, role:)
+        end
+
+        sig do
+          override.returns(
+            {
+              content: Anthropic::Beta::BetaMessageParam::Content::Variants,
+              role: Anthropic::Beta::BetaMessageParam::Role::OrSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Content
+          extend Anthropic::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                String,
+                T::Array[Anthropic::Beta::BetaContentBlockParam::Variants]
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[Anthropic::Beta::BetaMessageParam::Content::Variants]
+            )
+          end
+          def self.variants
+          end
+
+          BetaContentBlockParamArray =
+            T.let(
+              Anthropic::Internal::Type::ArrayOf[
+                union: Anthropic::Beta::BetaContentBlockParam
+              ],
+              Anthropic::Internal::Type::Converter
+            )
+        end
+
+        module Role
+          extend Anthropic::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Anthropic::Beta::BetaMessageParam::Role)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          USER =
+            T.let(:user, Anthropic::Beta::BetaMessageParam::Role::TaggedSymbol)
+          ASSISTANT =
+            T.let(
+              :assistant,
+              Anthropic::Beta::BetaMessageParam::Role::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[Anthropic::Beta::BetaMessageParam::Role::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/anthropic/models/beta/beta_message_tokens_count.rbi

@@ -0,0 +1,36 @@
+# typed: strong
+
+module Anthropic
+  module Models
+    BetaMessageTokensCount = Beta::BetaMessageTokensCount
+
+    module Beta
+      class BetaMessageTokensCount < Anthropic::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Anthropic::Beta::BetaMessageTokensCount,
+              Anthropic::Internal::AnyHash
+            )
+          end
+
+        # The total number of tokens across the provided list of messages, system prompt,
+        # and tools.
+        sig { returns(Integer) }
+        attr_accessor :input_tokens
+
+        sig { params(input_tokens: Integer).returns(T.attached_class) }
+        def self.new(
+          # The total number of tokens across the provided list of messages, system prompt,
+          # and tools.
+          input_tokens:
+        )
+        end
+
+        sig { override.returns({ input_tokens: Integer }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/anthropic/models/beta/beta_metadata.rbi

@@ -0,0 +1,39 @@
+# typed: strong
+
+module Anthropic
+  module Models
+    BetaMetadata = Beta::BetaMetadata
+
+    module Beta
+      class BetaMetadata < Anthropic::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Anthropic::Beta::BetaMetadata, Anthropic::Internal::AnyHash)
+          end
+
+        # An external identifier for the user who is associated with the request.
+        #
+        # This should be a uuid, hash value, or other opaque identifier. Anthropic may use
+        # this id to help detect abuse. Do not include any identifying information such as
+        # name, email address, or phone number.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :user_id
+
+        sig { params(user_id: T.nilable(String)).returns(T.attached_class) }
+        def self.new(
+          # An external identifier for the user who is associated with the request.
+          #
+          # This should be a uuid, hash value, or other opaque identifier. Anthropic may use
+          # this id to help detect abuse. Do not include any identifying information such as
+          # name, email address, or phone number.
+          user_id: nil
+        )
+        end
+
+        sig { override.returns({ user_id: T.nilable(String) }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/anthropic/models/beta/beta_model_info.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module Anthropic
+  module Models
+    BetaModelInfo = Beta::BetaModelInfo
+
+    module Beta
+      class BetaModelInfo < Anthropic::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Anthropic::Beta::BetaModelInfo, Anthropic::Internal::AnyHash)
+          end
+
+        # Unique model identifier.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # RFC 3339 datetime string representing the time at which the model was released.
+        # May be set to an epoch value if the release date is unknown.
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # A human-readable name for the model.
+        sig { returns(String) }
+        attr_accessor :display_name
+
+        # Object type.
+        #
+        # For Models, this is always `"model"`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        sig do
+          params(
+            id: String,
+            created_at: Time,
+            display_name: String,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Unique model identifier.
+          id:,
+          # RFC 3339 datetime string representing the time at which the model was released.
+          # May be set to an epoch value if the release date is unknown.
+          created_at:,
+          # A human-readable name for the model.
+          display_name:,
+          # Object type.
+          #
+          # For Models, this is always `"model"`.
+          type: :model
+        )
+        end
+
+        sig do
+          override.returns(
+            { id: String, created_at: Time, display_name: String, type: Symbol }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/anthropic/models/beta/beta_plain_text_source.rbi

@@ -0,0 +1,42 @@
+# typed: strong
+
+module Anthropic
+  module Models
+    BetaPlainTextSource = Beta::BetaPlainTextSource
+
+    module Beta
+      class BetaPlainTextSource < Anthropic::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Anthropic::Beta::BetaPlainTextSource,
+              Anthropic::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :data
+
+        sig { returns(Symbol) }
+        attr_accessor :media_type
+
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        sig do
+          params(data: String, media_type: Symbol, type: Symbol).returns(
+            T.attached_class
+          )
+        end
+        def self.new(data:, media_type: :"text/plain", type: :text)
+        end
+
+        sig do
+          override.returns({ data: String, media_type: Symbol, type: Symbol })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/anthropic/models/beta/beta_raw_content_block_delta.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module Anthropic
+  module Models
+    BetaRawContentBlockDelta = Beta::BetaRawContentBlockDelta
+
+    module Beta
+      module BetaRawContentBlockDelta
+        extend Anthropic::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              Anthropic::Beta::BetaTextDelta,
+              Anthropic::Beta::BetaInputJSONDelta,
+              Anthropic::Beta::BetaCitationsDelta,
+              Anthropic::Beta::BetaThinkingDelta,
+              Anthropic::Beta::BetaSignatureDelta
+            )
+          end
+
+        sig do
+          override.returns(
+            T::Array[Anthropic::Beta::BetaRawContentBlockDelta::Variants]
+          )
+        end
+        def self.variants
+        end
+      end
+    end
+  end
+end

data/rbi/anthropic/models/beta/beta_raw_content_block_delta_event.rbi

@@ -0,0 +1,57 @@
+# typed: strong
+
+module Anthropic
+  module Models
+    BetaRawContentBlockDeltaEvent = Beta::BetaRawContentBlockDeltaEvent
+
+    module Beta
+      class BetaRawContentBlockDeltaEvent < Anthropic::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Anthropic::Beta::BetaRawContentBlockDeltaEvent,
+              Anthropic::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Anthropic::Beta::BetaRawContentBlockDelta::Variants) }
+        attr_accessor :delta
+
+        sig { returns(Integer) }
+        attr_accessor :index
+
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        sig do
+          params(
+            delta:
+              T.any(
+                Anthropic::Beta::BetaTextDelta::OrHash,
+                Anthropic::Beta::BetaInputJSONDelta::OrHash,
+                Anthropic::Beta::BetaCitationsDelta::OrHash,
+                Anthropic::Beta::BetaThinkingDelta::OrHash,
+                Anthropic::Beta::BetaSignatureDelta::OrHash
+              ),
+            index: Integer,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(delta:, index:, type: :content_block_delta)
+        end
+
+        sig do
+          override.returns(
+            {
+              delta: Anthropic::Beta::BetaRawContentBlockDelta::Variants,
+              index: Integer,
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end