anthropic 0.0.0 → 0.1.0.pre.beta.9

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Beta
+      class BetaWebSearchToolRequestError < Anthropic::Internal::Type::BaseModel
+        # @!attribute error_code
+        #
+        #   @return [Symbol, Anthropic::Beta::BetaWebSearchToolRequestError::ErrorCode]
+        required :error_code, enum: -> { Anthropic::Beta::BetaWebSearchToolRequestError::ErrorCode }
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :web_search_tool_result_error]
+        required :type, const: :web_search_tool_result_error
+
+        # @!method initialize(error_code:, type: :web_search_tool_result_error)
+        #   @param error_code [Symbol, Anthropic::Beta::BetaWebSearchToolRequestError::ErrorCode]
+        #   @param type [Symbol, :web_search_tool_result_error]
+
+        # @see Anthropic::Beta::BetaWebSearchToolRequestError#error_code
+        module ErrorCode
+          extend Anthropic::Internal::Type::Enum
+
+          INVALID_TOOL_INPUT = :invalid_tool_input
+          UNAVAILABLE = :unavailable
+          MAX_USES_EXCEEDED = :max_uses_exceeded
+          TOO_MANY_REQUESTS = :too_many_requests
+          QUERY_TOO_LONG = :query_too_long
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+
+    BetaWebSearchToolRequestError = Beta::BetaWebSearchToolRequestError
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Beta
+      class BetaWebSearchToolResultBlock < Anthropic::Internal::Type::BaseModel
+        # @!attribute content
+        #
+        #   @return [Anthropic::Beta::BetaWebSearchToolResultError, Array<Anthropic::Beta::BetaWebSearchResultBlock>]
+        required :content, union: -> { Anthropic::Beta::BetaWebSearchToolResultBlockContent }
+
+        # @!attribute tool_use_id
+        #
+        #   @return [String]
+        required :tool_use_id, String
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :web_search_tool_result]
+        required :type, const: :web_search_tool_result
+
+        # @!method initialize(content:, tool_use_id:, type: :web_search_tool_result)
+        #   @param content [Anthropic::Beta::BetaWebSearchToolResultError, Array<Anthropic::Beta::BetaWebSearchResultBlock>]
+        #   @param tool_use_id [String]
+        #   @param type [Symbol, :web_search_tool_result]
+      end
+    end
+
+    BetaWebSearchToolResultBlock = Beta::BetaWebSearchToolResultBlock
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Beta
+      module BetaWebSearchToolResultBlockContent
+        extend Anthropic::Internal::Type::Union
+
+        variant -> { Anthropic::Beta::BetaWebSearchToolResultError }
+
+        variant -> { Anthropic::Beta::BetaWebSearchToolResultBlockContent::BetaWebSearchResultBlockArray }
+
+        # @!method self.variants
+        #   @return [Array(Anthropic::Beta::BetaWebSearchToolResultError, Array<Anthropic::Beta::BetaWebSearchResultBlock>)]
+
+        # @type [Anthropic::Internal::Type::Converter]
+        BetaWebSearchResultBlockArray =
+          Anthropic::Internal::Type::ArrayOf[-> { Anthropic::Beta::BetaWebSearchResultBlock }]
+      end
+    end
+
+    BetaWebSearchToolResultBlockContent = Beta::BetaWebSearchToolResultBlockContent
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Beta
+      class BetaWebSearchToolResultBlockParam < Anthropic::Internal::Type::BaseModel
+        # @!attribute content
+        #
+        #   @return [Array<Anthropic::Beta::BetaWebSearchResultBlockParam>, Anthropic::Beta::BetaWebSearchToolRequestError]
+        required :content, union: -> { Anthropic::Beta::BetaWebSearchToolResultBlockParamContent }
+
+        # @!attribute tool_use_id
+        #
+        #   @return [String]
+        required :tool_use_id, String
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :web_search_tool_result]
+        required :type, const: :web_search_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
+
+        # @!method initialize(content:, tool_use_id:, cache_control: nil, type: :web_search_tool_result)
+        #   @param content [Array<Anthropic::Beta::BetaWebSearchResultBlockParam>, Anthropic::Beta::BetaWebSearchToolRequestError]
+        #
+        #   @param tool_use_id [String]
+        #
+        #   @param cache_control [Anthropic::Beta::BetaCacheControlEphemeral, nil] Create a cache control breakpoint at this content block.
+        #
+        #   @param type [Symbol, :web_search_tool_result]
+      end
+    end
+
+    BetaWebSearchToolResultBlockParam = Beta::BetaWebSearchToolResultBlockParam
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Beta
+      module BetaWebSearchToolResultBlockParamContent
+        extend Anthropic::Internal::Type::Union
+
+        variant -> {
+          Anthropic::Beta::BetaWebSearchToolResultBlockParamContent::BetaWebSearchResultBlockParamArray
+        }
+
+        variant -> { Anthropic::Beta::BetaWebSearchToolRequestError }
+
+        # @!method self.variants
+        #   @return [Array(Array<Anthropic::Beta::BetaWebSearchResultBlockParam>, Anthropic::Beta::BetaWebSearchToolRequestError)]
+
+        # @type [Anthropic::Internal::Type::Converter]
+        BetaWebSearchResultBlockParamArray =
+          Anthropic::Internal::Type::ArrayOf[-> { Anthropic::Beta::BetaWebSearchResultBlockParam }]
+      end
+    end
+
+    BetaWebSearchToolResultBlockParamContent = Beta::BetaWebSearchToolResultBlockParamContent
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Beta
+      class BetaWebSearchToolResultError < Anthropic::Internal::Type::BaseModel
+        # @!attribute error_code
+        #
+        #   @return [Symbol, Anthropic::Beta::BetaWebSearchToolResultError::ErrorCode]
+        required :error_code, enum: -> { Anthropic::Beta::BetaWebSearchToolResultError::ErrorCode }
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :web_search_tool_result_error]
+        required :type, const: :web_search_tool_result_error
+
+        # @!method initialize(error_code:, type: :web_search_tool_result_error)
+        #   @param error_code [Symbol, Anthropic::Beta::BetaWebSearchToolResultError::ErrorCode]
+        #   @param type [Symbol, :web_search_tool_result_error]
+
+        # @see Anthropic::Beta::BetaWebSearchToolResultError#error_code
+        module ErrorCode
+          extend Anthropic::Internal::Type::Enum
+
+          INVALID_TOOL_INPUT = :invalid_tool_input
+          UNAVAILABLE = :unavailable
+          MAX_USES_EXCEEDED = :max_uses_exceeded
+          TOO_MANY_REQUESTS = :too_many_requests
+          QUERY_TOO_LONG = :query_too_long
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+
+    BetaWebSearchToolResultError = Beta::BetaWebSearchToolResultError
+  end
+end

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

@@ -0,0 +1,292 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Beta
+      # @see Anthropic::Resources::Beta::Messages#count_tokens
+      class MessageCountTokensParams < Anthropic::Internal::Type::BaseModel
+        extend Anthropic::Internal::Type::RequestParameters::Converter
+        include Anthropic::Internal::Type::RequestParameters
+
+        # @!attribute messages
+        #   Input messages.
+        #
+        #   Our models are trained to operate on alternating `user` and `assistant`
+        #   conversational turns. When creating a new `Message`, you specify the prior
+        #   conversational turns with the `messages` parameter, and the model then generates
+        #   the next `Message` in the conversation. Consecutive `user` or `assistant` turns
+        #   in your request will be combined into a single turn.
+        #
+        #   Each input message must be an object with a `role` and `content`. You can
+        #   specify a single `user`-role message, or you can include multiple `user` and
+        #   `assistant` messages.
+        #
+        #   If the final message uses the `assistant` role, the response content will
+        #   continue immediately from the content in that message. This can be used to
+        #   constrain part of the model's response.
+        #
+        #   Example with a single `user` message:
+        #
+        #   ```json
+        #   [{ "role": "user", "content": "Hello, Claude" }]
+        #   ```
+        #
+        #   Example with multiple conversational turns:
+        #
+        #   ```json
+        #   [
+        #     { "role": "user", "content": "Hello there." },
+        #     { "role": "assistant", "content": "Hi, I'm Claude. How can I help you?" },
+        #     { "role": "user", "content": "Can you explain LLMs in plain English?" }
+        #   ]
+        #   ```
+        #
+        #   Example with a partially-filled response from Claude:
+        #
+        #   ```json
+        #   [
+        #     {
+        #       "role": "user",
+        #       "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"
+        #     },
+        #     { "role": "assistant", "content": "The best answer is (" }
+        #   ]
+        #   ```
+        #
+        #   Each input message `content` may be either a single `string` or an array of
+        #   content blocks, where each block has a specific `type`. Using a `string` for
+        #   `content` is shorthand for an array of one content block of type `"text"`. The
+        #   following input messages are equivalent:
+        #
+        #   ```json
+        #   { "role": "user", "content": "Hello, Claude" }
+        #   ```
+        #
+        #   ```json
+        #   { "role": "user", "content": [{ "type": "text", "text": "Hello, Claude" }] }
+        #   ```
+        #
+        #   Starting with Claude 3 models, you can also send image content blocks:
+        #
+        #   ```json
+        #   {
+        #     "role": "user",
+        #     "content": [
+        #       {
+        #         "type": "image",
+        #         "source": {
+        #           "type": "base64",
+        #           "media_type": "image/jpeg",
+        #           "data": "/9j/4AAQSkZJRg..."
+        #         }
+        #       },
+        #       { "type": "text", "text": "What is in this image?" }
+        #     ]
+        #   }
+        #   ```
+        #
+        #   We currently support the `base64` source type for images, and the `image/jpeg`,
+        #   `image/png`, `image/gif`, and `image/webp` media types.
+        #
+        #   See [examples](https://docs.anthropic.com/en/api/messages-examples#vision) for
+        #   more input examples.
+        #
+        #   Note that if you want to include a
+        #   [system prompt](https://docs.anthropic.com/en/docs/system-prompts), you can use
+        #   the top-level `system` parameter — there is no `"system"` role for input
+        #   messages in the Messages API.
+        #
+        #   There is a limit of 100000 messages in a single request.
+        #
+        #   @return [Array<Anthropic::Beta::BetaMessageParam>]
+        required :messages, -> { Anthropic::Internal::Type::ArrayOf[Anthropic::Beta::BetaMessageParam] }
+
+        # @!attribute model
+        #   The model that will complete your prompt.\n\nSee
+        #   [models](https://docs.anthropic.com/en/docs/models-overview) for additional
+        #   details and options.
+        #
+        #   @return [Symbol, String, Anthropic::Model]
+        required :model, union: -> { Anthropic::Model }
+
+        # @!attribute system_
+        #   System prompt.
+        #
+        #   A system prompt is a way of providing context and instructions to Claude, such
+        #   as specifying a particular goal or role. See our
+        #   [guide to system prompts](https://docs.anthropic.com/en/docs/system-prompts).
+        #
+        #   @return [String, Array<Anthropic::Beta::BetaTextBlockParam>, nil]
+        optional :system_, union: -> { Anthropic::Beta::MessageCountTokensParams::System }, api_name: :system
+
+        # @!attribute thinking
+        #   Configuration for enabling Claude's extended thinking.
+        #
+        #   When enabled, responses include `thinking` content blocks showing Claude's
+        #   thinking process before the final answer. Requires a minimum budget of 1,024
+        #   tokens and counts towards your `max_tokens` limit.
+        #
+        #   See
+        #   [extended thinking](https://docs.anthropic.com/en/docs/build-with-claude/extended-thinking)
+        #   for details.
+        #
+        #   @return [Anthropic::Beta::BetaThinkingConfigEnabled, Anthropic::Beta::BetaThinkingConfigDisabled, nil]
+        optional :thinking, union: -> { Anthropic::Beta::BetaThinkingConfigParam }
+
+        # @!attribute tool_choice
+        #   How the model should use the provided tools. The model can use a specific tool,
+        #   any available tool, decide by itself, or not use tools at all.
+        #
+        #   @return [Anthropic::Beta::BetaToolChoiceAuto, Anthropic::Beta::BetaToolChoiceAny, Anthropic::Beta::BetaToolChoiceTool, Anthropic::Beta::BetaToolChoiceNone, nil]
+        optional :tool_choice, union: -> { Anthropic::Beta::BetaToolChoice }
+
+        # @!attribute tools
+        #   Definitions of tools that the model may use.
+        #
+        #   If you include `tools` in your API request, the model may return `tool_use`
+        #   content blocks that represent the model's use of those tools. You can then run
+        #   those tools using the tool input generated by the model and then optionally
+        #   return results back to the model using `tool_result` content blocks.
+        #
+        #   Each tool definition includes:
+        #
+        #   - `name`: Name of the tool.
+        #   - `description`: Optional, but strongly-recommended description of the tool.
+        #   - `input_schema`: [JSON schema](https://json-schema.org/draft/2020-12) for the
+        #     tool `input` shape that the model will produce in `tool_use` output content
+        #     blocks.
+        #
+        #   For example, if you defined `tools` as:
+        #
+        #   ```json
+        #   [
+        #     {
+        #       "name": "get_stock_price",
+        #       "description": "Get the current stock price for a given ticker symbol.",
+        #       "input_schema": {
+        #         "type": "object",
+        #         "properties": {
+        #           "ticker": {
+        #             "type": "string",
+        #             "description": "The stock ticker symbol, e.g. AAPL for Apple Inc."
+        #           }
+        #         },
+        #         "required": ["ticker"]
+        #       }
+        #     }
+        #   ]
+        #   ```
+        #
+        #   And then asked the model "What's the S&P 500 at today?", the model might produce
+        #   `tool_use` content blocks in the response like this:
+        #
+        #   ```json
+        #   [
+        #     {
+        #       "type": "tool_use",
+        #       "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",
+        #       "name": "get_stock_price",
+        #       "input": { "ticker": "^GSPC" }
+        #     }
+        #   ]
+        #   ```
+        #
+        #   You might then run your `get_stock_price` tool with `{"ticker": "^GSPC"}` as an
+        #   input, and return the following back to the model in a subsequent `user`
+        #   message:
+        #
+        #   ```json
+        #   [
+        #     {
+        #       "type": "tool_result",
+        #       "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",
+        #       "content": "259.75 USD"
+        #     }
+        #   ]
+        #   ```
+        #
+        #   Tools can be used for workflows that include running client-side tools and
+        #   functions, or more generally whenever you want the model to produce a particular
+        #   JSON structure of output.
+        #
+        #   See our [guide](https://docs.anthropic.com/en/docs/tool-use) for more details.
+        #
+        #   @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>, nil]
+        optional :tools,
+                 -> {
+                   Anthropic::Internal::Type::ArrayOf[union: Anthropic::Beta::MessageCountTokensParams::Tool]
+                 }
+
+        # @!attribute betas
+        #   Optional header to specify the beta version(s) you want to use.
+        #
+        #   @return [Array<String, Symbol, Anthropic::AnthropicBeta>, nil]
+        optional :betas, -> { Anthropic::Internal::Type::ArrayOf[union: Anthropic::AnthropicBeta] }
+
+        # @!method initialize(messages:, model:, system_: nil, thinking: nil, tool_choice: nil, tools: nil, betas: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Anthropic::Models::Beta::MessageCountTokensParams} for more details.
+        #
+        #   @param messages [Array<Anthropic::Beta::BetaMessageParam>] Input messages.
+        #
+        #   @param model [Symbol, String, Anthropic::Model] The model that will complete your prompt.\n\nSee [models](https://docs.anthropic
+        #
+        #   @param system_ [String, Array<Anthropic::Beta::BetaTextBlockParam>] System prompt.
+        #
+        #   @param thinking [Anthropic::Beta::BetaThinkingConfigEnabled, Anthropic::Beta::BetaThinkingConfigDisabled] Configuration for enabling Claude's extended thinking.
+        #
+        #   @param tool_choice [Anthropic::Beta::BetaToolChoiceAuto, Anthropic::Beta::BetaToolChoiceAny, Anthropic::Beta::BetaToolChoiceTool, Anthropic::Beta::BetaToolChoiceNone] How the model should use the provided tools. The model can use a specific tool,
+        #
+        #   @param tools [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>] Definitions of tools that the model may use.
+        #
+        #   @param betas [Array<String, Symbol, Anthropic::AnthropicBeta>] Optional header to specify the beta version(s) you want to use.
+        #
+        #   @param request_options [Anthropic::RequestOptions, Hash{Symbol=>Object}]
+
+        # System prompt.
+        #
+        # A system prompt is a way of providing context and instructions to Claude, such
+        # as specifying a particular goal or role. See our
+        # [guide to system prompts](https://docs.anthropic.com/en/docs/system-prompts).
+        module System
+          extend Anthropic::Internal::Type::Union
+
+          variant String
+
+          variant -> { Anthropic::Beta::MessageCountTokensParams::System::BetaTextBlockParamArray }
+
+          # @!method self.variants
+          #   @return [Array(String, Array<Anthropic::Beta::BetaTextBlockParam>)]
+
+          # @type [Anthropic::Internal::Type::Converter]
+          BetaTextBlockParamArray = Anthropic::Internal::Type::ArrayOf[-> {
+            Anthropic::Beta::BetaTextBlockParam
+          }]
+        end
+
+        module Tool
+          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
+    end
+  end
+end