anthropic 0.4.0 → 1.0.0

data/lib/anthropic/models/plain_text_source.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class PlainTextSource < Anthropic::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [String]
+      required :data, String
+
+      # @!attribute media_type
+      #
+      #   @return [Symbol, :"text/plain"]
+      required :media_type, const: :"text/plain"
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :text]
+      required :type, const: :text
+
+      # @!method initialize(data:, media_type: :"text/plain", type: :text)
+      #   @param data [String]
+      #   @param media_type [Symbol, :"text/plain"]
+      #   @param type [Symbol, :text]
+    end
+  end
+end

data/lib/anthropic/models/rate_limit_error.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class RateLimitError < Anthropic::Internal::Type::BaseModel
+      # @!attribute message
+      #
+      #   @return [String]
+      required :message, String
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :rate_limit_error]
+      required :type, const: :rate_limit_error
+
+      # @!method initialize(message:, type: :rate_limit_error)
+      #   @param message [String]
+      #   @param type [Symbol, :rate_limit_error]
+    end
+  end
+end

data/lib/anthropic/models/raw_content_block_delta.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module RawContentBlockDelta
+      extend Anthropic::Internal::Type::Union
+
+      discriminator :type
+
+      variant :text_delta, -> { Anthropic::TextDelta }
+
+      variant :input_json_delta, -> { Anthropic::InputJSONDelta }
+
+      variant :citations_delta, -> { Anthropic::CitationsDelta }
+
+      variant :thinking_delta, -> { Anthropic::ThinkingDelta }
+
+      variant :signature_delta, -> { Anthropic::SignatureDelta }
+
+      # @!method self.variants
+      #   @return [Array(Anthropic::TextDelta, Anthropic::InputJSONDelta, Anthropic::CitationsDelta, Anthropic::ThinkingDelta, Anthropic::SignatureDelta)]
+    end
+  end
+end

data/lib/anthropic/models/raw_content_block_delta_event.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class RawContentBlockDeltaEvent < Anthropic::Internal::Type::BaseModel
+      # @!attribute delta
+      #
+      #   @return [Anthropic::TextDelta, Anthropic::InputJSONDelta, Anthropic::CitationsDelta, Anthropic::ThinkingDelta, Anthropic::SignatureDelta]
+      required :delta, union: -> { Anthropic::RawContentBlockDelta }
+
+      # @!attribute index
+      #
+      #   @return [Integer]
+      required :index, Integer
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :content_block_delta]
+      required :type, const: :content_block_delta
+
+      # @!method initialize(delta:, index:, type: :content_block_delta)
+      #   @param delta [Anthropic::TextDelta, Anthropic::InputJSONDelta, Anthropic::CitationsDelta, Anthropic::ThinkingDelta, Anthropic::SignatureDelta]
+      #   @param index [Integer]
+      #   @param type [Symbol, :content_block_delta]
+    end
+  end
+end

data/lib/anthropic/models/raw_content_block_start_event.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class RawContentBlockStartEvent < Anthropic::Internal::Type::BaseModel
+      # @!attribute content_block
+      #
+      #   @return [Anthropic::TextBlock, Anthropic::ToolUseBlock, Anthropic::ServerToolUseBlock, Anthropic::WebSearchToolResultBlock, Anthropic::ThinkingBlock, Anthropic::RedactedThinkingBlock]
+      required :content_block, union: -> { Anthropic::RawContentBlockStartEvent::ContentBlock }
+
+      # @!attribute index
+      #
+      #   @return [Integer]
+      required :index, Integer
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :content_block_start]
+      required :type, const: :content_block_start
+
+      # @!method initialize(content_block:, index:, type: :content_block_start)
+      #   @param content_block [Anthropic::TextBlock, Anthropic::ToolUseBlock, Anthropic::ServerToolUseBlock, Anthropic::WebSearchToolResultBlock, Anthropic::ThinkingBlock, Anthropic::RedactedThinkingBlock]
+      #   @param index [Integer]
+      #   @param type [Symbol, :content_block_start]
+
+      # @see Anthropic::RawContentBlockStartEvent#content_block
+      module ContentBlock
+        extend Anthropic::Internal::Type::Union
+
+        discriminator :type
+
+        variant :text, -> { Anthropic::TextBlock }
+
+        variant :tool_use, -> { Anthropic::ToolUseBlock }
+
+        variant :server_tool_use, -> { Anthropic::ServerToolUseBlock }
+
+        variant :web_search_tool_result, -> { Anthropic::WebSearchToolResultBlock }
+
+        variant :thinking, -> { Anthropic::ThinkingBlock }
+
+        variant :redacted_thinking, -> { Anthropic::RedactedThinkingBlock }
+
+        # @!method self.variants
+        #   @return [Array(Anthropic::TextBlock, Anthropic::ToolUseBlock, Anthropic::ServerToolUseBlock, Anthropic::WebSearchToolResultBlock, Anthropic::ThinkingBlock, Anthropic::RedactedThinkingBlock)]
+      end
+    end
+  end
+end

data/lib/anthropic/models/raw_content_block_stop_event.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class RawContentBlockStopEvent < Anthropic::Internal::Type::BaseModel
+      # @!attribute index
+      #
+      #   @return [Integer]
+      required :index, Integer
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :content_block_stop]
+      required :type, const: :content_block_stop
+
+      # @!method initialize(index:, type: :content_block_stop)
+      #   @param index [Integer]
+      #   @param type [Symbol, :content_block_stop]
+    end
+  end
+end

data/lib/anthropic/models/raw_message_delta_event.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class RawMessageDeltaEvent < Anthropic::Internal::Type::BaseModel
+      # @!attribute delta
+      #
+      #   @return [Anthropic::RawMessageDeltaEvent::Delta]
+      required :delta, -> { Anthropic::RawMessageDeltaEvent::Delta }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :message_delta]
+      required :type, const: :message_delta
+
+      # @!attribute usage
+      #   Billing and rate-limit usage.
+      #
+      #   Anthropic's API bills and rate-limits by token counts, as tokens represent the
+      #   underlying cost to our systems.
+      #
+      #   Under the hood, the API transforms requests into a format suitable for the
+      #   model. The model's output then goes through a parsing stage before becoming an
+      #   API response. As a result, the token counts in `usage` will not match one-to-one
+      #   with the exact visible content of an API request or response.
+      #
+      #   For example, `output_tokens` will be non-zero, even for an empty string response
+      #   from Claude.
+      #
+      #   Total input tokens in a request is the summation of `input_tokens`,
+      #   `cache_creation_input_tokens`, and `cache_read_input_tokens`.
+      #
+      #   @return [Anthropic::MessageDeltaUsage]
+      required :usage, -> { Anthropic::MessageDeltaUsage }
+
+      # @!method initialize(delta:, usage:, type: :message_delta)
+      #   Some parameter documentations has been truncated, see
+      #   {Anthropic::RawMessageDeltaEvent} for more details.
+      #
+      #   @param delta [Anthropic::RawMessageDeltaEvent::Delta]
+      #
+      #   @param usage [Anthropic::MessageDeltaUsage] Billing and rate-limit usage.
+      #
+      #   @param type [Symbol, :message_delta]
+
+      # @see Anthropic::RawMessageDeltaEvent#delta
+      class Delta < Anthropic::Internal::Type::BaseModel
+        # @!attribute stop_reason
+        #
+        #   @return [Symbol, Anthropic::StopReason, nil]
+        required :stop_reason, enum: -> { Anthropic::StopReason }, nil?: true
+
+        # @!attribute stop_sequence
+        #
+        #   @return [String, nil]
+        required :stop_sequence, String, nil?: true
+
+        # @!method initialize(stop_reason:, stop_sequence:)
+        #   @param stop_reason [Symbol, Anthropic::StopReason, nil]
+        #   @param stop_sequence [String, nil]
+      end
+    end
+  end
+end

data/lib/anthropic/models/raw_message_start_event.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class RawMessageStartEvent < Anthropic::Internal::Type::BaseModel
+      # @!attribute message
+      #
+      #   @return [Anthropic::Message]
+      required :message, -> { Anthropic::Message }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :message_start]
+      required :type, const: :message_start
+
+      # @!method initialize(message:, type: :message_start)
+      #   @param message [Anthropic::Message]
+      #   @param type [Symbol, :message_start]
+    end
+  end
+end

data/lib/anthropic/models/raw_message_stop_event.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class RawMessageStopEvent < Anthropic::Internal::Type::BaseModel
+      # @!attribute type
+      #
+      #   @return [Symbol, :message_stop]
+      required :type, const: :message_stop
+
+      # @!method initialize(type: :message_stop)
+      #   @param type [Symbol, :message_stop]
+    end
+  end
+end

data/lib/anthropic/models/raw_message_stream_event.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module RawMessageStreamEvent
+      extend Anthropic::Internal::Type::Union
+
+      discriminator :type
+
+      variant :message_start, -> { Anthropic::RawMessageStartEvent }
+
+      variant :message_delta, -> { Anthropic::RawMessageDeltaEvent }
+
+      variant :message_stop, -> { Anthropic::RawMessageStopEvent }
+
+      variant :content_block_start, -> { Anthropic::RawContentBlockStartEvent }
+
+      variant :content_block_delta, -> { Anthropic::RawContentBlockDeltaEvent }
+
+      variant :content_block_stop, -> { Anthropic::RawContentBlockStopEvent }
+
+      # @!method self.variants
+      #   @return [Array(Anthropic::RawMessageStartEvent, Anthropic::RawMessageDeltaEvent, Anthropic::RawMessageStopEvent, Anthropic::RawContentBlockStartEvent, Anthropic::RawContentBlockDeltaEvent, Anthropic::RawContentBlockStopEvent)]
+    end
+  end
+end

data/lib/anthropic/models/redacted_thinking_block.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class RedactedThinkingBlock < Anthropic::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [String]
+      required :data, String
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :redacted_thinking]
+      required :type, const: :redacted_thinking
+
+      # @!method initialize(data:, type: :redacted_thinking)
+      #   @param data [String]
+      #   @param type [Symbol, :redacted_thinking]
+    end
+  end
+end

data/lib/anthropic/models/redacted_thinking_block_param.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class RedactedThinkingBlockParam < Anthropic::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [String]
+      required :data, String
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :redacted_thinking]
+      required :type, const: :redacted_thinking
+
+      # @!method initialize(data:, type: :redacted_thinking)
+      #   @param data [String]
+      #   @param type [Symbol, :redacted_thinking]
+    end
+  end
+end

data/lib/anthropic/models/server_tool_usage.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class ServerToolUsage < Anthropic::Internal::Type::BaseModel
+      # @!attribute web_search_requests
+      #   The number of web search tool requests.
+      #
+      #   @return [Integer]
+      required :web_search_requests, Integer
+
+      # @!method initialize(web_search_requests:)
+      #   @param web_search_requests [Integer] The number of web search tool requests.
+    end
+  end
+end

data/lib/anthropic/models/server_tool_use_block.rb

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

data/lib/anthropic/models/server_tool_use_block_param.rb

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

data/lib/anthropic/models/signature_delta.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class SignatureDelta < Anthropic::Internal::Type::BaseModel
+      # @!attribute signature
+      #
+      #   @return [String]
+      required :signature, String
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :signature_delta]
+      required :type, const: :signature_delta
+
+      # @!method initialize(signature:, type: :signature_delta)
+      #   @param signature [String]
+      #   @param type [Symbol, :signature_delta]
+    end
+  end
+end

data/lib/anthropic/models/stop_reason.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module StopReason
+      extend Anthropic::Internal::Type::Enum
+
+      END_TURN = :end_turn
+      MAX_TOKENS = :max_tokens
+      STOP_SEQUENCE = :stop_sequence
+      TOOL_USE = :tool_use
+      PAUSE_TURN = :pause_turn
+      REFUSAL = :refusal
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/anthropic/models/text_block.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class TextBlock < Anthropic::Internal::Type::BaseModel
+      # @!attribute citations
+      #   Citations supporting the text block.
+      #
+      #   The type of citation returned will depend on the type of document being cited.
+      #   Citing a PDF results in `page_location`, plain text results in `char_location`,
+      #   and content document results in `content_block_location`.
+      #
+      #   @return [Array<Anthropic::CitationCharLocation, Anthropic::CitationPageLocation, Anthropic::CitationContentBlockLocation, Anthropic::CitationsWebSearchResultLocation>, nil]
+      required :citations,
+               -> {
+                 Anthropic::Internal::Type::ArrayOf[union: Anthropic::TextCitation]
+               },
+               nil?: true
+
+      # @!attribute text
+      #
+      #   @return [String]
+      required :text, String
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :text]
+      required :type, const: :text
+
+      # @!method initialize(citations:, text:, type: :text)
+      #   Some parameter documentations has been truncated, see {Anthropic::TextBlock} for
+      #   more details.
+      #
+      #   @param citations [Array<Anthropic::CitationCharLocation, Anthropic::CitationPageLocation, Anthropic::CitationContentBlockLocation, Anthropic::CitationsWebSearchResultLocation>, nil] Citations supporting the text block.
+      #
+      #   @param text [String]
+      #
+      #   @param type [Symbol, :text]
+    end
+  end
+end

data/lib/anthropic/models/text_block_param.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class TextBlockParam < Anthropic::Internal::Type::BaseModel
+      # @!attribute text
+      #
+      #   @return [String]
+      required :text, String
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :text]
+      required :type, const: :text
+
+      # @!attribute cache_control
+      #   Create a cache control breakpoint at this content block.
+      #
+      #   @return [Anthropic::CacheControlEphemeral, nil]
+      optional :cache_control, -> { Anthropic::CacheControlEphemeral }, nil?: true
+
+      # @!attribute citations
+      #
+      #   @return [Array<Anthropic::CitationCharLocationParam, Anthropic::CitationPageLocationParam, Anthropic::CitationContentBlockLocationParam, Anthropic::CitationWebSearchResultLocationParam>, nil]
+      optional :citations,
+               -> { Anthropic::Internal::Type::ArrayOf[union: Anthropic::TextCitationParam] },
+               nil?: true
+
+      # @!method initialize(text:, cache_control: nil, citations: nil, type: :text)
+      #   @param text [String]
+      #
+      #   @param cache_control [Anthropic::CacheControlEphemeral, nil] Create a cache control breakpoint at this content block.
+      #
+      #   @param citations [Array<Anthropic::CitationCharLocationParam, Anthropic::CitationPageLocationParam, Anthropic::CitationContentBlockLocationParam, Anthropic::CitationWebSearchResultLocationParam>, nil]
+      #
+      #   @param type [Symbol, :text]
+    end
+  end
+end

data/lib/anthropic/models/text_citation.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module TextCitation
+      extend Anthropic::Internal::Type::Union
+
+      discriminator :type
+
+      variant :char_location, -> { Anthropic::CitationCharLocation }
+
+      variant :page_location, -> { Anthropic::CitationPageLocation }
+
+      variant :content_block_location, -> { Anthropic::CitationContentBlockLocation }
+
+      variant :web_search_result_location, -> { Anthropic::CitationsWebSearchResultLocation }
+
+      # @!method self.variants
+      #   @return [Array(Anthropic::CitationCharLocation, Anthropic::CitationPageLocation, Anthropic::CitationContentBlockLocation, Anthropic::CitationsWebSearchResultLocation)]
+    end
+  end
+end

data/lib/anthropic/models/text_citation_param.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module TextCitationParam
+      extend Anthropic::Internal::Type::Union
+
+      discriminator :type
+
+      variant :char_location, -> { Anthropic::CitationCharLocationParam }
+
+      variant :page_location, -> { Anthropic::CitationPageLocationParam }
+
+      variant :content_block_location, -> { Anthropic::CitationContentBlockLocationParam }
+
+      variant :web_search_result_location, -> { Anthropic::CitationWebSearchResultLocationParam }
+
+      # @!method self.variants
+      #   @return [Array(Anthropic::CitationCharLocationParam, Anthropic::CitationPageLocationParam, Anthropic::CitationContentBlockLocationParam, Anthropic::CitationWebSearchResultLocationParam)]
+    end
+  end
+end

data/lib/anthropic/models/text_delta.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class TextDelta < Anthropic::Internal::Type::BaseModel
+      # @!attribute text
+      #
+      #   @return [String]
+      required :text, String
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :text_delta]
+      required :type, const: :text_delta
+
+      # @!method initialize(text:, type: :text_delta)
+      #   @param text [String]
+      #   @param type [Symbol, :text_delta]
+    end
+  end
+end

data/lib/anthropic/models/thinking_block.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class ThinkingBlock < Anthropic::Internal::Type::BaseModel
+      # @!attribute signature
+      #
+      #   @return [String]
+      required :signature, String
+
+      # @!attribute thinking
+      #
+      #   @return [String]
+      required :thinking, String
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :thinking]
+      required :type, const: :thinking
+
+      # @!method initialize(signature:, thinking:, type: :thinking)
+      #   @param signature [String]
+      #   @param thinking [String]
+      #   @param type [Symbol, :thinking]
+    end
+  end
+end