openai 0.2.0 → 0.4.0.pre.beta.1

data/rbi/openai/models/chat/chat_completion_assistant_message_param.rbi

@@ -0,0 +1,299 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    ChatCompletionAssistantMessageParam =
+      Chat::ChatCompletionAssistantMessageParam
+
+    module Chat
+      class ChatCompletionAssistantMessageParam < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Chat::ChatCompletionAssistantMessageParam,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The role of the messages author, in this case `assistant`.
+        sig { returns(Symbol) }
+        attr_accessor :role
+
+        # Data about a previous audio response from the model.
+        # [Learn more](https://platform.openai.com/docs/guides/audio).
+        sig do
+          returns(
+            T.nilable(OpenAI::Chat::ChatCompletionAssistantMessageParam::Audio)
+          )
+        end
+        attr_reader :audio
+
+        sig do
+          params(
+            audio:
+              T.nilable(
+                OpenAI::Chat::ChatCompletionAssistantMessageParam::Audio::OrHash
+              )
+          ).void
+        end
+        attr_writer :audio
+
+        # The contents of the assistant message. Required unless `tool_calls` or
+        # `function_call` is specified.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Chat::ChatCompletionAssistantMessageParam::Content::Variants
+            )
+          )
+        end
+        attr_accessor :content
+
+        # Deprecated and replaced by `tool_calls`. The name and arguments of a function
+        # that should be called, as generated by the model.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Chat::ChatCompletionAssistantMessageParam::FunctionCall
+            )
+          )
+        end
+        attr_reader :function_call
+
+        sig do
+          params(
+            function_call:
+              T.nilable(
+                OpenAI::Chat::ChatCompletionAssistantMessageParam::FunctionCall::OrHash
+              )
+          ).void
+        end
+        attr_writer :function_call
+
+        # An optional name for the participant. Provides the model information to
+        # differentiate between participants of the same role.
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        # The refusal message by the assistant.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :refusal
+
+        # The tool calls generated by the model, such as function calls.
+        sig do
+          returns(
+            T.nilable(T::Array[OpenAI::Chat::ChatCompletionMessageToolCall])
+          )
+        end
+        attr_reader :tool_calls
+
+        sig do
+          params(
+            tool_calls:
+              T::Array[OpenAI::Chat::ChatCompletionMessageToolCall::OrHash]
+          ).void
+        end
+        attr_writer :tool_calls
+
+        # Messages sent by the model in response to user messages.
+        sig do
+          params(
+            audio:
+              T.nilable(
+                OpenAI::Chat::ChatCompletionAssistantMessageParam::Audio::OrHash
+              ),
+            content:
+              T.nilable(
+                OpenAI::Chat::ChatCompletionAssistantMessageParam::Content::Variants
+              ),
+            function_call:
+              T.nilable(
+                OpenAI::Chat::ChatCompletionAssistantMessageParam::FunctionCall::OrHash
+              ),
+            name: String,
+            refusal: T.nilable(String),
+            tool_calls:
+              T::Array[OpenAI::Chat::ChatCompletionMessageToolCall::OrHash],
+            role: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Data about a previous audio response from the model.
+          # [Learn more](https://platform.openai.com/docs/guides/audio).
+          audio: nil,
+          # The contents of the assistant message. Required unless `tool_calls` or
+          # `function_call` is specified.
+          content: nil,
+          # Deprecated and replaced by `tool_calls`. The name and arguments of a function
+          # that should be called, as generated by the model.
+          function_call: nil,
+          # An optional name for the participant. Provides the model information to
+          # differentiate between participants of the same role.
+          name: nil,
+          # The refusal message by the assistant.
+          refusal: nil,
+          # The tool calls generated by the model, such as function calls.
+          tool_calls: nil,
+          # The role of the messages author, in this case `assistant`.
+          role: :assistant
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              role: Symbol,
+              audio:
+                T.nilable(
+                  OpenAI::Chat::ChatCompletionAssistantMessageParam::Audio
+                ),
+              content:
+                T.nilable(
+                  OpenAI::Chat::ChatCompletionAssistantMessageParam::Content::Variants
+                ),
+              function_call:
+                T.nilable(
+                  OpenAI::Chat::ChatCompletionAssistantMessageParam::FunctionCall
+                ),
+              name: String,
+              refusal: T.nilable(String),
+              tool_calls: T::Array[OpenAI::Chat::ChatCompletionMessageToolCall]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Audio < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Chat::ChatCompletionAssistantMessageParam::Audio,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # Unique identifier for a previous audio response from the model.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Data about a previous audio response from the model.
+          # [Learn more](https://platform.openai.com/docs/guides/audio).
+          sig { params(id: String).returns(T.attached_class) }
+          def self.new(
+            # Unique identifier for a previous audio response from the model.
+            id:
+          )
+          end
+
+          sig { override.returns({ id: String }) }
+          def to_hash
+          end
+        end
+
+        # The contents of the assistant message. Required unless `tool_calls` or
+        # `function_call` is specified.
+        module Content
+          extend OpenAI::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                String,
+                T::Array[
+                  OpenAI::Chat::ChatCompletionAssistantMessageParam::Content::ArrayOfContentPart::Variants
+                ]
+              )
+            end
+
+          # Learn about
+          # [text inputs](https://platform.openai.com/docs/guides/text-generation).
+          module ArrayOfContentPart
+            extend OpenAI::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.any(
+                  OpenAI::Chat::ChatCompletionContentPartText,
+                  OpenAI::Chat::ChatCompletionContentPartRefusal
+                )
+              end
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Chat::ChatCompletionAssistantMessageParam::Content::ArrayOfContentPart::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+          end
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Chat::ChatCompletionAssistantMessageParam::Content::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+
+          ArrayOfContentPartArray =
+            T.let(
+              OpenAI::Internal::Type::ArrayOf[
+                union:
+                  OpenAI::Chat::ChatCompletionAssistantMessageParam::Content::ArrayOfContentPart
+              ],
+              OpenAI::Internal::Type::Converter
+            )
+        end
+
+        class FunctionCall < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Chat::ChatCompletionAssistantMessageParam::FunctionCall,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The arguments to call the function with, as generated by the model in JSON
+          # format. Note that the model does not always generate valid JSON, and may
+          # hallucinate parameters not defined by your function schema. Validate the
+          # arguments in your code before calling your function.
+          sig { returns(String) }
+          attr_accessor :arguments
+
+          # The name of the function to call.
+          sig { returns(String) }
+          attr_accessor :name
+
+          # Deprecated and replaced by `tool_calls`. The name and arguments of a function
+          # that should be called, as generated by the model.
+          sig do
+            params(arguments: String, name: String).returns(T.attached_class)
+          end
+          def self.new(
+            # The arguments to call the function with, as generated by the model in JSON
+            # format. Note that the model does not always generate valid JSON, and may
+            # hallucinate parameters not defined by your function schema. Validate the
+            # arguments in your code before calling your function.
+            arguments:,
+            # The name of the function to call.
+            name:
+          )
+          end
+
+          sig { override.returns({ arguments: String, name: String }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/chat/chat_completion_audio.rbi

@@ -0,0 +1,72 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    ChatCompletionAudio = Chat::ChatCompletionAudio
+
+    module Chat
+      class ChatCompletionAudio < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(OpenAI::Chat::ChatCompletionAudio, OpenAI::Internal::AnyHash)
+          end
+
+        # Unique identifier for this audio response.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Base64 encoded audio bytes generated by the model, in the format specified in
+        # the request.
+        sig { returns(String) }
+        attr_accessor :data
+
+        # The Unix timestamp (in seconds) for when this audio response will no longer be
+        # accessible on the server for use in multi-turn conversations.
+        sig { returns(Integer) }
+        attr_accessor :expires_at
+
+        # Transcript of the audio generated by the model.
+        sig { returns(String) }
+        attr_accessor :transcript
+
+        # If the audio output modality is requested, this object contains data about the
+        # audio response from the model.
+        # [Learn more](https://platform.openai.com/docs/guides/audio).
+        sig do
+          params(
+            id: String,
+            data: String,
+            expires_at: Integer,
+            transcript: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Unique identifier for this audio response.
+          id:,
+          # Base64 encoded audio bytes generated by the model, in the format specified in
+          # the request.
+          data:,
+          # The Unix timestamp (in seconds) for when this audio response will no longer be
+          # accessible on the server for use in multi-turn conversations.
+          expires_at:,
+          # Transcript of the audio generated by the model.
+          transcript:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              data: String,
+              expires_at: Integer,
+              transcript: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/chat/chat_completion_audio_param.rbi

@@ -0,0 +1,213 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    ChatCompletionAudioParam = Chat::ChatCompletionAudioParam
+
+    module Chat
+      class ChatCompletionAudioParam < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Chat::ChatCompletionAudioParam,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # Specifies the output audio format. Must be one of `wav`, `mp3`, `flac`, `opus`,
+        # or `pcm16`.
+        sig do
+          returns(OpenAI::Chat::ChatCompletionAudioParam::Format::OrSymbol)
+        end
+        attr_accessor :format_
+
+        # The voice the model uses to respond. Supported voices are `alloy`, `ash`,
+        # `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, and `shimmer`.
+        sig do
+          returns(
+            T.any(
+              String,
+              OpenAI::Chat::ChatCompletionAudioParam::Voice::OrSymbol
+            )
+          )
+        end
+        attr_accessor :voice
+
+        # Parameters for audio output. Required when audio output is requested with
+        # `modalities: ["audio"]`.
+        # [Learn more](https://platform.openai.com/docs/guides/audio).
+        sig do
+          params(
+            format_: OpenAI::Chat::ChatCompletionAudioParam::Format::OrSymbol,
+            voice:
+              T.any(
+                String,
+                OpenAI::Chat::ChatCompletionAudioParam::Voice::OrSymbol
+              )
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Specifies the output audio format. Must be one of `wav`, `mp3`, `flac`, `opus`,
+          # or `pcm16`.
+          format_:,
+          # The voice the model uses to respond. Supported voices are `alloy`, `ash`,
+          # `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, and `shimmer`.
+          voice:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              format_: OpenAI::Chat::ChatCompletionAudioParam::Format::OrSymbol,
+              voice:
+                T.any(
+                  String,
+                  OpenAI::Chat::ChatCompletionAudioParam::Voice::OrSymbol
+                )
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Specifies the output audio format. Must be one of `wav`, `mp3`, `flac`, `opus`,
+        # or `pcm16`.
+        module Format
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, OpenAI::Chat::ChatCompletionAudioParam::Format)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          WAV =
+            T.let(
+              :wav,
+              OpenAI::Chat::ChatCompletionAudioParam::Format::TaggedSymbol
+            )
+          AAC =
+            T.let(
+              :aac,
+              OpenAI::Chat::ChatCompletionAudioParam::Format::TaggedSymbol
+            )
+          MP3 =
+            T.let(
+              :mp3,
+              OpenAI::Chat::ChatCompletionAudioParam::Format::TaggedSymbol
+            )
+          FLAC =
+            T.let(
+              :flac,
+              OpenAI::Chat::ChatCompletionAudioParam::Format::TaggedSymbol
+            )
+          OPUS =
+            T.let(
+              :opus,
+              OpenAI::Chat::ChatCompletionAudioParam::Format::TaggedSymbol
+            )
+          PCM16 =
+            T.let(
+              :pcm16,
+              OpenAI::Chat::ChatCompletionAudioParam::Format::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Chat::ChatCompletionAudioParam::Format::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # The voice the model uses to respond. Supported voices are `alloy`, `ash`,
+        # `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, and `shimmer`.
+        module Voice
+          extend OpenAI::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                String,
+                OpenAI::Chat::ChatCompletionAudioParam::Voice::TaggedSymbol
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[OpenAI::Chat::ChatCompletionAudioParam::Voice::Variants]
+            )
+          end
+          def self.variants
+          end
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, OpenAI::Chat::ChatCompletionAudioParam::Voice)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ALLOY =
+            T.let(
+              :alloy,
+              OpenAI::Chat::ChatCompletionAudioParam::Voice::TaggedSymbol
+            )
+          ASH =
+            T.let(
+              :ash,
+              OpenAI::Chat::ChatCompletionAudioParam::Voice::TaggedSymbol
+            )
+          BALLAD =
+            T.let(
+              :ballad,
+              OpenAI::Chat::ChatCompletionAudioParam::Voice::TaggedSymbol
+            )
+          CORAL =
+            T.let(
+              :coral,
+              OpenAI::Chat::ChatCompletionAudioParam::Voice::TaggedSymbol
+            )
+          ECHO =
+            T.let(
+              :echo,
+              OpenAI::Chat::ChatCompletionAudioParam::Voice::TaggedSymbol
+            )
+          FABLE =
+            T.let(
+              :fable,
+              OpenAI::Chat::ChatCompletionAudioParam::Voice::TaggedSymbol
+            )
+          ONYX =
+            T.let(
+              :onyx,
+              OpenAI::Chat::ChatCompletionAudioParam::Voice::TaggedSymbol
+            )
+          NOVA =
+            T.let(
+              :nova,
+              OpenAI::Chat::ChatCompletionAudioParam::Voice::TaggedSymbol
+            )
+          SAGE =
+            T.let(
+              :sage,
+              OpenAI::Chat::ChatCompletionAudioParam::Voice::TaggedSymbol
+            )
+          SHIMMER =
+            T.let(
+              :shimmer,
+              OpenAI::Chat::ChatCompletionAudioParam::Voice::TaggedSymbol
+            )
+          VERSE =
+            T.let(
+              :verse,
+              OpenAI::Chat::ChatCompletionAudioParam::Voice::TaggedSymbol
+            )
+        end
+      end
+    end
+  end
+end