openai 0.1.0.pre.beta.2 → 0.1.0

data/lib/openai/models/responses/response_output_text.rb

@@ -1,165 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseOutputText < OpenAI::Internal::Type::BaseModel
-        # @!attribute annotations
-        #   The annotations of the text output.
-        #
-        #   @return [Array<OpenAI::Models::Responses::ResponseOutputText::Annotation::FileCitation, OpenAI::Models::Responses::ResponseOutputText::Annotation::URLCitation, OpenAI::Models::Responses::ResponseOutputText::Annotation::FilePath>]
-        required :annotations,
-                 -> {
-                   OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::ResponseOutputText::Annotation]
-                 }
-
-        # @!attribute text
-        #   The text output from the model.
-        #
-        #   @return [String]
-        required :text, String
-
-        # @!attribute type
-        #   The type of the output text. Always `output_text`.
-        #
-        #   @return [Symbol, :output_text]
-        required :type, const: :output_text
-
-        # @!method initialize(annotations:, text:, type: :output_text)
-        #   A text output from the model.
-        #
-        #   @param annotations [Array<OpenAI::Models::Responses::ResponseOutputText::Annotation::FileCitation, OpenAI::Models::Responses::ResponseOutputText::Annotation::URLCitation, OpenAI::Models::Responses::ResponseOutputText::Annotation::FilePath>] The annotations of the text output.
-        #
-        #   @param text [String] The text output from the model.
-        #
-        #   @param type [Symbol, :output_text] The type of the output text. Always `output_text`.
-
-        # A citation to a file.
-        module Annotation
-          extend OpenAI::Internal::Type::Union
-
-          discriminator :type
-
-          # A citation to a file.
-          variant :file_citation, -> { OpenAI::Responses::ResponseOutputText::Annotation::FileCitation }
-
-          # A citation for a web resource used to generate a model response.
-          variant :url_citation, -> { OpenAI::Responses::ResponseOutputText::Annotation::URLCitation }
-
-          # A path to a file.
-          variant :file_path, -> { OpenAI::Responses::ResponseOutputText::Annotation::FilePath }
-
-          class FileCitation < OpenAI::Internal::Type::BaseModel
-            # @!attribute file_id
-            #   The ID of the file.
-            #
-            #   @return [String]
-            required :file_id, String
-
-            # @!attribute index
-            #   The index of the file in the list of files.
-            #
-            #   @return [Integer]
-            required :index, Integer
-
-            # @!attribute type
-            #   The type of the file citation. Always `file_citation`.
-            #
-            #   @return [Symbol, :file_citation]
-            required :type, const: :file_citation
-
-            # @!method initialize(file_id:, index:, type: :file_citation)
-            #   A citation to a file.
-            #
-            #   @param file_id [String] The ID of the file.
-            #
-            #   @param index [Integer] The index of the file in the list of files.
-            #
-            #   @param type [Symbol, :file_citation] The type of the file citation. Always `file_citation`.
-          end
-
-          class URLCitation < OpenAI::Internal::Type::BaseModel
-            # @!attribute end_index
-            #   The index of the last character of the URL citation in the message.
-            #
-            #   @return [Integer]
-            required :end_index, Integer
-
-            # @!attribute start_index
-            #   The index of the first character of the URL citation in the message.
-            #
-            #   @return [Integer]
-            required :start_index, Integer
-
-            # @!attribute title
-            #   The title of the web resource.
-            #
-            #   @return [String]
-            required :title, String
-
-            # @!attribute type
-            #   The type of the URL citation. Always `url_citation`.
-            #
-            #   @return [Symbol, :url_citation]
-            required :type, const: :url_citation
-
-            # @!attribute url
-            #   The URL of the web resource.
-            #
-            #   @return [String]
-            required :url, String
-
-            # @!method initialize(end_index:, start_index:, title:, url:, type: :url_citation)
-            #   A citation for a web resource used to generate a model response.
-            #
-            #   @param end_index [Integer] The index of the last character of the URL citation in the message.
-            #
-            #   @param start_index [Integer] The index of the first character of the URL citation in the message.
-            #
-            #   @param title [String] The title of the web resource.
-            #
-            #   @param url [String] The URL of the web resource.
-            #
-            #   @param type [Symbol, :url_citation] The type of the URL citation. Always `url_citation`.
-          end
-
-          class FilePath < OpenAI::Internal::Type::BaseModel
-            # @!attribute file_id
-            #   The ID of the file.
-            #
-            #   @return [String]
-            required :file_id, String
-
-            # @!attribute index
-            #   The index of the file in the list of files.
-            #
-            #   @return [Integer]
-            required :index, Integer
-
-            # @!attribute type
-            #   The type of the file path. Always `file_path`.
-            #
-            #   @return [Symbol, :file_path]
-            required :type, const: :file_path
-
-            # @!method initialize(file_id:, index:, type: :file_path)
-            #   Some parameter documentations has been truncated, see
-            #   {OpenAI::Models::Responses::ResponseOutputText::Annotation::FilePath} for more
-            #   details.
-            #
-            #   A path to a file.
-            #
-            #   @param file_id [String] The ID of the file.
-            #
-            #   @param index [Integer] The index of the file in the list of files.
-            #
-            #   @param type [Symbol, :file_path] The type of the file path. Always `file_path`.
-          end
-
-          # @!method self.variants
-          #   @return [Array(OpenAI::Models::Responses::ResponseOutputText::Annotation::FileCitation, OpenAI::Models::Responses::ResponseOutputText::Annotation::URLCitation, OpenAI::Models::Responses::ResponseOutputText::Annotation::FilePath)]
-        end
-      end
-    end
-  end
-end

data/lib/openai/models/responses/response_output_text_annotation_added_event.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseOutputTextAnnotationAddedEvent < OpenAI::Internal::Type::BaseModel
-        # @!attribute annotation
-        #   The annotation object being added. (See annotation schema for details.)
-        #
-        #   @return [Object]
-        required :annotation, OpenAI::Internal::Type::Unknown
-
-        # @!attribute annotation_index
-        #   The index of the annotation within the content part.
-        #
-        #   @return [Integer]
-        required :annotation_index, Integer
-
-        # @!attribute content_index
-        #   The index of the content part within the output item.
-        #
-        #   @return [Integer]
-        required :content_index, Integer
-
-        # @!attribute item_id
-        #   The unique identifier of the item to which the annotation is being added.
-        #
-        #   @return [String]
-        required :item_id, String
-
-        # @!attribute output_index
-        #   The index of the output item in the response's output array.
-        #
-        #   @return [Integer]
-        required :output_index, Integer
-
-        # @!attribute sequence_number
-        #   The sequence number of this event.
-        #
-        #   @return [Integer]
-        required :sequence_number, Integer
-
-        # @!attribute type
-        #   The type of the event. Always 'response.output_text_annotation.added'.
-        #
-        #   @return [Symbol, :"response.output_text_annotation.added"]
-        required :type, const: :"response.output_text_annotation.added"
-
-        # @!method initialize(annotation:, annotation_index:, content_index:, item_id:, output_index:, sequence_number:, type: :"response.output_text_annotation.added")
-        #   Emitted when an annotation is added to output text content.
-        #
-        #   @param annotation [Object] The annotation object being added. (See annotation schema for details.)
-        #
-        #   @param annotation_index [Integer] The index of the annotation within the content part.
-        #
-        #   @param content_index [Integer] The index of the content part within the output item.
-        #
-        #   @param item_id [String] The unique identifier of the item to which the annotation is being added.
-        #
-        #   @param output_index [Integer] The index of the output item in the response's output array.
-        #
-        #   @param sequence_number [Integer] The sequence number of this event.
-        #
-        #   @param type [Symbol, :"response.output_text_annotation.added"] The type of the event. Always 'response.output_text_annotation.added'.
-      end
-    end
-  end
-end

data/lib/openai/models/responses/response_queued_event.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseQueuedEvent < OpenAI::Internal::Type::BaseModel
-        # @!attribute response
-        #   The full response object that is queued.
-        #
-        #   @return [OpenAI::Models::Responses::Response]
-        required :response, -> { OpenAI::Responses::Response }
-
-        # @!attribute sequence_number
-        #   The sequence number for this event.
-        #
-        #   @return [Integer]
-        required :sequence_number, Integer
-
-        # @!attribute type
-        #   The type of the event. Always 'response.queued'.
-        #
-        #   @return [Symbol, :"response.queued"]
-        required :type, const: :"response.queued"
-
-        # @!method initialize(response:, sequence_number:, type: :"response.queued")
-        #   Emitted when a response is queued and waiting to be processed.
-        #
-        #   @param response [OpenAI::Models::Responses::Response] The full response object that is queued.
-        #
-        #   @param sequence_number [Integer] The sequence number for this event.
-        #
-        #   @param type [Symbol, :"response.queued"] The type of the event. Always 'response.queued'.
-      end
-    end
-  end
-end

data/lib/openai/models/responses/response_reasoning_delta_event.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseReasoningDeltaEvent < OpenAI::Internal::Type::BaseModel
-        # @!attribute content_index
-        #   The index of the reasoning content part within the output item.
-        #
-        #   @return [Integer]
-        required :content_index, Integer
-
-        # @!attribute delta
-        #   The partial update to the reasoning content.
-        #
-        #   @return [Object]
-        required :delta, OpenAI::Internal::Type::Unknown
-
-        # @!attribute item_id
-        #   The unique identifier of the item for which reasoning is being updated.
-        #
-        #   @return [String]
-        required :item_id, String
-
-        # @!attribute output_index
-        #   The index of the output item in the response's output array.
-        #
-        #   @return [Integer]
-        required :output_index, Integer
-
-        # @!attribute sequence_number
-        #   The sequence number of this event.
-        #
-        #   @return [Integer]
-        required :sequence_number, Integer
-
-        # @!attribute type
-        #   The type of the event. Always 'response.reasoning.delta'.
-        #
-        #   @return [Symbol, :"response.reasoning.delta"]
-        required :type, const: :"response.reasoning.delta"
-
-        # @!method initialize(content_index:, delta:, item_id:, output_index:, sequence_number:, type: :"response.reasoning.delta")
-        #   Emitted when there is a delta (partial update) to the reasoning content.
-        #
-        #   @param content_index [Integer] The index of the reasoning content part within the output item.
-        #
-        #   @param delta [Object] The partial update to the reasoning content.
-        #
-        #   @param item_id [String] The unique identifier of the item for which reasoning is being updated.
-        #
-        #   @param output_index [Integer] The index of the output item in the response's output array.
-        #
-        #   @param sequence_number [Integer] The sequence number of this event.
-        #
-        #   @param type [Symbol, :"response.reasoning.delta"] The type of the event. Always 'response.reasoning.delta'.
-      end
-    end
-  end
-end

data/lib/openai/models/responses/response_reasoning_done_event.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseReasoningDoneEvent < OpenAI::Internal::Type::BaseModel
-        # @!attribute content_index
-        #   The index of the reasoning content part within the output item.
-        #
-        #   @return [Integer]
-        required :content_index, Integer
-
-        # @!attribute item_id
-        #   The unique identifier of the item for which reasoning is finalized.
-        #
-        #   @return [String]
-        required :item_id, String
-
-        # @!attribute output_index
-        #   The index of the output item in the response's output array.
-        #
-        #   @return [Integer]
-        required :output_index, Integer
-
-        # @!attribute sequence_number
-        #   The sequence number of this event.
-        #
-        #   @return [Integer]
-        required :sequence_number, Integer
-
-        # @!attribute text
-        #   The finalized reasoning text.
-        #
-        #   @return [String]
-        required :text, String
-
-        # @!attribute type
-        #   The type of the event. Always 'response.reasoning.done'.
-        #
-        #   @return [Symbol, :"response.reasoning.done"]
-        required :type, const: :"response.reasoning.done"
-
-        # @!method initialize(content_index:, item_id:, output_index:, sequence_number:, text:, type: :"response.reasoning.done")
-        #   Emitted when the reasoning content is finalized for an item.
-        #
-        #   @param content_index [Integer] The index of the reasoning content part within the output item.
-        #
-        #   @param item_id [String] The unique identifier of the item for which reasoning is finalized.
-        #
-        #   @param output_index [Integer] The index of the output item in the response's output array.
-        #
-        #   @param sequence_number [Integer] The sequence number of this event.
-        #
-        #   @param text [String] The finalized reasoning text.
-        #
-        #   @param type [Symbol, :"response.reasoning.done"] The type of the event. Always 'response.reasoning.done'.
-      end
-    end
-  end
-end

data/lib/openai/models/responses/response_reasoning_item.rb

@@ -1,98 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseReasoningItem < OpenAI::Internal::Type::BaseModel
-        # @!attribute id
-        #   The unique identifier of the reasoning content.
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute summary
-        #   Reasoning text contents.
-        #
-        #   @return [Array<OpenAI::Models::Responses::ResponseReasoningItem::Summary>]
-        required :summary,
-                 -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Responses::ResponseReasoningItem::Summary] }
-
-        # @!attribute type
-        #   The type of the object. Always `reasoning`.
-        #
-        #   @return [Symbol, :reasoning]
-        required :type, const: :reasoning
-
-        # @!attribute encrypted_content
-        #   The encrypted content of the reasoning item - populated when a response is
-        #   generated with `reasoning.encrypted_content` in the `include` parameter.
-        #
-        #   @return [String, nil]
-        optional :encrypted_content, String, nil?: true
-
-        # @!attribute status
-        #   The status of the item. One of `in_progress`, `completed`, or `incomplete`.
-        #   Populated when items are returned via API.
-        #
-        #   @return [Symbol, OpenAI::Models::Responses::ResponseReasoningItem::Status, nil]
-        optional :status, enum: -> { OpenAI::Responses::ResponseReasoningItem::Status }
-
-        # @!method initialize(id:, summary:, encrypted_content: nil, status: nil, type: :reasoning)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseReasoningItem} for more details.
-        #
-        #   A description of the chain of thought used by a reasoning model while generating
-        #   a response. Be sure to include these items in your `input` to the Responses API
-        #   for subsequent turns of a conversation if you are manually
-        #   [managing context](https://platform.openai.com/docs/guides/conversation-state).
-        #
-        #   @param id [String] The unique identifier of the reasoning content.
-        #
-        #   @param summary [Array<OpenAI::Models::Responses::ResponseReasoningItem::Summary>] Reasoning text contents.
-        #
-        #   @param encrypted_content [String, nil] The encrypted content of the reasoning item - populated when a response is
-        #
-        #   @param status [Symbol, OpenAI::Models::Responses::ResponseReasoningItem::Status] The status of the item. One of `in_progress`, `completed`, or
-        #
-        #   @param type [Symbol, :reasoning] The type of the object. Always `reasoning`.
-
-        class Summary < OpenAI::Internal::Type::BaseModel
-          # @!attribute text
-          #   A short summary of the reasoning used by the model when generating the response.
-          #
-          #   @return [String]
-          required :text, String
-
-          # @!attribute type
-          #   The type of the object. Always `summary_text`.
-          #
-          #   @return [Symbol, :summary_text]
-          required :type, const: :summary_text
-
-          # @!method initialize(text:, type: :summary_text)
-          #   Some parameter documentations has been truncated, see
-          #   {OpenAI::Models::Responses::ResponseReasoningItem::Summary} for more details.
-          #
-          #   @param text [String] A short summary of the reasoning used by the model when generating
-          #
-          #   @param type [Symbol, :summary_text] The type of the object. Always `summary_text`.
-        end
-
-        # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
-        # Populated when items are returned via API.
-        #
-        # @see OpenAI::Models::Responses::ResponseReasoningItem#status
-        module Status
-          extend OpenAI::Internal::Type::Enum
-
-          IN_PROGRESS = :in_progress
-          COMPLETED = :completed
-          INCOMPLETE = :incomplete
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-    end
-  end
-end

data/lib/openai/models/responses/response_reasoning_summary_delta_event.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseReasoningSummaryDeltaEvent < OpenAI::Internal::Type::BaseModel
-        # @!attribute delta
-        #   The partial update to the reasoning summary content.
-        #
-        #   @return [Object]
-        required :delta, OpenAI::Internal::Type::Unknown
-
-        # @!attribute item_id
-        #   The unique identifier of the item for which the reasoning summary is being
-        #   updated.
-        #
-        #   @return [String]
-        required :item_id, String
-
-        # @!attribute output_index
-        #   The index of the output item in the response's output array.
-        #
-        #   @return [Integer]
-        required :output_index, Integer
-
-        # @!attribute sequence_number
-        #   The sequence number of this event.
-        #
-        #   @return [Integer]
-        required :sequence_number, Integer
-
-        # @!attribute summary_index
-        #   The index of the summary part within the output item.
-        #
-        #   @return [Integer]
-        required :summary_index, Integer
-
-        # @!attribute type
-        #   The type of the event. Always 'response.reasoning_summary.delta'.
-        #
-        #   @return [Symbol, :"response.reasoning_summary.delta"]
-        required :type, const: :"response.reasoning_summary.delta"
-
-        # @!method initialize(delta:, item_id:, output_index:, sequence_number:, summary_index:, type: :"response.reasoning_summary.delta")
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Responses::ResponseReasoningSummaryDeltaEvent} for more
-        #   details.
-        #
-        #   Emitted when there is a delta (partial update) to the reasoning summary content.
-        #
-        #   @param delta [Object] The partial update to the reasoning summary content.
-        #
-        #   @param item_id [String] The unique identifier of the item for which the reasoning summary is being updat
-        #
-        #   @param output_index [Integer] The index of the output item in the response's output array.
-        #
-        #   @param sequence_number [Integer] The sequence number of this event.
-        #
-        #   @param summary_index [Integer] The index of the summary part within the output item.
-        #
-        #   @param type [Symbol, :"response.reasoning_summary.delta"] The type of the event. Always 'response.reasoning_summary.delta'.
-      end
-    end
-  end
-end

data/lib/openai/models/responses/response_reasoning_summary_done_event.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Responses
-      class ResponseReasoningSummaryDoneEvent < OpenAI::Internal::Type::BaseModel
-        # @!attribute item_id
-        #   The unique identifier of the item for which the reasoning summary is finalized.
-        #
-        #   @return [String]
-        required :item_id, String
-
-        # @!attribute output_index
-        #   The index of the output item in the response's output array.
-        #
-        #   @return [Integer]
-        required :output_index, Integer
-
-        # @!attribute sequence_number
-        #   The sequence number of this event.
-        #
-        #   @return [Integer]
-        required :sequence_number, Integer
-
-        # @!attribute summary_index
-        #   The index of the summary part within the output item.
-        #
-        #   @return [Integer]
-        required :summary_index, Integer
-
-        # @!attribute text
-        #   The finalized reasoning summary text.
-        #
-        #   @return [String]
-        required :text, String
-
-        # @!attribute type
-        #   The type of the event. Always 'response.reasoning_summary.done'.
-        #
-        #   @return [Symbol, :"response.reasoning_summary.done"]
-        required :type, const: :"response.reasoning_summary.done"
-
-        # @!method initialize(item_id:, output_index:, sequence_number:, summary_index:, text:, type: :"response.reasoning_summary.done")
-        #   Emitted when the reasoning summary content is finalized for an item.
-        #
-        #   @param item_id [String] The unique identifier of the item for which the reasoning summary is finalized.
-        #
-        #   @param output_index [Integer] The index of the output item in the response's output array.
-        #
-        #   @param sequence_number [Integer] The sequence number of this event.
-        #
-        #   @param summary_index [Integer] The index of the summary part within the output item.
-        #
-        #   @param text [String] The finalized reasoning summary text.
-        #
-        #   @param type [Symbol, :"response.reasoning_summary.done"] The type of the event. Always 'response.reasoning_summary.done'.
-      end
-    end
-  end
-end