anthropic 1.1.1 → 1.9.0

data/rbi/anthropic/resources/messages.rbi

@@ -43,6 +43,8 @@ module Anthropic
                 Anthropic::Tool::OrHash,
                 Anthropic::ToolBash20250124::OrHash,
                 Anthropic::ToolTextEditor20250124::OrHash,
+                Anthropic::ToolTextEditor20250429::OrHash,
+                Anthropic::ToolTextEditor20250728::OrHash,
                 Anthropic::WebSearchTool20250305::OrHash
               )
             ],
@@ -53,6 +55,298 @@ module Anthropic
         ).returns(Anthropic::Message)
       end
       def create(
+        # The maximum number of tokens to generate before stopping.
+        #
+        # Note that our models may stop _before_ reaching this maximum. This parameter
+        # only specifies the absolute maximum number of tokens to generate.
+        #
+        # Different models have different maximum values for this parameter. See
+        # [models](https://docs.anthropic.com/en/docs/models-overview) for details.
+        max_tokens:,
+        # 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" }] }
+        # ```
+        #
+        # See [input examples](https://docs.anthropic.com/en/api/messages-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 100,000 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:,
+        # An object describing metadata about the request.
+        metadata: nil,
+        # Determines whether to use priority capacity (if available) or standard capacity
+        # for this request.
+        #
+        # Anthropic offers different levels of service for your API requests. See
+        # [service-tiers](https://docs.anthropic.com/en/api/service-tiers) for details.
+        service_tier: nil,
+        # Custom text sequences that will cause the model to stop generating.
+        #
+        # Our models will normally stop when they have naturally completed their turn,
+        # which will result in a response `stop_reason` of `"end_turn"`.
+        #
+        # If you want the model to stop generating when it encounters custom strings of
+        # text, you can use the `stop_sequences` parameter. If the model encounters one of
+        # the custom sequences, the response `stop_reason` value will be `"stop_sequence"`
+        # and the response `stop_sequence` value will contain the matched stop sequence.
+        stop_sequences: 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,
+        # Amount of randomness injected into the response.
+        #
+        # Defaults to `1.0`. Ranges from `0.0` to `1.0`. Use `temperature` closer to `0.0`
+        # for analytical / multiple choice, and closer to `1.0` for creative and
+        # generative tasks.
+        #
+        # Note that even with `temperature` of `0.0`, the results will not be fully
+        # deterministic.
+        temperature: 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.
+        #
+        # There are two types of tools: **client tools** and **server tools**. The
+        # behavior described below applies to client tools. For
+        # [server tools](https://docs.anthropic.com/en/docs/agents-and-tools/tool-use/overview#server-tools),
+        # see their individual documentation as each has its own behavior (e.g., the
+        # [web search tool](https://docs.anthropic.com/en/docs/agents-and-tools/tool-use/web-search-tool)).
+        #
+        # 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,
+        # Only sample from the top K options for each subsequent token.
+        #
+        # Used to remove "long tail" low probability responses.
+        # [Learn more technical details here](https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277).
+        #
+        # Recommended for advanced use cases only. You usually only need to use
+        # `temperature`.
+        top_k: nil,
+        # Use nucleus sampling.
+        #
+        # In nucleus sampling, we compute the cumulative distribution over all the options
+        # for each subsequent token in decreasing probability order and cut it off once it
+        # reaches a particular probability specified by `top_p`. You should either alter
+        # `temperature` or `top_p`, but not both.
+        #
+        # Recommended for advanced use cases only. You usually only need to use
+        # `temperature`.
+        top_p: nil,
+        # There is no need to provide `stream:`. Instead, use `#stream_raw` or `#create`
+        # for streaming and non-streaming use cases, respectively.
+        stream: false,
+        request_options: {}
+      )
+      end
+
+      # See {Anthropic::Resources::Messages#create} for non-streaming counterpart.
+      #
+      # Send a structured list of input messages with text and/or image content, and the
+      # model will generate the next message in the conversation.
+      #
+      # The Messages API can be used for either single queries or stateless multi-turn
+      # conversations.
+      #
+      # Learn more about the Messages API in our [user guide](/en/docs/initial-setup)
+      sig do
+        params(
+          max_tokens: Integer,
+          messages:
+            T::Array[
+              T.any(
+                Anthropic::Models::MessageParam,
+                Anthropic::Internal::AnyHash
+              )
+            ],
+          model: T.any(Anthropic::Models::Model::OrSymbol, String),
+          metadata:
+            T.any(Anthropic::Models::Metadata, Anthropic::Internal::AnyHash),
+          stop_sequences: T::Array[String],
+          system_:
+            T.any(
+              String,
+              T::Array[
+                T.any(
+                  Anthropic::Models::TextBlockParam,
+                  Anthropic::Internal::AnyHash
+                )
+              ]
+            ),
+          temperature: Float,
+          thinking:
+            T.any(
+              Anthropic::Models::ThinkingConfigEnabled,
+              Anthropic::Internal::AnyHash,
+              Anthropic::Models::ThinkingConfigDisabled
+            ),
+          tool_choice:
+            T.any(
+              Anthropic::Models::ToolChoiceAuto,
+              Anthropic::Internal::AnyHash,
+              Anthropic::Models::ToolChoiceAny,
+              Anthropic::Models::ToolChoiceTool,
+              Anthropic::Models::ToolChoiceNone
+            ),
+          tools:
+            T::Array[
+              T.any(
+                Anthropic::Models::Tool,
+                Anthropic::Internal::AnyHash,
+                Anthropic::Models::ToolBash20250124,
+                Anthropic::Models::ToolTextEditor20250124
+              )
+            ],
+          top_k: Integer,
+          top_p: Float,
+          stream: T.noreturn,
+          request_options:
+            T.nilable(
+              T.any(Anthropic::RequestOptions, Anthropic::Internal::AnyHash)
+            )
+        ).returns(Anthropic::Helpers::Streaming::MessageStream)
+      end
+      def stream(
         # The maximum number of tokens to generate before stopping.
         #
         # Note that our models may stop _before_ reaching this maximum. This parameter
@@ -147,8 +441,6 @@ module Anthropic
         # [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
@@ -156,12 +448,6 @@ module Anthropic
         model:,
         # An object describing metadata about the request.
         metadata: nil,
-        # Determines whether to use priority capacity (if available) or standard capacity
-        # for this request.
-        #
-        # Anthropic offers different levels of service for your API requests. See
-        # [service-tiers](https://docs.anthropic.com/en/api/service-tiers) for details.
-        service_tier: nil,
         # Custom text sequences that will cause the model to stop generating.
         #
         # Our models will normally stop when they have naturally completed their turn,
@@ -290,20 +576,10 @@ module Anthropic
         top_p: nil,
         # There is no need to provide `stream:`. Instead, use `#stream_raw` or `#create`
         # for streaming and non-streaming use cases, respectively.
-        stream: false,
+        stream: true,
         request_options: {}
       )
       end
-
-      # See {Anthropic::Resources::Messages#create} for non-streaming counterpart.
-      #
-      # Send a structured list of input messages with text and/or image content, and the
-      # model will generate the next message in the conversation.
-      #
-      # The Messages API can be used for either single queries or stateless multi-turn
-      # conversations.
-      #
-      # Learn more about the Messages API in our [user guide](/en/docs/initial-setup)
       sig do
         params(
           max_tokens: Integer,
@@ -332,6 +608,8 @@ module Anthropic
                 Anthropic::Tool::OrHash,
                 Anthropic::ToolBash20250124::OrHash,
                 Anthropic::ToolTextEditor20250124::OrHash,
+                Anthropic::ToolTextEditor20250429::OrHash,
+                Anthropic::ToolTextEditor20250728::OrHash,
                 Anthropic::WebSearchTool20250305::OrHash
               )
             ],
@@ -411,37 +689,14 @@ module Anthropic
         # { "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.
+        # See [input examples](https://docs.anthropic.com/en/api/messages-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.
+        # There is a limit of 100,000 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
@@ -500,6 +755,12 @@ module Anthropic
         # those tools using the tool input generated by the model and then optionally
         # return results back to the model using `tool_result` content blocks.
         #
+        # There are two types of tools: **client tools** and **server tools**. The
+        # behavior described below applies to client tools. For
+        # [server tools](https://docs.anthropic.com/en/docs/agents-and-tools/tool-use/overview#server-tools),
+        # see their individual documentation as each has its own behavior (e.g., the
+        # [web search tool](https://docs.anthropic.com/en/docs/agents-and-tools/tool-use/web-search-tool)).
+        #
         # Each tool definition includes:
         #
         # - `name`: Name of the tool.
@@ -618,6 +879,8 @@ module Anthropic
                 Anthropic::Tool::OrHash,
                 Anthropic::ToolBash20250124::OrHash,
                 Anthropic::ToolTextEditor20250124::OrHash,
+                Anthropic::ToolTextEditor20250429::OrHash,
+                Anthropic::ToolTextEditor20250728::OrHash,
                 Anthropic::WebSearchTool20250305::OrHash
               )
             ],
@@ -682,37 +945,14 @@ module Anthropic
         # { "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.
+        # See [input examples](https://docs.anthropic.com/en/api/messages-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.
+        # There is a limit of 100,000 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
@@ -744,6 +984,12 @@ module Anthropic
         # those tools using the tool input generated by the model and then optionally
         # return results back to the model using `tool_result` content blocks.
         #
+        # There are two types of tools: **client tools** and **server tools**. The
+        # behavior described below applies to client tools. For
+        # [server tools](https://docs.anthropic.com/en/docs/agents-and-tools/tool-use/overview#server-tools),
+        # see their individual documentation as each has its own behavior (e.g., the
+        # [web search tool](https://docs.anthropic.com/en/docs/agents-and-tools/tool-use/web-search-tool)).
+        #
         # Each tool definition includes:
         #
         # - `name`: Name of the tool.

data/rbi/anthropic/streaming.rbi

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Anthropic
+  Streaming = Anthropic::Helpers::Streaming
+end

data/sig/anthropic/errors.rbs

@@ -5,6 +5,15 @@ module Anthropic
     end
 
     class ConversionError < Anthropic::Errors::Error
+      def cause: -> StandardError?
+
+      def initialize: (
+        on: Class,
+        method: Symbol,
+        target: top,
+        value: top,
+        ?cause: StandardError?
+      ) -> void
     end
 
     class APIError < Anthropic::Errors::Error

data/sig/anthropic/helpers/streaming/events.rbs

@@ -0,0 +1,117 @@
+module Anthropic
+  module Helpers
+    module Streaming
+      type text_event = { type: :text, text: String, snapshot: String }
+
+      class TextEvent < Anthropic::Internal::Type::BaseModel
+        attr_accessor type: :text
+
+        attr_accessor text: String
+
+        attr_accessor snapshot: String
+
+        def initialize: (text: String, snapshot: String, ?type: :text) -> void
+      end
+
+      type citation_event =
+        {
+          type: :citation,
+          citation: Anthropic::Models::CitationsDelta::citation,
+          snapshot: ::Array[Anthropic::Models::CitationsDelta::citation]
+        }
+
+      class CitationEvent < Anthropic::Internal::Type::BaseModel
+        attr_accessor type: :citation
+
+        attr_accessor citation: Anthropic::Models::CitationsDelta::citation
+
+        attr_accessor snapshot: ::Array[Anthropic::Models::CitationsDelta::citation]
+
+        def initialize: (
+          citation: Anthropic::Models::CitationsDelta::citation,
+          snapshot: ::Array[Anthropic::Models::CitationsDelta::citation],
+          ?type: :citation
+        ) -> void
+      end
+
+      type thinking_event =
+        { type: :thinking, thinking: String, snapshot: String }
+
+      class ThinkingEvent < Anthropic::Internal::Type::BaseModel
+        attr_accessor type: :thinking
+
+        attr_accessor thinking: String
+
+        attr_accessor snapshot: String
+
+        def initialize: (
+          thinking: String,
+          snapshot: String,
+          ?type: :thinking
+        ) -> void
+      end
+
+      type signature_event = { type: :signature, signature: String }
+
+      class SignatureEvent < Anthropic::Internal::Type::BaseModel
+        attr_accessor type: :signature
+
+        attr_accessor signature: String
+
+        def initialize: (signature: String, ?type: :signature) -> void
+      end
+
+      type input_json_event =
+        { type: :input_json, partial_json: String, snapshot: untyped }
+
+      class InputJsonEvent < Anthropic::Internal::Type::BaseModel
+        attr_accessor type: :input_json
+
+        attr_accessor partial_json: String
+
+        attr_accessor snapshot: untyped
+
+        def initialize: (
+          partial_json: String,
+          snapshot: untyped,
+          ?type: :input_json
+        ) -> void
+      end
+
+      type message_stop_event =
+        { type: :message_stop, message: Anthropic::Models::message }
+
+      class MessageStopEvent < Anthropic::Models::RawMessageStopEvent
+        attr_accessor type: :message_stop
+
+        attr_accessor message: Anthropic::Models::message
+
+        def initialize: (
+          message: Anthropic::Models::message,
+          ?type: :message_stop
+        ) -> void
+      end
+
+      type content_block_stop_event =
+        {
+          type: :content_block_stop,
+          index: Integer,
+          content_block: Anthropic::Models::content_block
+        }
+
+      class ContentBlockStopEvent < Anthropic::Models::RawContentBlockStopEvent
+        attr_accessor type: :content_block_stop
+
+        attr_accessor index: Integer
+
+        attr_accessor content_block: Anthropic::Models::content_block
+
+        def initialize: (
+          index: Integer,
+          content_block: Anthropic::Models::content_block,
+          ?type: :content_block_stop
+        ) -> void
+      end
+    end
+  end
+end

data/sig/anthropic/helpers/streaming/message_stream.rbs

@@ -0,0 +1,57 @@
+module Anthropic
+  module Helpers
+    module Streaming
+      type raw_message_event =
+        Anthropic::Models::raw_message_start_event
+        | Anthropic::Models::raw_message_delta_event
+        | Anthropic::Models::raw_message_stop_event
+        | Anthropic::Models::raw_content_block_start_event
+        | Anthropic::Models::raw_content_block_delta_event
+        | Anthropic::Models::raw_content_block_stop_event
+
+      type stream_event =
+        raw_message_event
+        | text_event
+        | citation_event
+        | thinking_event
+        | signature_event
+        | input_json_event
+        | message_stop_event
+        | content_block_stop_event
+
+      class MessageStream
+        include Anthropic::Internal::Type::BaseStream[raw_message_event, stream_event]
+
+        @raw_stream: Anthropic::Internal::Stream[raw_message_event]
+        @accumated_message_snapshot: Anthropic::Models::message?
+        @iterator: Enumerable[stream_event]?
+
+        def initialize: (
+          raw_stream: Anthropic::Internal::Stream[raw_message_event]
+        ) -> void
+
+        def until_done: -> void
+
+        def text: -> Enumerator[String]
+
+        def accumulated_message: -> Anthropic::Models::message
+
+        def accumulated_text: -> String
+
+        private
+
+        def iterator: -> Enumerable[stream_event]
+
+        def accumulate_event: (
+          event: raw_message_event,
+          current_snapshot: Anthropic::Models::message?
+        ) -> Anthropic::Models::message
+
+        def build_events: (
+          event: raw_message_event,
+          message_snapshot: Anthropic::Models::message
+        ) -> ::Array[stream_event]
+      end
+    end
+  end
+end

data/sig/anthropic/internal/transport/base_client.rbs

@@ -99,7 +99,7 @@ module Anthropic
           retry_count: Integer
         ) -> Float
 
-        private def send_request: (
+        def send_request: (
           Anthropic::Internal::Transport::BaseClient::request_input request,
           redirect_count: Integer,
           retry_count: Integer,

data/sig/anthropic/internal/type/base_stream.rbs

@@ -23,6 +23,10 @@ module Anthropic
           url: URI::Generic,
           status: Integer,
           response: top,
+          unwrap: Symbol
+          | Integer
+          | ::Array[Symbol | Integer]
+          | ^(top arg0) -> top,
           stream: Enumerable[Message]
         ) -> void