anthropic 0.4.1 → 1.1.0

data/rbi/anthropic/models/beta/message_count_tokens_params.rbi

@@ -0,0 +1,687 @@
+# typed: strong
+
+module Anthropic
+  module Models
+    module Beta
+      class MessageCountTokensParams < Anthropic::Internal::Type::BaseModel
+        extend Anthropic::Internal::Type::RequestParameters::Converter
+        include Anthropic::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Anthropic::Beta::MessageCountTokensParams,
+              Anthropic::Internal::AnyHash
+            )
+          end
+
+        # 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.
+        sig { returns(T::Array[Anthropic::Beta::BetaMessageParam]) }
+        attr_accessor :messages
+
+        # 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(T.any(Anthropic::Model::OrSymbol, String)) }
+        attr_accessor :model
+
+        # MCP servers to be utilized in this request
+        sig do
+          returns(
+            T.nilable(
+              T::Array[Anthropic::Beta::BetaRequestMCPServerURLDefinition]
+            )
+          )
+        end
+        attr_reader :mcp_servers
+
+        sig do
+          params(
+            mcp_servers:
+              T::Array[
+                Anthropic::Beta::BetaRequestMCPServerURLDefinition::OrHash
+              ]
+          ).void
+        end
+        attr_writer :mcp_servers
+
+        # 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).
+        sig do
+          returns(
+            T.nilable(
+              Anthropic::Beta::MessageCountTokensParams::System::Variants
+            )
+          )
+        end
+        attr_reader :system_
+
+        sig do
+          params(
+            system_: Anthropic::Beta::MessageCountTokensParams::System::Variants
+          ).void
+        end
+        attr_writer :system_
+
+        # 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.
+        sig do
+          returns(
+            T.nilable(
+              T.any(
+                Anthropic::Beta::BetaThinkingConfigEnabled,
+                Anthropic::Beta::BetaThinkingConfigDisabled
+              )
+            )
+          )
+        end
+        attr_reader :thinking
+
+        sig do
+          params(
+            thinking:
+              T.any(
+                Anthropic::Beta::BetaThinkingConfigEnabled::OrHash,
+                Anthropic::Beta::BetaThinkingConfigDisabled::OrHash
+              )
+          ).void
+        end
+        attr_writer :thinking
+
+        # 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.
+        sig do
+          returns(
+            T.nilable(
+              T.any(
+                Anthropic::Beta::BetaToolChoiceAuto,
+                Anthropic::Beta::BetaToolChoiceAny,
+                Anthropic::Beta::BetaToolChoiceTool,
+                Anthropic::Beta::BetaToolChoiceNone
+              )
+            )
+          )
+        end
+        attr_reader :tool_choice
+
+        sig do
+          params(
+            tool_choice:
+              T.any(
+                Anthropic::Beta::BetaToolChoiceAuto::OrHash,
+                Anthropic::Beta::BetaToolChoiceAny::OrHash,
+                Anthropic::Beta::BetaToolChoiceTool::OrHash,
+                Anthropic::Beta::BetaToolChoiceNone::OrHash
+              )
+          ).void
+        end
+        attr_writer :tool_choice
+
+        # 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.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                T.any(
+                  Anthropic::Beta::BetaTool,
+                  Anthropic::Beta::BetaToolComputerUse20241022,
+                  Anthropic::Beta::BetaToolBash20241022,
+                  Anthropic::Beta::BetaToolTextEditor20241022,
+                  Anthropic::Beta::BetaToolComputerUse20250124,
+                  Anthropic::Beta::BetaToolBash20250124,
+                  Anthropic::Beta::BetaToolTextEditor20250124,
+                  Anthropic::Beta::BetaToolTextEditor20250429,
+                  Anthropic::Beta::BetaWebSearchTool20250305,
+                  Anthropic::Beta::BetaCodeExecutionTool20250522
+                )
+              ]
+            )
+          )
+        end
+        attr_reader :tools
+
+        sig do
+          params(
+            tools:
+              T::Array[
+                T.any(
+                  Anthropic::Beta::BetaTool::OrHash,
+                  Anthropic::Beta::BetaToolComputerUse20241022::OrHash,
+                  Anthropic::Beta::BetaToolBash20241022::OrHash,
+                  Anthropic::Beta::BetaToolTextEditor20241022::OrHash,
+                  Anthropic::Beta::BetaToolComputerUse20250124::OrHash,
+                  Anthropic::Beta::BetaToolBash20250124::OrHash,
+                  Anthropic::Beta::BetaToolTextEditor20250124::OrHash,
+                  Anthropic::Beta::BetaToolTextEditor20250429::OrHash,
+                  Anthropic::Beta::BetaWebSearchTool20250305::OrHash,
+                  Anthropic::Beta::BetaCodeExecutionTool20250522::OrHash
+                )
+              ]
+          ).void
+        end
+        attr_writer :tools
+
+        # Optional header to specify the beta version(s) you want to use.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[T.any(String, Anthropic::AnthropicBeta::OrSymbol)]
+            )
+          )
+        end
+        attr_reader :betas
+
+        sig do
+          params(
+            betas: T::Array[T.any(String, Anthropic::AnthropicBeta::OrSymbol)]
+          ).void
+        end
+        attr_writer :betas
+
+        sig do
+          params(
+            messages: T::Array[Anthropic::Beta::BetaMessageParam::OrHash],
+            model: T.any(Anthropic::Model::OrSymbol, String),
+            mcp_servers:
+              T::Array[
+                Anthropic::Beta::BetaRequestMCPServerURLDefinition::OrHash
+              ],
+            system_:
+              Anthropic::Beta::MessageCountTokensParams::System::Variants,
+            thinking:
+              T.any(
+                Anthropic::Beta::BetaThinkingConfigEnabled::OrHash,
+                Anthropic::Beta::BetaThinkingConfigDisabled::OrHash
+              ),
+            tool_choice:
+              T.any(
+                Anthropic::Beta::BetaToolChoiceAuto::OrHash,
+                Anthropic::Beta::BetaToolChoiceAny::OrHash,
+                Anthropic::Beta::BetaToolChoiceTool::OrHash,
+                Anthropic::Beta::BetaToolChoiceNone::OrHash
+              ),
+            tools:
+              T::Array[
+                T.any(
+                  Anthropic::Beta::BetaTool::OrHash,
+                  Anthropic::Beta::BetaToolComputerUse20241022::OrHash,
+                  Anthropic::Beta::BetaToolBash20241022::OrHash,
+                  Anthropic::Beta::BetaToolTextEditor20241022::OrHash,
+                  Anthropic::Beta::BetaToolComputerUse20250124::OrHash,
+                  Anthropic::Beta::BetaToolBash20250124::OrHash,
+                  Anthropic::Beta::BetaToolTextEditor20250124::OrHash,
+                  Anthropic::Beta::BetaToolTextEditor20250429::OrHash,
+                  Anthropic::Beta::BetaWebSearchTool20250305::OrHash,
+                  Anthropic::Beta::BetaCodeExecutionTool20250522::OrHash
+                )
+              ],
+            betas: T::Array[T.any(String, Anthropic::AnthropicBeta::OrSymbol)],
+            request_options: Anthropic::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # 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.
+          messages:,
+          # The model that will complete your prompt.\n\nSee
+          # [models](https://docs.anthropic.com/en/docs/models-overview) for additional
+          # details and options.
+          model:,
+          # MCP servers to be utilized in this request
+          mcp_servers: nil,
+          # 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).
+          system_: nil,
+          # 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.
+          thinking: nil,
+          # 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.
+          tool_choice: nil,
+          # 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.
+          tools: nil,
+          # Optional header to specify the beta version(s) you want to use.
+          betas: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              messages: T::Array[Anthropic::Beta::BetaMessageParam],
+              model: T.any(Anthropic::Model::OrSymbol, String),
+              mcp_servers:
+                T::Array[Anthropic::Beta::BetaRequestMCPServerURLDefinition],
+              system_:
+                Anthropic::Beta::MessageCountTokensParams::System::Variants,
+              thinking:
+                T.any(
+                  Anthropic::Beta::BetaThinkingConfigEnabled,
+                  Anthropic::Beta::BetaThinkingConfigDisabled
+                ),
+              tool_choice:
+                T.any(
+                  Anthropic::Beta::BetaToolChoiceAuto,
+                  Anthropic::Beta::BetaToolChoiceAny,
+                  Anthropic::Beta::BetaToolChoiceTool,
+                  Anthropic::Beta::BetaToolChoiceNone
+                ),
+              tools:
+                T::Array[
+                  T.any(
+                    Anthropic::Beta::BetaTool,
+                    Anthropic::Beta::BetaToolComputerUse20241022,
+                    Anthropic::Beta::BetaToolBash20241022,
+                    Anthropic::Beta::BetaToolTextEditor20241022,
+                    Anthropic::Beta::BetaToolComputerUse20250124,
+                    Anthropic::Beta::BetaToolBash20250124,
+                    Anthropic::Beta::BetaToolTextEditor20250124,
+                    Anthropic::Beta::BetaToolTextEditor20250429,
+                    Anthropic::Beta::BetaWebSearchTool20250305,
+                    Anthropic::Beta::BetaCodeExecutionTool20250522
+                  )
+                ],
+              betas:
+                T::Array[T.any(String, Anthropic::AnthropicBeta::OrSymbol)],
+              request_options: Anthropic::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # 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
+
+          Variants =
+            T.type_alias do
+              T.any(String, T::Array[Anthropic::Beta::BetaTextBlockParam])
+            end
+
+          sig do
+            override.returns(
+              T::Array[
+                Anthropic::Beta::MessageCountTokensParams::System::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+
+          BetaTextBlockParamArray =
+            T.let(
+              Anthropic::Internal::Type::ArrayOf[
+                Anthropic::Beta::BetaTextBlockParam
+              ],
+              Anthropic::Internal::Type::Converter
+            )
+        end
+
+        module Tool
+          extend Anthropic::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                Anthropic::Beta::BetaTool,
+                Anthropic::Beta::BetaToolComputerUse20241022,
+                Anthropic::Beta::BetaToolBash20241022,
+                Anthropic::Beta::BetaToolTextEditor20241022,
+                Anthropic::Beta::BetaToolComputerUse20250124,
+                Anthropic::Beta::BetaToolBash20250124,
+                Anthropic::Beta::BetaToolTextEditor20250124,
+                Anthropic::Beta::BetaToolTextEditor20250429,
+                Anthropic::Beta::BetaWebSearchTool20250305,
+                Anthropic::Beta::BetaCodeExecutionTool20250522
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[
+                Anthropic::Beta::MessageCountTokensParams::Tool::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+    end
+  end
+end