anthropic 1.81.0 → 2.0.0

data/lib/anthropic/resources/completions.rb

@@ -1,149 +0,0 @@
-# frozen_string_literal: true
-
-module Anthropic
-  module Resources
-    class Completions
-      # @deprecated Use the [Messages API](https://platform.claude.com/docs/en/api/messages/create)
-      # instead.
-      #
-      # See {Anthropic::Resources::Completions#create_streaming} for streaming
-      # counterpart.
-      #
-      # [Legacy] Create a Text Completion.
-      #
-      # The Text Completions API is a legacy API. We recommend using the
-      # [Messages API](https://platform.claude.com/docs/en/api/messages) going forward.
-      #
-      # Future models and features will not be compatible with Text Completions. See our
-      # [migration guide](https://platform.claude.com/docs/en/build-with-claude/working-with-messages)
-      # for guidance in migrating from Text Completions to Messages.
-      #
-      # Some parameter documentations has been truncated, see
-      # {Anthropic::Models::CompletionCreateParams} for more details.
-      #
-      # @overload create(max_tokens_to_sample:, model:, prompt:, metadata: nil, stop_sequences: nil, temperature: nil, top_k: nil, top_p: nil, betas: nil, workspace_id: nil, request_options: {})
-      #
-      # @param max_tokens_to_sample [Integer] Body param: The maximum number of tokens to generate before stopping.
-      #
-      # @param model [Symbol, String, Anthropic::Models::Model] Body param: The model that will complete your prompt.
-      #
-      # @param prompt [String] Body param: The prompt that you want Claude to complete.
-      #
-      # @param metadata [Anthropic::Models::Metadata] Body param: An object describing metadata about the request.
-      #
-      # @param stop_sequences [Array<String>] Body param: Sequences that will cause the model to stop generating.
-      #
-      # @param temperature [Float] Body param: Amount of randomness injected into the response.
-      #
-      # @param top_k [Integer] Body param: Only sample from the top K options for each subsequent token.
-      #
-      # @param top_p [Float] Body param: Use nucleus sampling.
-      #
-      # @param betas [Array<Symbol, String, Anthropic::Models::AnthropicBeta>] Header param: Optional header to specify the beta version(s) you want to use.
-      #
-      # @param workspace_id [String] Header param: Optional header to select the Workspace for this request. The valu
-      #
-      # @param request_options [Anthropic::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Anthropic::Models::Completion]
-      #
-      # @see Anthropic::Models::CompletionCreateParams
-      def create(params)
-        parsed, options = Anthropic::CompletionCreateParams.dump_request(params)
-        if parsed[:stream]
-          message = "Please use `#create_streaming` for the streaming use case."
-          raise ArgumentError.new(message)
-        end
-        header_params = {betas: "anthropic-beta", workspace_id: "anthropic-workspace-id"}
-        @client.request(
-          span_name: Anthropic::Internal::Tracing::SpanName::COMPLETIONS_CREATE,
-          span_route: "/v1/complete",
-          method: :post,
-          path: "v1/complete",
-          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
-          body: parsed.except(*header_params.keys),
-          model: Anthropic::Completion,
-          options: {timeout: (@client.timeout_overridden? ? @client.timeout : 600), **options}
-        )
-      end
-
-      # @deprecated Use the [Messages API](https://platform.claude.com/docs/en/api/messages/create)
-      # instead.
-      #
-      # See {Anthropic::Resources::Completions#create} for non-streaming counterpart.
-      #
-      # [Legacy] Create a Text Completion.
-      #
-      # The Text Completions API is a legacy API. We recommend using the
-      # [Messages API](https://platform.claude.com/docs/en/api/messages) going forward.
-      #
-      # Future models and features will not be compatible with Text Completions. See our
-      # [migration guide](https://platform.claude.com/docs/en/build-with-claude/working-with-messages)
-      # for guidance in migrating from Text Completions to Messages.
-      #
-      # Some parameter documentations has been truncated, see
-      # {Anthropic::Models::CompletionCreateParams} for more details.
-      #
-      # @overload create_streaming(max_tokens_to_sample:, model:, prompt:, metadata: nil, stop_sequences: nil, temperature: nil, top_k: nil, top_p: nil, betas: nil, workspace_id: nil, request_options: {})
-      #
-      # @param max_tokens_to_sample [Integer] Body param: The maximum number of tokens to generate before stopping.
-      #
-      # @param model [Symbol, String, Anthropic::Models::Model] Body param: The model that will complete your prompt.
-      #
-      # @param prompt [String] Body param: The prompt that you want Claude to complete.
-      #
-      # @param metadata [Anthropic::Models::Metadata] Body param: An object describing metadata about the request.
-      #
-      # @param stop_sequences [Array<String>] Body param: Sequences that will cause the model to stop generating.
-      #
-      # @param temperature [Float] Body param: Amount of randomness injected into the response.
-      #
-      # @param top_k [Integer] Body param: Only sample from the top K options for each subsequent token.
-      #
-      # @param top_p [Float] Body param: Use nucleus sampling.
-      #
-      # @param betas [Array<Symbol, String, Anthropic::Models::AnthropicBeta>] Header param: Optional header to specify the beta version(s) you want to use.
-      #
-      # @param workspace_id [String] Header param: Optional header to select the Workspace for this request. The valu
-      #
-      # @param request_options [Anthropic::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Anthropic::Internal::Type::BaseStream<Anthropic::Models::Completion>]
-      #
-      # @see Anthropic::Models::CompletionCreateParams
-      def create_streaming(params)
-        parsed, options = Anthropic::CompletionCreateParams.dump_request(params)
-        unless parsed.fetch(:stream, true)
-          message = "Please use `#create` for the non-streaming use case."
-          raise ArgumentError.new(message)
-        end
-        parsed.store(:stream, true)
-        header_params = {betas: "anthropic-beta", workspace_id: "anthropic-workspace-id"}
-        @client.request(
-          span_name: Anthropic::Internal::Tracing::SpanName::COMPLETIONS_CREATE,
-          span_route: "/v1/complete",
-          method: :post,
-          path: "v1/complete",
-          headers: {
-            "accept" => "text/event-stream",
-            "accept-encoding" => "identity",
-            **parsed.slice(*header_params.keys)
-          }.transform_keys(
-            header_params
-          ),
-          body: parsed.except(*header_params.keys),
-          stream: Anthropic::Internal::Stream,
-          model: Anthropic::Completion,
-          options: {timeout: (@client.timeout_overridden? ? @client.timeout : 600), **options}
-        )
-      end
-
-      # @api private
-      #
-      # @param client [Anthropic::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/rbi/anthropic/models/completion.rbi

@@ -1,95 +0,0 @@
-# typed: strong
-
-module Anthropic
-  module Models
-    class Completion < Anthropic::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(Anthropic::Completion, Anthropic::Internal::AnyHash)
-        end
-
-      # Unique object identifier.
-      #
-      # The format and length of IDs may change over time.
-      sig { returns(String) }
-      attr_accessor :id
-
-      # The resulting completion up to and excluding the stop sequences.
-      sig { returns(String) }
-      attr_accessor :completion
-
-      # The model that will complete your prompt.
-      #
-      # See [models](https://docs.anthropic.com/en/docs/models-overview) for additional
-      # details and options.
-      sig { returns(Anthropic::Model::Variants) }
-      attr_accessor :model
-
-      # 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
-      sig { returns(T.nilable(String)) }
-      attr_accessor :stop_reason
-
-      # Object type.
-      #
-      # For Text Completions, this is always `"completion"`.
-      sig { returns(Symbol) }
-      attr_accessor :type
-
-      sig do
-        params(
-          id: String,
-          completion: String,
-          model: T.any(Anthropic::Model::OrSymbol, String),
-          stop_reason: T.nilable(String),
-          type: Symbol
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # Unique object identifier.
-        #
-        # The format and length of IDs may change over time.
-        id:,
-        # The resulting completion up to and excluding the stop sequences.
-        completion:,
-        # The model that will complete your prompt.
-        #
-        # See [models](https://docs.anthropic.com/en/docs/models-overview) for additional
-        # details and options.
-        model:,
-        # 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
-        stop_reason:,
-        # Object type.
-        #
-        # For Text Completions, this is always `"completion"`.
-        type: :completion
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            id: String,
-            completion: String,
-            model: Anthropic::Model::Variants,
-            stop_reason: T.nilable(String),
-            type: Symbol
-          }
-        )
-      end
-      def to_hash
-      end
-    end
-  end
-end

data/rbi/anthropic/models/completion_create_params.rbi

@@ -1,236 +0,0 @@
-# typed: strong
-
-module Anthropic
-  module Models
-    class CompletionCreateParams < Anthropic::Internal::Type::BaseModel
-      extend Anthropic::Internal::Type::RequestParameters::Converter
-      include Anthropic::Internal::Type::RequestParameters
-
-      OrHash =
-        T.type_alias do
-          T.any(Anthropic::CompletionCreateParams, Anthropic::Internal::AnyHash)
-        end
-
-      # 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.
-      sig { returns(Integer) }
-      attr_accessor :max_tokens_to_sample
-
-      # The model that will complete your prompt.
-      #
-      # See [models](https://docs.anthropic.com/en/docs/models-overview) for additional
-      # details and options.
-      sig { returns(T.any(Anthropic::Model::OrSymbol, String)) }
-      attr_accessor :model
-
-      # 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://platform.claude.com/docs/en/build-with-claude/working-with-messages)
-      # and our guide to
-      # [prompt design](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/overview)
-      # for more details.
-      sig { returns(String) }
-      attr_accessor :prompt
-
-      # An object describing metadata about the request.
-      sig { returns(T.nilable(Anthropic::Metadata)) }
-      attr_reader :metadata
-
-      sig { params(metadata: Anthropic::Metadata::OrHash).void }
-      attr_writer :metadata
-
-      # 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.
-      sig { returns(T.nilable(T::Array[String])) }
-      attr_reader :stop_sequences
-
-      sig { params(stop_sequences: T::Array[String]).void }
-      attr_writer :stop_sequences
-
-      # 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.
-      sig { returns(T.nilable(Float)) }
-      attr_reader :temperature
-
-      sig { params(temperature: Float).void }
-      attr_writer :temperature
-
-      # 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.
-      sig { returns(T.nilable(Integer)) }
-      attr_reader :top_k
-
-      sig { params(top_k: Integer).void }
-      attr_writer :top_k
-
-      # 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`.
-      #
-      # Recommended for advanced use cases only.
-      sig { returns(T.nilable(Float)) }
-      attr_reader :top_p
-
-      sig { params(top_p: Float).void }
-      attr_writer :top_p
-
-      # Optional header to specify the beta version(s) you want to use.
-      sig do
-        returns(
-          T.nilable(T::Array[T.any(Anthropic::AnthropicBeta::OrSymbol, String)])
-        )
-      end
-      attr_reader :betas
-
-      sig do
-        params(
-          betas: T::Array[T.any(Anthropic::AnthropicBeta::OrSymbol, String)]
-        ).void
-      end
-      attr_writer :betas
-
-      # Optional header to select the Workspace for this request. The value is a
-      # Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
-      #
-      # Only needed for credentials that can act on more than one Workspace. A
-      # credential that belongs to a specific Workspace may omit it; if sent, it must
-      # match that Workspace.
-      sig { returns(T.nilable(String)) }
-      attr_reader :workspace_id
-
-      sig { params(workspace_id: String).void }
-      attr_writer :workspace_id
-
-      sig do
-        params(
-          max_tokens_to_sample: Integer,
-          model: T.any(Anthropic::Model::OrSymbol, String),
-          prompt: String,
-          metadata: Anthropic::Metadata::OrHash,
-          stop_sequences: T::Array[String],
-          temperature: Float,
-          top_k: Integer,
-          top_p: Float,
-          betas: T::Array[T.any(Anthropic::AnthropicBeta::OrSymbol, String)],
-          workspace_id: String,
-          request_options: Anthropic::RequestOptions::OrHash
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # 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.
-        max_tokens_to_sample:,
-        # The model that will complete your prompt.
-        #
-        # See [models](https://docs.anthropic.com/en/docs/models-overview) for additional
-        # details and options.
-        model:,
-        # 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://platform.claude.com/docs/en/build-with-claude/working-with-messages)
-        # and our guide to
-        # [prompt design](https://platform.claude.com/docs/en/build-with-claude/prompt-engineering/overview)
-        # for more details.
-        prompt:,
-        # An object describing metadata about the request.
-        metadata: nil,
-        # 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.
-        stop_sequences: nil,
-        # 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.
-        temperature: nil,
-        # 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.
-        top_k: nil,
-        # 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`.
-        #
-        # Recommended for advanced use cases only.
-        top_p: nil,
-        # Optional header to specify the beta version(s) you want to use.
-        betas: nil,
-        # Optional header to select the Workspace for this request. The value is a
-        # Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).
-        #
-        # Only needed for credentials that can act on more than one Workspace. A
-        # credential that belongs to a specific Workspace may omit it; if sent, it must
-        # match that Workspace.
-        workspace_id: nil,
-        request_options: {}
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            max_tokens_to_sample: Integer,
-            model: T.any(Anthropic::Model::OrSymbol, String),
-            prompt: String,
-            metadata: Anthropic::Metadata,
-            stop_sequences: T::Array[String],
-            temperature: Float,
-            top_k: Integer,
-            top_p: Float,
-            betas: T::Array[T.any(Anthropic::AnthropicBeta::OrSymbol, String)],
-            workspace_id: String,
-            request_options: Anthropic::RequestOptions
-          }
-        )
-      end
-      def to_hash
-      end
-    end
-  end
-end