anthropic 0.0.0 → 0.1.0.pre.beta.9

data/lib/anthropic/models/beta_rate_limit_error.rb

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

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

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

data/lib/anthropic/models/citation_char_location.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class CitationCharLocation < Anthropic::Internal::Type::BaseModel
+      # @!attribute cited_text
+      #
+      #   @return [String]
+      required :cited_text, String
+
+      # @!attribute document_index
+      #
+      #   @return [Integer]
+      required :document_index, Integer
+
+      # @!attribute document_title
+      #
+      #   @return [String, nil]
+      required :document_title, String, nil?: true
+
+      # @!attribute end_char_index
+      #
+      #   @return [Integer]
+      required :end_char_index, Integer
+
+      # @!attribute start_char_index
+      #
+      #   @return [Integer]
+      required :start_char_index, Integer
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :char_location]
+      required :type, const: :char_location
+
+      # @!method initialize(cited_text:, document_index:, document_title:, end_char_index:, start_char_index:, type: :char_location)
+      #   @param cited_text [String]
+      #   @param document_index [Integer]
+      #   @param document_title [String, nil]
+      #   @param end_char_index [Integer]
+      #   @param start_char_index [Integer]
+      #   @param type [Symbol, :char_location]
+    end
+  end
+end

data/lib/anthropic/models/citation_char_location_param.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class CitationCharLocationParam < Anthropic::Internal::Type::BaseModel
+      # @!attribute cited_text
+      #
+      #   @return [String]
+      required :cited_text, String
+
+      # @!attribute document_index
+      #
+      #   @return [Integer]
+      required :document_index, Integer
+
+      # @!attribute document_title
+      #
+      #   @return [String, nil]
+      required :document_title, String, nil?: true
+
+      # @!attribute end_char_index
+      #
+      #   @return [Integer]
+      required :end_char_index, Integer
+
+      # @!attribute start_char_index
+      #
+      #   @return [Integer]
+      required :start_char_index, Integer
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :char_location]
+      required :type, const: :char_location
+
+      # @!method initialize(cited_text:, document_index:, document_title:, end_char_index:, start_char_index:, type: :char_location)
+      #   @param cited_text [String]
+      #   @param document_index [Integer]
+      #   @param document_title [String, nil]
+      #   @param end_char_index [Integer]
+      #   @param start_char_index [Integer]
+      #   @param type [Symbol, :char_location]
+    end
+  end
+end

data/lib/anthropic/models/citation_content_block_location.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class CitationContentBlockLocation < Anthropic::Internal::Type::BaseModel
+      # @!attribute cited_text
+      #
+      #   @return [String]
+      required :cited_text, String
+
+      # @!attribute document_index
+      #
+      #   @return [Integer]
+      required :document_index, Integer
+
+      # @!attribute document_title
+      #
+      #   @return [String, nil]
+      required :document_title, String, nil?: true
+
+      # @!attribute end_block_index
+      #
+      #   @return [Integer]
+      required :end_block_index, Integer
+
+      # @!attribute start_block_index
+      #
+      #   @return [Integer]
+      required :start_block_index, Integer
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :content_block_location]
+      required :type, const: :content_block_location
+
+      # @!method initialize(cited_text:, document_index:, document_title:, end_block_index:, start_block_index:, type: :content_block_location)
+      #   @param cited_text [String]
+      #   @param document_index [Integer]
+      #   @param document_title [String, nil]
+      #   @param end_block_index [Integer]
+      #   @param start_block_index [Integer]
+      #   @param type [Symbol, :content_block_location]
+    end
+  end
+end

data/lib/anthropic/models/citation_content_block_location_param.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class CitationContentBlockLocationParam < Anthropic::Internal::Type::BaseModel
+      # @!attribute cited_text
+      #
+      #   @return [String]
+      required :cited_text, String
+
+      # @!attribute document_index
+      #
+      #   @return [Integer]
+      required :document_index, Integer
+
+      # @!attribute document_title
+      #
+      #   @return [String, nil]
+      required :document_title, String, nil?: true
+
+      # @!attribute end_block_index
+      #
+      #   @return [Integer]
+      required :end_block_index, Integer
+
+      # @!attribute start_block_index
+      #
+      #   @return [Integer]
+      required :start_block_index, Integer
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :content_block_location]
+      required :type, const: :content_block_location
+
+      # @!method initialize(cited_text:, document_index:, document_title:, end_block_index:, start_block_index:, type: :content_block_location)
+      #   @param cited_text [String]
+      #   @param document_index [Integer]
+      #   @param document_title [String, nil]
+      #   @param end_block_index [Integer]
+      #   @param start_block_index [Integer]
+      #   @param type [Symbol, :content_block_location]
+    end
+  end
+end

data/lib/anthropic/models/citation_page_location.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class CitationPageLocation < Anthropic::Internal::Type::BaseModel
+      # @!attribute cited_text
+      #
+      #   @return [String]
+      required :cited_text, String
+
+      # @!attribute document_index
+      #
+      #   @return [Integer]
+      required :document_index, Integer
+
+      # @!attribute document_title
+      #
+      #   @return [String, nil]
+      required :document_title, String, nil?: true
+
+      # @!attribute end_page_number
+      #
+      #   @return [Integer]
+      required :end_page_number, Integer
+
+      # @!attribute start_page_number
+      #
+      #   @return [Integer]
+      required :start_page_number, Integer
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :page_location]
+      required :type, const: :page_location
+
+      # @!method initialize(cited_text:, document_index:, document_title:, end_page_number:, start_page_number:, type: :page_location)
+      #   @param cited_text [String]
+      #   @param document_index [Integer]
+      #   @param document_title [String, nil]
+      #   @param end_page_number [Integer]
+      #   @param start_page_number [Integer]
+      #   @param type [Symbol, :page_location]
+    end
+  end
+end

data/lib/anthropic/models/citation_page_location_param.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class CitationPageLocationParam < Anthropic::Internal::Type::BaseModel
+      # @!attribute cited_text
+      #
+      #   @return [String]
+      required :cited_text, String
+
+      # @!attribute document_index
+      #
+      #   @return [Integer]
+      required :document_index, Integer
+
+      # @!attribute document_title
+      #
+      #   @return [String, nil]
+      required :document_title, String, nil?: true
+
+      # @!attribute end_page_number
+      #
+      #   @return [Integer]
+      required :end_page_number, Integer
+
+      # @!attribute start_page_number
+      #
+      #   @return [Integer]
+      required :start_page_number, Integer
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :page_location]
+      required :type, const: :page_location
+
+      # @!method initialize(cited_text:, document_index:, document_title:, end_page_number:, start_page_number:, type: :page_location)
+      #   @param cited_text [String]
+      #   @param document_index [Integer]
+      #   @param document_title [String, nil]
+      #   @param end_page_number [Integer]
+      #   @param start_page_number [Integer]
+      #   @param type [Symbol, :page_location]
+    end
+  end
+end

data/lib/anthropic/models/citation_web_search_result_location_param.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class CitationWebSearchResultLocationParam < Anthropic::Internal::Type::BaseModel
+      # @!attribute cited_text
+      #
+      #   @return [String]
+      required :cited_text, String
+
+      # @!attribute encrypted_index
+      #
+      #   @return [String]
+      required :encrypted_index, String
+
+      # @!attribute title
+      #
+      #   @return [String, nil]
+      required :title, String, nil?: true
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :web_search_result_location]
+      required :type, const: :web_search_result_location
+
+      # @!attribute url
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!method initialize(cited_text:, encrypted_index:, title:, url:, type: :web_search_result_location)
+      #   @param cited_text [String]
+      #   @param encrypted_index [String]
+      #   @param title [String, nil]
+      #   @param url [String]
+      #   @param type [Symbol, :web_search_result_location]
+    end
+  end
+end

data/lib/anthropic/models/citations_config_param.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class CitationsConfigParam < Anthropic::Internal::Type::BaseModel
+      # @!attribute enabled
+      #
+      #   @return [Boolean, nil]
+      optional :enabled, Anthropic::Internal::Type::Boolean
+
+      # @!method initialize(enabled: nil)
+      #   @param enabled [Boolean]
+    end
+  end
+end

data/lib/anthropic/models/citations_delta.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class CitationsDelta < Anthropic::Internal::Type::BaseModel
+      # @!attribute citation
+      #
+      #   @return [Anthropic::CitationCharLocation, Anthropic::CitationPageLocation, Anthropic::CitationContentBlockLocation, Anthropic::CitationsWebSearchResultLocation]
+      required :citation, union: -> { Anthropic::CitationsDelta::Citation }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :citations_delta]
+      required :type, const: :citations_delta
+
+      # @!method initialize(citation:, type: :citations_delta)
+      #   @param citation [Anthropic::CitationCharLocation, Anthropic::CitationPageLocation, Anthropic::CitationContentBlockLocation, Anthropic::CitationsWebSearchResultLocation]
+      #   @param type [Symbol, :citations_delta]
+
+      # @see Anthropic::CitationsDelta#citation
+      module Citation
+        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
+end

data/lib/anthropic/models/citations_web_search_result_location.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    class CitationsWebSearchResultLocation < Anthropic::Internal::Type::BaseModel
+      # @!attribute cited_text
+      #
+      #   @return [String]
+      required :cited_text, String
+
+      # @!attribute encrypted_index
+      #
+      #   @return [String]
+      required :encrypted_index, String
+
+      # @!attribute title
+      #
+      #   @return [String, nil]
+      required :title, String, nil?: true
+
+      # @!attribute type
+      #
+      #   @return [Symbol, :web_search_result_location]
+      required :type, const: :web_search_result_location
+
+      # @!attribute url
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!method initialize(cited_text:, encrypted_index:, title:, url:, type: :web_search_result_location)
+      #   @param cited_text [String]
+      #   @param encrypted_index [String]
+      #   @param title [String, nil]
+      #   @param url [String]
+      #   @param type [Symbol, :web_search_result_location]
+    end
+  end
+end

data/lib/anthropic/models/completion.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Anthropic
+  module Models
+    # @see Anthropic::Resources::Completions#create
+    #
+    # @see Anthropic::Resources::Completions#create_streaming
+    class Completion < 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 completion
+      #   The resulting completion up to and excluding the stop sequences.
+      #
+      #   @return [String]
+      required :completion, String
+
+      # @!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::Model]
+      required :model, union: -> { Anthropic::Model }
+
+      # @!attribute stop_reason
+      #   The reason that we stopped.
+      #
+      #   This may be one the following values:
+      #
+      #   - `"stop_sequence"`: we reached a stop sequence — either provided by you via the
+      #     `stop_sequences` parameter, or a stop sequence built into the model
+      #   - `"max_tokens"`: we exceeded `max_tokens_to_sample` or the model's maximum
+      #
+      #   @return [String, nil]
+      required :stop_reason, String, nil?: true
+
+      # @!attribute type
+      #   Object type.
+      #
+      #   For Text Completions, this is always `"completion"`.
+      #
+      #   @return [Symbol, :completion]
+      required :type, const: :completion
+
+      # @!method initialize(id:, completion:, model:, stop_reason:, type: :completion)
+      #   Some parameter documentations has been truncated, see {Anthropic::Completion}
+      #   for more details.
+      #
+      #   @param id [String] Unique object identifier.
+      #
+      #   @param completion [String] The resulting completion up to and excluding the stop sequences.
+      #
+      #   @param model [Symbol, String, Anthropic::Model] The model that will complete your prompt.\n\nSee [models](https://docs.anthropic
+      #
+      #   @param stop_reason [String, nil] The reason that we stopped.
+      #
+      #   @param type [Symbol, :completion] Object type.
+    end
+  end
+end

data/lib/anthropic/models/completion_create_params.rb

@@ -0,0 +1,133 @@
+# 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
+      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::Model]
+      required :model, union: -> { Anthropic::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 metadata
+      #   An object describing metadata about the request.
+      #
+      #   @return [Anthropic::Metadata, nil]
+      optional :metadata, -> { Anthropic::Metadata }
+
+      # @!attribute 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]
+
+      # @!attribute 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
+
+      # @!attribute 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
+
+      # @!attribute 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
+
+      # @!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(max_tokens_to_sample:, model:, prompt:, metadata: nil, stop_sequences: nil, temperature: nil, top_k: nil, top_p: nil, betas: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Anthropic::Models::CompletionCreateParams} for more details.
+      #
+      #   @param max_tokens_to_sample [Integer] The maximum number of tokens to generate before stopping.
+      #
+      #   @param model [Symbol, String, Anthropic::Model] The model that will complete your prompt.\n\nSee [models](https://docs.anthropic
+      #
+      #   @param prompt [String] The prompt that you want Claude to complete.
+      #
+      #   @param metadata [Anthropic::Metadata] An object describing metadata about the request.
+      #
+      #   @param stop_sequences [Array<String>] Sequences that will cause the model to stop generating.
+      #
+      #   @param temperature [Float] Amount of randomness injected into the response.
+      #
+      #   @param top_k [Integer] Only sample from the top K options for each subsequent token.
+      #
+      #   @param top_p [Float] Use nucleus sampling.
+      #
+      #   @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