openai 0.1.0.pre.beta.2 → 0.1.0

data/rbi/openai/resources/chat.rbi

@@ -1,15 +0,0 @@
-# typed: strong
-
-module OpenAI
-  module Resources
-    class Chat
-      sig { returns(OpenAI::Resources::Chat::Completions) }
-      attr_reader :completions
-
-      # @api private
-      sig { params(client: OpenAI::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
-    end
-  end
-end

data/rbi/openai/resources/completions.rbi

@@ -1,292 +0,0 @@
-# typed: strong
-
-module OpenAI
-  module Resources
-    class Completions
-      # See {OpenAI::Resources::Completions#create_streaming} for streaming counterpart.
-      #
-      # Creates a completion for the provided prompt and parameters.
-      sig do
-        params(
-          model: T.any(String, OpenAI::CompletionCreateParams::Model::OrSymbol),
-          prompt: T.nilable(OpenAI::CompletionCreateParams::Prompt::Variants),
-          best_of: T.nilable(Integer),
-          echo: T.nilable(T::Boolean),
-          frequency_penalty: T.nilable(Float),
-          logit_bias: T.nilable(T::Hash[Symbol, Integer]),
-          logprobs: T.nilable(Integer),
-          max_tokens: T.nilable(Integer),
-          n: T.nilable(Integer),
-          presence_penalty: T.nilable(Float),
-          seed: T.nilable(Integer),
-          stop: T.nilable(OpenAI::CompletionCreateParams::Stop::Variants),
-          stream_options:
-            T.nilable(OpenAI::Chat::ChatCompletionStreamOptions::OrHash),
-          suffix: T.nilable(String),
-          temperature: T.nilable(Float),
-          top_p: T.nilable(Float),
-          user: String,
-          stream: T.noreturn,
-          request_options: OpenAI::RequestOptions::OrHash
-        ).returns(OpenAI::Completion)
-      end
-      def create(
-        # ID of the model to use. You can use the
-        # [List models](https://platform.openai.com/docs/api-reference/models/list) API to
-        # see all of your available models, or see our
-        # [Model overview](https://platform.openai.com/docs/models) for descriptions of
-        # them.
-        model:,
-        # The prompt(s) to generate completions for, encoded as a string, array of
-        # strings, array of tokens, or array of token arrays.
-        #
-        # Note that <|endoftext|> is the document separator that the model sees during
-        # training, so if a prompt is not specified the model will generate as if from the
-        # beginning of a new document.
-        prompt:,
-        # Generates `best_of` completions server-side and returns the "best" (the one with
-        # the highest log probability per token). Results cannot be streamed.
-        #
-        # When used with `n`, `best_of` controls the number of candidate completions and
-        # `n` specifies how many to return – `best_of` must be greater than `n`.
-        #
-        # **Note:** Because this parameter generates many completions, it can quickly
-        # consume your token quota. Use carefully and ensure that you have reasonable
-        # settings for `max_tokens` and `stop`.
-        best_of: nil,
-        # Echo back the prompt in addition to the completion
-        echo: nil,
-        # Number between -2.0 and 2.0. Positive values penalize new tokens based on their
-        # existing frequency in the text so far, decreasing the model's likelihood to
-        # repeat the same line verbatim.
-        #
-        # [See more information about frequency and presence penalties.](https://platform.openai.com/docs/guides/text-generation)
-        frequency_penalty: nil,
-        # Modify the likelihood of specified tokens appearing in the completion.
-        #
-        # Accepts a JSON object that maps tokens (specified by their token ID in the GPT
-        # tokenizer) to an associated bias value from -100 to 100. You can use this
-        # [tokenizer tool](/tokenizer?view=bpe) to convert text to token IDs.
-        # Mathematically, the bias is added to the logits generated by the model prior to
-        # sampling. The exact effect will vary per model, but values between -1 and 1
-        # should decrease or increase likelihood of selection; values like -100 or 100
-        # should result in a ban or exclusive selection of the relevant token.
-        #
-        # As an example, you can pass `{"50256": -100}` to prevent the <|endoftext|> token
-        # from being generated.
-        logit_bias: nil,
-        # Include the log probabilities on the `logprobs` most likely output tokens, as
-        # well the chosen tokens. For example, if `logprobs` is 5, the API will return a
-        # list of the 5 most likely tokens. The API will always return the `logprob` of
-        # the sampled token, so there may be up to `logprobs+1` elements in the response.
-        #
-        # The maximum value for `logprobs` is 5.
-        logprobs: nil,
-        # The maximum number of [tokens](/tokenizer) that can be generated in the
-        # completion.
-        #
-        # The token count of your prompt plus `max_tokens` cannot exceed the model's
-        # context length.
-        # [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken)
-        # for counting tokens.
-        max_tokens: nil,
-        # How many completions to generate for each prompt.
-        #
-        # **Note:** Because this parameter generates many completions, it can quickly
-        # consume your token quota. Use carefully and ensure that you have reasonable
-        # settings for `max_tokens` and `stop`.
-        n: nil,
-        # Number between -2.0 and 2.0. Positive values penalize new tokens based on
-        # whether they appear in the text so far, increasing the model's likelihood to
-        # talk about new topics.
-        #
-        # [See more information about frequency and presence penalties.](https://platform.openai.com/docs/guides/text-generation)
-        presence_penalty: nil,
-        # If specified, our system will make a best effort to sample deterministically,
-        # such that repeated requests with the same `seed` and parameters should return
-        # the same result.
-        #
-        # Determinism is not guaranteed, and you should refer to the `system_fingerprint`
-        # response parameter to monitor changes in the backend.
-        seed: nil,
-        # Not supported with latest reasoning models `o3` and `o4-mini`.
-        #
-        # Up to 4 sequences where the API will stop generating further tokens. The
-        # returned text will not contain the stop sequence.
-        stop: nil,
-        # Options for streaming response. Only set this when you set `stream: true`.
-        stream_options: nil,
-        # The suffix that comes after a completion of inserted text.
-        #
-        # This parameter is only supported for `gpt-3.5-turbo-instruct`.
-        suffix: nil,
-        # What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
-        # make the output more random, while lower values like 0.2 will make it more
-        # focused and deterministic.
-        #
-        # We generally recommend altering this or `top_p` but not both.
-        temperature: nil,
-        # An alternative to sampling with temperature, called nucleus sampling, where the
-        # model considers the results of the tokens with top_p probability mass. So 0.1
-        # means only the tokens comprising the top 10% probability mass are considered.
-        #
-        # We generally recommend altering this or `temperature` but not both.
-        top_p: nil,
-        # A unique identifier representing your end-user, which can help OpenAI to monitor
-        # and detect abuse.
-        # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
-        user: nil,
-        # There is no need to provide `stream:`. Instead, use `#create_streaming` or
-        # `#create` for streaming and non-streaming use cases, respectively.
-        stream: false,
-        request_options: {}
-      )
-      end
-
-      # See {OpenAI::Resources::Completions#create} for non-streaming counterpart.
-      #
-      # Creates a completion for the provided prompt and parameters.
-      sig do
-        params(
-          model: T.any(String, OpenAI::CompletionCreateParams::Model::OrSymbol),
-          prompt: T.nilable(OpenAI::CompletionCreateParams::Prompt::Variants),
-          best_of: T.nilable(Integer),
-          echo: T.nilable(T::Boolean),
-          frequency_penalty: T.nilable(Float),
-          logit_bias: T.nilable(T::Hash[Symbol, Integer]),
-          logprobs: T.nilable(Integer),
-          max_tokens: T.nilable(Integer),
-          n: T.nilable(Integer),
-          presence_penalty: T.nilable(Float),
-          seed: T.nilable(Integer),
-          stop: T.nilable(OpenAI::CompletionCreateParams::Stop::Variants),
-          stream_options:
-            T.nilable(OpenAI::Chat::ChatCompletionStreamOptions::OrHash),
-          suffix: T.nilable(String),
-          temperature: T.nilable(Float),
-          top_p: T.nilable(Float),
-          user: String,
-          stream: T.noreturn,
-          request_options: OpenAI::RequestOptions::OrHash
-        ).returns(OpenAI::Internal::Stream[OpenAI::Completion])
-      end
-      def create_streaming(
-        # ID of the model to use. You can use the
-        # [List models](https://platform.openai.com/docs/api-reference/models/list) API to
-        # see all of your available models, or see our
-        # [Model overview](https://platform.openai.com/docs/models) for descriptions of
-        # them.
-        model:,
-        # The prompt(s) to generate completions for, encoded as a string, array of
-        # strings, array of tokens, or array of token arrays.
-        #
-        # Note that <|endoftext|> is the document separator that the model sees during
-        # training, so if a prompt is not specified the model will generate as if from the
-        # beginning of a new document.
-        prompt:,
-        # Generates `best_of` completions server-side and returns the "best" (the one with
-        # the highest log probability per token). Results cannot be streamed.
-        #
-        # When used with `n`, `best_of` controls the number of candidate completions and
-        # `n` specifies how many to return – `best_of` must be greater than `n`.
-        #
-        # **Note:** Because this parameter generates many completions, it can quickly
-        # consume your token quota. Use carefully and ensure that you have reasonable
-        # settings for `max_tokens` and `stop`.
-        best_of: nil,
-        # Echo back the prompt in addition to the completion
-        echo: nil,
-        # Number between -2.0 and 2.0. Positive values penalize new tokens based on their
-        # existing frequency in the text so far, decreasing the model's likelihood to
-        # repeat the same line verbatim.
-        #
-        # [See more information about frequency and presence penalties.](https://platform.openai.com/docs/guides/text-generation)
-        frequency_penalty: nil,
-        # Modify the likelihood of specified tokens appearing in the completion.
-        #
-        # Accepts a JSON object that maps tokens (specified by their token ID in the GPT
-        # tokenizer) to an associated bias value from -100 to 100. You can use this
-        # [tokenizer tool](/tokenizer?view=bpe) to convert text to token IDs.
-        # Mathematically, the bias is added to the logits generated by the model prior to
-        # sampling. The exact effect will vary per model, but values between -1 and 1
-        # should decrease or increase likelihood of selection; values like -100 or 100
-        # should result in a ban or exclusive selection of the relevant token.
-        #
-        # As an example, you can pass `{"50256": -100}` to prevent the <|endoftext|> token
-        # from being generated.
-        logit_bias: nil,
-        # Include the log probabilities on the `logprobs` most likely output tokens, as
-        # well the chosen tokens. For example, if `logprobs` is 5, the API will return a
-        # list of the 5 most likely tokens. The API will always return the `logprob` of
-        # the sampled token, so there may be up to `logprobs+1` elements in the response.
-        #
-        # The maximum value for `logprobs` is 5.
-        logprobs: nil,
-        # The maximum number of [tokens](/tokenizer) that can be generated in the
-        # completion.
-        #
-        # The token count of your prompt plus `max_tokens` cannot exceed the model's
-        # context length.
-        # [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken)
-        # for counting tokens.
-        max_tokens: nil,
-        # How many completions to generate for each prompt.
-        #
-        # **Note:** Because this parameter generates many completions, it can quickly
-        # consume your token quota. Use carefully and ensure that you have reasonable
-        # settings for `max_tokens` and `stop`.
-        n: nil,
-        # Number between -2.0 and 2.0. Positive values penalize new tokens based on
-        # whether they appear in the text so far, increasing the model's likelihood to
-        # talk about new topics.
-        #
-        # [See more information about frequency and presence penalties.](https://platform.openai.com/docs/guides/text-generation)
-        presence_penalty: nil,
-        # If specified, our system will make a best effort to sample deterministically,
-        # such that repeated requests with the same `seed` and parameters should return
-        # the same result.
-        #
-        # Determinism is not guaranteed, and you should refer to the `system_fingerprint`
-        # response parameter to monitor changes in the backend.
-        seed: nil,
-        # Not supported with latest reasoning models `o3` and `o4-mini`.
-        #
-        # Up to 4 sequences where the API will stop generating further tokens. The
-        # returned text will not contain the stop sequence.
-        stop: nil,
-        # Options for streaming response. Only set this when you set `stream: true`.
-        stream_options: nil,
-        # The suffix that comes after a completion of inserted text.
-        #
-        # This parameter is only supported for `gpt-3.5-turbo-instruct`.
-        suffix: nil,
-        # What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
-        # make the output more random, while lower values like 0.2 will make it more
-        # focused and deterministic.
-        #
-        # We generally recommend altering this or `top_p` but not both.
-        temperature: nil,
-        # An alternative to sampling with temperature, called nucleus sampling, where the
-        # model considers the results of the tokens with top_p probability mass. So 0.1
-        # means only the tokens comprising the top 10% probability mass are considered.
-        #
-        # We generally recommend altering this or `temperature` but not both.
-        top_p: nil,
-        # A unique identifier representing your end-user, which can help OpenAI to monitor
-        # and detect abuse.
-        # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
-        user: nil,
-        # There is no need to provide `stream:`. Instead, use `#create_streaming` or
-        # `#create` for streaming and non-streaming use cases, respectively.
-        stream: true,
-        request_options: {}
-      )
-      end
-
-      # @api private
-      sig { params(client: OpenAI::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
-    end
-  end
-end

data/rbi/openai/resources/containers/files/content.rbi

@@ -1,27 +0,0 @@
-# typed: strong
-
-module OpenAI
-  module Resources
-    class Containers
-      class Files
-        class Content
-          # Retrieve Container File Content
-          sig do
-            params(
-              file_id: String,
-              container_id: String,
-              request_options: OpenAI::RequestOptions::OrHash
-            ).void
-          end
-          def retrieve(file_id, container_id:, request_options: {})
-          end
-
-          # @api private
-          sig { params(client: OpenAI::Client).returns(T.attached_class) }
-          def self.new(client:)
-          end
-        end
-      end
-    end
-  end
-end

data/rbi/openai/resources/containers/files.rbi

@@ -1,92 +0,0 @@
-# typed: strong
-
-module OpenAI
-  module Resources
-    class Containers
-      class Files
-        sig { returns(OpenAI::Resources::Containers::Files::Content) }
-        attr_reader :content
-
-        # Create a Container File
-        #
-        # You can send either a multipart/form-data request with the raw file content, or
-        # a JSON request with a file ID.
-        sig do
-          params(
-            container_id: String,
-            file: OpenAI::Internal::FileInput,
-            file_id: String,
-            request_options: OpenAI::RequestOptions::OrHash
-          ).returns(OpenAI::Models::Containers::FileCreateResponse)
-        end
-        def create(
-          container_id,
-          # The File object (not file name) to be uploaded.
-          file: nil,
-          # Name of the file to create.
-          file_id: nil,
-          request_options: {}
-        )
-        end
-
-        # Retrieve Container File
-        sig do
-          params(
-            file_id: String,
-            container_id: String,
-            request_options: OpenAI::RequestOptions::OrHash
-          ).returns(OpenAI::Models::Containers::FileRetrieveResponse)
-        end
-        def retrieve(file_id, container_id:, request_options: {})
-        end
-
-        # List Container files
-        sig do
-          params(
-            container_id: String,
-            after: String,
-            limit: Integer,
-            order: OpenAI::Containers::FileListParams::Order::OrSymbol,
-            request_options: OpenAI::RequestOptions::OrHash
-          ).returns(
-            OpenAI::Internal::CursorPage[
-              OpenAI::Models::Containers::FileListResponse
-            ]
-          )
-        end
-        def list(
-          container_id,
-          # A cursor for use in pagination. `after` is an object ID that defines your place
-          # in the list. For instance, if you make a list request and receive 100 objects,
-          # ending with obj_foo, your subsequent call can include after=obj_foo in order to
-          # fetch the next page of the list.
-          after: nil,
-          # A limit on the number of objects to be returned. Limit can range between 1 and
-          # 100, and the default is 20.
-          limit: nil,
-          # Sort order by the `created_at` timestamp of the objects. `asc` for ascending
-          # order and `desc` for descending order.
-          order: nil,
-          request_options: {}
-        )
-        end
-
-        # Delete Container File
-        sig do
-          params(
-            file_id: String,
-            container_id: String,
-            request_options: OpenAI::RequestOptions::OrHash
-          ).void
-        end
-        def delete(file_id, container_id:, request_options: {})
-        end
-
-        # @api private
-        sig { params(client: OpenAI::Client).returns(T.attached_class) }
-        def self.new(client:)
-        end
-      end
-    end
-  end
-end

data/rbi/openai/resources/containers.rbi

@@ -1,86 +0,0 @@
-# typed: strong
-
-module OpenAI
-  module Resources
-    class Containers
-      sig { returns(OpenAI::Resources::Containers::Files) }
-      attr_reader :files
-
-      # Create Container
-      sig do
-        params(
-          name: String,
-          expires_after: OpenAI::ContainerCreateParams::ExpiresAfter::OrHash,
-          file_ids: T::Array[String],
-          request_options: OpenAI::RequestOptions::OrHash
-        ).returns(OpenAI::Models::ContainerCreateResponse)
-      end
-      def create(
-        # Name of the container to create.
-        name:,
-        # Container expiration time in seconds relative to the 'anchor' time.
-        expires_after: nil,
-        # IDs of files to copy to the container.
-        file_ids: nil,
-        request_options: {}
-      )
-      end
-
-      # Retrieve Container
-      sig do
-        params(
-          container_id: String,
-          request_options: OpenAI::RequestOptions::OrHash
-        ).returns(OpenAI::Models::ContainerRetrieveResponse)
-      end
-      def retrieve(container_id, request_options: {})
-      end
-
-      # List Containers
-      sig do
-        params(
-          after: String,
-          limit: Integer,
-          order: OpenAI::ContainerListParams::Order::OrSymbol,
-          request_options: OpenAI::RequestOptions::OrHash
-        ).returns(
-          OpenAI::Internal::CursorPage[OpenAI::Models::ContainerListResponse]
-        )
-      end
-      def list(
-        # A cursor for use in pagination. `after` is an object ID that defines your place
-        # in the list. For instance, if you make a list request and receive 100 objects,
-        # ending with obj_foo, your subsequent call can include after=obj_foo in order to
-        # fetch the next page of the list.
-        after: nil,
-        # A limit on the number of objects to be returned. Limit can range between 1 and
-        # 100, and the default is 20.
-        limit: nil,
-        # Sort order by the `created_at` timestamp of the objects. `asc` for ascending
-        # order and `desc` for descending order.
-        order: nil,
-        request_options: {}
-      )
-      end
-
-      # Delete Container
-      sig do
-        params(
-          container_id: String,
-          request_options: OpenAI::RequestOptions::OrHash
-        ).void
-      end
-      def delete(
-        # The ID of the container to delete.
-        container_id,
-        request_options: {}
-      )
-      end
-
-      # @api private
-      sig { params(client: OpenAI::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
-    end
-  end
-end

data/rbi/openai/resources/embeddings.rbi

@@ -1,55 +0,0 @@
-# typed: strong
-
-module OpenAI
-  module Resources
-    class Embeddings
-      # Creates an embedding vector representing the input text.
-      sig do
-        params(
-          input: OpenAI::EmbeddingCreateParams::Input::Variants,
-          model: T.any(String, OpenAI::EmbeddingModel::OrSymbol),
-          dimensions: Integer,
-          encoding_format:
-            OpenAI::EmbeddingCreateParams::EncodingFormat::OrSymbol,
-          user: String,
-          request_options: OpenAI::RequestOptions::OrHash
-        ).returns(OpenAI::CreateEmbeddingResponse)
-      end
-      def create(
-        # Input text to embed, encoded as a string or array of tokens. To embed multiple
-        # inputs in a single request, pass an array of strings or array of token arrays.
-        # The input must not exceed the max input tokens for the model (8192 tokens for
-        # all embedding models), cannot be an empty string, and any array must be 2048
-        # dimensions or less.
-        # [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken)
-        # for counting tokens. In addition to the per-input token limit, all embedding
-        # models enforce a maximum of 300,000 tokens summed across all inputs in a single
-        # request.
-        input:,
-        # ID of the model to use. You can use the
-        # [List models](https://platform.openai.com/docs/api-reference/models/list) API to
-        # see all of your available models, or see our
-        # [Model overview](https://platform.openai.com/docs/models) for descriptions of
-        # them.
-        model:,
-        # The number of dimensions the resulting output embeddings should have. Only
-        # supported in `text-embedding-3` and later models.
-        dimensions: nil,
-        # The format to return the embeddings in. Can be either `float` or
-        # [`base64`](https://pypi.org/project/pybase64/).
-        encoding_format: nil,
-        # A unique identifier representing your end-user, which can help OpenAI to monitor
-        # and detect abuse.
-        # [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).
-        user: nil,
-        request_options: {}
-      )
-      end
-
-      # @api private
-      sig { params(client: OpenAI::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
-    end
-  end
-end

data/rbi/openai/resources/evals/runs/output_items.rbi

@@ -1,73 +0,0 @@
-# typed: strong
-
-module OpenAI
-  module Resources
-    class Evals
-      class Runs
-        class OutputItems
-          # Get an evaluation run output item by ID.
-          sig do
-            params(
-              output_item_id: String,
-              eval_id: String,
-              run_id: String,
-              request_options: OpenAI::RequestOptions::OrHash
-            ).returns(OpenAI::Models::Evals::Runs::OutputItemRetrieveResponse)
-          end
-          def retrieve(
-            # The ID of the output item to retrieve.
-            output_item_id,
-            # The ID of the evaluation to retrieve runs for.
-            eval_id:,
-            # The ID of the run to retrieve.
-            run_id:,
-            request_options: {}
-          )
-          end
-
-          # Get a list of output items for an evaluation run.
-          sig do
-            params(
-              run_id: String,
-              eval_id: String,
-              after: String,
-              limit: Integer,
-              order: OpenAI::Evals::Runs::OutputItemListParams::Order::OrSymbol,
-              status:
-                OpenAI::Evals::Runs::OutputItemListParams::Status::OrSymbol,
-              request_options: OpenAI::RequestOptions::OrHash
-            ).returns(
-              OpenAI::Internal::CursorPage[
-                OpenAI::Models::Evals::Runs::OutputItemListResponse
-              ]
-            )
-          end
-          def list(
-            # Path param: The ID of the run to retrieve output items for.
-            run_id,
-            # Path param: The ID of the evaluation to retrieve runs for.
-            eval_id:,
-            # Query param: Identifier for the last output item from the previous pagination
-            # request.
-            after: nil,
-            # Query param: Number of output items to retrieve.
-            limit: nil,
-            # Query param: Sort order for output items by timestamp. Use `asc` for ascending
-            # order or `desc` for descending order. Defaults to `asc`.
-            order: nil,
-            # Query param: Filter output items by status. Use `failed` to filter by failed
-            # output items or `pass` to filter by passed output items.
-            status: nil,
-            request_options: {}
-          )
-          end
-
-          # @api private
-          sig { params(client: OpenAI::Client).returns(T.attached_class) }
-          def self.new(client:)
-          end
-        end
-      end
-    end
-  end
-end