anthropic 0.4.0 → 1.0.0

data/lib/anthropic/models/beta/messages/beta_message_batch.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Beta
+      module Messages
+        # @see Anthropic::Resources::Beta::Messages::Batches#create
+        class BetaMessageBatch < 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::Beta::Messages::BetaMessageBatch::ProcessingStatus]
+          required :processing_status,
+                   enum: -> {
+                     Anthropic::Beta::Messages::BetaMessageBatch::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::Beta::Messages::BetaMessageBatchRequestCounts]
+          required :request_counts, -> { Anthropic::Beta::Messages::BetaMessageBatchRequestCounts }
+
+          # @!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::Beta::Messages::BetaMessageBatch} 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::Beta::Messages::BetaMessageBatch::ProcessingStatus] Processing status of the Message Batch.
+          #
+          #   @param request_counts [Anthropic::Beta::Messages::BetaMessageBatchRequestCounts] 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::Beta::Messages::BetaMessageBatch#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
+    end
+  end
+end

data/lib/anthropic/models/beta/messages/beta_message_batch_canceled_result.rb

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

data/lib/anthropic/models/beta/messages/beta_message_batch_errored_result.rb

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

data/lib/anthropic/models/beta/messages/beta_message_batch_expired_result.rb

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

data/lib/anthropic/models/beta/messages/beta_message_batch_individual_response.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Beta
+      module Messages
+        # @see Anthropic::Resources::Beta::Messages::Batches#results_streaming
+        class BetaMessageBatchIndividualResponse < 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::Beta::Messages::BetaMessageBatchSucceededResult, Anthropic::Beta::Messages::BetaMessageBatchErroredResult, Anthropic::Beta::Messages::BetaMessageBatchCanceledResult, Anthropic::Beta::Messages::BetaMessageBatchExpiredResult]
+          required :result, union: -> { Anthropic::Beta::Messages::BetaMessageBatchResult }
+
+          # @!method initialize(custom_id:, result:)
+          #   Some parameter documentations has been truncated, see
+          #   {Anthropic::Beta::Messages::BetaMessageBatchIndividualResponse} 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::Beta::Messages::BetaMessageBatchSucceededResult, Anthropic::Beta::Messages::BetaMessageBatchErroredResult, Anthropic::Beta::Messages::BetaMessageBatchCanceledResult, Anthropic::Beta::Messages::BetaMessageBatchExpiredResult] Processing result for this request.
+        end
+      end
+    end
+  end
+end

data/lib/anthropic/models/beta/messages/beta_message_batch_request_counts.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Beta
+      module Messages
+        class BetaMessageBatchRequestCounts < 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::Beta::Messages::BetaMessageBatchRequestCounts} 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
+    end
+  end
+end

data/lib/anthropic/models/beta/messages/beta_message_batch_result.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Beta
+      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 BetaMessageBatchResult
+          extend Anthropic::Internal::Type::Union
+
+          discriminator :type
+
+          variant :succeeded, -> { Anthropic::Beta::Messages::BetaMessageBatchSucceededResult }
+
+          variant :errored, -> { Anthropic::Beta::Messages::BetaMessageBatchErroredResult }
+
+          variant :canceled, -> { Anthropic::Beta::Messages::BetaMessageBatchCanceledResult }
+
+          variant :expired, -> { Anthropic::Beta::Messages::BetaMessageBatchExpiredResult }
+
+          # @!method self.variants
+          #   @return [Array(Anthropic::Beta::Messages::BetaMessageBatchSucceededResult, Anthropic::Beta::Messages::BetaMessageBatchErroredResult, Anthropic::Beta::Messages::BetaMessageBatchCanceledResult, Anthropic::Beta::Messages::BetaMessageBatchExpiredResult)]
+        end
+      end
+    end
+  end
+end

data/lib/anthropic/models/beta/messages/beta_message_batch_succeeded_result.rb

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

data/lib/anthropic/models/beta/model_list_params.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Beta
+      # @see Anthropic::Resources::Beta::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::Beta::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
+end

data/lib/anthropic/models/beta/model_retrieve_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module Beta
+      # @see Anthropic::Resources::Beta::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
+end

data/lib/anthropic/models/beta_api_error.rb

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

data/lib/anthropic/models/beta_authentication_error.rb

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

data/lib/anthropic/models/beta_billing_error.rb

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

data/lib/anthropic/models/beta_error.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    module BetaError
+      extend Anthropic::Internal::Type::Union
+
+      discriminator :type
+
+      variant :invalid_request_error, -> { Anthropic::BetaInvalidRequestError }
+
+      variant :authentication_error, -> { Anthropic::BetaAuthenticationError }
+
+      variant :billing_error, -> { Anthropic::BetaBillingError }
+
+      variant :permission_error, -> { Anthropic::BetaPermissionError }
+
+      variant :not_found_error, -> { Anthropic::BetaNotFoundError }
+
+      variant :rate_limit_error, -> { Anthropic::BetaRateLimitError }
+
+      variant :timeout_error, -> { Anthropic::BetaGatewayTimeoutError }
+
+      variant :api_error, -> { Anthropic::BetaAPIError }
+
+      variant :overloaded_error, -> { Anthropic::BetaOverloadedError }
+
+      # @!method self.variants
+      #   @return [Array(Anthropic::BetaInvalidRequestError, Anthropic::BetaAuthenticationError, Anthropic::BetaBillingError, Anthropic::BetaPermissionError, Anthropic::BetaNotFoundError, Anthropic::BetaRateLimitError, Anthropic::BetaGatewayTimeoutError, Anthropic::BetaAPIError, Anthropic::BetaOverloadedError)]
+    end
+  end
+end

data/lib/anthropic/models/beta_error_response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class BetaErrorResponse < Anthropic::Internal::Type::BaseModel
+      # @!attribute error
+      #
+      #   @return [Anthropic::BetaInvalidRequestError, Anthropic::BetaAuthenticationError, Anthropic::BetaBillingError, Anthropic::BetaPermissionError, Anthropic::BetaNotFoundError, Anthropic::BetaRateLimitError, Anthropic::BetaGatewayTimeoutError, Anthropic::BetaAPIError, Anthropic::BetaOverloadedError]
+      required :error, union: -> { Anthropic::BetaError }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :error]
+      required :type, const: :error
+
+      # @!method initialize(error:, type: :error)
+      #   @param error [Anthropic::BetaInvalidRequestError, Anthropic::BetaAuthenticationError, Anthropic::BetaBillingError, Anthropic::BetaPermissionError, Anthropic::BetaNotFoundError, Anthropic::BetaRateLimitError, Anthropic::BetaGatewayTimeoutError, Anthropic::BetaAPIError, Anthropic::BetaOverloadedError]
+      #   @param type [Symbol, :error]
+    end
+  end
+end

data/lib/anthropic/models/beta_gateway_timeout_error.rb

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

data/lib/anthropic/models/beta_invalid_request_error.rb

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

data/lib/anthropic/models/beta_not_found_error.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class BetaNotFoundError < 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/beta_overloaded_error.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class BetaOverloadedError < 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/beta_permission_error.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class BetaPermissionError < 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