openai 0.1.0.pre.beta.2 → 0.1.0

data/lib/openai/models/beta/threads/runs/step_retrieve_params.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Beta
-      module Threads
-        module Runs
-          # @see OpenAI::Resources::Beta::Threads::Runs::Steps#retrieve
-          class StepRetrieveParams < OpenAI::Internal::Type::BaseModel
-            extend OpenAI::Internal::Type::RequestParameters::Converter
-            include OpenAI::Internal::Type::RequestParameters
-
-            # @!attribute thread_id
-            #
-            #   @return [String]
-            required :thread_id, String
-
-            # @!attribute run_id
-            #
-            #   @return [String]
-            required :run_id, String
-
-            # @!attribute include
-            #   A list of additional fields to include in the response. Currently the only
-            #   supported value is `step_details.tool_calls[*].file_search.results[*].content`
-            #   to fetch the file search result content.
-            #
-            #   See the
-            #   [file search tool documentation](https://platform.openai.com/docs/assistants/tools/file-search#customizing-file-search-settings)
-            #   for more information.
-            #
-            #   @return [Array<Symbol, OpenAI::Models::Beta::Threads::Runs::RunStepInclude>, nil]
-            optional :include,
-                     -> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Beta::Threads::Runs::RunStepInclude] }
-
-            # @!method initialize(thread_id:, run_id:, include: nil, request_options: {})
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Beta::Threads::Runs::StepRetrieveParams} for more details.
-            #
-            #   @param thread_id [String]
-            #
-            #   @param run_id [String]
-            #
-            #   @param include [Array<Symbol, OpenAI::Models::Beta::Threads::Runs::RunStepInclude>] A list of additional fields to include in the response. Currently the only suppo
-            #
-            #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
-          end
-        end
-      end
-    end
-  end
-end

data/lib/openai/models/beta/threads/runs/tool_call.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Beta
-      module Threads
-        module Runs
-          # Details of the Code Interpreter tool call the run step was involved in.
-          module ToolCall
-            extend OpenAI::Internal::Type::Union
-
-            discriminator :type
-
-            # Details of the Code Interpreter tool call the run step was involved in.
-            variant :code_interpreter, -> { OpenAI::Beta::Threads::Runs::CodeInterpreterToolCall }
-
-            variant :file_search, -> { OpenAI::Beta::Threads::Runs::FileSearchToolCall }
-
-            variant :function, -> { OpenAI::Beta::Threads::Runs::FunctionToolCall }
-
-            # @!method self.variants
-            #   @return [Array(OpenAI::Models::Beta::Threads::Runs::CodeInterpreterToolCall, OpenAI::Models::Beta::Threads::Runs::FileSearchToolCall, OpenAI::Models::Beta::Threads::Runs::FunctionToolCall)]
-          end
-        end
-      end
-    end
-  end
-end

data/lib/openai/models/beta/threads/runs/tool_call_delta.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Beta
-      module Threads
-        module Runs
-          # Details of the Code Interpreter tool call the run step was involved in.
-          module ToolCallDelta
-            extend OpenAI::Internal::Type::Union
-
-            discriminator :type
-
-            # Details of the Code Interpreter tool call the run step was involved in.
-            variant :code_interpreter, -> { OpenAI::Beta::Threads::Runs::CodeInterpreterToolCallDelta }
-
-            variant :file_search, -> { OpenAI::Beta::Threads::Runs::FileSearchToolCallDelta }
-
-            variant :function, -> { OpenAI::Beta::Threads::Runs::FunctionToolCallDelta }
-
-            # @!method self.variants
-            #   @return [Array(OpenAI::Models::Beta::Threads::Runs::CodeInterpreterToolCallDelta, OpenAI::Models::Beta::Threads::Runs::FileSearchToolCallDelta, OpenAI::Models::Beta::Threads::Runs::FunctionToolCallDelta)]
-          end
-        end
-      end
-    end
-  end
-end

data/lib/openai/models/beta/threads/runs/tool_call_delta_object.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Beta
-      module Threads
-        module Runs
-          class ToolCallDeltaObject < OpenAI::Internal::Type::BaseModel
-            # @!attribute type
-            #   Always `tool_calls`.
-            #
-            #   @return [Symbol, :tool_calls]
-            required :type, const: :tool_calls
-
-            # @!attribute tool_calls
-            #   An array of tool calls the run step was involved in. These can be associated
-            #   with one of three types of tools: `code_interpreter`, `file_search`, or
-            #   `function`.
-            #
-            #   @return [Array<OpenAI::Models::Beta::Threads::Runs::CodeInterpreterToolCallDelta, OpenAI::Models::Beta::Threads::Runs::FileSearchToolCallDelta, OpenAI::Models::Beta::Threads::Runs::FunctionToolCallDelta>, nil]
-            optional :tool_calls,
-                     -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::Threads::Runs::ToolCallDelta] }
-
-            # @!method initialize(tool_calls: nil, type: :tool_calls)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Beta::Threads::Runs::ToolCallDeltaObject} for more details.
-            #
-            #   Details of the tool call.
-            #
-            #   @param tool_calls [Array<OpenAI::Models::Beta::Threads::Runs::CodeInterpreterToolCallDelta, OpenAI::Models::Beta::Threads::Runs::FileSearchToolCallDelta, OpenAI::Models::Beta::Threads::Runs::FunctionToolCallDelta>] An array of tool calls the run step was involved in. These can be associated wit
-            #
-            #   @param type [Symbol, :tool_calls] Always `tool_calls`.
-          end
-        end
-      end
-    end
-  end
-end

data/lib/openai/models/beta/threads/runs/tool_calls_step_details.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Beta
-      module Threads
-        module Runs
-          class ToolCallsStepDetails < OpenAI::Internal::Type::BaseModel
-            # @!attribute tool_calls
-            #   An array of tool calls the run step was involved in. These can be associated
-            #   with one of three types of tools: `code_interpreter`, `file_search`, or
-            #   `function`.
-            #
-            #   @return [Array<OpenAI::Models::Beta::Threads::Runs::CodeInterpreterToolCall, OpenAI::Models::Beta::Threads::Runs::FileSearchToolCall, OpenAI::Models::Beta::Threads::Runs::FunctionToolCall>]
-            required :tool_calls,
-                     -> {
-                       OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::Threads::Runs::ToolCall]
-                     }
-
-            # @!attribute type
-            #   Always `tool_calls`.
-            #
-            #   @return [Symbol, :tool_calls]
-            required :type, const: :tool_calls
-
-            # @!method initialize(tool_calls:, type: :tool_calls)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Beta::Threads::Runs::ToolCallsStepDetails} for more details.
-            #
-            #   Details of the tool call.
-            #
-            #   @param tool_calls [Array<OpenAI::Models::Beta::Threads::Runs::CodeInterpreterToolCall, OpenAI::Models::Beta::Threads::Runs::FileSearchToolCall, OpenAI::Models::Beta::Threads::Runs::FunctionToolCall>] An array of tool calls the run step was involved in. These can be associated wit
-            #
-            #   @param type [Symbol, :tool_calls] Always `tool_calls`.
-          end
-        end
-      end
-    end
-  end
-end

data/lib/openai/models/beta/threads/text.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Beta
-      module Threads
-        class Text < OpenAI::Internal::Type::BaseModel
-          # @!attribute annotations
-          #
-          #   @return [Array<OpenAI::Models::Beta::Threads::FileCitationAnnotation, OpenAI::Models::Beta::Threads::FilePathAnnotation>]
-          required :annotations,
-                   -> {
-                     OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::Threads::Annotation]
-                   }
-
-          # @!attribute value
-          #   The data that makes up the text.
-          #
-          #   @return [String]
-          required :value, String
-
-          # @!method initialize(annotations:, value:)
-          #   @param annotations [Array<OpenAI::Models::Beta::Threads::FileCitationAnnotation, OpenAI::Models::Beta::Threads::FilePathAnnotation>]
-          #
-          #   @param value [String] The data that makes up the text.
-        end
-      end
-    end
-  end
-end

data/lib/openai/models/beta/threads/text_content_block.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Beta
-      module Threads
-        class TextContentBlock < OpenAI::Internal::Type::BaseModel
-          # @!attribute text
-          #
-          #   @return [OpenAI::Models::Beta::Threads::Text]
-          required :text, -> { OpenAI::Beta::Threads::Text }
-
-          # @!attribute type
-          #   Always `text`.
-          #
-          #   @return [Symbol, :text]
-          required :type, const: :text
-
-          # @!method initialize(text:, type: :text)
-          #   The text content that is part of a message.
-          #
-          #   @param text [OpenAI::Models::Beta::Threads::Text]
-          #
-          #   @param type [Symbol, :text] Always `text`.
-        end
-      end
-    end
-  end
-end

data/lib/openai/models/beta/threads/text_content_block_param.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Beta
-      module Threads
-        class TextContentBlockParam < OpenAI::Internal::Type::BaseModel
-          # @!attribute text
-          #   Text content to be sent to the model
-          #
-          #   @return [String]
-          required :text, String
-
-          # @!attribute type
-          #   Always `text`.
-          #
-          #   @return [Symbol, :text]
-          required :type, const: :text
-
-          # @!method initialize(text:, type: :text)
-          #   The text content that is part of a message.
-          #
-          #   @param text [String] Text content to be sent to the model
-          #
-          #   @param type [Symbol, :text] Always `text`.
-        end
-      end
-    end
-  end
-end

data/lib/openai/models/beta/threads/text_delta.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Beta
-      module Threads
-        class TextDelta < OpenAI::Internal::Type::BaseModel
-          # @!attribute annotations
-          #
-          #   @return [Array<OpenAI::Models::Beta::Threads::FileCitationDeltaAnnotation, OpenAI::Models::Beta::Threads::FilePathDeltaAnnotation>, nil]
-          optional :annotations,
-                   -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::Threads::AnnotationDelta] }
-
-          # @!attribute value
-          #   The data that makes up the text.
-          #
-          #   @return [String, nil]
-          optional :value, String
-
-          # @!method initialize(annotations: nil, value: nil)
-          #   @param annotations [Array<OpenAI::Models::Beta::Threads::FileCitationDeltaAnnotation, OpenAI::Models::Beta::Threads::FilePathDeltaAnnotation>]
-          #
-          #   @param value [String] The data that makes up the text.
-        end
-      end
-    end
-  end
-end

data/lib/openai/models/beta/threads/text_delta_block.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Beta
-      module Threads
-        class TextDeltaBlock < OpenAI::Internal::Type::BaseModel
-          # @!attribute index
-          #   The index of the content part in the message.
-          #
-          #   @return [Integer]
-          required :index, Integer
-
-          # @!attribute type
-          #   Always `text`.
-          #
-          #   @return [Symbol, :text]
-          required :type, const: :text
-
-          # @!attribute text
-          #
-          #   @return [OpenAI::Models::Beta::Threads::TextDelta, nil]
-          optional :text, -> { OpenAI::Beta::Threads::TextDelta }
-
-          # @!method initialize(index:, text: nil, type: :text)
-          #   The text content that is part of a message.
-          #
-          #   @param index [Integer] The index of the content part in the message.
-          #
-          #   @param text [OpenAI::Models::Beta::Threads::TextDelta]
-          #
-          #   @param type [Symbol, :text] Always `text`.
-        end
-      end
-    end
-  end
-end

data/lib/openai/models/chat/chat_completion.rb

@@ -1,225 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Chat
-      # @see OpenAI::Resources::Chat::Completions#create
-      #
-      # @see OpenAI::Resources::Chat::Completions#stream_raw
-      class ChatCompletion < OpenAI::Internal::Type::BaseModel
-        # @!attribute id
-        #   A unique identifier for the chat completion.
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute choices
-        #   A list of chat completion choices. Can be more than one if `n` is greater
-        #   than 1.
-        #
-        #   @return [Array<OpenAI::Models::Chat::ChatCompletion::Choice>]
-        required :choices, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Chat::ChatCompletion::Choice] }
-
-        # @!attribute created
-        #   The Unix timestamp (in seconds) of when the chat completion was created.
-        #
-        #   @return [Integer]
-        required :created, Integer
-
-        # @!attribute model
-        #   The model used for the chat completion.
-        #
-        #   @return [String]
-        required :model, String
-
-        # @!attribute object
-        #   The object type, which is always `chat.completion`.
-        #
-        #   @return [Symbol, :"chat.completion"]
-        required :object, const: :"chat.completion"
-
-        # @!attribute service_tier
-        #   Specifies the latency tier to use for processing the request. This parameter is
-        #   relevant for customers subscribed to the scale tier service:
-        #
-        #   - If set to 'auto', and the Project is Scale tier enabled, the system will
-        #     utilize scale tier credits until they are exhausted.
-        #   - If set to 'auto', and the Project is not Scale tier enabled, the request will
-        #     be processed using the default service tier with a lower uptime SLA and no
-        #     latency guarentee.
-        #   - If set to 'default', the request will be processed using the default service
-        #     tier with a lower uptime SLA and no latency guarentee.
-        #   - If set to 'flex', the request will be processed with the Flex Processing
-        #     service tier.
-        #     [Learn more](https://platform.openai.com/docs/guides/flex-processing).
-        #   - When not set, the default behavior is 'auto'.
-        #
-        #   When this parameter is set, the response body will include the `service_tier`
-        #   utilized.
-        #
-        #   @return [Symbol, OpenAI::Models::Chat::ChatCompletion::ServiceTier, nil]
-        optional :service_tier, enum: -> { OpenAI::Chat::ChatCompletion::ServiceTier }, nil?: true
-
-        # @!attribute system_fingerprint
-        #   This fingerprint represents the backend configuration that the model runs with.
-        #
-        #   Can be used in conjunction with the `seed` request parameter to understand when
-        #   backend changes have been made that might impact determinism.
-        #
-        #   @return [String, nil]
-        optional :system_fingerprint, String
-
-        # @!attribute usage
-        #   Usage statistics for the completion request.
-        #
-        #   @return [OpenAI::Models::CompletionUsage, nil]
-        optional :usage, -> { OpenAI::CompletionUsage }
-
-        # @!method initialize(id:, choices:, created:, model:, service_tier: nil, system_fingerprint: nil, usage: nil, object: :"chat.completion")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Chat::ChatCompletion} for more details.
-        #
-        #   Represents a chat completion response returned by model, based on the provided
-        #   input.
-        #
-        #   @param id [String] A unique identifier for the chat completion.
-        #
-        #   @param choices [Array<OpenAI::Models::Chat::ChatCompletion::Choice>] A list of chat completion choices. Can be more than one if `n` is greater than 1
-        #
-        #   @param created [Integer] The Unix timestamp (in seconds) of when the chat completion was created.
-        #
-        #   @param model [String] The model used for the chat completion.
-        #
-        #   @param service_tier [Symbol, OpenAI::Models::Chat::ChatCompletion::ServiceTier, nil] Specifies the latency tier to use for processing the request. This parameter is
-        #
-        #   @param system_fingerprint [String] This fingerprint represents the backend configuration that the model runs with.
-        #
-        #   @param usage [OpenAI::Models::CompletionUsage] Usage statistics for the completion request.
-        #
-        #   @param object [Symbol, :"chat.completion"] The object type, which is always `chat.completion`.
-
-        class Choice < OpenAI::Internal::Type::BaseModel
-          # @!attribute finish_reason
-          #   The reason the model stopped generating tokens. This will be `stop` if the model
-          #   hit a natural stop point or a provided stop sequence, `length` if the maximum
-          #   number of tokens specified in the request was reached, `content_filter` if
-          #   content was omitted due to a flag from our content filters, `tool_calls` if the
-          #   model called a tool, or `function_call` (deprecated) if the model called a
-          #   function.
-          #
-          #   @return [Symbol, OpenAI::Models::Chat::ChatCompletion::Choice::FinishReason]
-          required :finish_reason, enum: -> { OpenAI::Chat::ChatCompletion::Choice::FinishReason }
-
-          # @!attribute index
-          #   The index of the choice in the list of choices.
-          #
-          #   @return [Integer]
-          required :index, Integer
-
-          # @!attribute logprobs
-          #   Log probability information for the choice.
-          #
-          #   @return [OpenAI::Models::Chat::ChatCompletion::Choice::Logprobs, nil]
-          required :logprobs, -> { OpenAI::Chat::ChatCompletion::Choice::Logprobs }, nil?: true
-
-          # @!attribute message
-          #   A chat completion message generated by the model.
-          #
-          #   @return [OpenAI::Models::Chat::ChatCompletionMessage]
-          required :message, -> { OpenAI::Chat::ChatCompletionMessage }
-
-          # @!method initialize(finish_reason:, index:, logprobs:, message:)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Chat::ChatCompletion::Choice} for more details.
-          #
-          #   @param finish_reason [Symbol, OpenAI::Models::Chat::ChatCompletion::Choice::FinishReason] The reason the model stopped generating tokens. This will be `stop` if the model
-          #
-          #   @param index [Integer] The index of the choice in the list of choices.
-          #
-          #   @param logprobs [OpenAI::Models::Chat::ChatCompletion::Choice::Logprobs, nil] Log probability information for the choice.
-          #
-          #   @param message [OpenAI::Models::Chat::ChatCompletionMessage] A chat completion message generated by the model.
-
-          # The reason the model stopped generating tokens. This will be `stop` if the model
-          # hit a natural stop point or a provided stop sequence, `length` if the maximum
-          # number of tokens specified in the request was reached, `content_filter` if
-          # content was omitted due to a flag from our content filters, `tool_calls` if the
-          # model called a tool, or `function_call` (deprecated) if the model called a
-          # function.
-          #
-          # @see OpenAI::Models::Chat::ChatCompletion::Choice#finish_reason
-          module FinishReason
-            extend OpenAI::Internal::Type::Enum
-
-            STOP = :stop
-            LENGTH = :length
-            TOOL_CALLS = :tool_calls
-            CONTENT_FILTER = :content_filter
-            FUNCTION_CALL = :function_call
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-
-          # @see OpenAI::Models::Chat::ChatCompletion::Choice#logprobs
-          class Logprobs < OpenAI::Internal::Type::BaseModel
-            # @!attribute content
-            #   A list of message content tokens with log probability information.
-            #
-            #   @return [Array<OpenAI::Models::Chat::ChatCompletionTokenLogprob>, nil]
-            required :content,
-                     -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Chat::ChatCompletionTokenLogprob] },
-                     nil?: true
-
-            # @!attribute refusal
-            #   A list of message refusal tokens with log probability information.
-            #
-            #   @return [Array<OpenAI::Models::Chat::ChatCompletionTokenLogprob>, nil]
-            required :refusal,
-                     -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Chat::ChatCompletionTokenLogprob] },
-                     nil?: true
-
-            # @!method initialize(content:, refusal:)
-            #   Log probability information for the choice.
-            #
-            #   @param content [Array<OpenAI::Models::Chat::ChatCompletionTokenLogprob>, nil] A list of message content tokens with log probability information.
-            #
-            #   @param refusal [Array<OpenAI::Models::Chat::ChatCompletionTokenLogprob>, nil] A list of message refusal tokens with log probability information.
-          end
-        end
-
-        # Specifies the latency tier to use for processing the request. This parameter is
-        # relevant for customers subscribed to the scale tier service:
-        #
-        # - If set to 'auto', and the Project is Scale tier enabled, the system will
-        #   utilize scale tier credits until they are exhausted.
-        # - If set to 'auto', and the Project is not Scale tier enabled, the request will
-        #   be processed using the default service tier with a lower uptime SLA and no
-        #   latency guarentee.
-        # - If set to 'default', the request will be processed using the default service
-        #   tier with a lower uptime SLA and no latency guarentee.
-        # - If set to 'flex', the request will be processed with the Flex Processing
-        #   service tier.
-        #   [Learn more](https://platform.openai.com/docs/guides/flex-processing).
-        # - When not set, the default behavior is 'auto'.
-        #
-        # When this parameter is set, the response body will include the `service_tier`
-        # utilized.
-        #
-        # @see OpenAI::Models::Chat::ChatCompletion#service_tier
-        module ServiceTier
-          extend OpenAI::Internal::Type::Enum
-
-          AUTO = :auto
-          DEFAULT = :default
-          FLEX = :flex
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-    end
-
-    ChatCompletion = Chat::ChatCompletion
-  end
-end