anthropic 0.4.1 → 1.0.0

data/rbi/anthropic/models/web_search_tool_20250305.rbi

@@ -0,0 +1,181 @@
+# typed: strong
+
+module Anthropic
+  module Models
+    class WebSearchTool20250305 < Anthropic::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Anthropic::WebSearchTool20250305, Anthropic::Internal::AnyHash)
+        end
+
+      # Name of the tool.
+      #
+      # This is how the tool will be called by the model and in `tool_use` blocks.
+      sig { returns(Symbol) }
+      attr_accessor :name
+
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      # If provided, only these domains will be included in results. Cannot be used
+      # alongside `blocked_domains`.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :allowed_domains
+
+      # If provided, these domains will never appear in results. Cannot be used
+      # alongside `allowed_domains`.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :blocked_domains
+
+      # Create a cache control breakpoint at this content block.
+      sig { returns(T.nilable(Anthropic::CacheControlEphemeral)) }
+      attr_reader :cache_control
+
+      sig do
+        params(
+          cache_control: T.nilable(Anthropic::CacheControlEphemeral::OrHash)
+        ).void
+      end
+      attr_writer :cache_control
+
+      # Maximum number of times the tool can be used in the API request.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :max_uses
+
+      # Parameters for the user's location. Used to provide more relevant search
+      # results.
+      sig { returns(T.nilable(Anthropic::WebSearchTool20250305::UserLocation)) }
+      attr_reader :user_location
+
+      sig do
+        params(
+          user_location:
+            T.nilable(Anthropic::WebSearchTool20250305::UserLocation::OrHash)
+        ).void
+      end
+      attr_writer :user_location
+
+      sig do
+        params(
+          allowed_domains: T.nilable(T::Array[String]),
+          blocked_domains: T.nilable(T::Array[String]),
+          cache_control: T.nilable(Anthropic::CacheControlEphemeral::OrHash),
+          max_uses: T.nilable(Integer),
+          user_location:
+            T.nilable(Anthropic::WebSearchTool20250305::UserLocation::OrHash),
+          name: Symbol,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # If provided, only these domains will be included in results. Cannot be used
+        # alongside `blocked_domains`.
+        allowed_domains: nil,
+        # If provided, these domains will never appear in results. Cannot be used
+        # alongside `allowed_domains`.
+        blocked_domains: nil,
+        # Create a cache control breakpoint at this content block.
+        cache_control: nil,
+        # Maximum number of times the tool can be used in the API request.
+        max_uses: nil,
+        # Parameters for the user's location. Used to provide more relevant search
+        # results.
+        user_location: nil,
+        # Name of the tool.
+        #
+        # This is how the tool will be called by the model and in `tool_use` blocks.
+        name: :web_search,
+        type: :web_search_20250305
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            name: Symbol,
+            type: Symbol,
+            allowed_domains: T.nilable(T::Array[String]),
+            blocked_domains: T.nilable(T::Array[String]),
+            cache_control: T.nilable(Anthropic::CacheControlEphemeral),
+            max_uses: T.nilable(Integer),
+            user_location:
+              T.nilable(Anthropic::WebSearchTool20250305::UserLocation)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class UserLocation < Anthropic::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Anthropic::WebSearchTool20250305::UserLocation,
+              Anthropic::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The city of the user.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :city
+
+        # The two letter
+        # [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the
+        # user.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :country
+
+        # The region of the user.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :region
+
+        # The [IANA timezone](https://nodatime.org/TimeZones) of the user.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :timezone
+
+        # Parameters for the user's location. Used to provide more relevant search
+        # results.
+        sig do
+          params(
+            city: T.nilable(String),
+            country: T.nilable(String),
+            region: T.nilable(String),
+            timezone: T.nilable(String),
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The city of the user.
+          city: nil,
+          # The two letter
+          # [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the
+          # user.
+          country: nil,
+          # The region of the user.
+          region: nil,
+          # The [IANA timezone](https://nodatime.org/TimeZones) of the user.
+          timezone: nil,
+          type: :approximate
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              type: Symbol,
+              city: T.nilable(String),
+              country: T.nilable(String),
+              region: T.nilable(String),
+              timezone: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/anthropic/models/web_search_tool_request_error.rbi

@@ -0,0 +1,88 @@
+# typed: strong
+
+module Anthropic
+  module Models
+    class WebSearchToolRequestError < Anthropic::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Anthropic::WebSearchToolRequestError,
+            Anthropic::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Anthropic::WebSearchToolRequestError::ErrorCode::OrSymbol) }
+      attr_accessor :error_code
+
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      sig do
+        params(
+          error_code: Anthropic::WebSearchToolRequestError::ErrorCode::OrSymbol,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(error_code:, type: :web_search_tool_result_error)
+      end
+
+      sig do
+        override.returns(
+          {
+            error_code:
+              Anthropic::WebSearchToolRequestError::ErrorCode::OrSymbol,
+            type: Symbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module ErrorCode
+        extend Anthropic::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Anthropic::WebSearchToolRequestError::ErrorCode)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        INVALID_TOOL_INPUT =
+          T.let(
+            :invalid_tool_input,
+            Anthropic::WebSearchToolRequestError::ErrorCode::TaggedSymbol
+          )
+        UNAVAILABLE =
+          T.let(
+            :unavailable,
+            Anthropic::WebSearchToolRequestError::ErrorCode::TaggedSymbol
+          )
+        MAX_USES_EXCEEDED =
+          T.let(
+            :max_uses_exceeded,
+            Anthropic::WebSearchToolRequestError::ErrorCode::TaggedSymbol
+          )
+        TOO_MANY_REQUESTS =
+          T.let(
+            :too_many_requests,
+            Anthropic::WebSearchToolRequestError::ErrorCode::TaggedSymbol
+          )
+        QUERY_TOO_LONG =
+          T.let(
+            :query_too_long,
+            Anthropic::WebSearchToolRequestError::ErrorCode::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Anthropic::WebSearchToolRequestError::ErrorCode::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/anthropic/models/web_search_tool_result_block.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module Anthropic
+  module Models
+    class WebSearchToolResultBlock < Anthropic::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Anthropic::WebSearchToolResultBlock,
+            Anthropic::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Anthropic::WebSearchToolResultBlockContent::Variants) }
+      attr_accessor :content
+
+      sig { returns(String) }
+      attr_accessor :tool_use_id
+
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      sig do
+        params(
+          content:
+            T.any(
+              Anthropic::WebSearchToolResultError::OrHash,
+              T::Array[Anthropic::WebSearchResultBlock::OrHash]
+            ),
+          tool_use_id: String,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(content:, tool_use_id:, type: :web_search_tool_result)
+      end
+
+      sig do
+        override.returns(
+          {
+            content: Anthropic::WebSearchToolResultBlockContent::Variants,
+            tool_use_id: String,
+            type: Symbol
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/anthropic/models/web_search_tool_result_block_content.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module Anthropic
+  module Models
+    module WebSearchToolResultBlockContent
+      extend Anthropic::Internal::Type::Union
+
+      Variants =
+        T.type_alias do
+          T.any(
+            Anthropic::WebSearchToolResultError,
+            T::Array[Anthropic::WebSearchResultBlock]
+          )
+        end
+
+      sig do
+        override.returns(
+          T::Array[Anthropic::WebSearchToolResultBlockContent::Variants]
+        )
+      end
+      def self.variants
+      end
+
+      WebSearchResultBlockArray =
+        T.let(
+          Anthropic::Internal::Type::ArrayOf[Anthropic::WebSearchResultBlock],
+          Anthropic::Internal::Type::Converter
+        )
+    end
+  end
+end

data/rbi/anthropic/models/web_search_tool_result_block_param.rbi

@@ -0,0 +1,80 @@
+# typed: strong
+
+module Anthropic
+  module Models
+    class WebSearchToolResultBlockParam < Anthropic::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Anthropic::WebSearchToolResultBlockParam,
+            Anthropic::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(
+          T.any(
+            T::Array[Anthropic::WebSearchResultBlockParam],
+            Anthropic::WebSearchToolRequestError
+          )
+        )
+      end
+      attr_accessor :content
+
+      sig { returns(String) }
+      attr_accessor :tool_use_id
+
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      # Create a cache control breakpoint at this content block.
+      sig { returns(T.nilable(Anthropic::CacheControlEphemeral)) }
+      attr_reader :cache_control
+
+      sig do
+        params(
+          cache_control: T.nilable(Anthropic::CacheControlEphemeral::OrHash)
+        ).void
+      end
+      attr_writer :cache_control
+
+      sig do
+        params(
+          content:
+            T.any(
+              T::Array[Anthropic::WebSearchResultBlockParam::OrHash],
+              Anthropic::WebSearchToolRequestError::OrHash
+            ),
+          tool_use_id: String,
+          cache_control: T.nilable(Anthropic::CacheControlEphemeral::OrHash),
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        content:,
+        tool_use_id:,
+        # Create a cache control breakpoint at this content block.
+        cache_control: nil,
+        type: :web_search_tool_result
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            content:
+              T.any(
+                T::Array[Anthropic::WebSearchResultBlockParam],
+                Anthropic::WebSearchToolRequestError
+              ),
+            tool_use_id: String,
+            type: Symbol,
+            cache_control: T.nilable(Anthropic::CacheControlEphemeral)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/anthropic/models/web_search_tool_result_block_param_content.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module Anthropic
+  module Models
+    module WebSearchToolResultBlockParamContent
+      extend Anthropic::Internal::Type::Union
+
+      Variants =
+        T.type_alias do
+          T.any(
+            T::Array[Anthropic::WebSearchResultBlockParam],
+            Anthropic::WebSearchToolRequestError
+          )
+        end
+
+      sig do
+        override.returns(
+          T::Array[Anthropic::WebSearchToolResultBlockParamContent::Variants]
+        )
+      end
+      def self.variants
+      end
+
+      WebSearchResultBlockParamArray =
+        T.let(
+          Anthropic::Internal::Type::ArrayOf[
+            Anthropic::WebSearchResultBlockParam
+          ],
+          Anthropic::Internal::Type::Converter
+        )
+    end
+  end
+end

data/rbi/anthropic/models/web_search_tool_result_error.rbi

@@ -0,0 +1,90 @@
+# typed: strong
+
+module Anthropic
+  module Models
+    class WebSearchToolResultError < Anthropic::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Anthropic::WebSearchToolResultError,
+            Anthropic::Internal::AnyHash
+          )
+        end
+
+      sig do
+        returns(Anthropic::WebSearchToolResultError::ErrorCode::TaggedSymbol)
+      end
+      attr_accessor :error_code
+
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      sig do
+        params(
+          error_code: Anthropic::WebSearchToolResultError::ErrorCode::OrSymbol,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(error_code:, type: :web_search_tool_result_error)
+      end
+
+      sig do
+        override.returns(
+          {
+            error_code:
+              Anthropic::WebSearchToolResultError::ErrorCode::TaggedSymbol,
+            type: Symbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module ErrorCode
+        extend Anthropic::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Anthropic::WebSearchToolResultError::ErrorCode)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        INVALID_TOOL_INPUT =
+          T.let(
+            :invalid_tool_input,
+            Anthropic::WebSearchToolResultError::ErrorCode::TaggedSymbol
+          )
+        UNAVAILABLE =
+          T.let(
+            :unavailable,
+            Anthropic::WebSearchToolResultError::ErrorCode::TaggedSymbol
+          )
+        MAX_USES_EXCEEDED =
+          T.let(
+            :max_uses_exceeded,
+            Anthropic::WebSearchToolResultError::ErrorCode::TaggedSymbol
+          )
+        TOO_MANY_REQUESTS =
+          T.let(
+            :too_many_requests,
+            Anthropic::WebSearchToolResultError::ErrorCode::TaggedSymbol
+          )
+        QUERY_TOO_LONG =
+          T.let(
+            :query_too_long,
+            Anthropic::WebSearchToolResultError::ErrorCode::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Anthropic::WebSearchToolResultError::ErrorCode::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end