anthropic 0.4.0 → 1.0.0

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Beta
+      class BetaToolComputerUse20250124 < Anthropic::Internal::Type::BaseModel
+        # @!attribute display_height_px
+        #   The height of the display in pixels.
+        #
+        #   @return [Integer]
+        required :display_height_px, Integer
+
+        # @!attribute display_width_px
+        #   The width of the display in pixels.
+        #
+        #   @return [Integer]
+        required :display_width_px, Integer
+
+        # @!attribute name
+        #   Name of the tool.
+        #
+        #   This is how the tool will be called by the model and in `tool_use` blocks.
+        #
+        #   @return [Symbol, :computer]
+        required :name, const: :computer
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :computer_20250124]
+        required :type, const: :computer_20250124
+
+        # @!attribute cache_control
+        #   Create a cache control breakpoint at this content block.
+        #
+        #   @return [Anthropic::Beta::BetaCacheControlEphemeral, nil]
+        optional :cache_control, -> { Anthropic::Beta::BetaCacheControlEphemeral }, nil?: true
+
+        # @!attribute display_number
+        #   The X11 display number (e.g. 0, 1) for the display.
+        #
+        #   @return [Integer, nil]
+        optional :display_number, Integer, nil?: true
+
+        # @!method initialize(display_height_px:, display_width_px:, cache_control: nil, display_number: nil, name: :computer, type: :computer_20250124)
+        #   Some parameter documentations has been truncated, see
+        #   {Anthropic::Beta::BetaToolComputerUse20250124} for more details.
+        #
+        #   @param display_height_px [Integer] The height of the display in pixels.
+        #
+        #   @param display_width_px [Integer] The width of the display in pixels.
+        #
+        #   @param cache_control [Anthropic::Beta::BetaCacheControlEphemeral, nil] Create a cache control breakpoint at this content block.
+        #
+        #   @param display_number [Integer, nil] The X11 display number (e.g. 0, 1) for the display.
+        #
+        #   @param name [Symbol, :computer] Name of the tool.
+        #
+        #   @param type [Symbol, :computer_20250124]
+      end
+    end
+
+    BetaToolComputerUse20250124 = Beta::BetaToolComputerUse20250124
+  end
+end

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Beta
+      class BetaToolResultBlockParam < Anthropic::Internal::Type::BaseModel
+        # @!attribute tool_use_id
+        #
+        #   @return [String]
+        required :tool_use_id, String
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :tool_result]
+        required :type, const: :tool_result
+
+        # @!attribute cache_control
+        #   Create a cache control breakpoint at this content block.
+        #
+        #   @return [Anthropic::Beta::BetaCacheControlEphemeral, nil]
+        optional :cache_control, -> { Anthropic::Beta::BetaCacheControlEphemeral }, nil?: true
+
+        # @!attribute content
+        #
+        #   @return [String, Array<Anthropic::Beta::BetaTextBlockParam, Anthropic::Beta::BetaImageBlockParam>, nil]
+        optional :content, union: -> { Anthropic::Beta::BetaToolResultBlockParam::Content }
+
+        # @!attribute is_error
+        #
+        #   @return [Boolean, nil]
+        optional :is_error, Anthropic::Internal::Type::Boolean
+
+        # @!method initialize(tool_use_id:, cache_control: nil, content: nil, is_error: nil, type: :tool_result)
+        #   @param tool_use_id [String]
+        #
+        #   @param cache_control [Anthropic::Beta::BetaCacheControlEphemeral, nil] Create a cache control breakpoint at this content block.
+        #
+        #   @param content [String, Array<Anthropic::Beta::BetaTextBlockParam, Anthropic::Beta::BetaImageBlockParam>]
+        #
+        #   @param is_error [Boolean]
+        #
+        #   @param type [Symbol, :tool_result]
+
+        # @see Anthropic::Beta::BetaToolResultBlockParam#content
+        module Content
+          extend Anthropic::Internal::Type::Union
+
+          variant String
+
+          variant -> { Anthropic::Beta::BetaToolResultBlockParam::Content::ContentArray }
+
+          module Content
+            extend Anthropic::Internal::Type::Union
+
+            discriminator :type
+
+            variant :text, -> { Anthropic::Beta::BetaTextBlockParam }
+
+            variant :image, -> { Anthropic::Beta::BetaImageBlockParam }
+
+            # @!method self.variants
+            #   @return [Array(Anthropic::Beta::BetaTextBlockParam, Anthropic::Beta::BetaImageBlockParam)]
+          end
+
+          # @!method self.variants
+          #   @return [Array(String, Array<Anthropic::Beta::BetaTextBlockParam, Anthropic::Beta::BetaImageBlockParam>)]
+
+          # @type [Anthropic::Internal::Type::Converter]
+          ContentArray =
+            Anthropic::Internal::Type::ArrayOf[union: -> {
+              Anthropic::Beta::BetaToolResultBlockParam::Content::Content
+            }]
+        end
+      end
+    end
+
+    BetaToolResultBlockParam = Beta::BetaToolResultBlockParam
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Beta
+      class BetaToolTextEditor20241022 < Anthropic::Internal::Type::BaseModel
+        # @!attribute name
+        #   Name of the tool.
+        #
+        #   This is how the tool will be called by the model and in `tool_use` blocks.
+        #
+        #   @return [Symbol, :str_replace_editor]
+        required :name, const: :str_replace_editor
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :text_editor_20241022]
+        required :type, const: :text_editor_20241022
+
+        # @!attribute cache_control
+        #   Create a cache control breakpoint at this content block.
+        #
+        #   @return [Anthropic::Beta::BetaCacheControlEphemeral, nil]
+        optional :cache_control, -> { Anthropic::Beta::BetaCacheControlEphemeral }, nil?: true
+
+        # @!method initialize(cache_control: nil, name: :str_replace_editor, type: :text_editor_20241022)
+        #   Some parameter documentations has been truncated, see
+        #   {Anthropic::Beta::BetaToolTextEditor20241022} for more details.
+        #
+        #   @param cache_control [Anthropic::Beta::BetaCacheControlEphemeral, nil] Create a cache control breakpoint at this content block.
+        #
+        #   @param name [Symbol, :str_replace_editor] Name of the tool.
+        #
+        #   @param type [Symbol, :text_editor_20241022]
+      end
+    end
+
+    BetaToolTextEditor20241022 = Beta::BetaToolTextEditor20241022
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Beta
+      class BetaToolTextEditor20250124 < Anthropic::Internal::Type::BaseModel
+        # @!attribute name
+        #   Name of the tool.
+        #
+        #   This is how the tool will be called by the model and in `tool_use` blocks.
+        #
+        #   @return [Symbol, :str_replace_editor]
+        required :name, const: :str_replace_editor
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :text_editor_20250124]
+        required :type, const: :text_editor_20250124
+
+        # @!attribute cache_control
+        #   Create a cache control breakpoint at this content block.
+        #
+        #   @return [Anthropic::Beta::BetaCacheControlEphemeral, nil]
+        optional :cache_control, -> { Anthropic::Beta::BetaCacheControlEphemeral }, nil?: true
+
+        # @!method initialize(cache_control: nil, name: :str_replace_editor, type: :text_editor_20250124)
+        #   Some parameter documentations has been truncated, see
+        #   {Anthropic::Beta::BetaToolTextEditor20250124} for more details.
+        #
+        #   @param cache_control [Anthropic::Beta::BetaCacheControlEphemeral, nil] Create a cache control breakpoint at this content block.
+        #
+        #   @param name [Symbol, :str_replace_editor] Name of the tool.
+        #
+        #   @param type [Symbol, :text_editor_20250124]
+      end
+    end
+
+    BetaToolTextEditor20250124 = Beta::BetaToolTextEditor20250124
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Beta
+      module BetaToolUnion
+        extend Anthropic::Internal::Type::Union
+
+        variant -> { Anthropic::Beta::BetaTool }
+
+        variant -> { Anthropic::Beta::BetaToolComputerUse20241022 }
+
+        variant -> { Anthropic::Beta::BetaToolBash20241022 }
+
+        variant -> { Anthropic::Beta::BetaToolTextEditor20241022 }
+
+        variant -> { Anthropic::Beta::BetaToolComputerUse20250124 }
+
+        variant -> { Anthropic::Beta::BetaToolBash20250124 }
+
+        variant -> { Anthropic::Beta::BetaToolTextEditor20250124 }
+
+        variant -> { Anthropic::Beta::BetaWebSearchTool20250305 }
+
+        # @!method self.variants
+        #   @return [Array(Anthropic::Beta::BetaTool, Anthropic::Beta::BetaToolComputerUse20241022, Anthropic::Beta::BetaToolBash20241022, Anthropic::Beta::BetaToolTextEditor20241022, Anthropic::Beta::BetaToolComputerUse20250124, Anthropic::Beta::BetaToolBash20250124, Anthropic::Beta::BetaToolTextEditor20250124, Anthropic::Beta::BetaWebSearchTool20250305)]
+      end
+    end
+
+    BetaToolUnion = Beta::BetaToolUnion
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Beta
+      class BetaToolUseBlock < Anthropic::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute input
+        #
+        #   @return [Object]
+        required :input, Anthropic::Internal::Type::Unknown
+
+        # @!attribute name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :tool_use]
+        required :type, const: :tool_use
+
+        # @!method initialize(id:, input:, name:, type: :tool_use)
+        #   @param id [String]
+        #   @param input [Object]
+        #   @param name [String]
+        #   @param type [Symbol, :tool_use]
+      end
+    end
+
+    BetaToolUseBlock = Beta::BetaToolUseBlock
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Beta
+      class BetaToolUseBlockParam < Anthropic::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute input
+        #
+        #   @return [Object]
+        required :input, Anthropic::Internal::Type::Unknown
+
+        # @!attribute name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :tool_use]
+        required :type, const: :tool_use
+
+        # @!attribute cache_control
+        #   Create a cache control breakpoint at this content block.
+        #
+        #   @return [Anthropic::Beta::BetaCacheControlEphemeral, nil]
+        optional :cache_control, -> { Anthropic::Beta::BetaCacheControlEphemeral }, nil?: true
+
+        # @!method initialize(id:, input:, name:, cache_control: nil, type: :tool_use)
+        #   @param id [String]
+        #
+        #   @param input [Object]
+        #
+        #   @param name [String]
+        #
+        #   @param cache_control [Anthropic::Beta::BetaCacheControlEphemeral, nil] Create a cache control breakpoint at this content block.
+        #
+        #   @param type [Symbol, :tool_use]
+      end
+    end
+
+    BetaToolUseBlockParam = Beta::BetaToolUseBlockParam
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Beta
+      class BetaURLImageSource < Anthropic::Internal::Type::BaseModel
+        # @!attribute type
+        #
+        #   @return [Symbol, :url]
+        required :type, const: :url
+
+        # @!attribute url
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!method initialize(url:, type: :url)
+        #   @param url [String]
+        #   @param type [Symbol, :url]
+      end
+    end
+
+    BetaURLImageSource = Beta::BetaURLImageSource
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Beta
+      class BetaURLPDFSource < Anthropic::Internal::Type::BaseModel
+        # @!attribute type
+        #
+        #   @return [Symbol, :url]
+        required :type, const: :url
+
+        # @!attribute url
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!method initialize(url:, type: :url)
+        #   @param url [String]
+        #   @param type [Symbol, :url]
+      end
+    end
+
+    BetaURLPDFSource = Beta::BetaURLPDFSource
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Beta
+      class BetaUsage < Anthropic::Internal::Type::BaseModel
+        # @!attribute cache_creation_input_tokens
+        #   The number of input tokens used to create the cache entry.
+        #
+        #   @return [Integer, nil]
+        required :cache_creation_input_tokens, Integer, nil?: true
+
+        # @!attribute cache_read_input_tokens
+        #   The number of input tokens read from the cache.
+        #
+        #   @return [Integer, nil]
+        required :cache_read_input_tokens, Integer, nil?: true
+
+        # @!attribute input_tokens
+        #   The number of input tokens which were used.
+        #
+        #   @return [Integer]
+        required :input_tokens, Integer
+
+        # @!attribute output_tokens
+        #   The number of output tokens which were used.
+        #
+        #   @return [Integer]
+        required :output_tokens, Integer
+
+        # @!attribute server_tool_use
+        #   The number of server tool requests.
+        #
+        #   @return [Anthropic::Beta::BetaServerToolUsage, nil]
+        required :server_tool_use, -> { Anthropic::Beta::BetaServerToolUsage }, nil?: true
+
+        # @!method initialize(cache_creation_input_tokens:, cache_read_input_tokens:, input_tokens:, output_tokens:, server_tool_use:)
+        #   @param cache_creation_input_tokens [Integer, nil] The number of input tokens used to create the cache entry.
+        #
+        #   @param cache_read_input_tokens [Integer, nil] The number of input tokens read from the cache.
+        #
+        #   @param input_tokens [Integer] The number of input tokens which were used.
+        #
+        #   @param output_tokens [Integer] The number of output tokens which were used.
+        #
+        #   @param server_tool_use [Anthropic::Beta::BetaServerToolUsage, nil] The number of server tool requests.
+      end
+    end
+
+    BetaUsage = Beta::BetaUsage
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Beta
+      class BetaWebSearchResultBlock < Anthropic::Internal::Type::BaseModel
+        # @!attribute encrypted_content
+        #
+        #   @return [String]
+        required :encrypted_content, String
+
+        # @!attribute page_age
+        #
+        #   @return [String, nil]
+        required :page_age, String, nil?: true
+
+        # @!attribute title
+        #
+        #   @return [String]
+        required :title, String
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :web_search_result]
+        required :type, const: :web_search_result
+
+        # @!attribute url
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!method initialize(encrypted_content:, page_age:, title:, url:, type: :web_search_result)
+        #   @param encrypted_content [String]
+        #   @param page_age [String, nil]
+        #   @param title [String]
+        #   @param url [String]
+        #   @param type [Symbol, :web_search_result]
+      end
+    end
+
+    BetaWebSearchResultBlock = Beta::BetaWebSearchResultBlock
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Beta
+      class BetaWebSearchResultBlockParam < Anthropic::Internal::Type::BaseModel
+        # @!attribute encrypted_content
+        #
+        #   @return [String]
+        required :encrypted_content, String
+
+        # @!attribute title
+        #
+        #   @return [String]
+        required :title, String
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :web_search_result]
+        required :type, const: :web_search_result
+
+        # @!attribute url
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!attribute page_age
+        #
+        #   @return [String, nil]
+        optional :page_age, String, nil?: true
+
+        # @!method initialize(encrypted_content:, title:, url:, page_age: nil, type: :web_search_result)
+        #   @param encrypted_content [String]
+        #   @param title [String]
+        #   @param url [String]
+        #   @param page_age [String, nil]
+        #   @param type [Symbol, :web_search_result]
+      end
+    end
+
+    BetaWebSearchResultBlockParam = Beta::BetaWebSearchResultBlockParam
+  end
+end

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

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Beta
+      class BetaWebSearchTool20250305 < Anthropic::Internal::Type::BaseModel
+        # @!attribute name
+        #   Name of the tool.
+        #
+        #   This is how the tool will be called by the model and in `tool_use` blocks.
+        #
+        #   @return [Symbol, :web_search]
+        required :name, const: :web_search
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :web_search_20250305]
+        required :type, const: :web_search_20250305
+
+        # @!attribute allowed_domains
+        #   If provided, only these domains will be included in results. Cannot be used
+        #   alongside `blocked_domains`.
+        #
+        #   @return [Array<String>, nil]
+        optional :allowed_domains, Anthropic::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!attribute blocked_domains
+        #   If provided, these domains will never appear in results. Cannot be used
+        #   alongside `allowed_domains`.
+        #
+        #   @return [Array<String>, nil]
+        optional :blocked_domains, Anthropic::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!attribute cache_control
+        #   Create a cache control breakpoint at this content block.
+        #
+        #   @return [Anthropic::Beta::BetaCacheControlEphemeral, nil]
+        optional :cache_control, -> { Anthropic::Beta::BetaCacheControlEphemeral }, nil?: true
+
+        # @!attribute max_uses
+        #   Maximum number of times the tool can be used in the API request.
+        #
+        #   @return [Integer, nil]
+        optional :max_uses, Integer, nil?: true
+
+        # @!attribute user_location
+        #   Parameters for the user's location. Used to provide more relevant search
+        #   results.
+        #
+        #   @return [Anthropic::Beta::BetaWebSearchTool20250305::UserLocation, nil]
+        optional :user_location, -> { Anthropic::Beta::BetaWebSearchTool20250305::UserLocation }, nil?: true
+
+        # @!method initialize(allowed_domains: nil, blocked_domains: nil, cache_control: nil, max_uses: nil, user_location: nil, name: :web_search, type: :web_search_20250305)
+        #   Some parameter documentations has been truncated, see
+        #   {Anthropic::Beta::BetaWebSearchTool20250305} for more details.
+        #
+        #   @param allowed_domains [Array<String>, nil] If provided, only these domains will be included in results. Cannot be used alon
+        #
+        #   @param blocked_domains [Array<String>, nil] If provided, these domains will never appear in results. Cannot be used alongsid
+        #
+        #   @param cache_control [Anthropic::Beta::BetaCacheControlEphemeral, nil] Create a cache control breakpoint at this content block.
+        #
+        #   @param max_uses [Integer, nil] Maximum number of times the tool can be used in the API request.
+        #
+        #   @param user_location [Anthropic::Beta::BetaWebSearchTool20250305::UserLocation, nil] Parameters for the user's location. Used to provide more relevant search results
+        #
+        #   @param name [Symbol, :web_search] Name of the tool.
+        #
+        #   @param type [Symbol, :web_search_20250305]
+
+        # @see Anthropic::Beta::BetaWebSearchTool20250305#user_location
+        class UserLocation < Anthropic::Internal::Type::BaseModel
+          # @!attribute type
+          #
+          #   @return [Symbol, :approximate]
+          required :type, const: :approximate
+
+          # @!attribute city
+          #   The city of the user.
+          #
+          #   @return [String, nil]
+          optional :city, String, nil?: true
+
+          # @!attribute country
+          #   The two letter
+          #   [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the
+          #   user.
+          #
+          #   @return [String, nil]
+          optional :country, String, nil?: true
+
+          # @!attribute region
+          #   The region of the user.
+          #
+          #   @return [String, nil]
+          optional :region, String, nil?: true
+
+          # @!attribute timezone
+          #   The [IANA timezone](https://nodatime.org/TimeZones) of the user.
+          #
+          #   @return [String, nil]
+          optional :timezone, String, nil?: true
+
+          # @!method initialize(city: nil, country: nil, region: nil, timezone: nil, type: :approximate)
+          #   Some parameter documentations has been truncated, see
+          #   {Anthropic::Beta::BetaWebSearchTool20250305::UserLocation} for more details.
+          #
+          #   Parameters for the user's location. Used to provide more relevant search
+          #   results.
+          #
+          #   @param city [String, nil] The city of the user.
+          #
+          #   @param country [String, nil] The two letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha
+          #
+          #   @param region [String, nil] The region of the user.
+          #
+          #   @param timezone [String, nil] The [IANA timezone](https://nodatime.org/TimeZones) of the user.
+          #
+          #   @param type [Symbol, :approximate]
+        end
+      end
+    end
+
+    BetaWebSearchTool20250305 = Beta::BetaWebSearchTool20250305
+  end
+end