anthropic-sdk-beta 0.1.0.pre.beta.3

data/lib/anthropic/models/completion_create_params.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    # @see Anthropic::Resources::Completions#create
+    #
+    # @see Anthropic::Resources::Completions#create_streaming
+    class CompletionCreateParams < Anthropic::Internal::Type::BaseModel
+      # @!parse
+      #   extend Anthropic::Internal::Type::RequestParameters::Converter
+      include Anthropic::Internal::Type::RequestParameters
+
+      # @!attribute max_tokens_to_sample
+      #   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.
+      #
+      #   @return [Integer]
+      required :max_tokens_to_sample, Integer
+
+      # @!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::Models::Model]
+      required :model, union: -> { Anthropic::Models::Model }
+
+      # @!attribute prompt
+      #   The prompt that you want Claude to complete.
+      #
+      #   For proper response generation you will need to format your prompt using
+      #   alternating `\n\nHuman:` and `\n\nAssistant:` conversational turns. For example:
+      #
+      #   ```
+      #   "\n\nHuman: {userQuestion}\n\nAssistant:"
+      #   ```
+      #
+      #   See [prompt validation](https://docs.anthropic.com/en/api/prompt-validation) and
+      #   our guide to
+      #   [prompt design](https://docs.anthropic.com/en/docs/intro-to-prompting) for more
+      #   details.
+      #
+      #   @return [String]
+      required :prompt, String
+
+      # @!attribute [r] metadata
+      #   An object describing metadata about the request.
+      #
+      #   @return [Anthropic::Models::Metadata, nil]
+      optional :metadata, -> { Anthropic::Models::Metadata }
+
+      # @!parse
+      #   # @return [Anthropic::Models::Metadata]
+      #   attr_writer :metadata
+
+      # @!attribute [r] stop_sequences
+      #   Sequences that will cause the model to stop generating.
+      #
+      #   Our models stop on `"\n\nHuman:"`, and may include additional built-in stop
+      #   sequences in the future. By providing the stop_sequences parameter, you may
+      #   include additional strings that will cause the model to stop generating.
+      #
+      #   @return [Array<String>, nil]
+      optional :stop_sequences, Anthropic::Internal::Type::ArrayOf[String]
+
+      # @!parse
+      #   # @return [Array<String>]
+      #   attr_writer :stop_sequences
+
+      # @!attribute [r] temperature
+      #   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.
+      #
+      #   @return [Float, nil]
+      optional :temperature, Float
+
+      # @!parse
+      #   # @return [Float]
+      #   attr_writer :temperature
+
+      # @!attribute [r] top_k
+      #   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`.
+      #
+      #   @return [Integer, nil]
+      optional :top_k, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :top_k
+
+      # @!attribute [r] top_p
+      #   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`.
+      #
+      #   @return [Float, nil]
+      optional :top_p, Float
+
+      # @!parse
+      #   # @return [Float]
+      #   attr_writer :top_p
+
+      # @!parse
+      #   # @param max_tokens_to_sample [Integer]
+      #   # @param model [Symbol, String, Anthropic::Models::Model]
+      #   # @param prompt [String]
+      #   # @param metadata [Anthropic::Models::Metadata]
+      #   # @param stop_sequences [Array<String>]
+      #   # @param temperature [Float]
+      #   # @param top_k [Integer]
+      #   # @param top_p [Float]
+      #   # @param request_options [Anthropic::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     max_tokens_to_sample:,
+      #     model:,
+      #     prompt:,
+      #     metadata: nil,
+      #     stop_sequences: nil,
+      #     temperature: nil,
+      #     top_k: nil,
+      #     top_p: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Anthropic::Internal::Type::BaseModel) -> void
+    end
+  end
+end

data/lib/anthropic/models/content_block.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module ContentBlock
+      extend Anthropic::Internal::Type::Union
+
+      discriminator :type
+
+      variant :text, -> { Anthropic::Models::TextBlock }
+
+      variant :tool_use, -> { Anthropic::Models::ToolUseBlock }
+
+      variant :thinking, -> { Anthropic::Models::ThinkingBlock }
+
+      variant :redacted_thinking, -> { Anthropic::Models::RedactedThinkingBlock }
+
+      # @!parse
+      #   # @return [Array(Anthropic::Models::TextBlock, Anthropic::Models::ToolUseBlock, Anthropic::Models::ThinkingBlock, Anthropic::Models::RedactedThinkingBlock)]
+      #   def self.variants; end
+    end
+  end
+end

data/lib/anthropic/models/content_block_param.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module ContentBlockParam
+      extend Anthropic::Internal::Type::Union
+
+      discriminator :type
+
+      variant :text, -> { Anthropic::Models::TextBlockParam }
+
+      variant :image, -> { Anthropic::Models::ImageBlockParam }
+
+      variant :tool_use, -> { Anthropic::Models::ToolUseBlockParam }
+
+      variant :tool_result, -> { Anthropic::Models::ToolResultBlockParam }
+
+      variant :document, -> { Anthropic::Models::DocumentBlockParam }
+
+      variant :thinking, -> { Anthropic::Models::ThinkingBlockParam }
+
+      variant :redacted_thinking, -> { Anthropic::Models::RedactedThinkingBlockParam }
+
+      # @!parse
+      #   # @return [Array(Anthropic::Models::TextBlockParam, Anthropic::Models::ImageBlockParam, Anthropic::Models::ToolUseBlockParam, Anthropic::Models::ToolResultBlockParam, Anthropic::Models::DocumentBlockParam, Anthropic::Models::ThinkingBlockParam, Anthropic::Models::RedactedThinkingBlockParam)]
+      #   def self.variants; end
+    end
+  end
+end

data/lib/anthropic/models/content_block_source.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class ContentBlockSource < Anthropic::Internal::Type::BaseModel
+      # @!attribute content
+      #
+      #   @return [String, Array<Anthropic::Models::TextBlockParam, Anthropic::Models::ImageBlockParam>]
+      required :content, union: -> { Anthropic::Models::ContentBlockSource::Content }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :content]
+      required :type, const: :content
+
+      # @!parse
+      #   # @param content [String, Array<Anthropic::Models::TextBlockParam, Anthropic::Models::ImageBlockParam>]
+      #   # @param type [Symbol, :content]
+      #   #
+      #   def initialize(content:, type: :content, **) = super
+
+      # def initialize: (Hash | Anthropic::Internal::Type::BaseModel) -> void
+
+      # @see Anthropic::Models::ContentBlockSource#content
+      module Content
+        extend Anthropic::Internal::Type::Union
+
+        variant String
+
+        variant -> { Anthropic::Models::ContentBlockSource::Content::ContentBlockSourceContentArray }
+
+        # @!parse
+        #   # @return [Array(String, Array<Anthropic::Models::TextBlockParam, Anthropic::Models::ImageBlockParam>)]
+        #   def self.variants; end
+
+        ContentBlockSourceContentArray =
+          Anthropic::Internal::Type::ArrayOf[union: -> { Anthropic::Models::ContentBlockSourceContent }]
+      end
+    end
+  end
+end

data/lib/anthropic/models/content_block_source_content.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module ContentBlockSourceContent
+      extend Anthropic::Internal::Type::Union
+
+      discriminator :type
+
+      variant :text, -> { Anthropic::Models::TextBlockParam }
+
+      variant :image, -> { Anthropic::Models::ImageBlockParam }
+
+      # @!parse
+      #   # @return [Array(Anthropic::Models::TextBlockParam, Anthropic::Models::ImageBlockParam)]
+      #   def self.variants; end
+    end
+  end
+end

data/lib/anthropic/models/document_block_param.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class DocumentBlockParam < Anthropic::Internal::Type::BaseModel
+      # @!attribute source
+      #
+      #   @return [Anthropic::Models::Base64PDFSource, Anthropic::Models::PlainTextSource, Anthropic::Models::ContentBlockSource, Anthropic::Models::URLPDFSource]
+      required :source, union: -> { Anthropic::Models::DocumentBlockParam::Source }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :document]
+      required :type, const: :document
+
+      # @!attribute cache_control
+      #
+      #   @return [Anthropic::Models::CacheControlEphemeral, nil]
+      optional :cache_control, -> { Anthropic::Models::CacheControlEphemeral }, nil?: true
+
+      # @!attribute [r] citations
+      #
+      #   @return [Anthropic::Models::CitationsConfigParam, nil]
+      optional :citations, -> { Anthropic::Models::CitationsConfigParam }
+
+      # @!parse
+      #   # @return [Anthropic::Models::CitationsConfigParam]
+      #   attr_writer :citations
+
+      # @!attribute context
+      #
+      #   @return [String, nil]
+      optional :context, String, nil?: true
+
+      # @!attribute title
+      #
+      #   @return [String, nil]
+      optional :title, String, nil?: true
+
+      # @!parse
+      #   # @param source [Anthropic::Models::Base64PDFSource, Anthropic::Models::PlainTextSource, Anthropic::Models::ContentBlockSource, Anthropic::Models::URLPDFSource]
+      #   # @param cache_control [Anthropic::Models::CacheControlEphemeral, nil]
+      #   # @param citations [Anthropic::Models::CitationsConfigParam]
+      #   # @param context [String, nil]
+      #   # @param title [String, nil]
+      #   # @param type [Symbol, :document]
+      #   #
+      #   def initialize(source:, cache_control: nil, citations: nil, context: nil, title: nil, type: :document, **) = super
+
+      # def initialize: (Hash | Anthropic::Internal::Type::BaseModel) -> void
+
+      # @see Anthropic::Models::DocumentBlockParam#source
+      module Source
+        extend Anthropic::Internal::Type::Union
+
+        discriminator :type
+
+        variant :base64, -> { Anthropic::Models::Base64PDFSource }
+
+        variant :text, -> { Anthropic::Models::PlainTextSource }
+
+        variant :content, -> { Anthropic::Models::ContentBlockSource }
+
+        variant :url, -> { Anthropic::Models::URLPDFSource }
+
+        # @!parse
+        #   # @return [Array(Anthropic::Models::Base64PDFSource, Anthropic::Models::PlainTextSource, Anthropic::Models::ContentBlockSource, Anthropic::Models::URLPDFSource)]
+        #   def self.variants; end
+      end
+    end
+  end
+end

data/lib/anthropic/models/error_object.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module ErrorObject
+      extend Anthropic::Internal::Type::Union
+
+      discriminator :type
+
+      variant :invalid_request_error, -> { Anthropic::Models::InvalidRequestError }
+
+      variant :authentication_error, -> { Anthropic::Models::AuthenticationError }
+
+      variant :billing_error, -> { Anthropic::Models::BillingError }
+
+      variant :permission_error, -> { Anthropic::Models::PermissionError }
+
+      variant :not_found_error, -> { Anthropic::Models::NotFoundError }
+
+      variant :rate_limit_error, -> { Anthropic::Models::RateLimitError }
+
+      variant :timeout_error, -> { Anthropic::Models::GatewayTimeoutError }
+
+      variant :api_error, -> { Anthropic::Models::APIErrorObject }
+
+      variant :overloaded_error, -> { Anthropic::Models::OverloadedError }
+
+      # @!parse
+      #   # @return [Array(Anthropic::Models::InvalidRequestError, Anthropic::Models::AuthenticationError, Anthropic::Models::BillingError, Anthropic::Models::PermissionError, Anthropic::Models::NotFoundError, Anthropic::Models::RateLimitError, Anthropic::Models::GatewayTimeoutError, Anthropic::Models::APIErrorObject, Anthropic::Models::OverloadedError)]
+      #   def self.variants; end
+    end
+  end
+end

data/lib/anthropic/models/error_response.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class ErrorResponse < Anthropic::Internal::Type::BaseModel
+      # @!attribute error
+      #
+      #   @return [Anthropic::Models::InvalidRequestError, Anthropic::Models::AuthenticationError, Anthropic::Models::BillingError, Anthropic::Models::PermissionError, Anthropic::Models::NotFoundError, Anthropic::Models::RateLimitError, Anthropic::Models::GatewayTimeoutError, Anthropic::Models::APIErrorObject, Anthropic::Models::OverloadedError]
+      required :error, union: -> { Anthropic::Models::ErrorObject }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :error]
+      required :type, const: :error
+
+      # @!parse
+      #   # @param error [Anthropic::Models::InvalidRequestError, Anthropic::Models::AuthenticationError, Anthropic::Models::BillingError, Anthropic::Models::PermissionError, Anthropic::Models::NotFoundError, Anthropic::Models::RateLimitError, Anthropic::Models::GatewayTimeoutError, Anthropic::Models::APIErrorObject, Anthropic::Models::OverloadedError]
+      #   # @param type [Symbol, :error]
+      #   #
+      #   def initialize(error:, type: :error, **) = super
+
+      # def initialize: (Hash | Anthropic::Internal::Type::BaseModel) -> void
+    end
+  end
+end

data/lib/anthropic/models/gateway_timeout_error.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class GatewayTimeoutError < Anthropic::Internal::Type::BaseModel
+      # @!attribute message
+      #
+      #   @return [String]
+      required :message, String
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :timeout_error]
+      required :type, const: :timeout_error
+
+      # @!parse
+      #   # @param message [String]
+      #   # @param type [Symbol, :timeout_error]
+      #   #
+      #   def initialize(message:, type: :timeout_error, **) = super
+
+      # def initialize: (Hash | Anthropic::Internal::Type::BaseModel) -> void
+    end
+  end
+end

data/lib/anthropic/models/image_block_param.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class ImageBlockParam < Anthropic::Internal::Type::BaseModel
+      # @!attribute source
+      #
+      #   @return [Anthropic::Models::Base64ImageSource, Anthropic::Models::URLImageSource]
+      required :source, union: -> { Anthropic::Models::ImageBlockParam::Source }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :image]
+      required :type, const: :image
+
+      # @!attribute cache_control
+      #
+      #   @return [Anthropic::Models::CacheControlEphemeral, nil]
+      optional :cache_control, -> { Anthropic::Models::CacheControlEphemeral }, nil?: true
+
+      # @!parse
+      #   # @param source [Anthropic::Models::Base64ImageSource, Anthropic::Models::URLImageSource]
+      #   # @param cache_control [Anthropic::Models::CacheControlEphemeral, nil]
+      #   # @param type [Symbol, :image]
+      #   #
+      #   def initialize(source:, cache_control: nil, type: :image, **) = super
+
+      # def initialize: (Hash | Anthropic::Internal::Type::BaseModel) -> void
+
+      # @see Anthropic::Models::ImageBlockParam#source
+      module Source
+        extend Anthropic::Internal::Type::Union
+
+        discriminator :type
+
+        variant :base64, -> { Anthropic::Models::Base64ImageSource }
+
+        variant :url, -> { Anthropic::Models::URLImageSource }
+
+        # @!parse
+        #   # @return [Array(Anthropic::Models::Base64ImageSource, Anthropic::Models::URLImageSource)]
+        #   def self.variants; end
+      end
+    end
+  end
+end

data/lib/anthropic/models/input_json_delta.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class InputJSONDelta < Anthropic::Internal::Type::BaseModel
+      # @!attribute partial_json
+      #
+      #   @return [String]
+      required :partial_json, String
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :input_json_delta]
+      required :type, const: :input_json_delta
+
+      # @!parse
+      #   # @param partial_json [String]
+      #   # @param type [Symbol, :input_json_delta]
+      #   #
+      #   def initialize(partial_json:, type: :input_json_delta, **) = super
+
+      # def initialize: (Hash | Anthropic::Internal::Type::BaseModel) -> void
+    end
+  end
+end

data/lib/anthropic/models/invalid_request_error.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class InvalidRequestError < Anthropic::Internal::Type::BaseModel
+      # @!attribute message
+      #
+      #   @return [String]
+      required :message, String
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :invalid_request_error]
+      required :type, const: :invalid_request_error
+
+      # @!parse
+      #   # @param message [String]
+      #   # @param type [Symbol, :invalid_request_error]
+      #   #
+      #   def initialize(message:, type: :invalid_request_error, **) = super
+
+      # def initialize: (Hash | Anthropic::Internal::Type::BaseModel) -> void
+    end
+  end
+end

data/lib/anthropic/models/message.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    # @see Anthropic::Resources::Messages#create
+    #
+    # @see Anthropic::Resources::Messages#stream_raw
+    class Message < Anthropic::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique object identifier.
+      #
+      #   The format and length of IDs may change over time.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute content
+      #   Content generated by the model.
+      #
+      #   This is an array of content blocks, each of which has a `type` that determines
+      #   its shape.
+      #
+      #   Example:
+      #
+      #   ```json
+      #   [{ "type": "text", "text": "Hi, I'm Claude." }]
+      #   ```
+      #
+      #   If the request input `messages` ended with an `assistant` turn, then the
+      #   response `content` will continue directly from that last turn. You can use this
+      #   to constrain the model's output.
+      #
+      #   For example, if the input `messages` were:
+      #
+      #   ```json
+      #   [
+      #     {
+      #       "role": "user",
+      #       "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"
+      #     },
+      #     { "role": "assistant", "content": "The best answer is (" }
+      #   ]
+      #   ```
+      #
+      #   Then the response `content` might be:
+      #
+      #   ```json
+      #   [{ "type": "text", "text": "B)" }]
+      #   ```
+      #
+      #   @return [Array<Anthropic::Models::TextBlock, Anthropic::Models::ToolUseBlock, Anthropic::Models::ThinkingBlock, Anthropic::Models::RedactedThinkingBlock>]
+      required :content, -> { Anthropic::Internal::Type::ArrayOf[union: Anthropic::Models::ContentBlock] }
+
+      # @!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::Models::Model]
+      required :model, union: -> { Anthropic::Models::Model }
+
+      # @!attribute role
+      #   Conversational role of the generated message.
+      #
+      #   This will always be `"assistant"`.
+      #
+      #   @return [Symbol, :assistant]
+      required :role, const: :assistant
+
+      # @!attribute stop_reason
+      #   The reason that we stopped.
+      #
+      #   This may be one the following values:
+      #
+      #   - `"end_turn"`: the model reached a natural stopping point
+      #   - `"max_tokens"`: we exceeded the requested `max_tokens` or the model's maximum
+      #   - `"stop_sequence"`: one of your provided custom `stop_sequences` was generated
+      #   - `"tool_use"`: the model invoked one or more tools
+      #
+      #   In non-streaming mode this value is always non-null. In streaming mode, it is
+      #   null in the `message_start` event and non-null otherwise.
+      #
+      #   @return [Symbol, Anthropic::Models::StopReason, nil]
+      required :stop_reason, enum: -> { Anthropic::Models::StopReason }, nil?: true
+
+      # @!attribute stop_sequence
+      #   Which custom stop sequence was generated, if any.
+      #
+      #   This value will be a non-null string if one of your custom stop sequences was
+      #   generated.
+      #
+      #   @return [String, nil]
+      required :stop_sequence, String, nil?: true
+
+      # @!attribute type
+      #   Object type.
+      #
+      #   For Messages, this is always `"message"`.
+      #
+      #   @return [Symbol, :message]
+      required :type, const: :message
+
+      # @!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::Models::Usage]
+      required :usage, -> { Anthropic::Models::Usage }
+
+      # @!parse
+      #   # @param id [String]
+      #   # @param content [Array<Anthropic::Models::TextBlock, Anthropic::Models::ToolUseBlock, Anthropic::Models::ThinkingBlock, Anthropic::Models::RedactedThinkingBlock>]
+      #   # @param model [Symbol, String, Anthropic::Models::Model]
+      #   # @param stop_reason [Symbol, Anthropic::Models::StopReason, nil]
+      #   # @param stop_sequence [String, nil]
+      #   # @param usage [Anthropic::Models::Usage]
+      #   # @param role [Symbol, :assistant]
+      #   # @param type [Symbol, :message]
+      #   #
+      #   def initialize(id:, content:, model:, stop_reason:, stop_sequence:, usage:, role: :assistant, type: :message, **) = super
+
+      # def initialize: (Hash | Anthropic::Internal::Type::BaseModel) -> void
+    end
+  end
+end