anthropic 0.0.0 → 0.1.0.pre.beta.9

data/lib/anthropic/models/messages/message_batch.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Messages
+      # @see Anthropic::Resources::Messages::Batches#create
+      class MessageBatch < 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 archived_at
+        #   RFC 3339 datetime string representing the time at which the Message Batch was
+        #   archived and its results became unavailable.
+        #
+        #   @return [Time, nil]
+        required :archived_at, Time, nil?: true
+
+        # @!attribute cancel_initiated_at
+        #   RFC 3339 datetime string representing the time at which cancellation was
+        #   initiated for the Message Batch. Specified only if cancellation was initiated.
+        #
+        #   @return [Time, nil]
+        required :cancel_initiated_at, Time, nil?: true
+
+        # @!attribute created_at
+        #   RFC 3339 datetime string representing the time at which the Message Batch was
+        #   created.
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute ended_at
+        #   RFC 3339 datetime string representing the time at which processing for the
+        #   Message Batch ended. Specified only once processing ends.
+        #
+        #   Processing ends when every request in a Message Batch has either succeeded,
+        #   errored, canceled, or expired.
+        #
+        #   @return [Time, nil]
+        required :ended_at, Time, nil?: true
+
+        # @!attribute expires_at
+        #   RFC 3339 datetime string representing the time at which the Message Batch will
+        #   expire and end processing, which is 24 hours after creation.
+        #
+        #   @return [Time]
+        required :expires_at, Time
+
+        # @!attribute processing_status
+        #   Processing status of the Message Batch.
+        #
+        #   @return [Symbol, Anthropic::Messages::MessageBatch::ProcessingStatus]
+        required :processing_status, enum: -> { Anthropic::Messages::MessageBatch::ProcessingStatus }
+
+        # @!attribute request_counts
+        #   Tallies requests within the Message Batch, categorized by their status.
+        #
+        #   Requests start as `processing` and move to one of the other statuses only once
+        #   processing of the entire batch ends. The sum of all values always matches the
+        #   total number of requests in the batch.
+        #
+        #   @return [Anthropic::Messages::MessageBatchRequestCounts]
+        required :request_counts, -> { Anthropic::Messages::MessageBatchRequestCounts }
+
+        # @!attribute results_url
+        #   URL to a `.jsonl` file containing the results of the Message Batch requests.
+        #   Specified only once processing ends.
+        #
+        #   Results in the file are not guaranteed to be in the same order as requests. Use
+        #   the `custom_id` field to match results to requests.
+        #
+        #   @return [String, nil]
+        required :results_url, String, nil?: true
+
+        # @!attribute type
+        #   Object type.
+        #
+        #   For Message Batches, this is always `"message_batch"`.
+        #
+        #   @return [Symbol, :message_batch]
+        required :type, const: :message_batch
+
+        # @!method initialize(id:, archived_at:, cancel_initiated_at:, created_at:, ended_at:, expires_at:, processing_status:, request_counts:, results_url:, type: :message_batch)
+        #   Some parameter documentations has been truncated, see
+        #   {Anthropic::Messages::MessageBatch} for more details.
+        #
+        #   @param id [String] Unique object identifier.
+        #
+        #   @param archived_at [Time, nil] RFC 3339 datetime string representing the time at which the Message Batch was ar
+        #
+        #   @param cancel_initiated_at [Time, nil] RFC 3339 datetime string representing the time at which cancellation was initiat
+        #
+        #   @param created_at [Time] RFC 3339 datetime string representing the time at which the Message Batch was cr
+        #
+        #   @param ended_at [Time, nil] RFC 3339 datetime string representing the time at which processing for the Messa
+        #
+        #   @param expires_at [Time] RFC 3339 datetime string representing the time at which the Message Batch will e
+        #
+        #   @param processing_status [Symbol, Anthropic::Messages::MessageBatch::ProcessingStatus] Processing status of the Message Batch.
+        #
+        #   @param request_counts [Anthropic::Messages::MessageBatchRequestCounts] Tallies requests within the Message Batch, categorized by their status.
+        #
+        #   @param results_url [String, nil] URL to a `.jsonl` file containing the results of the Message Batch requests. Spe
+        #
+        #   @param type [Symbol, :message_batch] Object type.
+
+        # Processing status of the Message Batch.
+        #
+        # @see Anthropic::Messages::MessageBatch#processing_status
+        module ProcessingStatus
+          extend Anthropic::Internal::Type::Enum
+
+          IN_PROGRESS = :in_progress
+          CANCELING = :canceling
+          ENDED = :ended
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+
+    MessageBatch = Messages::MessageBatch
+  end
+end

data/lib/anthropic/models/messages/message_batch_canceled_result.rb

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

data/lib/anthropic/models/messages/message_batch_errored_result.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Messages
+      class MessageBatchErroredResult < Anthropic::Internal::Type::BaseModel
+        # @!attribute error
+        #
+        #   @return [Anthropic::ErrorResponse]
+        required :error, -> { Anthropic::ErrorResponse }
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :errored]
+        required :type, const: :errored
+
+        # @!method initialize(error:, type: :errored)
+        #   @param error [Anthropic::ErrorResponse]
+        #   @param type [Symbol, :errored]
+      end
+    end
+
+    MessageBatchErroredResult = Messages::MessageBatchErroredResult
+  end
+end

data/lib/anthropic/models/messages/message_batch_expired_result.rb

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

data/lib/anthropic/models/messages/message_batch_individual_response.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Messages
+      # @see Anthropic::Resources::Messages::Batches#results_streaming
+      class MessageBatchIndividualResponse < Anthropic::Internal::Type::BaseModel
+        # @!attribute custom_id
+        #   Developer-provided ID created for each request in a Message Batch. Useful for
+        #   matching results to requests, as results may be given out of request order.
+        #
+        #   Must be unique for each request within the Message Batch.
+        #
+        #   @return [String]
+        required :custom_id, String
+
+        # @!attribute result
+        #   Processing result for this request.
+        #
+        #   Contains a Message output if processing was successful, an error response if
+        #   processing failed, or the reason why processing was not attempted, such as
+        #   cancellation or expiration.
+        #
+        #   @return [Anthropic::Messages::MessageBatchSucceededResult, Anthropic::Messages::MessageBatchErroredResult, Anthropic::Messages::MessageBatchCanceledResult, Anthropic::Messages::MessageBatchExpiredResult]
+        required :result, union: -> { Anthropic::Messages::MessageBatchResult }
+
+        # @!method initialize(custom_id:, result:)
+        #   Some parameter documentations has been truncated, see
+        #   {Anthropic::Messages::MessageBatchIndividualResponse} for more details.
+        #
+        #   This is a single line in the response `.jsonl` file and does not represent the
+        #   response as a whole.
+        #
+        #   @param custom_id [String] Developer-provided ID created for each request in a Message Batch. Useful for ma
+        #
+        #   @param result [Anthropic::Messages::MessageBatchSucceededResult, Anthropic::Messages::MessageBatchErroredResult, Anthropic::Messages::MessageBatchCanceledResult, Anthropic::Messages::MessageBatchExpiredResult] Processing result for this request.
+      end
+    end
+
+    MessageBatchIndividualResponse = Messages::MessageBatchIndividualResponse
+  end
+end

data/lib/anthropic/models/messages/message_batch_request_counts.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Messages
+      class MessageBatchRequestCounts < Anthropic::Internal::Type::BaseModel
+        # @!attribute canceled
+        #   Number of requests in the Message Batch that have been canceled.
+        #
+        #   This is zero until processing of the entire Message Batch has ended.
+        #
+        #   @return [Integer]
+        required :canceled, Integer
+
+        # @!attribute errored
+        #   Number of requests in the Message Batch that encountered an error.
+        #
+        #   This is zero until processing of the entire Message Batch has ended.
+        #
+        #   @return [Integer]
+        required :errored, Integer
+
+        # @!attribute expired
+        #   Number of requests in the Message Batch that have expired.
+        #
+        #   This is zero until processing of the entire Message Batch has ended.
+        #
+        #   @return [Integer]
+        required :expired, Integer
+
+        # @!attribute processing
+        #   Number of requests in the Message Batch that are processing.
+        #
+        #   @return [Integer]
+        required :processing, Integer
+
+        # @!attribute succeeded
+        #   Number of requests in the Message Batch that have completed successfully.
+        #
+        #   This is zero until processing of the entire Message Batch has ended.
+        #
+        #   @return [Integer]
+        required :succeeded, Integer
+
+        # @!method initialize(canceled:, errored:, expired:, processing:, succeeded:)
+        #   Some parameter documentations has been truncated, see
+        #   {Anthropic::Messages::MessageBatchRequestCounts} for more details.
+        #
+        #   @param canceled [Integer] Number of requests in the Message Batch that have been canceled.
+        #
+        #   @param errored [Integer] Number of requests in the Message Batch that encountered an error.
+        #
+        #   @param expired [Integer] Number of requests in the Message Batch that have expired.
+        #
+        #   @param processing [Integer] Number of requests in the Message Batch that are processing.
+        #
+        #   @param succeeded [Integer] Number of requests in the Message Batch that have completed successfully.
+      end
+    end
+
+    MessageBatchRequestCounts = Messages::MessageBatchRequestCounts
+  end
+end

data/lib/anthropic/models/messages/message_batch_result.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Messages
+      # Processing result for this request.
+      #
+      # Contains a Message output if processing was successful, an error response if
+      # processing failed, or the reason why processing was not attempted, such as
+      # cancellation or expiration.
+      module MessageBatchResult
+        extend Anthropic::Internal::Type::Union
+
+        discriminator :type
+
+        variant :succeeded, -> { Anthropic::Messages::MessageBatchSucceededResult }
+
+        variant :errored, -> { Anthropic::Messages::MessageBatchErroredResult }
+
+        variant :canceled, -> { Anthropic::Messages::MessageBatchCanceledResult }
+
+        variant :expired, -> { Anthropic::Messages::MessageBatchExpiredResult }
+
+        # @!method self.variants
+        #   @return [Array(Anthropic::Messages::MessageBatchSucceededResult, Anthropic::Messages::MessageBatchErroredResult, Anthropic::Messages::MessageBatchCanceledResult, Anthropic::Messages::MessageBatchExpiredResult)]
+      end
+    end
+
+    MessageBatchResult = Messages::MessageBatchResult
+  end
+end

data/lib/anthropic/models/messages/message_batch_succeeded_result.rb

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

data/lib/anthropic/models/metadata.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class Metadata < Anthropic::Internal::Type::BaseModel
+      # @!attribute user_id
+      #   An external identifier for the user who is associated with the request.
+      #
+      #   This should be a uuid, hash value, or other opaque identifier. Anthropic may use
+      #   this id to help detect abuse. Do not include any identifying information such as
+      #   name, email address, or phone number.
+      #
+      #   @return [String, nil]
+      optional :user_id, String, nil?: true
+
+      # @!method initialize(user_id: nil)
+      #   Some parameter documentations has been truncated, see {Anthropic::Metadata} for
+      #   more details.
+      #
+      #   @param user_id [String, nil] An external identifier for the user who is associated with the request.
+    end
+  end
+end

data/lib/anthropic/models/model.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    # The model that will complete your prompt.\n\nSee
+    # [models](https://docs.anthropic.com/en/docs/models-overview) for additional
+    # details and options.
+    module Model
+      extend Anthropic::Internal::Type::Union
+
+      variant const: -> { Anthropic::Model::CLAUDE_3_7_SONNET_LATEST }
+
+      variant const: -> { Anthropic::Model::CLAUDE_3_7_SONNET_20250219 }
+
+      variant const: -> { Anthropic::Model::CLAUDE_3_5_HAIKU_LATEST }
+
+      variant const: -> { Anthropic::Model::CLAUDE_3_5_HAIKU_20241022 }
+
+      variant const: -> { Anthropic::Model::CLAUDE_3_5_SONNET_LATEST }
+
+      variant const: -> { Anthropic::Model::CLAUDE_3_5_SONNET_20241022 }
+
+      variant const: -> { Anthropic::Model::CLAUDE_3_5_SONNET_20240620 }
+
+      variant const: -> { Anthropic::Model::CLAUDE_3_OPUS_LATEST }
+
+      variant const: -> { Anthropic::Model::CLAUDE_3_OPUS_20240229 }
+
+      variant const: -> { Anthropic::Model::CLAUDE_3_SONNET_20240229 }
+
+      variant const: -> { Anthropic::Model::CLAUDE_3_HAIKU_20240307 }
+
+      variant const: -> { Anthropic::Model::CLAUDE_2_1 }
+
+      variant const: -> { Anthropic::Model::CLAUDE_2_0 }
+
+      variant String
+
+      # @!method self.variants
+      #   @return [Array(Symbol, String)]
+
+      define_sorbet_constant!(:Variants) do
+        T.type_alias { T.any(Anthropic::Model::TaggedSymbol, String) }
+      end
+
+      # @!group
+
+      # Our most intelligent model
+      CLAUDE_3_7_SONNET_LATEST = :"claude-3-7-sonnet-latest"
+
+      # Our most intelligent model
+      CLAUDE_3_7_SONNET_20250219 = :"claude-3-7-sonnet-20250219"
+
+      # Fastest and most compact model for near-instant responsiveness
+      CLAUDE_3_5_HAIKU_LATEST = :"claude-3-5-haiku-latest"
+
+      # Our fastest model
+      CLAUDE_3_5_HAIKU_20241022 = :"claude-3-5-haiku-20241022"
+
+      # Our previous most intelligent model
+      CLAUDE_3_5_SONNET_LATEST = :"claude-3-5-sonnet-latest"
+
+      # Our previous most intelligent model
+      CLAUDE_3_5_SONNET_20241022 = :"claude-3-5-sonnet-20241022"
+
+      CLAUDE_3_5_SONNET_20240620 = :"claude-3-5-sonnet-20240620"
+
+      # Excels at writing and complex tasks
+      CLAUDE_3_OPUS_LATEST = :"claude-3-opus-latest"
+
+      # Excels at writing and complex tasks
+      CLAUDE_3_OPUS_20240229 = :"claude-3-opus-20240229"
+
+      # Balance of speed and intelligence
+      # @deprecated Will reach end-of-life on July 21st, 2025. Please migrate to a newer model.
+      # Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more
+      # information.
+      CLAUDE_3_SONNET_20240229 = :"claude-3-sonnet-20240229"
+
+      # Our previous most fast and cost-effective
+      CLAUDE_3_HAIKU_20240307 = :"claude-3-haiku-20240307"
+
+      # @deprecated Will reach end-of-life on July 21st, 2025. Please migrate to a newer model.
+      # Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more
+      # information.
+      CLAUDE_2_1 = :"claude-2.1"
+
+      # @deprecated Will reach end-of-life on July 21st, 2025. Please migrate to a newer model.
+      # Visit https://docs.anthropic.com/en/docs/resources/model-deprecations for more
+      # information.
+      CLAUDE_2_0 = :"claude-2.0"
+
+      # @!endgroup
+    end
+  end
+end

data/lib/anthropic/models/model_info.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    # @see Anthropic::Resources::Models#retrieve
+    class ModelInfo < Anthropic::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique model identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   RFC 3339 datetime string representing the time at which the model was released.
+      #   May be set to an epoch value if the release date is unknown.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute display_name
+      #   A human-readable name for the model.
+      #
+      #   @return [String]
+      required :display_name, String
+
+      # @!attribute type
+      #   Object type.
+      #
+      #   For Models, this is always `"model"`.
+      #
+      #   @return [Symbol, :model]
+      required :type, const: :model
+
+      # @!method initialize(id:, created_at:, display_name:, type: :model)
+      #   Some parameter documentations has been truncated, see {Anthropic::ModelInfo} for
+      #   more details.
+      #
+      #   @param id [String] Unique model identifier.
+      #
+      #   @param created_at [Time] RFC 3339 datetime string representing the time at which the model was released.
+      #
+      #   @param display_name [String] A human-readable name for the model.
+      #
+      #   @param type [Symbol, :model] Object type.
+    end
+  end
+end

data/lib/anthropic/models/model_list_params.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    # @see Anthropic::Resources::Models#list
+    class ModelListParams < Anthropic::Internal::Type::BaseModel
+      extend Anthropic::Internal::Type::RequestParameters::Converter
+      include Anthropic::Internal::Type::RequestParameters
+
+      # @!attribute after_id
+      #   ID of the object to use as a cursor for pagination. When provided, returns the
+      #   page of results immediately after this object.
+      #
+      #   @return [String, nil]
+      optional :after_id, String
+
+      # @!attribute before_id
+      #   ID of the object to use as a cursor for pagination. When provided, returns the
+      #   page of results immediately before this object.
+      #
+      #   @return [String, nil]
+      optional :before_id, String
+
+      # @!attribute limit
+      #   Number of items to return per page.
+      #
+      #   Defaults to `20`. Ranges from `1` to `1000`.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute betas
+      #   Optional header to specify the beta version(s) you want to use.
+      #
+      #   @return [Array<String, Symbol, Anthropic::AnthropicBeta>, nil]
+      optional :betas, -> { Anthropic::Internal::Type::ArrayOf[union: Anthropic::AnthropicBeta] }
+
+      # @!method initialize(after_id: nil, before_id: nil, limit: nil, betas: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Anthropic::Models::ModelListParams} for more details.
+      #
+      #   @param after_id [String] ID of the object to use as a cursor for pagination. When provided, returns the p
+      #
+      #   @param before_id [String] ID of the object to use as a cursor for pagination. When provided, returns the p
+      #
+      #   @param limit [Integer] Number of items to return per page.
+      #
+      #   @param betas [Array<String, Symbol, Anthropic::AnthropicBeta>] Optional header to specify the beta version(s) you want to use.
+      #
+      #   @param request_options [Anthropic::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/anthropic/models/model_retrieve_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    # @see Anthropic::Resources::Models#retrieve
+    class ModelRetrieveParams < Anthropic::Internal::Type::BaseModel
+      extend Anthropic::Internal::Type::RequestParameters::Converter
+      include Anthropic::Internal::Type::RequestParameters
+
+      # @!attribute betas
+      #   Optional header to specify the beta version(s) you want to use.
+      #
+      #   @return [Array<String, Symbol, Anthropic::AnthropicBeta>, nil]
+      optional :betas, -> { Anthropic::Internal::Type::ArrayOf[union: Anthropic::AnthropicBeta] }
+
+      # @!method initialize(betas: nil, request_options: {})
+      #   @param betas [Array<String, Symbol, Anthropic::AnthropicBeta>] Optional header to specify the beta version(s) you want to use.
+      #
+      #   @param request_options [Anthropic::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/anthropic/models/not_found_error.rb

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

data/lib/anthropic/models/overloaded_error.rb

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

data/lib/anthropic/models/permission_error.rb

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