diff --git a/lib/openai/models/audio/speech_create_params.rb b/lib/openai/models/audio/speech_create_params.rb index f59e9311..e7ebf9d7 100644 --- a/lib/openai/models/audio/speech_create_params.rb +++ b/lib/openai/models/audio/speech_create_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module Audio + # @see OpenAI::Resources::Audio::Speech#create class SpeechCreateParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/audio/transcription_create_params.rb b/lib/openai/models/audio/transcription_create_params.rb index bcd93827..9326a51f 100644 --- a/lib/openai/models/audio/transcription_create_params.rb +++ b/lib/openai/models/audio/transcription_create_params.rb @@ -3,6 +3,9 @@ module OpenAI module Models module Audio + # @see OpenAI::Resources::Audio::Transcriptions#create + # + # @see OpenAI::Resources::Audio::Transcriptions#create_streaming class TranscriptionCreateParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/audio/translation_create_params.rb b/lib/openai/models/audio/translation_create_params.rb index 5f5c90ad..80c1292c 100644 --- a/lib/openai/models/audio/translation_create_params.rb +++ b/lib/openai/models/audio/translation_create_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module Audio + # @see OpenAI::Resources::Audio::Translations#create class TranslationCreateParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/batch.rb b/lib/openai/models/batch.rb index 96e290bb..e41efffb 100644 --- a/lib/openai/models/batch.rb +++ b/lib/openai/models/batch.rb @@ -225,6 +225,8 @@ class Batch < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # The current status of the batch. + # + # @see OpenAI::Models::Batch#status module Status extend OpenAI::Enum @@ -244,6 +246,7 @@ module Status # def self.values; end end + # @see OpenAI::Models::Batch#errors class Errors < OpenAI::BaseModel # @!attribute [r] data # diff --git a/lib/openai/models/batch_cancel_params.rb b/lib/openai/models/batch_cancel_params.rb index 6772ee41..1b94b154 100644 --- a/lib/openai/models/batch_cancel_params.rb +++ b/lib/openai/models/batch_cancel_params.rb @@ -2,6 +2,7 @@ module OpenAI module Models + # @see OpenAI::Resources::Batches#cancel class BatchCancelParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/batch_create_params.rb b/lib/openai/models/batch_create_params.rb index b58fb416..91a8de4e 100644 --- a/lib/openai/models/batch_create_params.rb +++ b/lib/openai/models/batch_create_params.rb @@ -2,6 +2,7 @@ module OpenAI module Models + # @see OpenAI::Resources::Batches#create class BatchCreateParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/batch_list_params.rb b/lib/openai/models/batch_list_params.rb index 5bd6a019..0515bbc5 100644 --- a/lib/openai/models/batch_list_params.rb +++ b/lib/openai/models/batch_list_params.rb @@ -2,6 +2,7 @@ module OpenAI module Models + # @see OpenAI::Resources::Batches#list class BatchListParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/batch_retrieve_params.rb b/lib/openai/models/batch_retrieve_params.rb index 12c4186e..fae80854 100644 --- a/lib/openai/models/batch_retrieve_params.rb +++ b/lib/openai/models/batch_retrieve_params.rb @@ -2,6 +2,7 @@ module OpenAI module Models + # @see OpenAI::Resources::Batches#retrieve class BatchRetrieveParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/beta/assistant.rb b/lib/openai/models/beta/assistant.rb index c7a250d4..5b56453e 100644 --- a/lib/openai/models/beta/assistant.rb +++ b/lib/openai/models/beta/assistant.rb @@ -160,6 +160,7 @@ class Assistant < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::Assistant#tool_resources class ToolResources < OpenAI::BaseModel # @!attribute [r] code_interpreter # @@ -192,6 +193,7 @@ class ToolResources < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::Assistant::ToolResources#code_interpreter class CodeInterpreter < OpenAI::BaseModel # @!attribute [r] file_ids # A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made @@ -213,6 +215,7 @@ class CodeInterpreter < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void end + # @see OpenAI::Models::Beta::Assistant::ToolResources#file_search class FileSearch < OpenAI::BaseModel # @!attribute [r] vector_store_ids # The ID of the diff --git a/lib/openai/models/beta/assistant_create_params.rb b/lib/openai/models/beta/assistant_create_params.rb index dab3186e..881fd6ee 100644 --- a/lib/openai/models/beta/assistant_create_params.rb +++ b/lib/openai/models/beta/assistant_create_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module Beta + # @see OpenAI::Resources::Beta::Assistants#create class AssistantCreateParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter @@ -208,6 +209,7 @@ class ToolResources < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::AssistantCreateParams::ToolResources#code_interpreter class CodeInterpreter < OpenAI::BaseModel # @!attribute [r] file_ids # A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made @@ -229,6 +231,7 @@ class CodeInterpreter < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void end + # @see OpenAI::Models::Beta::AssistantCreateParams::ToolResources#file_search class FileSearch < OpenAI::BaseModel # @!attribute [r] vector_store_ids # The @@ -312,6 +315,8 @@ class VectorStore < OpenAI::BaseModel # The chunking strategy used to chunk the file(s). If not set, will use the `auto` # strategy. + # + # @see OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore#chunking_strategy module ChunkingStrategy extend OpenAI::Union @@ -363,6 +368,7 @@ class Static < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static#static class Static < OpenAI::BaseModel # @!attribute chunk_overlap_tokens # The number of tokens that overlap between chunks. The default value is `400`. diff --git a/lib/openai/models/beta/assistant_delete_params.rb b/lib/openai/models/beta/assistant_delete_params.rb index 939c39ee..08dbb202 100644 --- a/lib/openai/models/beta/assistant_delete_params.rb +++ b/lib/openai/models/beta/assistant_delete_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module Beta + # @see OpenAI::Resources::Beta::Assistants#delete class AssistantDeleteParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/beta/assistant_list_params.rb b/lib/openai/models/beta/assistant_list_params.rb index 601a694b..2ccfe616 100644 --- a/lib/openai/models/beta/assistant_list_params.rb +++ b/lib/openai/models/beta/assistant_list_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module Beta + # @see OpenAI::Resources::Beta::Assistants#list class AssistantListParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/beta/assistant_retrieve_params.rb b/lib/openai/models/beta/assistant_retrieve_params.rb index 40ba9b41..7fe50f31 100644 --- a/lib/openai/models/beta/assistant_retrieve_params.rb +++ b/lib/openai/models/beta/assistant_retrieve_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module Beta + # @see OpenAI::Resources::Beta::Assistants#retrieve class AssistantRetrieveParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/beta/assistant_tool_choice.rb b/lib/openai/models/beta/assistant_tool_choice.rb index b7cb38c3..1caf13f7 100644 --- a/lib/openai/models/beta/assistant_tool_choice.rb +++ b/lib/openai/models/beta/assistant_tool_choice.rb @@ -31,6 +31,8 @@ class AssistantToolChoice < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # The type of the tool. If type is `function`, the function name must be set + # + # @see OpenAI::Models::Beta::AssistantToolChoice#type module Type extend OpenAI::Enum diff --git a/lib/openai/models/beta/assistant_update_params.rb b/lib/openai/models/beta/assistant_update_params.rb index 6b2bbaf8..3c3bdd37 100644 --- a/lib/openai/models/beta/assistant_update_params.rb +++ b/lib/openai/models/beta/assistant_update_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module Beta + # @see OpenAI::Resources::Beta::Assistants#update class AssistantUpdateParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter @@ -304,6 +305,7 @@ class ToolResources < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::AssistantUpdateParams::ToolResources#code_interpreter class CodeInterpreter < OpenAI::BaseModel # @!attribute [r] file_ids # Overrides the list of @@ -326,6 +328,7 @@ class CodeInterpreter < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void end + # @see OpenAI::Models::Beta::AssistantUpdateParams::ToolResources#file_search class FileSearch < OpenAI::BaseModel # @!attribute [r] vector_store_ids # Overrides the diff --git a/lib/openai/models/beta/file_search_tool.rb b/lib/openai/models/beta/file_search_tool.rb index 98e95ab3..9a23f3f2 100644 --- a/lib/openai/models/beta/file_search_tool.rb +++ b/lib/openai/models/beta/file_search_tool.rb @@ -28,6 +28,7 @@ class FileSearchTool < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::FileSearchTool#file_search class FileSearch < OpenAI::BaseModel # @!attribute [r] max_num_results # The maximum number of results the file search tool should output. The default is @@ -71,6 +72,7 @@ class FileSearch < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::FileSearchTool::FileSearch#ranking_options class RankingOptions < OpenAI::BaseModel # @!attribute score_threshold # The score threshold for the file search. All values must be a floating point @@ -107,6 +109,8 @@ class RankingOptions < OpenAI::BaseModel # The ranker to use for the file search. If not specified will use the `auto` # ranker. + # + # @see OpenAI::Models::Beta::FileSearchTool::FileSearch::RankingOptions#ranker module Ranker extend OpenAI::Enum diff --git a/lib/openai/models/beta/thread.rb b/lib/openai/models/beta/thread.rb index 3de11c4c..737cbf81 100644 --- a/lib/openai/models/beta/thread.rb +++ b/lib/openai/models/beta/thread.rb @@ -56,6 +56,7 @@ class Thread < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::Thread#tool_resources class ToolResources < OpenAI::BaseModel # @!attribute [r] code_interpreter # @@ -88,6 +89,7 @@ class ToolResources < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::Thread::ToolResources#code_interpreter class CodeInterpreter < OpenAI::BaseModel # @!attribute [r] file_ids # A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made @@ -109,6 +111,7 @@ class CodeInterpreter < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void end + # @see OpenAI::Models::Beta::Thread::ToolResources#file_search class FileSearch < OpenAI::BaseModel # @!attribute [r] vector_store_ids # The diff --git a/lib/openai/models/beta/thread_create_and_run_params.rb b/lib/openai/models/beta/thread_create_and_run_params.rb index 56c776fa..d1a26adb 100644 --- a/lib/openai/models/beta/thread_create_and_run_params.rb +++ b/lib/openai/models/beta/thread_create_and_run_params.rb @@ -3,6 +3,9 @@ module OpenAI module Models module Beta + # @see OpenAI::Resources::Beta::Threads#create_and_run + # + # @see OpenAI::Resources::Beta::Threads#create_and_run_streaming class ThreadCreateAndRunParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter @@ -322,6 +325,8 @@ class Message < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # The text contents of the message. + # + # @see OpenAI::Models::Beta::ThreadCreateAndRunParams::Thread::Message#content module Content extend OpenAI::Union @@ -345,6 +350,8 @@ module Content # most cases to represent user-generated messages. # - `assistant`: Indicates the message is generated by the assistant. Use this # value to insert messages from the assistant into the conversation. + # + # @see OpenAI::Models::Beta::ThreadCreateAndRunParams::Thread::Message#role module Role extend OpenAI::Enum @@ -420,6 +427,7 @@ class FileSearch < OpenAI::BaseModel end end + # @see OpenAI::Models::Beta::ThreadCreateAndRunParams::Thread#tool_resources class ToolResources < OpenAI::BaseModel # @!attribute [r] code_interpreter # @@ -454,6 +462,7 @@ class ToolResources < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::ThreadCreateAndRunParams::Thread::ToolResources#code_interpreter class CodeInterpreter < OpenAI::BaseModel # @!attribute [r] file_ids # A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made @@ -475,6 +484,7 @@ class CodeInterpreter < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void end + # @see OpenAI::Models::Beta::ThreadCreateAndRunParams::Thread::ToolResources#file_search class FileSearch < OpenAI::BaseModel # @!attribute [r] vector_store_ids # The @@ -558,6 +568,8 @@ class VectorStore < OpenAI::BaseModel # The chunking strategy used to chunk the file(s). If not set, will use the `auto` # strategy. + # + # @see OpenAI::Models::Beta::ThreadCreateAndRunParams::Thread::ToolResources::FileSearch::VectorStore#chunking_strategy module ChunkingStrategy extend OpenAI::Union @@ -609,6 +621,7 @@ class Static < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::ThreadCreateAndRunParams::Thread::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static#static class Static < OpenAI::BaseModel # @!attribute chunk_overlap_tokens # The number of tokens that overlap between chunks. The default value is `400`. @@ -677,6 +690,7 @@ class ToolResources < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::ThreadCreateAndRunParams::ToolResources#code_interpreter class CodeInterpreter < OpenAI::BaseModel # @!attribute [r] file_ids # A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made @@ -698,6 +712,7 @@ class CodeInterpreter < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void end + # @see OpenAI::Models::Beta::ThreadCreateAndRunParams::ToolResources#file_search class FileSearch < OpenAI::BaseModel # @!attribute [r] vector_store_ids # The ID of the @@ -767,6 +782,8 @@ class TruncationStrategy < OpenAI::BaseModel # `last_messages`, the thread will be truncated to the n most recent messages in # the thread. When set to `auto`, messages in the middle of the thread will be # dropped to fit the context length of the model, `max_prompt_tokens`. + # + # @see OpenAI::Models::Beta::ThreadCreateAndRunParams::TruncationStrategy#type module Type extend OpenAI::Enum diff --git a/lib/openai/models/beta/thread_create_params.rb b/lib/openai/models/beta/thread_create_params.rb index 3095b908..d778808c 100644 --- a/lib/openai/models/beta/thread_create_params.rb +++ b/lib/openai/models/beta/thread_create_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module Beta + # @see OpenAI::Resources::Beta::Threads#create class ThreadCreateParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter @@ -97,6 +98,8 @@ class Message < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # The text contents of the message. + # + # @see OpenAI::Models::Beta::ThreadCreateParams::Message#content module Content extend OpenAI::Union @@ -120,6 +123,8 @@ module Content # most cases to represent user-generated messages. # - `assistant`: Indicates the message is generated by the assistant. Use this # value to insert messages from the assistant into the conversation. + # + # @see OpenAI::Models::Beta::ThreadCreateParams::Message#role module Role extend OpenAI::Enum @@ -228,6 +233,7 @@ class ToolResources < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::ThreadCreateParams::ToolResources#code_interpreter class CodeInterpreter < OpenAI::BaseModel # @!attribute [r] file_ids # A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made @@ -249,6 +255,7 @@ class CodeInterpreter < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void end + # @see OpenAI::Models::Beta::ThreadCreateParams::ToolResources#file_search class FileSearch < OpenAI::BaseModel # @!attribute [r] vector_store_ids # The @@ -332,6 +339,8 @@ class VectorStore < OpenAI::BaseModel # The chunking strategy used to chunk the file(s). If not set, will use the `auto` # strategy. + # + # @see OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore#chunking_strategy module ChunkingStrategy extend OpenAI::Union @@ -383,6 +392,7 @@ class Static < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::ThreadCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static#static class Static < OpenAI::BaseModel # @!attribute chunk_overlap_tokens # The number of tokens that overlap between chunks. The default value is `400`. diff --git a/lib/openai/models/beta/thread_delete_params.rb b/lib/openai/models/beta/thread_delete_params.rb index f81ea4ec..71afbb41 100644 --- a/lib/openai/models/beta/thread_delete_params.rb +++ b/lib/openai/models/beta/thread_delete_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module Beta + # @see OpenAI::Resources::Beta::Threads#delete class ThreadDeleteParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/beta/thread_retrieve_params.rb b/lib/openai/models/beta/thread_retrieve_params.rb index 4df984d4..c12d6b56 100644 --- a/lib/openai/models/beta/thread_retrieve_params.rb +++ b/lib/openai/models/beta/thread_retrieve_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module Beta + # @see OpenAI::Resources::Beta::Threads#retrieve class ThreadRetrieveParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/beta/thread_update_params.rb b/lib/openai/models/beta/thread_update_params.rb index e4d3d234..e80088af 100644 --- a/lib/openai/models/beta/thread_update_params.rb +++ b/lib/openai/models/beta/thread_update_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module Beta + # @see OpenAI::Resources::Beta::Threads#update class ThreadUpdateParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter @@ -70,6 +71,7 @@ class ToolResources < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::ThreadUpdateParams::ToolResources#code_interpreter class CodeInterpreter < OpenAI::BaseModel # @!attribute [r] file_ids # A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made @@ -91,6 +93,7 @@ class CodeInterpreter < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void end + # @see OpenAI::Models::Beta::ThreadUpdateParams::ToolResources#file_search class FileSearch < OpenAI::BaseModel # @!attribute [r] vector_store_ids # The diff --git a/lib/openai/models/beta/threads/file_citation_annotation.rb b/lib/openai/models/beta/threads/file_citation_annotation.rb index 0c3116f3..e471d257 100644 --- a/lib/openai/models/beta/threads/file_citation_annotation.rb +++ b/lib/openai/models/beta/threads/file_citation_annotation.rb @@ -47,6 +47,7 @@ class FileCitationAnnotation < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::Threads::FileCitationAnnotation#file_citation class FileCitation < OpenAI::BaseModel # @!attribute file_id # The ID of the specific File the citation is from. diff --git a/lib/openai/models/beta/threads/file_citation_delta_annotation.rb b/lib/openai/models/beta/threads/file_citation_delta_annotation.rb index 512bc7ad..5d2bf50f 100644 --- a/lib/openai/models/beta/threads/file_citation_delta_annotation.rb +++ b/lib/openai/models/beta/threads/file_citation_delta_annotation.rb @@ -70,6 +70,7 @@ class FileCitationDeltaAnnotation < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::Threads::FileCitationDeltaAnnotation#file_citation class FileCitation < OpenAI::BaseModel # @!attribute [r] file_id # The ID of the specific File the citation is from. diff --git a/lib/openai/models/beta/threads/file_path_annotation.rb b/lib/openai/models/beta/threads/file_path_annotation.rb index a04561c4..fbe60a09 100644 --- a/lib/openai/models/beta/threads/file_path_annotation.rb +++ b/lib/openai/models/beta/threads/file_path_annotation.rb @@ -46,6 +46,7 @@ class FilePathAnnotation < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::Threads::FilePathAnnotation#file_path class FilePath < OpenAI::BaseModel # @!attribute file_id # The ID of the file that was generated. diff --git a/lib/openai/models/beta/threads/file_path_delta_annotation.rb b/lib/openai/models/beta/threads/file_path_delta_annotation.rb index 1ef92d3a..8fe4a8e7 100644 --- a/lib/openai/models/beta/threads/file_path_delta_annotation.rb +++ b/lib/openai/models/beta/threads/file_path_delta_annotation.rb @@ -69,6 +69,7 @@ class FilePathDeltaAnnotation < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::Threads::FilePathDeltaAnnotation#file_path class FilePath < OpenAI::BaseModel # @!attribute [r] file_id # The ID of the file that was generated. diff --git a/lib/openai/models/beta/threads/image_file.rb b/lib/openai/models/beta/threads/image_file.rb index 2a06f605..8f66bf22 100644 --- a/lib/openai/models/beta/threads/image_file.rb +++ b/lib/openai/models/beta/threads/image_file.rb @@ -34,6 +34,8 @@ class ImageFile < OpenAI::BaseModel # Specifies the detail level of the image if specified by the user. `low` uses # fewer tokens, you can opt in to high resolution using `high`. + # + # @see OpenAI::Models::Beta::Threads::ImageFile#detail module Detail extend OpenAI::Enum diff --git a/lib/openai/models/beta/threads/image_file_delta.rb b/lib/openai/models/beta/threads/image_file_delta.rb index 9f702f21..cb52ad4b 100644 --- a/lib/openai/models/beta/threads/image_file_delta.rb +++ b/lib/openai/models/beta/threads/image_file_delta.rb @@ -38,6 +38,8 @@ class ImageFileDelta < OpenAI::BaseModel # Specifies the detail level of the image if specified by the user. `low` uses # fewer tokens, you can opt in to high resolution using `high`. + # + # @see OpenAI::Models::Beta::Threads::ImageFileDelta#detail module Detail extend OpenAI::Enum diff --git a/lib/openai/models/beta/threads/image_url.rb b/lib/openai/models/beta/threads/image_url.rb index e6830beb..a38ccdbd 100644 --- a/lib/openai/models/beta/threads/image_url.rb +++ b/lib/openai/models/beta/threads/image_url.rb @@ -33,6 +33,8 @@ class ImageURL < OpenAI::BaseModel # Specifies the detail level of the image. `low` uses fewer tokens, you can opt in # to high resolution using `high`. Default value is `auto` + # + # @see OpenAI::Models::Beta::Threads::ImageURL#detail module Detail extend OpenAI::Enum diff --git a/lib/openai/models/beta/threads/image_url_delta.rb b/lib/openai/models/beta/threads/image_url_delta.rb index d47277f4..6c80622a 100644 --- a/lib/openai/models/beta/threads/image_url_delta.rb +++ b/lib/openai/models/beta/threads/image_url_delta.rb @@ -37,6 +37,8 @@ class ImageURLDelta < OpenAI::BaseModel # Specifies the detail level of the image. `low` uses fewer tokens, you can opt in # to high resolution using `high`. + # + # @see OpenAI::Models::Beta::Threads::ImageURLDelta#detail module Detail extend OpenAI::Enum diff --git a/lib/openai/models/beta/threads/message.rb b/lib/openai/models/beta/threads/message.rb index b3a7faab..3d07bbd7 100644 --- a/lib/openai/models/beta/threads/message.rb +++ b/lib/openai/models/beta/threads/message.rb @@ -200,6 +200,7 @@ class AssistantToolsFileSearchTypeOnly < OpenAI::BaseModel end end + # @see OpenAI::Models::Beta::Threads::Message#incomplete_details class IncompleteDetails < OpenAI::BaseModel # @!attribute reason # The reason the message is incomplete. @@ -217,6 +218,8 @@ class IncompleteDetails < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # The reason the message is incomplete. + # + # @see OpenAI::Models::Beta::Threads::Message::IncompleteDetails#reason module Reason extend OpenAI::Enum @@ -235,6 +238,8 @@ module Reason end # The entity that produced the message. One of `user` or `assistant`. + # + # @see OpenAI::Models::Beta::Threads::Message#role module Role extend OpenAI::Enum @@ -250,6 +255,8 @@ module Role # The status of the message, which can be either `in_progress`, `incomplete`, or # `completed`. + # + # @see OpenAI::Models::Beta::Threads::Message#status module Status extend OpenAI::Enum diff --git a/lib/openai/models/beta/threads/message_create_params.rb b/lib/openai/models/beta/threads/message_create_params.rb index 6738bb76..340c113a 100644 --- a/lib/openai/models/beta/threads/message_create_params.rb +++ b/lib/openai/models/beta/threads/message_create_params.rb @@ -4,6 +4,7 @@ module OpenAI module Models module Beta module Threads + # @see OpenAI::Resources::Beta::Threads::Messages#create class MessageCreateParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/beta/threads/message_delete_params.rb b/lib/openai/models/beta/threads/message_delete_params.rb index abe4fb7f..2a93e0d9 100644 --- a/lib/openai/models/beta/threads/message_delete_params.rb +++ b/lib/openai/models/beta/threads/message_delete_params.rb @@ -4,6 +4,7 @@ module OpenAI module Models module Beta module Threads + # @see OpenAI::Resources::Beta::Threads::Messages#delete class MessageDeleteParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/beta/threads/message_delta.rb b/lib/openai/models/beta/threads/message_delta.rb index 301bea9e..c13c0e39 100644 --- a/lib/openai/models/beta/threads/message_delta.rb +++ b/lib/openai/models/beta/threads/message_delta.rb @@ -36,6 +36,8 @@ class MessageDelta < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # The entity that produced the message. One of `user` or `assistant`. + # + # @see OpenAI::Models::Beta::Threads::MessageDelta#role module Role extend OpenAI::Enum diff --git a/lib/openai/models/beta/threads/message_list_params.rb b/lib/openai/models/beta/threads/message_list_params.rb index cc3f0ae0..1c5efce5 100644 --- a/lib/openai/models/beta/threads/message_list_params.rb +++ b/lib/openai/models/beta/threads/message_list_params.rb @@ -4,6 +4,7 @@ module OpenAI module Models module Beta module Threads + # @see OpenAI::Resources::Beta::Threads::Messages#list class MessageListParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/beta/threads/message_retrieve_params.rb b/lib/openai/models/beta/threads/message_retrieve_params.rb index c51fa75c..9a0811a6 100644 --- a/lib/openai/models/beta/threads/message_retrieve_params.rb +++ b/lib/openai/models/beta/threads/message_retrieve_params.rb @@ -4,6 +4,7 @@ module OpenAI module Models module Beta module Threads + # @see OpenAI::Resources::Beta::Threads::Messages#retrieve class MessageRetrieveParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/beta/threads/message_update_params.rb b/lib/openai/models/beta/threads/message_update_params.rb index 46ffdaa4..ba22a469 100644 --- a/lib/openai/models/beta/threads/message_update_params.rb +++ b/lib/openai/models/beta/threads/message_update_params.rb @@ -4,6 +4,7 @@ module OpenAI module Models module Beta module Threads + # @see OpenAI::Resources::Beta::Threads::Messages#update class MessageUpdateParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/beta/threads/required_action_function_tool_call.rb b/lib/openai/models/beta/threads/required_action_function_tool_call.rb index 51e0aba3..d9f3e412 100644 --- a/lib/openai/models/beta/threads/required_action_function_tool_call.rb +++ b/lib/openai/models/beta/threads/required_action_function_tool_call.rb @@ -38,6 +38,7 @@ class RequiredActionFunctionToolCall < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::Threads::RequiredActionFunctionToolCall#function class Function < OpenAI::BaseModel # @!attribute arguments # The arguments that the model expects you to pass to the function. diff --git a/lib/openai/models/beta/threads/run.rb b/lib/openai/models/beta/threads/run.rb index 05dd765d..f104ddeb 100644 --- a/lib/openai/models/beta/threads/run.rb +++ b/lib/openai/models/beta/threads/run.rb @@ -283,6 +283,7 @@ class Run < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::Threads::Run#incomplete_details class IncompleteDetails < OpenAI::BaseModel # @!attribute [r] reason # The reason why the run is incomplete. This will point to which specific token @@ -307,6 +308,8 @@ class IncompleteDetails < OpenAI::BaseModel # The reason why the run is incomplete. This will point to which specific token # limit was reached over the course of the run. + # + # @see OpenAI::Models::Beta::Threads::Run::IncompleteDetails#reason module Reason extend OpenAI::Enum @@ -321,6 +324,7 @@ module Reason end end + # @see OpenAI::Models::Beta::Threads::Run#last_error class LastError < OpenAI::BaseModel # @!attribute code # One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. @@ -345,6 +349,8 @@ class LastError < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`. + # + # @see OpenAI::Models::Beta::Threads::Run::LastError#code module Code extend OpenAI::Enum @@ -360,6 +366,7 @@ module Code end end + # @see OpenAI::Models::Beta::Threads::Run#required_action class RequiredAction < OpenAI::BaseModel # @!attribute submit_tool_outputs # Details on the tool outputs needed for this run to continue. @@ -385,6 +392,7 @@ class RequiredAction < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::Threads::Run::RequiredAction#submit_tool_outputs class SubmitToolOutputs < OpenAI::BaseModel # @!attribute tool_calls # A list of the relevant tool calls. @@ -404,6 +412,7 @@ class SubmitToolOutputs < OpenAI::BaseModel end end + # @see OpenAI::Models::Beta::Threads::Run#truncation_strategy class TruncationStrategy < OpenAI::BaseModel # @!attribute type # The truncation strategy to use for the thread. The default is `auto`. If set to @@ -436,6 +445,8 @@ class TruncationStrategy < OpenAI::BaseModel # `last_messages`, the thread will be truncated to the n most recent messages in # the thread. When set to `auto`, messages in the middle of the thread will be # dropped to fit the context length of the model, `max_prompt_tokens`. + # + # @see OpenAI::Models::Beta::Threads::Run::TruncationStrategy#type module Type extend OpenAI::Enum @@ -450,6 +461,7 @@ module Type end end + # @see OpenAI::Models::Beta::Threads::Run#usage class Usage < OpenAI::BaseModel # @!attribute completion_tokens # Number of completion tokens used over the course of the run. diff --git a/lib/openai/models/beta/threads/run_cancel_params.rb b/lib/openai/models/beta/threads/run_cancel_params.rb index 14a4bc2b..f2fe43f6 100644 --- a/lib/openai/models/beta/threads/run_cancel_params.rb +++ b/lib/openai/models/beta/threads/run_cancel_params.rb @@ -4,6 +4,7 @@ module OpenAI module Models module Beta module Threads + # @see OpenAI::Resources::Beta::Threads::Runs#cancel class RunCancelParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/beta/threads/run_create_params.rb b/lib/openai/models/beta/threads/run_create_params.rb index ad9f9698..d0c690be 100644 --- a/lib/openai/models/beta/threads/run_create_params.rb +++ b/lib/openai/models/beta/threads/run_create_params.rb @@ -4,6 +4,9 @@ module OpenAI module Models module Beta module Threads + # @see OpenAI::Resources::Beta::Threads::Runs#create + # + # @see OpenAI::Resources::Beta::Threads::Runs#create_streaming class RunCreateParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter @@ -286,6 +289,8 @@ class AdditionalMessage < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # The text contents of the message. + # + # @see OpenAI::Models::Beta::Threads::RunCreateParams::AdditionalMessage#content module Content extend OpenAI::Union @@ -309,6 +314,8 @@ module Content # most cases to represent user-generated messages. # - `assistant`: Indicates the message is generated by the assistant. Use this # value to insert messages from the assistant into the conversation. + # + # @see OpenAI::Models::Beta::Threads::RunCreateParams::AdditionalMessage#role module Role extend OpenAI::Enum @@ -433,6 +440,8 @@ class TruncationStrategy < OpenAI::BaseModel # `last_messages`, the thread will be truncated to the n most recent messages in # the thread. When set to `auto`, messages in the middle of the thread will be # dropped to fit the context length of the model, `max_prompt_tokens`. + # + # @see OpenAI::Models::Beta::Threads::RunCreateParams::TruncationStrategy#type module Type extend OpenAI::Enum diff --git a/lib/openai/models/beta/threads/run_list_params.rb b/lib/openai/models/beta/threads/run_list_params.rb index 8f3dfdb6..43e8bd9d 100644 --- a/lib/openai/models/beta/threads/run_list_params.rb +++ b/lib/openai/models/beta/threads/run_list_params.rb @@ -4,6 +4,7 @@ module OpenAI module Models module Beta module Threads + # @see OpenAI::Resources::Beta::Threads::Runs#list class RunListParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/beta/threads/run_retrieve_params.rb b/lib/openai/models/beta/threads/run_retrieve_params.rb index 4bc9a2aa..c75947e3 100644 --- a/lib/openai/models/beta/threads/run_retrieve_params.rb +++ b/lib/openai/models/beta/threads/run_retrieve_params.rb @@ -4,6 +4,7 @@ module OpenAI module Models module Beta module Threads + # @see OpenAI::Resources::Beta::Threads::Runs#retrieve class RunRetrieveParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/beta/threads/run_submit_tool_outputs_params.rb b/lib/openai/models/beta/threads/run_submit_tool_outputs_params.rb index c2d753ad..8ed57b07 100644 --- a/lib/openai/models/beta/threads/run_submit_tool_outputs_params.rb +++ b/lib/openai/models/beta/threads/run_submit_tool_outputs_params.rb @@ -4,6 +4,9 @@ module OpenAI module Models module Beta module Threads + # @see OpenAI::Resources::Beta::Threads::Runs#submit_tool_outputs + # + # @see OpenAI::Resources::Beta::Threads::Runs#submit_tool_outputs_streaming class RunSubmitToolOutputsParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/beta/threads/run_update_params.rb b/lib/openai/models/beta/threads/run_update_params.rb index 6e213a7f..54971ac1 100644 --- a/lib/openai/models/beta/threads/run_update_params.rb +++ b/lib/openai/models/beta/threads/run_update_params.rb @@ -4,6 +4,7 @@ module OpenAI module Models module Beta module Threads + # @see OpenAI::Resources::Beta::Threads::Runs#update class RunUpdateParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/beta/threads/runs/code_interpreter_output_image.rb b/lib/openai/models/beta/threads/runs/code_interpreter_output_image.rb index 89ebfd97..42262679 100644 --- a/lib/openai/models/beta/threads/runs/code_interpreter_output_image.rb +++ b/lib/openai/models/beta/threads/runs/code_interpreter_output_image.rb @@ -36,6 +36,7 @@ class CodeInterpreterOutputImage < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::Threads::Runs::CodeInterpreterOutputImage#image class Image < OpenAI::BaseModel # @!attribute [r] file_id # The [file](https://platform.openai.com/docs/api-reference/files) ID of the diff --git a/lib/openai/models/beta/threads/runs/code_interpreter_tool_call.rb b/lib/openai/models/beta/threads/runs/code_interpreter_tool_call.rb index 4cfc8daf..62aeaf0c 100644 --- a/lib/openai/models/beta/threads/runs/code_interpreter_tool_call.rb +++ b/lib/openai/models/beta/threads/runs/code_interpreter_tool_call.rb @@ -37,6 +37,7 @@ class CodeInterpreterToolCall < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::Threads::Runs::CodeInterpreterToolCall#code_interpreter class CodeInterpreter < OpenAI::BaseModel # @!attribute input # The input to the Code Interpreter tool call. @@ -121,6 +122,7 @@ class Image < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::Threads::Runs::CodeInterpreterToolCall::CodeInterpreter::Output::Image#image class Image < OpenAI::BaseModel # @!attribute file_id # The [file](https://platform.openai.com/docs/api-reference/files) ID of the diff --git a/lib/openai/models/beta/threads/runs/code_interpreter_tool_call_delta.rb b/lib/openai/models/beta/threads/runs/code_interpreter_tool_call_delta.rb index 8b00e21b..5e5b0369 100644 --- a/lib/openai/models/beta/threads/runs/code_interpreter_tool_call_delta.rb +++ b/lib/openai/models/beta/threads/runs/code_interpreter_tool_call_delta.rb @@ -52,6 +52,7 @@ class CodeInterpreterToolCallDelta < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::Threads::Runs::CodeInterpreterToolCallDelta#code_interpreter class CodeInterpreter < OpenAI::BaseModel # @!attribute [r] input # The input to the Code Interpreter tool call. diff --git a/lib/openai/models/beta/threads/runs/file_search_tool_call.rb b/lib/openai/models/beta/threads/runs/file_search_tool_call.rb index 282a9534..09267fd0 100644 --- a/lib/openai/models/beta/threads/runs/file_search_tool_call.rb +++ b/lib/openai/models/beta/threads/runs/file_search_tool_call.rb @@ -34,6 +34,7 @@ class FileSearchToolCall < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::Threads::Runs::FileSearchToolCall#file_search class FileSearch < OpenAI::BaseModel # @!attribute [r] ranking_options # The ranking options for the file search. @@ -67,6 +68,7 @@ class FileSearch < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::Threads::Runs::FileSearchToolCall::FileSearch#ranking_options class RankingOptions < OpenAI::BaseModel # @!attribute ranker # The ranker to use for the file search. If not specified will use the `auto` @@ -95,6 +97,8 @@ class RankingOptions < OpenAI::BaseModel # The ranker to use for the file search. If not specified will use the `auto` # ranker. + # + # @see OpenAI::Models::Beta::Threads::Runs::FileSearchToolCall::FileSearch::RankingOptions#ranker module Ranker extend OpenAI::Enum @@ -184,6 +188,8 @@ class Content < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # The type of the content. + # + # @see OpenAI::Models::Beta::Threads::Runs::FileSearchToolCall::FileSearch::Result::Content#type module Type extend OpenAI::Enum diff --git a/lib/openai/models/beta/threads/runs/function_tool_call.rb b/lib/openai/models/beta/threads/runs/function_tool_call.rb index f3e392ba..9d5784e9 100644 --- a/lib/openai/models/beta/threads/runs/function_tool_call.rb +++ b/lib/openai/models/beta/threads/runs/function_tool_call.rb @@ -34,6 +34,7 @@ class FunctionToolCall < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::Threads::Runs::FunctionToolCall#function class Function < OpenAI::BaseModel # @!attribute arguments # The arguments passed to the function. diff --git a/lib/openai/models/beta/threads/runs/function_tool_call_delta.rb b/lib/openai/models/beta/threads/runs/function_tool_call_delta.rb index 02069f3b..d77981e5 100644 --- a/lib/openai/models/beta/threads/runs/function_tool_call_delta.rb +++ b/lib/openai/models/beta/threads/runs/function_tool_call_delta.rb @@ -49,6 +49,7 @@ class FunctionToolCallDelta < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::Threads::Runs::FunctionToolCallDelta#function class Function < OpenAI::BaseModel # @!attribute [r] arguments # The arguments passed to the function. diff --git a/lib/openai/models/beta/threads/runs/message_creation_step_details.rb b/lib/openai/models/beta/threads/runs/message_creation_step_details.rb index 459f5bdc..f7bde3db 100644 --- a/lib/openai/models/beta/threads/runs/message_creation_step_details.rb +++ b/lib/openai/models/beta/threads/runs/message_creation_step_details.rb @@ -28,6 +28,7 @@ class MessageCreationStepDetails < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::Threads::Runs::MessageCreationStepDetails#message_creation class MessageCreation < OpenAI::BaseModel # @!attribute message_id # The ID of the message that was created by this run step. diff --git a/lib/openai/models/beta/threads/runs/run_step.rb b/lib/openai/models/beta/threads/runs/run_step.rb index acd1f507..2c9449fe 100644 --- a/lib/openai/models/beta/threads/runs/run_step.rb +++ b/lib/openai/models/beta/threads/runs/run_step.rb @@ -159,6 +159,7 @@ class RunStep < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::Threads::Runs::RunStep#last_error class LastError < OpenAI::BaseModel # @!attribute code # One of `server_error` or `rate_limit_exceeded`. @@ -184,6 +185,8 @@ class LastError < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # One of `server_error` or `rate_limit_exceeded`. + # + # @see OpenAI::Models::Beta::Threads::Runs::RunStep::LastError#code module Code extend OpenAI::Enum @@ -200,6 +203,8 @@ module Code # The status of the run step, which can be either `in_progress`, `cancelled`, # `failed`, `completed`, or `expired`. + # + # @see OpenAI::Models::Beta::Threads::Runs::RunStep#status module Status extend OpenAI::Enum @@ -217,6 +222,8 @@ module Status end # The details of the run step. + # + # @see OpenAI::Models::Beta::Threads::Runs::RunStep#step_details module StepDetails extend OpenAI::Union @@ -234,6 +241,8 @@ module StepDetails end # The type of run step, which can be either `message_creation` or `tool_calls`. + # + # @see OpenAI::Models::Beta::Threads::Runs::RunStep#type module Type extend OpenAI::Enum @@ -247,6 +256,7 @@ module Type # def self.values; end end + # @see OpenAI::Models::Beta::Threads::Runs::RunStep#usage class Usage < OpenAI::BaseModel # @!attribute completion_tokens # Number of completion tokens used over the course of the run step. diff --git a/lib/openai/models/beta/threads/runs/run_step_delta.rb b/lib/openai/models/beta/threads/runs/run_step_delta.rb index 84f2aa92..929339da 100644 --- a/lib/openai/models/beta/threads/runs/run_step_delta.rb +++ b/lib/openai/models/beta/threads/runs/run_step_delta.rb @@ -26,6 +26,8 @@ class RunStepDelta < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # The details of the run step. + # + # @see OpenAI::Models::Beta::Threads::Runs::RunStepDelta#step_details module StepDetails extend OpenAI::Union diff --git a/lib/openai/models/beta/threads/runs/run_step_delta_message_delta.rb b/lib/openai/models/beta/threads/runs/run_step_delta_message_delta.rb index 4c2d9170..7acf2e7e 100644 --- a/lib/openai/models/beta/threads/runs/run_step_delta_message_delta.rb +++ b/lib/openai/models/beta/threads/runs/run_step_delta_message_delta.rb @@ -32,6 +32,7 @@ class RunStepDeltaMessageDelta < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Beta::Threads::Runs::RunStepDeltaMessageDelta#message_creation class MessageCreation < OpenAI::BaseModel # @!attribute [r] message_id # The ID of the message that was created by this run step. diff --git a/lib/openai/models/beta/threads/runs/step_list_params.rb b/lib/openai/models/beta/threads/runs/step_list_params.rb index eb22d47e..08c4b854 100644 --- a/lib/openai/models/beta/threads/runs/step_list_params.rb +++ b/lib/openai/models/beta/threads/runs/step_list_params.rb @@ -5,6 +5,7 @@ module Models module Beta module Threads module Runs + # @see OpenAI::Resources::Beta::Threads::Runs::Steps#list class StepListParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/beta/threads/runs/step_retrieve_params.rb b/lib/openai/models/beta/threads/runs/step_retrieve_params.rb index ff4b6ccd..9f539603 100644 --- a/lib/openai/models/beta/threads/runs/step_retrieve_params.rb +++ b/lib/openai/models/beta/threads/runs/step_retrieve_params.rb @@ -5,6 +5,7 @@ module Models module Beta module Threads module Runs + # @see OpenAI::Resources::Beta::Threads::Runs::Steps#retrieve class StepRetrieveParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/chat/chat_completion.rb b/lib/openai/models/chat/chat_completion.rb index bc94f59d..2cdec571 100644 --- a/lib/openai/models/chat/chat_completion.rb +++ b/lib/openai/models/chat/chat_completion.rb @@ -139,6 +139,8 @@ class Choice < OpenAI::BaseModel # 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::Enum @@ -155,6 +157,7 @@ module FinishReason # def self.values; end end + # @see OpenAI::Models::Chat::ChatCompletion::Choice#logprobs class Logprobs < OpenAI::BaseModel # @!attribute content # A list of message content tokens with log probability information. @@ -181,6 +184,8 @@ class Logprobs < OpenAI::BaseModel end # The service tier used for processing the request. + # + # @see OpenAI::Models::Chat::ChatCompletion#service_tier module ServiceTier extend OpenAI::Enum diff --git a/lib/openai/models/chat/chat_completion_assistant_message_param.rb b/lib/openai/models/chat/chat_completion_assistant_message_param.rb index c6a293dd..adf7a92f 100644 --- a/lib/openai/models/chat/chat_completion_assistant_message_param.rb +++ b/lib/openai/models/chat/chat_completion_assistant_message_param.rb @@ -88,6 +88,7 @@ class ChatCompletionAssistantMessageParam < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Chat::ChatCompletionAssistantMessageParam#audio class Audio < OpenAI::BaseModel # @!attribute id # Unique identifier for a previous audio response from the model. @@ -108,6 +109,8 @@ class Audio < OpenAI::BaseModel # The contents of the assistant message. Required unless `tool_calls` or # `function_call` is specified. + # + # @see OpenAI::Models::Chat::ChatCompletionAssistantMessageParam#content module Content extend OpenAI::Union @@ -143,6 +146,8 @@ module ArrayOfContentPart end # @deprecated + # + # @see OpenAI::Models::Chat::ChatCompletionAssistantMessageParam#function_call class FunctionCall < OpenAI::BaseModel # @!attribute arguments # The arguments to call the function with, as generated by the model in JSON diff --git a/lib/openai/models/chat/chat_completion_audio_param.rb b/lib/openai/models/chat/chat_completion_audio_param.rb index 638a7c7e..558fb748 100644 --- a/lib/openai/models/chat/chat_completion_audio_param.rb +++ b/lib/openai/models/chat/chat_completion_audio_param.rb @@ -32,6 +32,8 @@ class ChatCompletionAudioParam < OpenAI::BaseModel # Specifies the output audio format. Must be one of `wav`, `mp3`, `flac`, `opus`, # or `pcm16`. + # + # @see OpenAI::Models::Chat::ChatCompletionAudioParam#format_ module Format extend OpenAI::Enum @@ -50,6 +52,8 @@ module Format # The voice the model uses to respond. Supported voices are `alloy`, `ash`, # `ballad`, `coral`, `echo`, `sage`, and `shimmer`. + # + # @see OpenAI::Models::Chat::ChatCompletionAudioParam#voice module Voice extend OpenAI::Union diff --git a/lib/openai/models/chat/chat_completion_chunk.rb b/lib/openai/models/chat/chat_completion_chunk.rb index dde734e3..3e09badb 100644 --- a/lib/openai/models/chat/chat_completion_chunk.rb +++ b/lib/openai/models/chat/chat_completion_chunk.rb @@ -139,6 +139,7 @@ class Choice < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Chat::ChatCompletionChunk::Choice#delta class Delta < OpenAI::BaseModel # @!attribute content # The contents of the chunk message. @@ -197,6 +198,8 @@ class Delta < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # @deprecated + # + # @see OpenAI::Models::Chat::ChatCompletionChunk::Choice::Delta#function_call class FunctionCall < OpenAI::BaseModel # @!attribute [r] arguments # The arguments to call the function with, as generated by the model in JSON @@ -234,6 +237,8 @@ class FunctionCall < OpenAI::BaseModel end # The role of the author of this message. + # + # @see OpenAI::Models::Chat::ChatCompletionChunk::Choice::Delta#role module Role extend OpenAI::Enum @@ -295,6 +300,7 @@ class ToolCall < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Chat::ChatCompletionChunk::Choice::Delta::ToolCall#function class Function < OpenAI::BaseModel # @!attribute [r] arguments # The arguments to call the function with, as generated by the model in JSON @@ -329,6 +335,8 @@ class Function < OpenAI::BaseModel end # The type of the tool. Currently, only `function` is supported. + # + # @see OpenAI::Models::Chat::ChatCompletionChunk::Choice::Delta::ToolCall#type module Type extend OpenAI::Enum @@ -349,6 +357,8 @@ module Type # 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::ChatCompletionChunk::Choice#finish_reason module FinishReason extend OpenAI::Enum @@ -365,6 +375,7 @@ module FinishReason # def self.values; end end + # @see OpenAI::Models::Chat::ChatCompletionChunk::Choice#logprobs class Logprobs < OpenAI::BaseModel # @!attribute content # A list of message content tokens with log probability information. @@ -391,6 +402,8 @@ class Logprobs < OpenAI::BaseModel end # The service tier used for processing the request. + # + # @see OpenAI::Models::Chat::ChatCompletionChunk#service_tier module ServiceTier extend OpenAI::Enum diff --git a/lib/openai/models/chat/chat_completion_content_part.rb b/lib/openai/models/chat/chat_completion_content_part.rb index 72530466..dfa175c4 100644 --- a/lib/openai/models/chat/chat_completion_content_part.rb +++ b/lib/openai/models/chat/chat_completion_content_part.rb @@ -45,6 +45,7 @@ class File < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Chat::ChatCompletionContentPart::File#file class File < OpenAI::BaseModel # @!attribute [r] file_data # The base64 encoded file data, used when passing the file to the model as a diff --git a/lib/openai/models/chat/chat_completion_content_part_image.rb b/lib/openai/models/chat/chat_completion_content_part_image.rb index 3fd2baeb..107b95af 100644 --- a/lib/openai/models/chat/chat_completion_content_part_image.rb +++ b/lib/openai/models/chat/chat_completion_content_part_image.rb @@ -25,6 +25,7 @@ class ChatCompletionContentPartImage < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Chat::ChatCompletionContentPartImage#image_url class ImageURL < OpenAI::BaseModel # @!attribute url # Either a URL of the image or the base64 encoded image data. @@ -53,6 +54,8 @@ class ImageURL < OpenAI::BaseModel # Specifies the detail level of the image. Learn more in the # [Vision guide](https://platform.openai.com/docs/guides/vision#low-or-high-fidelity-image-understanding). + # + # @see OpenAI::Models::Chat::ChatCompletionContentPartImage::ImageURL#detail module Detail extend OpenAI::Enum diff --git a/lib/openai/models/chat/chat_completion_content_part_input_audio.rb b/lib/openai/models/chat/chat_completion_content_part_input_audio.rb index 269e74c7..4be021ce 100644 --- a/lib/openai/models/chat/chat_completion_content_part_input_audio.rb +++ b/lib/openai/models/chat/chat_completion_content_part_input_audio.rb @@ -25,6 +25,7 @@ class ChatCompletionContentPartInputAudio < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Chat::ChatCompletionContentPartInputAudio#input_audio class InputAudio < OpenAI::BaseModel # @!attribute data # Base64 encoded audio data. @@ -49,6 +50,8 @@ class InputAudio < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # The format of the encoded audio data. Currently supports "wav" and "mp3". + # + # @see OpenAI::Models::Chat::ChatCompletionContentPartInputAudio::InputAudio#format_ module Format extend OpenAI::Enum diff --git a/lib/openai/models/chat/chat_completion_developer_message_param.rb b/lib/openai/models/chat/chat_completion_developer_message_param.rb index 98b66dd7..6a5af05b 100644 --- a/lib/openai/models/chat/chat_completion_developer_message_param.rb +++ b/lib/openai/models/chat/chat_completion_developer_message_param.rb @@ -41,6 +41,8 @@ class ChatCompletionDeveloperMessageParam < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # The contents of the developer message. + # + # @see OpenAI::Models::Chat::ChatCompletionDeveloperMessageParam#content module Content extend OpenAI::Union diff --git a/lib/openai/models/chat/chat_completion_message.rb b/lib/openai/models/chat/chat_completion_message.rb index 228616ad..f153dbe8 100644 --- a/lib/openai/models/chat/chat_completion_message.rb +++ b/lib/openai/models/chat/chat_completion_message.rb @@ -111,6 +111,7 @@ class Annotation < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Chat::ChatCompletionMessage::Annotation#url_citation class URLCitation < OpenAI::BaseModel # @!attribute end_index # The index of the last character of the URL citation in the message. @@ -151,6 +152,8 @@ class URLCitation < OpenAI::BaseModel end # @deprecated + # + # @see OpenAI::Models::Chat::ChatCompletionMessage#function_call class FunctionCall < OpenAI::BaseModel # @!attribute arguments # The arguments to call the function with, as generated by the model in JSON diff --git a/lib/openai/models/chat/chat_completion_message_tool_call.rb b/lib/openai/models/chat/chat_completion_message_tool_call.rb index f4628729..e114fcfe 100644 --- a/lib/openai/models/chat/chat_completion_message_tool_call.rb +++ b/lib/openai/models/chat/chat_completion_message_tool_call.rb @@ -31,6 +31,7 @@ class ChatCompletionMessageToolCall < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Chat::ChatCompletionMessageToolCall#function class Function < OpenAI::BaseModel # @!attribute arguments # The arguments to call the function with, as generated by the model in JSON diff --git a/lib/openai/models/chat/chat_completion_named_tool_choice.rb b/lib/openai/models/chat/chat_completion_named_tool_choice.rb index 84744f2a..6d8c1713 100644 --- a/lib/openai/models/chat/chat_completion_named_tool_choice.rb +++ b/lib/openai/models/chat/chat_completion_named_tool_choice.rb @@ -26,6 +26,7 @@ class ChatCompletionNamedToolChoice < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Chat::ChatCompletionNamedToolChoice#function class Function < OpenAI::BaseModel # @!attribute name # The name of the function to call. diff --git a/lib/openai/models/chat/chat_completion_prediction_content.rb b/lib/openai/models/chat/chat_completion_prediction_content.rb index e170c46d..5865f161 100644 --- a/lib/openai/models/chat/chat_completion_prediction_content.rb +++ b/lib/openai/models/chat/chat_completion_prediction_content.rb @@ -33,6 +33,8 @@ class ChatCompletionPredictionContent < OpenAI::BaseModel # The content that should be matched when generating a model response. If # generated tokens would match this content, the entire model response can be # returned much more quickly. + # + # @see OpenAI::Models::Chat::ChatCompletionPredictionContent#content module Content extend OpenAI::Union diff --git a/lib/openai/models/chat/chat_completion_system_message_param.rb b/lib/openai/models/chat/chat_completion_system_message_param.rb index b311ca43..6426eaad 100644 --- a/lib/openai/models/chat/chat_completion_system_message_param.rb +++ b/lib/openai/models/chat/chat_completion_system_message_param.rb @@ -41,6 +41,8 @@ class ChatCompletionSystemMessageParam < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # The contents of the system message. + # + # @see OpenAI::Models::Chat::ChatCompletionSystemMessageParam#content module Content extend OpenAI::Union diff --git a/lib/openai/models/chat/chat_completion_tool_message_param.rb b/lib/openai/models/chat/chat_completion_tool_message_param.rb index 31644647..37d6d123 100644 --- a/lib/openai/models/chat/chat_completion_tool_message_param.rb +++ b/lib/openai/models/chat/chat_completion_tool_message_param.rb @@ -32,6 +32,8 @@ class ChatCompletionToolMessageParam < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # The contents of the tool message. + # + # @see OpenAI::Models::Chat::ChatCompletionToolMessageParam#content module Content extend OpenAI::Union diff --git a/lib/openai/models/chat/chat_completion_user_message_param.rb b/lib/openai/models/chat/chat_completion_user_message_param.rb index b938d473..eb640b44 100644 --- a/lib/openai/models/chat/chat_completion_user_message_param.rb +++ b/lib/openai/models/chat/chat_completion_user_message_param.rb @@ -40,6 +40,8 @@ class ChatCompletionUserMessageParam < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # The contents of the user message. + # + # @see OpenAI::Models::Chat::ChatCompletionUserMessageParam#content module Content extend OpenAI::Union diff --git a/lib/openai/models/chat/completion_create_params.rb b/lib/openai/models/chat/completion_create_params.rb index 8eb609ab..b612cb26 100644 --- a/lib/openai/models/chat/completion_create_params.rb +++ b/lib/openai/models/chat/completion_create_params.rb @@ -3,6 +3,9 @@ module OpenAI module Models module Chat + # @see OpenAI::Resources::Chat::Completions#create + # + # @see OpenAI::Resources::Chat::Completions#create_streaming class CompletionCreateParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter @@ -652,6 +655,8 @@ class WebSearchOptions < OpenAI::BaseModel # High level guidance for the amount of context window space to use for the # search. One of `low`, `medium`, or `high`. `medium` is the default. + # + # @see OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions#search_context_size module SearchContextSize extend OpenAI::Enum @@ -666,6 +671,7 @@ module SearchContextSize # def self.values; end end + # @see OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions#user_location class UserLocation < OpenAI::BaseModel # @!attribute approximate # Approximate location parameters for the search. @@ -690,6 +696,7 @@ class UserLocation < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Chat::CompletionCreateParams::WebSearchOptions::UserLocation#approximate class Approximate < OpenAI::BaseModel # @!attribute [r] city # Free text input for the city of the user, e.g. `San Francisco`. diff --git a/lib/openai/models/chat/completion_delete_params.rb b/lib/openai/models/chat/completion_delete_params.rb index cbcb2c22..70e85073 100644 --- a/lib/openai/models/chat/completion_delete_params.rb +++ b/lib/openai/models/chat/completion_delete_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module Chat + # @see OpenAI::Resources::Chat::Completions#delete class CompletionDeleteParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/chat/completion_list_params.rb b/lib/openai/models/chat/completion_list_params.rb index 8b2e8ef7..905fe4ea 100644 --- a/lib/openai/models/chat/completion_list_params.rb +++ b/lib/openai/models/chat/completion_list_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module Chat + # @see OpenAI::Resources::Chat::Completions#list class CompletionListParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/chat/completion_retrieve_params.rb b/lib/openai/models/chat/completion_retrieve_params.rb index e8ee1b1c..3465af46 100644 --- a/lib/openai/models/chat/completion_retrieve_params.rb +++ b/lib/openai/models/chat/completion_retrieve_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module Chat + # @see OpenAI::Resources::Chat::Completions#retrieve class CompletionRetrieveParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/chat/completion_update_params.rb b/lib/openai/models/chat/completion_update_params.rb index 32797eb4..4e7909e9 100644 --- a/lib/openai/models/chat/completion_update_params.rb +++ b/lib/openai/models/chat/completion_update_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module Chat + # @see OpenAI::Resources::Chat::Completions#update class CompletionUpdateParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/chat/completions/message_list_params.rb b/lib/openai/models/chat/completions/message_list_params.rb index 74ccbdc7..d72b3255 100644 --- a/lib/openai/models/chat/completions/message_list_params.rb +++ b/lib/openai/models/chat/completions/message_list_params.rb @@ -4,6 +4,7 @@ module OpenAI module Models module Chat module Completions + # @see OpenAI::Resources::Chat::Completions::Messages#list class MessageListParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/comparison_filter.rb b/lib/openai/models/comparison_filter.rb index e79a3435..313ae677 100644 --- a/lib/openai/models/comparison_filter.rb +++ b/lib/openai/models/comparison_filter.rb @@ -49,6 +49,8 @@ class ComparisonFilter < OpenAI::BaseModel # - `gte`: greater than or equal # - `lt`: less than # - `lte`: less than or equal + # + # @see OpenAI::Models::ComparisonFilter#type module Type extend OpenAI::Enum @@ -68,6 +70,8 @@ module Type # The value to compare against the attribute key; supports string, number, or # boolean types. + # + # @see OpenAI::Models::ComparisonFilter#value module Value extend OpenAI::Union diff --git a/lib/openai/models/completion_choice.rb b/lib/openai/models/completion_choice.rb index 5e4a549b..66f575ee 100644 --- a/lib/openai/models/completion_choice.rb +++ b/lib/openai/models/completion_choice.rb @@ -41,6 +41,8 @@ class CompletionChoice < OpenAI::BaseModel # hit a natural stop point or a provided stop sequence, `length` if the maximum # number of tokens specified in the request was reached, or `content_filter` if # content was omitted due to a flag from our content filters. + # + # @see OpenAI::Models::CompletionChoice#finish_reason module FinishReason extend OpenAI::Enum @@ -55,6 +57,7 @@ module FinishReason # def self.values; end end + # @see OpenAI::Models::CompletionChoice#logprobs class Logprobs < OpenAI::BaseModel # @!attribute [r] text_offset # diff --git a/lib/openai/models/completion_create_params.rb b/lib/openai/models/completion_create_params.rb index d4935347..18e6bdb2 100644 --- a/lib/openai/models/completion_create_params.rb +++ b/lib/openai/models/completion_create_params.rb @@ -2,6 +2,9 @@ module OpenAI module Models + # @see OpenAI::Resources::Completions#create + # + # @see OpenAI::Resources::Completions#create_streaming class CompletionCreateParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/completion_usage.rb b/lib/openai/models/completion_usage.rb index 5eebf968..553021f3 100644 --- a/lib/openai/models/completion_usage.rb +++ b/lib/openai/models/completion_usage.rb @@ -63,6 +63,7 @@ class CompletionUsage < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::CompletionUsage#completion_tokens_details class CompletionTokensDetails < OpenAI::BaseModel # @!attribute [r] accepted_prediction_tokens # When using Predicted Outputs, the number of tokens in the prediction that @@ -129,6 +130,7 @@ class CompletionTokensDetails < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void end + # @see OpenAI::Models::CompletionUsage#prompt_tokens_details class PromptTokensDetails < OpenAI::BaseModel # @!attribute [r] audio_tokens # Audio input tokens present in the prompt. diff --git a/lib/openai/models/compound_filter.rb b/lib/openai/models/compound_filter.rb index 7fd45e2c..0a5c34a4 100644 --- a/lib/openai/models/compound_filter.rb +++ b/lib/openai/models/compound_filter.rb @@ -42,6 +42,8 @@ module Filter end # Type of operation: `and` or `or`. + # + # @see OpenAI::Models::CompoundFilter#type module Type extend OpenAI::Enum diff --git a/lib/openai/models/create_embedding_response.rb b/lib/openai/models/create_embedding_response.rb index a47238ef..2679c15d 100644 --- a/lib/openai/models/create_embedding_response.rb +++ b/lib/openai/models/create_embedding_response.rb @@ -37,6 +37,7 @@ class CreateEmbeddingResponse < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::CreateEmbeddingResponse#usage class Usage < OpenAI::BaseModel # @!attribute prompt_tokens # The number of tokens used by the prompt. diff --git a/lib/openai/models/embedding_create_params.rb b/lib/openai/models/embedding_create_params.rb index 7bcadd1d..9bae0793 100644 --- a/lib/openai/models/embedding_create_params.rb +++ b/lib/openai/models/embedding_create_params.rb @@ -2,6 +2,7 @@ module OpenAI module Models + # @see OpenAI::Resources::Embeddings#create class EmbeddingCreateParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/file_content_params.rb b/lib/openai/models/file_content_params.rb index 597cc103..c1e2edd4 100644 --- a/lib/openai/models/file_content_params.rb +++ b/lib/openai/models/file_content_params.rb @@ -2,6 +2,7 @@ module OpenAI module Models + # @see OpenAI::Resources::Files#content class FileContentParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/file_create_params.rb b/lib/openai/models/file_create_params.rb index c37dba0c..da8f43df 100644 --- a/lib/openai/models/file_create_params.rb +++ b/lib/openai/models/file_create_params.rb @@ -2,6 +2,7 @@ module OpenAI module Models + # @see OpenAI::Resources::Files#create class FileCreateParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/file_delete_params.rb b/lib/openai/models/file_delete_params.rb index 22f10a38..c8b31252 100644 --- a/lib/openai/models/file_delete_params.rb +++ b/lib/openai/models/file_delete_params.rb @@ -2,6 +2,7 @@ module OpenAI module Models + # @see OpenAI::Resources::Files#delete class FileDeleteParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/file_list_params.rb b/lib/openai/models/file_list_params.rb index 9d825d43..997d1fa1 100644 --- a/lib/openai/models/file_list_params.rb +++ b/lib/openai/models/file_list_params.rb @@ -2,6 +2,7 @@ module OpenAI module Models + # @see OpenAI::Resources::Files#list class FileListParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/file_object.rb b/lib/openai/models/file_object.rb index 7b08ec97..e85f9017 100644 --- a/lib/openai/models/file_object.rb +++ b/lib/openai/models/file_object.rb @@ -102,6 +102,8 @@ class FileObject < OpenAI::BaseModel # The intended purpose of the file. Supported values are `assistants`, # `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results` # and `vision`. + # + # @see OpenAI::Models::FileObject#purpose module Purpose extend OpenAI::Enum @@ -124,6 +126,8 @@ module Purpose # # Deprecated. The current status of the file, which can be either `uploaded`, # `processed`, or `error`. + # + # @see OpenAI::Models::FileObject#status module Status extend OpenAI::Enum diff --git a/lib/openai/models/file_retrieve_params.rb b/lib/openai/models/file_retrieve_params.rb index a4f815c3..c1729f9e 100644 --- a/lib/openai/models/file_retrieve_params.rb +++ b/lib/openai/models/file_retrieve_params.rb @@ -2,6 +2,7 @@ module OpenAI module Models + # @see OpenAI::Resources::Files#retrieve class FileRetrieveParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/fine_tuning/fine_tuning_job.rb b/lib/openai/models/fine_tuning/fine_tuning_job.rb index 743bd260..07a3dd60 100644 --- a/lib/openai/models/fine_tuning/fine_tuning_job.rb +++ b/lib/openai/models/fine_tuning/fine_tuning_job.rb @@ -192,6 +192,7 @@ class FineTuningJob < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::FineTuning::FineTuningJob#error class Error < OpenAI::BaseModel # @!attribute code # A machine-readable error code. @@ -225,6 +226,7 @@ class Error < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void end + # @see OpenAI::Models::FineTuning::FineTuningJob#hyperparameters class Hyperparameters < OpenAI::BaseModel # @!attribute [r] batch_size # Number of examples in each batch. A larger batch size means that model @@ -274,6 +276,8 @@ class Hyperparameters < OpenAI::BaseModel # Number of examples in each batch. A larger batch size means that model # parameters are updated less frequently, but with lower variance. + # + # @see OpenAI::Models::FineTuning::FineTuningJob::Hyperparameters#batch_size module BatchSize extend OpenAI::Union @@ -288,6 +292,8 @@ module BatchSize # Scaling factor for the learning rate. A smaller learning rate may be useful to # avoid overfitting. + # + # @see OpenAI::Models::FineTuning::FineTuningJob::Hyperparameters#learning_rate_multiplier module LearningRateMultiplier extend OpenAI::Union @@ -302,6 +308,8 @@ module LearningRateMultiplier # The number of epochs to train the model for. An epoch refers to one full cycle # through the training dataset. + # + # @see OpenAI::Models::FineTuning::FineTuningJob::Hyperparameters#n_epochs module NEpochs extend OpenAI::Union @@ -317,6 +325,8 @@ module NEpochs # The current status of the fine-tuning job, which can be either # `validating_files`, `queued`, `running`, `succeeded`, `failed`, or `cancelled`. + # + # @see OpenAI::Models::FineTuning::FineTuningJob#status module Status extend OpenAI::Enum @@ -334,6 +344,7 @@ module Status # def self.values; end end + # @see OpenAI::Models::FineTuning::FineTuningJob#method_ class Method < OpenAI::BaseModel # @!attribute [r] dpo # Configuration for the DPO fine-tuning method. @@ -376,6 +387,7 @@ class Method < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::FineTuning::FineTuningJob::Method#dpo class Dpo < OpenAI::BaseModel # @!attribute [r] hyperparameters # The hyperparameters used for the fine-tuning job. @@ -396,6 +408,7 @@ class Dpo < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::FineTuning::FineTuningJob::Method::Dpo#hyperparameters class Hyperparameters < OpenAI::BaseModel # @!attribute [r] batch_size # Number of examples in each batch. A larger batch size means that model @@ -459,6 +472,8 @@ class Hyperparameters < OpenAI::BaseModel # Number of examples in each batch. A larger batch size means that model # parameters are updated less frequently, but with lower variance. + # + # @see OpenAI::Models::FineTuning::FineTuningJob::Method::Dpo::Hyperparameters#batch_size module BatchSize extend OpenAI::Union @@ -473,6 +488,8 @@ module BatchSize # The beta value for the DPO method. A higher beta value will increase the weight # of the penalty between the policy and reference model. + # + # @see OpenAI::Models::FineTuning::FineTuningJob::Method::Dpo::Hyperparameters#beta module Beta extend OpenAI::Union @@ -487,6 +504,8 @@ module Beta # Scaling factor for the learning rate. A smaller learning rate may be useful to # avoid overfitting. + # + # @see OpenAI::Models::FineTuning::FineTuningJob::Method::Dpo::Hyperparameters#learning_rate_multiplier module LearningRateMultiplier extend OpenAI::Union @@ -501,6 +520,8 @@ module LearningRateMultiplier # The number of epochs to train the model for. An epoch refers to one full cycle # through the training dataset. + # + # @see OpenAI::Models::FineTuning::FineTuningJob::Method::Dpo::Hyperparameters#n_epochs module NEpochs extend OpenAI::Union @@ -515,6 +536,7 @@ module NEpochs end end + # @see OpenAI::Models::FineTuning::FineTuningJob::Method#supervised class Supervised < OpenAI::BaseModel # @!attribute [r] hyperparameters # The hyperparameters used for the fine-tuning job. @@ -536,6 +558,7 @@ class Supervised < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::FineTuning::FineTuningJob::Method::Supervised#hyperparameters class Hyperparameters < OpenAI::BaseModel # @!attribute [r] batch_size # Number of examples in each batch. A larger batch size means that model @@ -586,6 +609,8 @@ class Hyperparameters < OpenAI::BaseModel # Number of examples in each batch. A larger batch size means that model # parameters are updated less frequently, but with lower variance. + # + # @see OpenAI::Models::FineTuning::FineTuningJob::Method::Supervised::Hyperparameters#batch_size module BatchSize extend OpenAI::Union @@ -600,6 +625,8 @@ module BatchSize # Scaling factor for the learning rate. A smaller learning rate may be useful to # avoid overfitting. + # + # @see OpenAI::Models::FineTuning::FineTuningJob::Method::Supervised::Hyperparameters#learning_rate_multiplier module LearningRateMultiplier extend OpenAI::Union @@ -614,6 +641,8 @@ module LearningRateMultiplier # The number of epochs to train the model for. An epoch refers to one full cycle # through the training dataset. + # + # @see OpenAI::Models::FineTuning::FineTuningJob::Method::Supervised::Hyperparameters#n_epochs module NEpochs extend OpenAI::Union @@ -629,6 +658,8 @@ module NEpochs end # The type of method. Is either `supervised` or `dpo`. + # + # @see OpenAI::Models::FineTuning::FineTuningJob::Method#type module Type extend OpenAI::Enum diff --git a/lib/openai/models/fine_tuning/fine_tuning_job_event.rb b/lib/openai/models/fine_tuning/fine_tuning_job_event.rb index 92a9a009..c6bd2025 100644 --- a/lib/openai/models/fine_tuning/fine_tuning_job_event.rb +++ b/lib/openai/models/fine_tuning/fine_tuning_job_event.rb @@ -70,6 +70,8 @@ class FineTuningJobEvent < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # The log level of the event. + # + # @see OpenAI::Models::FineTuning::FineTuningJobEvent#level module Level extend OpenAI::Enum @@ -85,6 +87,8 @@ module Level end # The type of event. + # + # @see OpenAI::Models::FineTuning::FineTuningJobEvent#type module Type extend OpenAI::Enum diff --git a/lib/openai/models/fine_tuning/job_cancel_params.rb b/lib/openai/models/fine_tuning/job_cancel_params.rb index 979023cf..e1830988 100644 --- a/lib/openai/models/fine_tuning/job_cancel_params.rb +++ b/lib/openai/models/fine_tuning/job_cancel_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module FineTuning + # @see OpenAI::Resources::FineTuning::Jobs#cancel class JobCancelParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/fine_tuning/job_create_params.rb b/lib/openai/models/fine_tuning/job_create_params.rb index 1e8ddf18..f5770f51 100644 --- a/lib/openai/models/fine_tuning/job_create_params.rb +++ b/lib/openai/models/fine_tuning/job_create_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module FineTuning + # @see OpenAI::Resources::FineTuning::Jobs#create class JobCreateParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter @@ -222,6 +223,8 @@ class Hyperparameters < OpenAI::BaseModel # Number of examples in each batch. A larger batch size means that model # parameters are updated less frequently, but with lower variance. + # + # @see OpenAI::Models::FineTuning::JobCreateParams::Hyperparameters#batch_size module BatchSize extend OpenAI::Union @@ -236,6 +239,8 @@ module BatchSize # Scaling factor for the learning rate. A smaller learning rate may be useful to # avoid overfitting. + # + # @see OpenAI::Models::FineTuning::JobCreateParams::Hyperparameters#learning_rate_multiplier module LearningRateMultiplier extend OpenAI::Union @@ -250,6 +255,8 @@ module LearningRateMultiplier # The number of epochs to train the model for. An epoch refers to one full cycle # through the training dataset. + # + # @see OpenAI::Models::FineTuning::JobCreateParams::Hyperparameters#n_epochs module NEpochs extend OpenAI::Union @@ -288,6 +295,7 @@ class Integration < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::FineTuning::JobCreateParams::Integration#wandb class Wandb < OpenAI::BaseModel # @!attribute project # The name of the project that the new run will be created under. @@ -381,6 +389,7 @@ class Method < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::FineTuning::JobCreateParams::Method#dpo class Dpo < OpenAI::BaseModel # @!attribute [r] hyperparameters # The hyperparameters used for the fine-tuning job. @@ -402,6 +411,7 @@ class Dpo < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::FineTuning::JobCreateParams::Method::Dpo#hyperparameters class Hyperparameters < OpenAI::BaseModel # @!attribute [r] batch_size # Number of examples in each batch. A larger batch size means that model @@ -465,6 +475,8 @@ class Hyperparameters < OpenAI::BaseModel # Number of examples in each batch. A larger batch size means that model # parameters are updated less frequently, but with lower variance. + # + # @see OpenAI::Models::FineTuning::JobCreateParams::Method::Dpo::Hyperparameters#batch_size module BatchSize extend OpenAI::Union @@ -479,6 +491,8 @@ module BatchSize # The beta value for the DPO method. A higher beta value will increase the weight # of the penalty between the policy and reference model. + # + # @see OpenAI::Models::FineTuning::JobCreateParams::Method::Dpo::Hyperparameters#beta module Beta extend OpenAI::Union @@ -493,6 +507,8 @@ module Beta # Scaling factor for the learning rate. A smaller learning rate may be useful to # avoid overfitting. + # + # @see OpenAI::Models::FineTuning::JobCreateParams::Method::Dpo::Hyperparameters#learning_rate_multiplier module LearningRateMultiplier extend OpenAI::Union @@ -507,6 +523,8 @@ module LearningRateMultiplier # The number of epochs to train the model for. An epoch refers to one full cycle # through the training dataset. + # + # @see OpenAI::Models::FineTuning::JobCreateParams::Method::Dpo::Hyperparameters#n_epochs module NEpochs extend OpenAI::Union @@ -521,6 +539,7 @@ module NEpochs end end + # @see OpenAI::Models::FineTuning::JobCreateParams::Method#supervised class Supervised < OpenAI::BaseModel # @!attribute [r] hyperparameters # The hyperparameters used for the fine-tuning job. @@ -542,6 +561,7 @@ class Supervised < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::FineTuning::JobCreateParams::Method::Supervised#hyperparameters class Hyperparameters < OpenAI::BaseModel # @!attribute [r] batch_size # Number of examples in each batch. A larger batch size means that model @@ -592,6 +612,8 @@ class Hyperparameters < OpenAI::BaseModel # Number of examples in each batch. A larger batch size means that model # parameters are updated less frequently, but with lower variance. + # + # @see OpenAI::Models::FineTuning::JobCreateParams::Method::Supervised::Hyperparameters#batch_size module BatchSize extend OpenAI::Union @@ -606,6 +628,8 @@ module BatchSize # Scaling factor for the learning rate. A smaller learning rate may be useful to # avoid overfitting. + # + # @see OpenAI::Models::FineTuning::JobCreateParams::Method::Supervised::Hyperparameters#learning_rate_multiplier module LearningRateMultiplier extend OpenAI::Union @@ -620,6 +644,8 @@ module LearningRateMultiplier # The number of epochs to train the model for. An epoch refers to one full cycle # through the training dataset. + # + # @see OpenAI::Models::FineTuning::JobCreateParams::Method::Supervised::Hyperparameters#n_epochs module NEpochs extend OpenAI::Union @@ -635,6 +661,8 @@ module NEpochs end # The type of method. Is either `supervised` or `dpo`. + # + # @see OpenAI::Models::FineTuning::JobCreateParams::Method#type module Type extend OpenAI::Enum diff --git a/lib/openai/models/fine_tuning/job_list_events_params.rb b/lib/openai/models/fine_tuning/job_list_events_params.rb index bbb67fa8..167b9242 100644 --- a/lib/openai/models/fine_tuning/job_list_events_params.rb +++ b/lib/openai/models/fine_tuning/job_list_events_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module FineTuning + # @see OpenAI::Resources::FineTuning::Jobs#list_events class JobListEventsParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/fine_tuning/job_list_params.rb b/lib/openai/models/fine_tuning/job_list_params.rb index f9c13fc9..c3abbcd5 100644 --- a/lib/openai/models/fine_tuning/job_list_params.rb +++ b/lib/openai/models/fine_tuning/job_list_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module FineTuning + # @see OpenAI::Resources::FineTuning::Jobs#list class JobListParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/fine_tuning/job_retrieve_params.rb b/lib/openai/models/fine_tuning/job_retrieve_params.rb index 7735a847..e62d1b6f 100644 --- a/lib/openai/models/fine_tuning/job_retrieve_params.rb +++ b/lib/openai/models/fine_tuning/job_retrieve_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module FineTuning + # @see OpenAI::Resources::FineTuning::Jobs#retrieve class JobRetrieveParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/fine_tuning/jobs/checkpoint_list_params.rb b/lib/openai/models/fine_tuning/jobs/checkpoint_list_params.rb index ee8722ea..1b5657d6 100644 --- a/lib/openai/models/fine_tuning/jobs/checkpoint_list_params.rb +++ b/lib/openai/models/fine_tuning/jobs/checkpoint_list_params.rb @@ -4,6 +4,7 @@ module OpenAI module Models module FineTuning module Jobs + # @see OpenAI::Resources::FineTuning::Jobs::Checkpoints#list class CheckpointListParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/fine_tuning/jobs/fine_tuning_job_checkpoint.rb b/lib/openai/models/fine_tuning/jobs/fine_tuning_job_checkpoint.rb index 11dfff02..0390e0c6 100644 --- a/lib/openai/models/fine_tuning/jobs/fine_tuning_job_checkpoint.rb +++ b/lib/openai/models/fine_tuning/jobs/fine_tuning_job_checkpoint.rb @@ -74,6 +74,7 @@ class FineTuningJobCheckpoint < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::FineTuning::Jobs::FineTuningJobCheckpoint#metrics class Metrics < OpenAI::BaseModel # @!attribute [r] full_valid_loss # diff --git a/lib/openai/models/image_create_variation_params.rb b/lib/openai/models/image_create_variation_params.rb index 87a15c79..b958af96 100644 --- a/lib/openai/models/image_create_variation_params.rb +++ b/lib/openai/models/image_create_variation_params.rb @@ -2,6 +2,7 @@ module OpenAI module Models + # @see OpenAI::Resources::Images#create_variation class ImageCreateVariationParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/image_edit_params.rb b/lib/openai/models/image_edit_params.rb index cf4ca6e4..d9678ace 100644 --- a/lib/openai/models/image_edit_params.rb +++ b/lib/openai/models/image_edit_params.rb @@ -2,6 +2,7 @@ module OpenAI module Models + # @see OpenAI::Resources::Images#edit class ImageEditParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/image_generate_params.rb b/lib/openai/models/image_generate_params.rb index 43ed870f..52810d19 100644 --- a/lib/openai/models/image_generate_params.rb +++ b/lib/openai/models/image_generate_params.rb @@ -2,6 +2,7 @@ module OpenAI module Models + # @see OpenAI::Resources::Images#generate class ImageGenerateParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/model_delete_params.rb b/lib/openai/models/model_delete_params.rb index 3076a522..186515a2 100644 --- a/lib/openai/models/model_delete_params.rb +++ b/lib/openai/models/model_delete_params.rb @@ -2,6 +2,7 @@ module OpenAI module Models + # @see OpenAI::Resources::Models#delete class ModelDeleteParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/model_list_params.rb b/lib/openai/models/model_list_params.rb index 1718546b..191cb53f 100644 --- a/lib/openai/models/model_list_params.rb +++ b/lib/openai/models/model_list_params.rb @@ -2,6 +2,7 @@ module OpenAI module Models + # @see OpenAI::Resources::Models#list class ModelListParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/model_retrieve_params.rb b/lib/openai/models/model_retrieve_params.rb index 335e5c97..6c19bb2b 100644 --- a/lib/openai/models/model_retrieve_params.rb +++ b/lib/openai/models/model_retrieve_params.rb @@ -2,6 +2,7 @@ module OpenAI module Models + # @see OpenAI::Resources::Models#retrieve class ModelRetrieveParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/moderation.rb b/lib/openai/models/moderation.rb index b1bb2ec1..9d8bf7a0 100644 --- a/lib/openai/models/moderation.rb +++ b/lib/openai/models/moderation.rb @@ -37,6 +37,7 @@ class Moderation < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Moderation#categories class Categories < OpenAI::BaseModel # @!attribute harassment # Content that expresses, incites, or promotes harassing language towards any @@ -172,6 +173,7 @@ class Categories < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void end + # @see OpenAI::Models::Moderation#category_applied_input_types class CategoryAppliedInputTypes < OpenAI::BaseModel # @!attribute harassment # The applied input type(s) for the category 'harassment'. @@ -472,6 +474,7 @@ module ViolenceGraphic end end + # @see OpenAI::Models::Moderation#category_scores class CategoryScores < OpenAI::BaseModel # @!attribute harassment # The score for the category 'harassment'. diff --git a/lib/openai/models/moderation_create_params.rb b/lib/openai/models/moderation_create_params.rb index 93150dbd..6d03f271 100644 --- a/lib/openai/models/moderation_create_params.rb +++ b/lib/openai/models/moderation_create_params.rb @@ -2,6 +2,7 @@ module OpenAI module Models + # @see OpenAI::Resources::Moderations#create class ModerationCreateParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/moderation_image_url_input.rb b/lib/openai/models/moderation_image_url_input.rb index de867149..c02f0627 100644 --- a/lib/openai/models/moderation_image_url_input.rb +++ b/lib/openai/models/moderation_image_url_input.rb @@ -25,6 +25,7 @@ class ModerationImageURLInput < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::ModerationImageURLInput#image_url class ImageURL < OpenAI::BaseModel # @!attribute url # Either a URL of the image or the base64 encoded image data. diff --git a/lib/openai/models/reasoning.rb b/lib/openai/models/reasoning.rb index 64a9d430..af30c4e0 100644 --- a/lib/openai/models/reasoning.rb +++ b/lib/openai/models/reasoning.rb @@ -42,6 +42,8 @@ class Reasoning < OpenAI::BaseModel # A summary of the reasoning performed by the model. This can be useful for # debugging and understanding the model's reasoning process. One of `concise` or # `detailed`. + # + # @see OpenAI::Models::Reasoning#generate_summary module GenerateSummary extend OpenAI::Enum diff --git a/lib/openai/models/response_format_json_schema.rb b/lib/openai/models/response_format_json_schema.rb index 907a4666..8dac86a9 100644 --- a/lib/openai/models/response_format_json_schema.rb +++ b/lib/openai/models/response_format_json_schema.rb @@ -27,6 +27,7 @@ class ResponseFormatJSONSchema < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::ResponseFormatJSONSchema#json_schema class JSONSchema < OpenAI::BaseModel # @!attribute name # The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores diff --git a/lib/openai/models/responses/computer_tool.rb b/lib/openai/models/responses/computer_tool.rb index 6802a365..57d62fd4 100644 --- a/lib/openai/models/responses/computer_tool.rb +++ b/lib/openai/models/responses/computer_tool.rb @@ -42,6 +42,8 @@ class ComputerTool < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # The type of computer environment to control. + # + # @see OpenAI::Models::Responses::ComputerTool#environment module Environment extend OpenAI::Enum diff --git a/lib/openai/models/responses/easy_input_message.rb b/lib/openai/models/responses/easy_input_message.rb index 3c79d015..715855e0 100644 --- a/lib/openai/models/responses/easy_input_message.rb +++ b/lib/openai/models/responses/easy_input_message.rb @@ -45,6 +45,8 @@ class EasyInputMessage < OpenAI::BaseModel # Text, image, or audio input to the model, used to generate a response. Can also # contain previous assistant responses. + # + # @see OpenAI::Models::Responses::EasyInputMessage#content module Content extend OpenAI::Union @@ -62,6 +64,8 @@ module Content # The role of the message input. One of `user`, `assistant`, `system`, or # `developer`. + # + # @see OpenAI::Models::Responses::EasyInputMessage#role module Role extend OpenAI::Enum @@ -78,6 +82,8 @@ module Role end # The type of the message input. Always `message`. + # + # @see OpenAI::Models::Responses::EasyInputMessage#type module Type extend OpenAI::Enum diff --git a/lib/openai/models/responses/file_search_tool.rb b/lib/openai/models/responses/file_search_tool.rb index 6c9f5511..18833fef 100644 --- a/lib/openai/models/responses/file_search_tool.rb +++ b/lib/openai/models/responses/file_search_tool.rb @@ -63,6 +63,8 @@ class FileSearchTool < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # A filter to apply based on file attributes. + # + # @see OpenAI::Models::Responses::FileSearchTool#filters module Filters extend OpenAI::Union @@ -77,6 +79,7 @@ module Filters # def self.variants; end end + # @see OpenAI::Models::Responses::FileSearchTool#ranking_options class RankingOptions < OpenAI::BaseModel # @!attribute [r] ranker # The ranker to use for the file search. @@ -111,6 +114,8 @@ class RankingOptions < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # The ranker to use for the file search. + # + # @see OpenAI::Models::Responses::FileSearchTool::RankingOptions#ranker module Ranker extend OpenAI::Enum diff --git a/lib/openai/models/responses/input_item_list_params.rb b/lib/openai/models/responses/input_item_list_params.rb index 3bf3624b..82362ce6 100644 --- a/lib/openai/models/responses/input_item_list_params.rb +++ b/lib/openai/models/responses/input_item_list_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module Responses + # @see OpenAI::Resources::Responses::InputItems#list class InputItemListParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/responses/response.rb b/lib/openai/models/responses/response.rb index 296c2d41..9f71b7aa 100644 --- a/lib/openai/models/responses/response.rb +++ b/lib/openai/models/responses/response.rb @@ -269,6 +269,7 @@ class Response < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Responses::Response#incomplete_details class IncompleteDetails < OpenAI::BaseModel # @!attribute [r] reason # The reason why the response is incomplete. @@ -290,6 +291,8 @@ class IncompleteDetails < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # The reason why the response is incomplete. + # + # @see OpenAI::Models::Responses::Response::IncompleteDetails#reason module Reason extend OpenAI::Enum @@ -307,6 +310,8 @@ module Reason # How the model should select which tool (or tools) to use when generating a # response. See the `tools` parameter to see how to specify which tools the model # can call. + # + # @see OpenAI::Models::Responses::Response#tool_choice module ToolChoice extend OpenAI::Union @@ -339,6 +344,8 @@ module ToolChoice # window by dropping input items in the middle of the conversation. # - `disabled` (default): If a model response will exceed the context window size # for a model, the request will fail with a 400 error. + # + # @see OpenAI::Models::Responses::Response#truncation module Truncation extend OpenAI::Enum diff --git a/lib/openai/models/responses/response_code_interpreter_tool_call.rb b/lib/openai/models/responses/response_code_interpreter_tool_call.rb index 0d7ae42f..5ce7e550 100644 --- a/lib/openai/models/responses/response_code_interpreter_tool_call.rb +++ b/lib/openai/models/responses/response_code_interpreter_tool_call.rb @@ -136,6 +136,8 @@ class File < OpenAI::BaseModel end # The status of the code interpreter tool call. + # + # @see OpenAI::Models::Responses::ResponseCodeInterpreterToolCall#status module Status extend OpenAI::Enum diff --git a/lib/openai/models/responses/response_computer_tool_call.rb b/lib/openai/models/responses/response_computer_tool_call.rb index 6e5128d4..207a2584 100644 --- a/lib/openai/models/responses/response_computer_tool_call.rb +++ b/lib/openai/models/responses/response_computer_tool_call.rb @@ -59,6 +59,8 @@ class ResponseComputerToolCall < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # A click action. + # + # @see OpenAI::Models::Responses::ResponseComputerToolCall#action module Action extend OpenAI::Union @@ -132,6 +134,8 @@ class Click < OpenAI::BaseModel # Indicates which mouse button was pressed during the click. One of `left`, # `right`, `wheel`, `back`, or `forward`. + # + # @see OpenAI::Models::Responses::ResponseComputerToolCall::Action::Click#button module Button extend OpenAI::Enum @@ -442,6 +446,8 @@ class PendingSafetyCheck < OpenAI::BaseModel # The status of the item. One of `in_progress`, `completed`, or `incomplete`. # Populated when items are returned via API. + # + # @see OpenAI::Models::Responses::ResponseComputerToolCall#status module Status extend OpenAI::Enum @@ -457,6 +463,8 @@ module Status end # The type of the computer call. Always `computer_call`. + # + # @see OpenAI::Models::Responses::ResponseComputerToolCall#type module Type extend OpenAI::Enum diff --git a/lib/openai/models/responses/response_computer_tool_call_output_item.rb b/lib/openai/models/responses/response_computer_tool_call_output_item.rb index 856d3c99..467d41e0 100644 --- a/lib/openai/models/responses/response_computer_tool_call_output_item.rb +++ b/lib/openai/models/responses/response_computer_tool_call_output_item.rb @@ -96,6 +96,8 @@ class AcknowledgedSafetyCheck < OpenAI::BaseModel # The status of the message input. One of `in_progress`, `completed`, or # `incomplete`. Populated when input items are returned via API. + # + # @see OpenAI::Models::Responses::ResponseComputerToolCallOutputItem#status module Status extend OpenAI::Enum diff --git a/lib/openai/models/responses/response_content_part_added_event.rb b/lib/openai/models/responses/response_content_part_added_event.rb index d1242f76..66590848 100644 --- a/lib/openai/models/responses/response_content_part_added_event.rb +++ b/lib/openai/models/responses/response_content_part_added_event.rb @@ -48,6 +48,8 @@ class ResponseContentPartAddedEvent < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # The content part that was added. + # + # @see OpenAI::Models::Responses::ResponseContentPartAddedEvent#part module Part extend OpenAI::Union diff --git a/lib/openai/models/responses/response_content_part_done_event.rb b/lib/openai/models/responses/response_content_part_done_event.rb index 8481a853..988c11d1 100644 --- a/lib/openai/models/responses/response_content_part_done_event.rb +++ b/lib/openai/models/responses/response_content_part_done_event.rb @@ -48,6 +48,8 @@ class ResponseContentPartDoneEvent < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # The content part that is done. + # + # @see OpenAI::Models::Responses::ResponseContentPartDoneEvent#part module Part extend OpenAI::Union diff --git a/lib/openai/models/responses/response_create_params.rb b/lib/openai/models/responses/response_create_params.rb index e5c04cf7..41049b5b 100644 --- a/lib/openai/models/responses/response_create_params.rb +++ b/lib/openai/models/responses/response_create_params.rb @@ -3,6 +3,9 @@ module OpenAI module Models module Responses + # @see OpenAI::Resources::Responses#create + # + # @see OpenAI::Resources::Responses#create_streaming class ResponseCreateParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/responses/response_delete_params.rb b/lib/openai/models/responses/response_delete_params.rb index ee46f30c..389d812a 100644 --- a/lib/openai/models/responses/response_delete_params.rb +++ b/lib/openai/models/responses/response_delete_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module Responses + # @see OpenAI::Resources::Responses#delete class ResponseDeleteParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/responses/response_error.rb b/lib/openai/models/responses/response_error.rb index 4b7b4755..465b571a 100644 --- a/lib/openai/models/responses/response_error.rb +++ b/lib/openai/models/responses/response_error.rb @@ -27,6 +27,8 @@ class ResponseError < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # The error code for the response. + # + # @see OpenAI::Models::Responses::ResponseError#code module Code extend OpenAI::Enum diff --git a/lib/openai/models/responses/response_file_search_tool_call.rb b/lib/openai/models/responses/response_file_search_tool_call.rb index 20201242..3606686b 100644 --- a/lib/openai/models/responses/response_file_search_tool_call.rb +++ b/lib/openai/models/responses/response_file_search_tool_call.rb @@ -54,6 +54,8 @@ class ResponseFileSearchToolCall < OpenAI::BaseModel # The status of the file search tool call. One of `in_progress`, `searching`, # `incomplete` or `failed`, + # + # @see OpenAI::Models::Responses::ResponseFileSearchToolCall#status module Status extend OpenAI::Enum diff --git a/lib/openai/models/responses/response_function_tool_call.rb b/lib/openai/models/responses/response_function_tool_call.rb index 6d337c8f..92fbd817 100644 --- a/lib/openai/models/responses/response_function_tool_call.rb +++ b/lib/openai/models/responses/response_function_tool_call.rb @@ -67,6 +67,8 @@ class ResponseFunctionToolCall < OpenAI::BaseModel # The status of the item. One of `in_progress`, `completed`, or `incomplete`. # Populated when items are returned via API. + # + # @see OpenAI::Models::Responses::ResponseFunctionToolCall#status module Status extend OpenAI::Enum diff --git a/lib/openai/models/responses/response_function_tool_call_output_item.rb b/lib/openai/models/responses/response_function_tool_call_output_item.rb index 83d109ab..310a8685 100644 --- a/lib/openai/models/responses/response_function_tool_call_output_item.rb +++ b/lib/openai/models/responses/response_function_tool_call_output_item.rb @@ -52,6 +52,8 @@ class ResponseFunctionToolCallOutputItem < OpenAI::BaseModel # The status of the item. One of `in_progress`, `completed`, or `incomplete`. # Populated when items are returned via API. + # + # @see OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem#status module Status extend OpenAI::Enum diff --git a/lib/openai/models/responses/response_function_web_search.rb b/lib/openai/models/responses/response_function_web_search.rb index 78f572ca..41ecb9f4 100644 --- a/lib/openai/models/responses/response_function_web_search.rb +++ b/lib/openai/models/responses/response_function_web_search.rb @@ -36,6 +36,8 @@ class ResponseFunctionWebSearch < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # The status of the web search tool call. + # + # @see OpenAI::Models::Responses::ResponseFunctionWebSearch#status module Status extend OpenAI::Enum diff --git a/lib/openai/models/responses/response_input_audio.rb b/lib/openai/models/responses/response_input_audio.rb index a039c35c..e6caa2ed 100644 --- a/lib/openai/models/responses/response_input_audio.rb +++ b/lib/openai/models/responses/response_input_audio.rb @@ -34,6 +34,8 @@ class ResponseInputAudio < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # The format of the audio data. Currently supported formats are `mp3` and `wav`. + # + # @see OpenAI::Models::Responses::ResponseInputAudio#format_ module Format extend OpenAI::Enum diff --git a/lib/openai/models/responses/response_input_image.rb b/lib/openai/models/responses/response_input_image.rb index 2e770199..5c5bb8ce 100644 --- a/lib/openai/models/responses/response_input_image.rb +++ b/lib/openai/models/responses/response_input_image.rb @@ -45,6 +45,8 @@ class ResponseInputImage < OpenAI::BaseModel # The detail level of the image to be sent to the model. One of `high`, `low`, or # `auto`. Defaults to `auto`. + # + # @see OpenAI::Models::Responses::ResponseInputImage#detail module Detail extend OpenAI::Enum diff --git a/lib/openai/models/responses/response_input_item.rb b/lib/openai/models/responses/response_input_item.rb index d2e09cef..206650eb 100644 --- a/lib/openai/models/responses/response_input_item.rb +++ b/lib/openai/models/responses/response_input_item.rb @@ -107,6 +107,8 @@ class Message < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # The role of the message input. One of `user`, `system`, or `developer`. + # + # @see OpenAI::Models::Responses::ResponseInputItem::Message#role module Role extend OpenAI::Enum @@ -123,6 +125,8 @@ module Role # The status of item. One of `in_progress`, `completed`, or `incomplete`. # Populated when items are returned via API. + # + # @see OpenAI::Models::Responses::ResponseInputItem::Message#status module Status extend OpenAI::Enum @@ -138,6 +142,8 @@ module Status end # The type of the message input. Always set to `message`. + # + # @see OpenAI::Models::Responses::ResponseInputItem::Message#type module Type extend OpenAI::Enum @@ -250,6 +256,8 @@ class AcknowledgedSafetyCheck < OpenAI::BaseModel # The status of the message input. One of `in_progress`, `completed`, or # `incomplete`. Populated when input items are returned via API. + # + # @see OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput#status module Status extend OpenAI::Enum @@ -321,6 +329,8 @@ class FunctionCallOutput < OpenAI::BaseModel # The status of the item. One of `in_progress`, `completed`, or `incomplete`. # Populated when items are returned via API. + # + # @see OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput#status module Status extend OpenAI::Enum diff --git a/lib/openai/models/responses/response_input_message_item.rb b/lib/openai/models/responses/response_input_message_item.rb index 3962d98d..65bfbf76 100644 --- a/lib/openai/models/responses/response_input_message_item.rb +++ b/lib/openai/models/responses/response_input_message_item.rb @@ -56,6 +56,8 @@ class ResponseInputMessageItem < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # The role of the message input. One of `user`, `system`, or `developer`. + # + # @see OpenAI::Models::Responses::ResponseInputMessageItem#role module Role extend OpenAI::Enum @@ -72,6 +74,8 @@ module Role # The status of item. One of `in_progress`, `completed`, or `incomplete`. # Populated when items are returned via API. + # + # @see OpenAI::Models::Responses::ResponseInputMessageItem#status module Status extend OpenAI::Enum @@ -87,6 +91,8 @@ module Status end # The type of the message input. Always set to `message`. + # + # @see OpenAI::Models::Responses::ResponseInputMessageItem#type module Type extend OpenAI::Enum diff --git a/lib/openai/models/responses/response_output_message.rb b/lib/openai/models/responses/response_output_message.rb index 04b05a0d..373721b0 100644 --- a/lib/openai/models/responses/response_output_message.rb +++ b/lib/openai/models/responses/response_output_message.rb @@ -68,6 +68,8 @@ module Content # The status of the message input. One of `in_progress`, `completed`, or # `incomplete`. Populated when input items are returned via API. + # + # @see OpenAI::Models::Responses::ResponseOutputMessage#status module Status extend OpenAI::Enum diff --git a/lib/openai/models/responses/response_reasoning_item.rb b/lib/openai/models/responses/response_reasoning_item.rb index bb1bc110..e5539f3d 100644 --- a/lib/openai/models/responses/response_reasoning_item.rb +++ b/lib/openai/models/responses/response_reasoning_item.rb @@ -70,6 +70,8 @@ class Summary < OpenAI::BaseModel # 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::Enum diff --git a/lib/openai/models/responses/response_retrieve_params.rb b/lib/openai/models/responses/response_retrieve_params.rb index 6d3028c3..36f30f22 100644 --- a/lib/openai/models/responses/response_retrieve_params.rb +++ b/lib/openai/models/responses/response_retrieve_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module Responses + # @see OpenAI::Resources::Responses#retrieve class ResponseRetrieveParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/responses/response_text_annotation_delta_event.rb b/lib/openai/models/responses/response_text_annotation_delta_event.rb index f796c035..c6291cf6 100644 --- a/lib/openai/models/responses/response_text_annotation_delta_event.rb +++ b/lib/openai/models/responses/response_text_annotation_delta_event.rb @@ -66,6 +66,8 @@ class ResponseTextAnnotationDeltaEvent < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # A citation to a file. + # + # @see OpenAI::Models::Responses::ResponseTextAnnotationDeltaEvent#annotation module Annotation extend OpenAI::Union diff --git a/lib/openai/models/responses/response_usage.rb b/lib/openai/models/responses/response_usage.rb index 8e4ccddd..316d5b3f 100644 --- a/lib/openai/models/responses/response_usage.rb +++ b/lib/openai/models/responses/response_usage.rb @@ -48,6 +48,7 @@ class ResponseUsage < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::Responses::ResponseUsage#input_tokens_details class InputTokensDetails < OpenAI::BaseModel # @!attribute cached_tokens # The number of tokens that were retrieved from the cache. @@ -66,6 +67,7 @@ class InputTokensDetails < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void end + # @see OpenAI::Models::Responses::ResponseUsage#output_tokens_details class OutputTokensDetails < OpenAI::BaseModel # @!attribute reasoning_tokens # The number of reasoning tokens. diff --git a/lib/openai/models/responses/tool_choice_types.rb b/lib/openai/models/responses/tool_choice_types.rb index b6041f87..cddbcc56 100644 --- a/lib/openai/models/responses/tool_choice_types.rb +++ b/lib/openai/models/responses/tool_choice_types.rb @@ -35,6 +35,8 @@ class ToolChoiceTypes < OpenAI::BaseModel # - `file_search` # - `web_search_preview` # - `computer_use_preview` + # + # @see OpenAI::Models::Responses::ToolChoiceTypes#type module Type extend OpenAI::Enum diff --git a/lib/openai/models/responses/web_search_tool.rb b/lib/openai/models/responses/web_search_tool.rb index 31542421..58f833d7 100644 --- a/lib/openai/models/responses/web_search_tool.rb +++ b/lib/openai/models/responses/web_search_tool.rb @@ -46,6 +46,8 @@ class WebSearchTool < OpenAI::BaseModel # # - `web_search_preview` # - `web_search_preview_2025_03_11` + # + # @see OpenAI::Models::Responses::WebSearchTool#type module Type extend OpenAI::Enum @@ -61,6 +63,8 @@ module Type # High level guidance for the amount of context window space to use for the # search. One of `low`, `medium`, or `high`. `medium` is the default. + # + # @see OpenAI::Models::Responses::WebSearchTool#search_context_size module SearchContextSize extend OpenAI::Enum @@ -75,6 +79,7 @@ module SearchContextSize # def self.values; end end + # @see OpenAI::Models::Responses::WebSearchTool#user_location class UserLocation < OpenAI::BaseModel # @!attribute type # The type of location approximation. Always `approximate`. diff --git a/lib/openai/models/upload.rb b/lib/openai/models/upload.rb index 4f319b8c..a1652e79 100644 --- a/lib/openai/models/upload.rb +++ b/lib/openai/models/upload.rb @@ -77,6 +77,8 @@ class Upload < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # The status of the Upload. + # + # @see OpenAI::Models::Upload#status module Status extend OpenAI::Enum diff --git a/lib/openai/models/upload_cancel_params.rb b/lib/openai/models/upload_cancel_params.rb index 62d1e116..e509a7b1 100644 --- a/lib/openai/models/upload_cancel_params.rb +++ b/lib/openai/models/upload_cancel_params.rb @@ -2,6 +2,7 @@ module OpenAI module Models + # @see OpenAI::Resources::Uploads#cancel class UploadCancelParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/upload_complete_params.rb b/lib/openai/models/upload_complete_params.rb index 866303ce..1d3ff0d8 100644 --- a/lib/openai/models/upload_complete_params.rb +++ b/lib/openai/models/upload_complete_params.rb @@ -2,6 +2,7 @@ module OpenAI module Models + # @see OpenAI::Resources::Uploads#complete class UploadCompleteParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/upload_create_params.rb b/lib/openai/models/upload_create_params.rb index 3650d2dd..68511cf4 100644 --- a/lib/openai/models/upload_create_params.rb +++ b/lib/openai/models/upload_create_params.rb @@ -2,6 +2,7 @@ module OpenAI module Models + # @see OpenAI::Resources::Uploads#create class UploadCreateParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/uploads/part_create_params.rb b/lib/openai/models/uploads/part_create_params.rb index 2d3a2fb7..636b73b1 100644 --- a/lib/openai/models/uploads/part_create_params.rb +++ b/lib/openai/models/uploads/part_create_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module Uploads + # @see OpenAI::Resources::Uploads::Parts#create class PartCreateParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/vector_store.rb b/lib/openai/models/vector_store.rb index dd5df66d..8832fca7 100644 --- a/lib/openai/models/vector_store.rb +++ b/lib/openai/models/vector_store.rb @@ -114,6 +114,7 @@ class VectorStore < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::VectorStore#file_counts class FileCounts < OpenAI::BaseModel # @!attribute cancelled # The number of files that were cancelled. @@ -160,6 +161,8 @@ class FileCounts < OpenAI::BaseModel # The status of the vector store, which can be either `expired`, `in_progress`, or # `completed`. A status of `completed` indicates that the vector store is ready # for use. + # + # @see OpenAI::Models::VectorStore#status module Status extend OpenAI::Enum @@ -174,6 +177,7 @@ module Status # def self.values; end end + # @see OpenAI::Models::VectorStore#expires_after class ExpiresAfter < OpenAI::BaseModel # @!attribute anchor # Anchor timestamp after which the expiration policy applies. Supported anchors: diff --git a/lib/openai/models/vector_store_create_params.rb b/lib/openai/models/vector_store_create_params.rb index 43b4e601..a4633e39 100644 --- a/lib/openai/models/vector_store_create_params.rb +++ b/lib/openai/models/vector_store_create_params.rb @@ -2,6 +2,7 @@ module OpenAI module Models + # @see OpenAI::Resources::VectorStores#create class VectorStoreCreateParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/vector_store_delete_params.rb b/lib/openai/models/vector_store_delete_params.rb index 25113370..a6973a49 100644 --- a/lib/openai/models/vector_store_delete_params.rb +++ b/lib/openai/models/vector_store_delete_params.rb @@ -2,6 +2,7 @@ module OpenAI module Models + # @see OpenAI::Resources::VectorStores#delete class VectorStoreDeleteParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/vector_store_list_params.rb b/lib/openai/models/vector_store_list_params.rb index 614dc937..90569e9b 100644 --- a/lib/openai/models/vector_store_list_params.rb +++ b/lib/openai/models/vector_store_list_params.rb @@ -2,6 +2,7 @@ module OpenAI module Models + # @see OpenAI::Resources::VectorStores#list class VectorStoreListParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/vector_store_retrieve_params.rb b/lib/openai/models/vector_store_retrieve_params.rb index 60ede4d7..8328d0a1 100644 --- a/lib/openai/models/vector_store_retrieve_params.rb +++ b/lib/openai/models/vector_store_retrieve_params.rb @@ -2,6 +2,7 @@ module OpenAI module Models + # @see OpenAI::Resources::VectorStores#retrieve class VectorStoreRetrieveParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/vector_store_search_params.rb b/lib/openai/models/vector_store_search_params.rb index c970dbc4..bde42131 100644 --- a/lib/openai/models/vector_store_search_params.rb +++ b/lib/openai/models/vector_store_search_params.rb @@ -2,6 +2,7 @@ module OpenAI module Models + # @see OpenAI::Resources::VectorStores#search class VectorStoreSearchParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter @@ -135,6 +136,7 @@ class RankingOptions < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::VectorStoreSearchParams::RankingOptions#ranker module Ranker extend OpenAI::Enum diff --git a/lib/openai/models/vector_store_search_response.rb b/lib/openai/models/vector_store_search_response.rb index 11a8b9e3..c4914147 100644 --- a/lib/openai/models/vector_store_search_response.rb +++ b/lib/openai/models/vector_store_search_response.rb @@ -86,6 +86,8 @@ class Content < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # The type of content. + # + # @see OpenAI::Models::VectorStoreSearchResponse::Content#type module Type extend OpenAI::Enum diff --git a/lib/openai/models/vector_store_update_params.rb b/lib/openai/models/vector_store_update_params.rb index 7e6fb3a6..62b9c58d 100644 --- a/lib/openai/models/vector_store_update_params.rb +++ b/lib/openai/models/vector_store_update_params.rb @@ -2,6 +2,7 @@ module OpenAI module Models + # @see OpenAI::Resources::VectorStores#update class VectorStoreUpdateParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/vector_stores/file_batch_cancel_params.rb b/lib/openai/models/vector_stores/file_batch_cancel_params.rb index 3e5971ff..b9d746ca 100644 --- a/lib/openai/models/vector_stores/file_batch_cancel_params.rb +++ b/lib/openai/models/vector_stores/file_batch_cancel_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module VectorStores + # @see OpenAI::Resources::VectorStores::FileBatches#cancel class FileBatchCancelParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/vector_stores/file_batch_create_params.rb b/lib/openai/models/vector_stores/file_batch_create_params.rb index 69286492..ce0dbcf7 100644 --- a/lib/openai/models/vector_stores/file_batch_create_params.rb +++ b/lib/openai/models/vector_stores/file_batch_create_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module VectorStores + # @see OpenAI::Resources::VectorStores::FileBatches#create class FileBatchCreateParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/vector_stores/file_batch_list_files_params.rb b/lib/openai/models/vector_stores/file_batch_list_files_params.rb index 1dbc17b1..a5e43403 100644 --- a/lib/openai/models/vector_stores/file_batch_list_files_params.rb +++ b/lib/openai/models/vector_stores/file_batch_list_files_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module VectorStores + # @see OpenAI::Resources::VectorStores::FileBatches#list_files class FileBatchListFilesParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/vector_stores/file_batch_retrieve_params.rb b/lib/openai/models/vector_stores/file_batch_retrieve_params.rb index 34ccee34..37c6f122 100644 --- a/lib/openai/models/vector_stores/file_batch_retrieve_params.rb +++ b/lib/openai/models/vector_stores/file_batch_retrieve_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module VectorStores + # @see OpenAI::Resources::VectorStores::FileBatches#retrieve class FileBatchRetrieveParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/vector_stores/file_content_params.rb b/lib/openai/models/vector_stores/file_content_params.rb index 8e88a4ff..52f123e2 100644 --- a/lib/openai/models/vector_stores/file_content_params.rb +++ b/lib/openai/models/vector_stores/file_content_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module VectorStores + # @see OpenAI::Resources::VectorStores::Files#content class FileContentParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/vector_stores/file_create_params.rb b/lib/openai/models/vector_stores/file_create_params.rb index 79ef17c3..514d5c8b 100644 --- a/lib/openai/models/vector_stores/file_create_params.rb +++ b/lib/openai/models/vector_stores/file_create_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module VectorStores + # @see OpenAI::Resources::VectorStores::Files#create class FileCreateParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/vector_stores/file_delete_params.rb b/lib/openai/models/vector_stores/file_delete_params.rb index 8baa3964..8ed88cd8 100644 --- a/lib/openai/models/vector_stores/file_delete_params.rb +++ b/lib/openai/models/vector_stores/file_delete_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module VectorStores + # @see OpenAI::Resources::VectorStores::Files#delete class FileDeleteParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/vector_stores/file_list_params.rb b/lib/openai/models/vector_stores/file_list_params.rb index 78acf207..34115039 100644 --- a/lib/openai/models/vector_stores/file_list_params.rb +++ b/lib/openai/models/vector_stores/file_list_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module VectorStores + # @see OpenAI::Resources::VectorStores::Files#list class FileListParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/vector_stores/file_retrieve_params.rb b/lib/openai/models/vector_stores/file_retrieve_params.rb index bfb3d370..65d9dcbe 100644 --- a/lib/openai/models/vector_stores/file_retrieve_params.rb +++ b/lib/openai/models/vector_stores/file_retrieve_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module VectorStores + # @see OpenAI::Resources::VectorStores::Files#retrieve class FileRetrieveParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/vector_stores/file_update_params.rb b/lib/openai/models/vector_stores/file_update_params.rb index e1a477eb..8d952ea8 100644 --- a/lib/openai/models/vector_stores/file_update_params.rb +++ b/lib/openai/models/vector_stores/file_update_params.rb @@ -3,6 +3,7 @@ module OpenAI module Models module VectorStores + # @see OpenAI::Resources::VectorStores::Files#update class FileUpdateParams < OpenAI::BaseModel # @!parse # extend OpenAI::Type::RequestParameters::Converter diff --git a/lib/openai/models/vector_stores/vector_store_file.rb b/lib/openai/models/vector_stores/vector_store_file.rb index 12c6f576..a1a631ed 100644 --- a/lib/openai/models/vector_stores/vector_store_file.rb +++ b/lib/openai/models/vector_stores/vector_store_file.rb @@ -105,6 +105,7 @@ class VectorStoreFile < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::VectorStores::VectorStoreFile#last_error class LastError < OpenAI::BaseModel # @!attribute code # One of `server_error` or `rate_limit_exceeded`. @@ -130,6 +131,8 @@ class LastError < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void # One of `server_error` or `rate_limit_exceeded`. + # + # @see OpenAI::Models::VectorStores::VectorStoreFile::LastError#code module Code extend OpenAI::Enum @@ -148,6 +151,8 @@ module Code # The status of the vector store file, which can be either `in_progress`, # `completed`, `cancelled`, or `failed`. The status `completed` indicates that the # vector store file is ready for use. + # + # @see OpenAI::Models::VectorStores::VectorStoreFile#status module Status extend OpenAI::Enum diff --git a/lib/openai/models/vector_stores/vector_store_file_batch.rb b/lib/openai/models/vector_stores/vector_store_file_batch.rb index 8fc405d8..dfc5192d 100644 --- a/lib/openai/models/vector_stores/vector_store_file_batch.rb +++ b/lib/openai/models/vector_stores/vector_store_file_batch.rb @@ -58,6 +58,7 @@ class VectorStoreFileBatch < OpenAI::BaseModel # def initialize: (Hash | OpenAI::BaseModel) -> void + # @see OpenAI::Models::VectorStores::VectorStoreFileBatch#file_counts class FileCounts < OpenAI::BaseModel # @!attribute cancelled # The number of files that where cancelled. @@ -103,6 +104,8 @@ class FileCounts < OpenAI::BaseModel # The status of the vector store files batch, which can be either `in_progress`, # `completed`, `cancelled` or `failed`. + # + # @see OpenAI::Models::VectorStores::VectorStoreFileBatch#status module Status extend OpenAI::Enum diff --git a/lib/openai/resources/audio.rb b/lib/openai/resources/audio.rb index e82c41f4..2ddf1970 100644 --- a/lib/openai/resources/audio.rb +++ b/lib/openai/resources/audio.rb @@ -12,6 +12,8 @@ class Audio # @return [OpenAI::Resources::Audio::Speech] attr_reader :speech + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/lib/openai/resources/audio/speech.rb b/lib/openai/resources/audio/speech.rb index 0b5bb925..23e2ee76 100644 --- a/lib/openai/resources/audio/speech.rb +++ b/lib/openai/resources/audio/speech.rb @@ -30,6 +30,8 @@ class Speech # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [StringIO] + # + # @see OpenAI::Models::Audio::SpeechCreateParams def create(params) parsed, options = OpenAI::Models::Audio::SpeechCreateParams.dump_request(params) @client.request( @@ -42,6 +44,8 @@ def create(params) ) end + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/lib/openai/resources/audio/transcriptions.rb b/lib/openai/resources/audio/transcriptions.rb index 3c7238bf..cfbc82a3 100644 --- a/lib/openai/resources/audio/transcriptions.rb +++ b/lib/openai/resources/audio/transcriptions.rb @@ -49,6 +49,8 @@ class Transcriptions # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Audio::Transcription, OpenAI::Models::Audio::TranscriptionVerbose] + # + # @see OpenAI::Models::Audio::TranscriptionCreateParams def create(params) parsed, options = OpenAI::Models::Audio::TranscriptionCreateParams.dump_request(params) if parsed[:stream] @@ -110,6 +112,8 @@ def create(params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Stream] + # + # @see OpenAI::Models::Audio::TranscriptionCreateParams def create_streaming(params) parsed, options = OpenAI::Models::Audio::TranscriptionCreateParams.dump_request(params) unless parsed.fetch(:stream, true) @@ -128,6 +132,8 @@ def create_streaming(params) ) end + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/lib/openai/resources/audio/translations.rb b/lib/openai/resources/audio/translations.rb index ea8e0e4a..e3f7a9f2 100644 --- a/lib/openai/resources/audio/translations.rb +++ b/lib/openai/resources/audio/translations.rb @@ -31,6 +31,8 @@ class Translations # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Audio::Translation, OpenAI::Models::Audio::TranslationVerbose] + # + # @see OpenAI::Models::Audio::TranslationCreateParams def create(params) parsed, options = OpenAI::Models::Audio::TranslationCreateParams.dump_request(params) @client.request( @@ -43,6 +45,8 @@ def create(params) ) end + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/lib/openai/resources/batches.rb b/lib/openai/resources/batches.rb index 143a05ee..b9f05f65 100644 --- a/lib/openai/resources/batches.rb +++ b/lib/openai/resources/batches.rb @@ -35,6 +35,8 @@ class Batches # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Batch] + # + # @see OpenAI::Models::BatchCreateParams def create(params) parsed, options = OpenAI::Models::BatchCreateParams.dump_request(params) @client.request( @@ -55,6 +57,8 @@ def create(params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Batch] + # + # @see OpenAI::Models::BatchRetrieveParams def retrieve(batch_id, params = {}) @client.request( method: :get, @@ -79,6 +83,8 @@ def retrieve(batch_id, params = {}) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::CursorPage] + # + # @see OpenAI::Models::BatchListParams def list(params = {}) parsed, options = OpenAI::Models::BatchListParams.dump_request(params) @client.request( @@ -102,6 +108,8 @@ def list(params = {}) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Batch] + # + # @see OpenAI::Models::BatchCancelParams def cancel(batch_id, params = {}) @client.request( method: :post, @@ -111,6 +119,8 @@ def cancel(batch_id, params = {}) ) end + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/lib/openai/resources/beta.rb b/lib/openai/resources/beta.rb index c1b7273a..62d4e049 100644 --- a/lib/openai/resources/beta.rb +++ b/lib/openai/resources/beta.rb @@ -9,6 +9,8 @@ class Beta # @return [OpenAI::Resources::Beta::Threads] attr_reader :threads + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/lib/openai/resources/beta/assistants.rb b/lib/openai/resources/beta/assistants.rb index 1557a813..928cc77e 100644 --- a/lib/openai/resources/beta/assistants.rb +++ b/lib/openai/resources/beta/assistants.rb @@ -78,6 +78,8 @@ class Assistants # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Beta::Assistant] + # + # @see OpenAI::Models::Beta::AssistantCreateParams def create(params) parsed, options = OpenAI::Models::Beta::AssistantCreateParams.dump_request(params) @client.request( @@ -98,6 +100,8 @@ def create(params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Beta::Assistant] + # + # @see OpenAI::Models::Beta::AssistantRetrieveParams def retrieve(assistant_id, params = {}) @client.request( method: :get, @@ -183,6 +187,8 @@ def retrieve(assistant_id, params = {}) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Beta::Assistant] + # + # @see OpenAI::Models::Beta::AssistantUpdateParams def update(assistant_id, params = {}) parsed, options = OpenAI::Models::Beta::AssistantUpdateParams.dump_request(params) @client.request( @@ -217,6 +223,8 @@ def update(assistant_id, params = {}) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::CursorPage] + # + # @see OpenAI::Models::Beta::AssistantListParams def list(params = {}) parsed, options = OpenAI::Models::Beta::AssistantListParams.dump_request(params) @client.request( @@ -238,6 +246,8 @@ def list(params = {}) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Beta::AssistantDeleted] + # + # @see OpenAI::Models::Beta::AssistantDeleteParams def delete(assistant_id, params = {}) @client.request( method: :delete, @@ -247,6 +257,8 @@ def delete(assistant_id, params = {}) ) end + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/lib/openai/resources/beta/threads.rb b/lib/openai/resources/beta/threads.rb index 767bd13c..587f677e 100644 --- a/lib/openai/resources/beta/threads.rb +++ b/lib/openai/resources/beta/threads.rb @@ -32,6 +32,8 @@ class Threads # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Beta::Thread] + # + # @see OpenAI::Models::Beta::ThreadCreateParams def create(params = {}) parsed, options = OpenAI::Models::Beta::ThreadCreateParams.dump_request(params) @client.request( @@ -52,6 +54,8 @@ def create(params = {}) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Beta::Thread] + # + # @see OpenAI::Models::Beta::ThreadRetrieveParams def retrieve(thread_id, params = {}) @client.request( method: :get, @@ -82,6 +86,8 @@ def retrieve(thread_id, params = {}) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Beta::Thread] + # + # @see OpenAI::Models::Beta::ThreadUpdateParams def update(thread_id, params = {}) parsed, options = OpenAI::Models::Beta::ThreadUpdateParams.dump_request(params) @client.request( @@ -102,6 +108,8 @@ def update(thread_id, params = {}) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Beta::ThreadDeleted] + # + # @see OpenAI::Models::Beta::ThreadDeleteParams def delete(thread_id, params = {}) @client.request( method: :delete, @@ -206,6 +214,8 @@ def delete(thread_id, params = {}) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Beta::Threads::Run] + # + # @see OpenAI::Models::Beta::ThreadCreateAndRunParams def create_and_run(params) parsed, options = OpenAI::Models::Beta::ThreadCreateAndRunParams.dump_request(params) if parsed[:stream] @@ -316,6 +326,8 @@ def create_and_run(params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Stream] + # + # @see OpenAI::Models::Beta::ThreadCreateAndRunParams def create_and_run_streaming(params) parsed, options = OpenAI::Models::Beta::ThreadCreateAndRunParams.dump_request(params) unless parsed.fetch(:stream, true) @@ -334,6 +346,8 @@ def create_and_run_streaming(params) ) end + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/lib/openai/resources/beta/threads/messages.rb b/lib/openai/resources/beta/threads/messages.rb index fdcef361..0e86c04e 100644 --- a/lib/openai/resources/beta/threads/messages.rb +++ b/lib/openai/resources/beta/threads/messages.rb @@ -33,6 +33,8 @@ class Messages # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Beta::Threads::Message] + # + # @see OpenAI::Models::Beta::Threads::MessageCreateParams def create(thread_id, params) parsed, options = OpenAI::Models::Beta::Threads::MessageCreateParams.dump_request(params) @client.request( @@ -56,6 +58,8 @@ def create(thread_id, params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Beta::Threads::Message] + # + # @see OpenAI::Models::Beta::Threads::MessageRetrieveParams def retrieve(message_id, params) parsed, options = OpenAI::Models::Beta::Threads::MessageRetrieveParams.dump_request(params) thread_id = @@ -88,6 +92,8 @@ def retrieve(message_id, params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Beta::Threads::Message] + # + # @see OpenAI::Models::Beta::Threads::MessageUpdateParams def update(message_id, params) parsed, options = OpenAI::Models::Beta::Threads::MessageUpdateParams.dump_request(params) thread_id = @@ -131,6 +137,8 @@ def update(message_id, params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::CursorPage] + # + # @see OpenAI::Models::Beta::Threads::MessageListParams def list(thread_id, params = {}) parsed, options = OpenAI::Models::Beta::Threads::MessageListParams.dump_request(params) @client.request( @@ -154,6 +162,8 @@ def list(thread_id, params = {}) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Beta::Threads::MessageDeleted] + # + # @see OpenAI::Models::Beta::Threads::MessageDeleteParams def delete(message_id, params) parsed, options = OpenAI::Models::Beta::Threads::MessageDeleteParams.dump_request(params) thread_id = @@ -168,6 +178,8 @@ def delete(message_id, params) ) end + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/lib/openai/resources/beta/threads/runs.rb b/lib/openai/resources/beta/threads/runs.rb index d67d31ee..a36e8c81 100644 --- a/lib/openai/resources/beta/threads/runs.rb +++ b/lib/openai/resources/beta/threads/runs.rb @@ -123,6 +123,8 @@ class Runs # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Beta::Threads::Run] + # + # @see OpenAI::Models::Beta::Threads::RunCreateParams def create(thread_id, params) parsed, options = OpenAI::Models::Beta::Threads::RunCreateParams.dump_request(params) if parsed[:stream] @@ -255,6 +257,8 @@ def create(thread_id, params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Stream] + # + # @see OpenAI::Models::Beta::Threads::RunCreateParams def create_streaming(thread_id, params) parsed, options = OpenAI::Models::Beta::Threads::RunCreateParams.dump_request(params) unless parsed.fetch(:stream, true) @@ -287,6 +291,8 @@ def create_streaming(thread_id, params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Beta::Threads::Run] + # + # @see OpenAI::Models::Beta::Threads::RunRetrieveParams def retrieve(run_id, params) parsed, options = OpenAI::Models::Beta::Threads::RunRetrieveParams.dump_request(params) thread_id = @@ -320,6 +326,8 @@ def retrieve(run_id, params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Beta::Threads::Run] + # + # @see OpenAI::Models::Beta::Threads::RunUpdateParams def update(run_id, params) parsed, options = OpenAI::Models::Beta::Threads::RunUpdateParams.dump_request(params) thread_id = @@ -360,6 +368,8 @@ def update(run_id, params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::CursorPage] + # + # @see OpenAI::Models::Beta::Threads::RunListParams def list(thread_id, params = {}) parsed, options = OpenAI::Models::Beta::Threads::RunListParams.dump_request(params) @client.request( @@ -383,6 +393,8 @@ def list(thread_id, params = {}) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Beta::Threads::Run] + # + # @see OpenAI::Models::Beta::Threads::RunCancelParams def cancel(run_id, params) parsed, options = OpenAI::Models::Beta::Threads::RunCancelParams.dump_request(params) thread_id = @@ -415,6 +427,8 @@ def cancel(run_id, params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Beta::Threads::Run] + # + # @see OpenAI::Models::Beta::Threads::RunSubmitToolOutputsParams def submit_tool_outputs(run_id, params) parsed, options = OpenAI::Models::Beta::Threads::RunSubmitToolOutputsParams.dump_request(params) if parsed[:stream] @@ -452,6 +466,8 @@ def submit_tool_outputs(run_id, params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Stream] + # + # @see OpenAI::Models::Beta::Threads::RunSubmitToolOutputsParams def submit_tool_outputs_streaming(run_id, params) parsed, options = OpenAI::Models::Beta::Threads::RunSubmitToolOutputsParams.dump_request(params) unless parsed.fetch(:stream, true) @@ -474,6 +490,8 @@ def submit_tool_outputs_streaming(run_id, params) ) end + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/lib/openai/resources/beta/threads/runs/steps.rb b/lib/openai/resources/beta/threads/runs/steps.rb index 9d087222..5d5559cd 100644 --- a/lib/openai/resources/beta/threads/runs/steps.rb +++ b/lib/openai/resources/beta/threads/runs/steps.rb @@ -28,6 +28,8 @@ class Steps # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Beta::Threads::Runs::RunStep] + # + # @see OpenAI::Models::Beta::Threads::Runs::StepRetrieveParams def retrieve(step_id, params) parsed, options = OpenAI::Models::Beta::Threads::Runs::StepRetrieveParams.dump_request(params) thread_id = @@ -83,6 +85,8 @@ def retrieve(step_id, params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::CursorPage] + # + # @see OpenAI::Models::Beta::Threads::Runs::StepListParams def list(run_id, params) parsed, options = OpenAI::Models::Beta::Threads::Runs::StepListParams.dump_request(params) thread_id = @@ -99,6 +103,8 @@ def list(run_id, params) ) end + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/lib/openai/resources/chat.rb b/lib/openai/resources/chat.rb index d5bf1e2e..9bebeb10 100644 --- a/lib/openai/resources/chat.rb +++ b/lib/openai/resources/chat.rb @@ -6,6 +6,8 @@ class Chat # @return [OpenAI::Resources::Chat::Completions] attr_reader :completions + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/lib/openai/resources/chat/completions.rb b/lib/openai/resources/chat/completions.rb index 86c7172c..516866e9 100644 --- a/lib/openai/resources/chat/completions.rb +++ b/lib/openai/resources/chat/completions.rb @@ -213,6 +213,8 @@ class Completions # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Chat::ChatCompletion] + # + # @see OpenAI::Models::Chat::CompletionCreateParams def create(params) parsed, options = OpenAI::Models::Chat::CompletionCreateParams.dump_request(params) if parsed[:stream] @@ -434,6 +436,8 @@ def create(params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Stream] + # + # @see OpenAI::Models::Chat::CompletionCreateParams def create_streaming(params) parsed, options = OpenAI::Models::Chat::CompletionCreateParams.dump_request(params) unless parsed.fetch(:stream, true) @@ -462,6 +466,8 @@ def create_streaming(params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Chat::ChatCompletion] + # + # @see OpenAI::Models::Chat::CompletionRetrieveParams def retrieve(completion_id, params = {}) @client.request( method: :get, @@ -489,6 +495,8 @@ def retrieve(completion_id, params = {}) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Chat::ChatCompletion] + # + # @see OpenAI::Models::Chat::CompletionUpdateParams def update(completion_id, params) parsed, options = OpenAI::Models::Chat::CompletionUpdateParams.dump_request(params) @client.request( @@ -521,6 +529,8 @@ def update(completion_id, params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::CursorPage] + # + # @see OpenAI::Models::Chat::CompletionListParams def list(params = {}) parsed, options = OpenAI::Models::Chat::CompletionListParams.dump_request(params) @client.request( @@ -543,6 +553,8 @@ def list(params = {}) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Chat::ChatCompletionDeleted] + # + # @see OpenAI::Models::Chat::CompletionDeleteParams def delete(completion_id, params = {}) @client.request( method: :delete, @@ -552,6 +564,8 @@ def delete(completion_id, params = {}) ) end + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/lib/openai/resources/chat/completions/messages.rb b/lib/openai/resources/chat/completions/messages.rb index e40262ce..c55835f8 100644 --- a/lib/openai/resources/chat/completions/messages.rb +++ b/lib/openai/resources/chat/completions/messages.rb @@ -22,6 +22,8 @@ class Messages # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::CursorPage] + # + # @see OpenAI::Models::Chat::Completions::MessageListParams def list(completion_id, params = {}) parsed, options = OpenAI::Models::Chat::Completions::MessageListParams.dump_request(params) @client.request( @@ -34,6 +36,8 @@ def list(completion_id, params = {}) ) end + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/lib/openai/resources/completions.rb b/lib/openai/resources/completions.rb index 2cf80ec1..8a22b8c0 100644 --- a/lib/openai/resources/completions.rb +++ b/lib/openai/resources/completions.rb @@ -113,6 +113,8 @@ class Completions # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Completion] + # + # @see OpenAI::Models::CompletionCreateParams def create(params) parsed, options = OpenAI::Models::CompletionCreateParams.dump_request(params) if parsed[:stream] @@ -238,6 +240,8 @@ def create(params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Stream] + # + # @see OpenAI::Models::CompletionCreateParams def create_streaming(params) parsed, options = OpenAI::Models::CompletionCreateParams.dump_request(params) unless parsed.fetch(:stream, true) @@ -256,6 +260,8 @@ def create_streaming(params) ) end + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/lib/openai/resources/embeddings.rb b/lib/openai/resources/embeddings.rb index b70c1ef5..dd58f2c8 100644 --- a/lib/openai/resources/embeddings.rb +++ b/lib/openai/resources/embeddings.rb @@ -35,6 +35,8 @@ class Embeddings # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::CreateEmbeddingResponse] + # + # @see OpenAI::Models::EmbeddingCreateParams def create(params) parsed, options = OpenAI::Models::EmbeddingCreateParams.dump_request(params) @client.request( @@ -46,6 +48,8 @@ def create(params) ) end + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/lib/openai/resources/files.rb b/lib/openai/resources/files.rb index d0253a42..48756391 100644 --- a/lib/openai/resources/files.rb +++ b/lib/openai/resources/files.rb @@ -37,6 +37,8 @@ class Files # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::FileObject] + # + # @see OpenAI::Models::FileCreateParams def create(params) parsed, options = OpenAI::Models::FileCreateParams.dump_request(params) @client.request( @@ -58,6 +60,8 @@ def create(params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::FileObject] + # + # @see OpenAI::Models::FileRetrieveParams def retrieve(file_id, params = {}) @client.request( method: :get, @@ -87,6 +91,8 @@ def retrieve(file_id, params = {}) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::CursorPage] + # + # @see OpenAI::Models::FileListParams def list(params = {}) parsed, options = OpenAI::Models::FileListParams.dump_request(params) @client.request( @@ -108,6 +114,8 @@ def list(params = {}) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::FileDeleted] + # + # @see OpenAI::Models::FileDeleteParams def delete(file_id, params = {}) @client.request( method: :delete, @@ -126,6 +134,8 @@ def delete(file_id, params = {}) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [StringIO] + # + # @see OpenAI::Models::FileContentParams def content(file_id, params = {}) @client.request( method: :get, @@ -136,6 +146,8 @@ def content(file_id, params = {}) ) end + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/lib/openai/resources/fine_tuning.rb b/lib/openai/resources/fine_tuning.rb index 61663e79..c2f263c6 100644 --- a/lib/openai/resources/fine_tuning.rb +++ b/lib/openai/resources/fine_tuning.rb @@ -6,6 +6,8 @@ class FineTuning # @return [OpenAI::Resources::FineTuning::Jobs] attr_reader :jobs + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/lib/openai/resources/fine_tuning/jobs.rb b/lib/openai/resources/fine_tuning/jobs.rb index baf7a2cc..fd4eb576 100644 --- a/lib/openai/resources/fine_tuning/jobs.rb +++ b/lib/openai/resources/fine_tuning/jobs.rb @@ -78,6 +78,8 @@ class Jobs # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::FineTuning::FineTuningJob] + # + # @see OpenAI::Models::FineTuning::JobCreateParams def create(params) parsed, options = OpenAI::Models::FineTuning::JobCreateParams.dump_request(params) @client.request( @@ -100,6 +102,8 @@ def create(params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::FineTuning::FineTuningJob] + # + # @see OpenAI::Models::FineTuning::JobRetrieveParams def retrieve(fine_tuning_job_id, params = {}) @client.request( method: :get, @@ -123,6 +127,8 @@ def retrieve(fine_tuning_job_id, params = {}) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::CursorPage] + # + # @see OpenAI::Models::FineTuning::JobListParams def list(params = {}) parsed, options = OpenAI::Models::FineTuning::JobListParams.dump_request(params) @client.request( @@ -144,6 +150,8 @@ def list(params = {}) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::FineTuning::FineTuningJob] + # + # @see OpenAI::Models::FineTuning::JobCancelParams def cancel(fine_tuning_job_id, params = {}) @client.request( method: :post, @@ -166,6 +174,8 @@ def cancel(fine_tuning_job_id, params = {}) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::CursorPage] + # + # @see OpenAI::Models::FineTuning::JobListEventsParams def list_events(fine_tuning_job_id, params = {}) parsed, options = OpenAI::Models::FineTuning::JobListEventsParams.dump_request(params) @client.request( @@ -178,6 +188,8 @@ def list_events(fine_tuning_job_id, params = {}) ) end + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/lib/openai/resources/fine_tuning/jobs/checkpoints.rb b/lib/openai/resources/fine_tuning/jobs/checkpoints.rb index ced20ee9..de62c140 100644 --- a/lib/openai/resources/fine_tuning/jobs/checkpoints.rb +++ b/lib/openai/resources/fine_tuning/jobs/checkpoints.rb @@ -18,6 +18,8 @@ class Checkpoints # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::CursorPage] + # + # @see OpenAI::Models::FineTuning::Jobs::CheckpointListParams def list(fine_tuning_job_id, params = {}) parsed, options = OpenAI::Models::FineTuning::Jobs::CheckpointListParams.dump_request(params) @client.request( @@ -30,6 +32,8 @@ def list(fine_tuning_job_id, params = {}) ) end + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/lib/openai/resources/images.rb b/lib/openai/resources/images.rb index 48b2ac87..0464b4d4 100644 --- a/lib/openai/resources/images.rb +++ b/lib/openai/resources/images.rb @@ -30,6 +30,8 @@ class Images # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::ImagesResponse] + # + # @see OpenAI::Models::ImageCreateVariationParams def create_variation(params) parsed, options = OpenAI::Models::ImageCreateVariationParams.dump_request(params) @client.request( @@ -75,6 +77,8 @@ def create_variation(params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::ImagesResponse] + # + # @see OpenAI::Models::ImageEditParams def edit(params) parsed, options = OpenAI::Models::ImageEditParams.dump_request(params) @client.request( @@ -123,6 +127,8 @@ def edit(params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::ImagesResponse] + # + # @see OpenAI::Models::ImageGenerateParams def generate(params) parsed, options = OpenAI::Models::ImageGenerateParams.dump_request(params) @client.request( @@ -134,6 +140,8 @@ def generate(params) ) end + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/lib/openai/resources/models.rb b/lib/openai/resources/models.rb index 937381d2..044d32d7 100644 --- a/lib/openai/resources/models.rb +++ b/lib/openai/resources/models.rb @@ -13,6 +13,8 @@ class Models # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Model] + # + # @see OpenAI::Models::ModelRetrieveParams def retrieve(model, params = {}) @client.request( method: :get, @@ -30,6 +32,8 @@ def retrieve(model, params = {}) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Page] + # + # @see OpenAI::Models::ModelListParams def list(params = {}) @client.request( method: :get, @@ -50,6 +54,8 @@ def list(params = {}) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::ModelDeleted] + # + # @see OpenAI::Models::ModelDeleteParams def delete(model, params = {}) @client.request( method: :delete, @@ -59,6 +65,8 @@ def delete(model, params = {}) ) end + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/lib/openai/resources/moderations.rb b/lib/openai/resources/moderations.rb index 85d8cd8f..aa98d908 100644 --- a/lib/openai/resources/moderations.rb +++ b/lib/openai/resources/moderations.rb @@ -19,6 +19,8 @@ class Moderations # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::ModerationCreateResponse] + # + # @see OpenAI::Models::ModerationCreateParams def create(params) parsed, options = OpenAI::Models::ModerationCreateParams.dump_request(params) @client.request( @@ -30,6 +32,8 @@ def create(params) ) end + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/lib/openai/resources/responses.rb b/lib/openai/resources/responses.rb index 99f01ccb..7bd97e6e 100644 --- a/lib/openai/resources/responses.rb +++ b/lib/openai/resources/responses.rb @@ -127,6 +127,8 @@ class Responses # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Responses::Response] + # + # @see OpenAI::Models::Responses::ResponseCreateParams def create(params) parsed, options = OpenAI::Models::Responses::ResponseCreateParams.dump_request(params) if parsed[:stream] @@ -263,6 +265,8 @@ def create(params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Stream] + # + # @see OpenAI::Models::Responses::ResponseCreateParams def create_streaming(params) parsed, options = OpenAI::Models::Responses::ResponseCreateParams.dump_request(params) unless parsed.fetch(:stream, true) @@ -293,6 +297,8 @@ def create_streaming(params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Responses::Response] + # + # @see OpenAI::Models::Responses::ResponseRetrieveParams def retrieve(response_id, params = {}) parsed, options = OpenAI::Models::Responses::ResponseRetrieveParams.dump_request(params) @client.request( @@ -313,6 +319,8 @@ def retrieve(response_id, params = {}) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [nil] + # + # @see OpenAI::Models::Responses::ResponseDeleteParams def delete(response_id, params = {}) @client.request( method: :delete, @@ -322,6 +330,8 @@ def delete(response_id, params = {}) ) end + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/lib/openai/resources/responses/input_items.rb b/lib/openai/resources/responses/input_items.rb index 30f343fd..15d5fd19 100644 --- a/lib/openai/resources/responses/input_items.rb +++ b/lib/openai/resources/responses/input_items.rb @@ -28,6 +28,8 @@ class InputItems # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::CursorPage] + # + # @see OpenAI::Models::Responses::InputItemListParams def list(response_id, params = {}) parsed, options = OpenAI::Models::Responses::InputItemListParams.dump_request(params) @client.request( @@ -40,6 +42,8 @@ def list(response_id, params = {}) ) end + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/lib/openai/resources/uploads.rb b/lib/openai/resources/uploads.rb index f50e95ed..490e742a 100644 --- a/lib/openai/resources/uploads.rb +++ b/lib/openai/resources/uploads.rb @@ -45,6 +45,8 @@ class Uploads # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Upload] + # + # @see OpenAI::Models::UploadCreateParams def create(params) parsed, options = OpenAI::Models::UploadCreateParams.dump_request(params) @client.request( @@ -65,6 +67,8 @@ def create(params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Upload] + # + # @see OpenAI::Models::UploadCancelParams def cancel(upload_id, params = {}) @client.request( method: :post, @@ -100,6 +104,8 @@ def cancel(upload_id, params = {}) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Upload] + # + # @see OpenAI::Models::UploadCompleteParams def complete(upload_id, params) parsed, options = OpenAI::Models::UploadCompleteParams.dump_request(params) @client.request( @@ -111,6 +117,8 @@ def complete(upload_id, params) ) end + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/lib/openai/resources/uploads/parts.rb b/lib/openai/resources/uploads/parts.rb index ea9e8a5f..bc06cf70 100644 --- a/lib/openai/resources/uploads/parts.rb +++ b/lib/openai/resources/uploads/parts.rb @@ -25,6 +25,8 @@ class Parts # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::Uploads::UploadPart] + # + # @see OpenAI::Models::Uploads::PartCreateParams def create(upload_id, params) parsed, options = OpenAI::Models::Uploads::PartCreateParams.dump_request(params) @client.request( @@ -37,6 +39,8 @@ def create(upload_id, params) ) end + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/lib/openai/resources/vector_stores.rb b/lib/openai/resources/vector_stores.rb index 5d0fe33d..644fbec4 100644 --- a/lib/openai/resources/vector_stores.rb +++ b/lib/openai/resources/vector_stores.rb @@ -34,6 +34,8 @@ class VectorStores # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::VectorStore] + # + # @see OpenAI::Models::VectorStoreCreateParams def create(params = {}) parsed, options = OpenAI::Models::VectorStoreCreateParams.dump_request(params) @client.request( @@ -54,6 +56,8 @@ def create(params = {}) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::VectorStore] + # + # @see OpenAI::Models::VectorStoreRetrieveParams def retrieve(vector_store_id, params = {}) @client.request( method: :get, @@ -83,6 +87,8 @@ def retrieve(vector_store_id, params = {}) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::VectorStore] + # + # @see OpenAI::Models::VectorStoreUpdateParams def update(vector_store_id, params = {}) parsed, options = OpenAI::Models::VectorStoreUpdateParams.dump_request(params) @client.request( @@ -117,6 +123,8 @@ def update(vector_store_id, params = {}) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::CursorPage] + # + # @see OpenAI::Models::VectorStoreListParams def list(params = {}) parsed, options = OpenAI::Models::VectorStoreListParams.dump_request(params) @client.request( @@ -138,6 +146,8 @@ def list(params = {}) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::VectorStoreDeleted] + # + # @see OpenAI::Models::VectorStoreDeleteParams def delete(vector_store_id, params = {}) @client.request( method: :delete, @@ -168,6 +178,8 @@ def delete(vector_store_id, params = {}) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Page] + # + # @see OpenAI::Models::VectorStoreSearchParams def search(vector_store_id, params) parsed, options = OpenAI::Models::VectorStoreSearchParams.dump_request(params) @client.request( @@ -180,6 +192,8 @@ def search(vector_store_id, params) ) end + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/lib/openai/resources/vector_stores/file_batches.rb b/lib/openai/resources/vector_stores/file_batches.rb index 1a9d1dae..e2b1e6ac 100644 --- a/lib/openai/resources/vector_stores/file_batches.rb +++ b/lib/openai/resources/vector_stores/file_batches.rb @@ -26,6 +26,8 @@ class FileBatches # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::VectorStores::VectorStoreFileBatch] + # + # @see OpenAI::Models::VectorStores::FileBatchCreateParams def create(vector_store_id, params) parsed, options = OpenAI::Models::VectorStores::FileBatchCreateParams.dump_request(params) @client.request( @@ -48,6 +50,8 @@ def create(vector_store_id, params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::VectorStores::VectorStoreFileBatch] + # + # @see OpenAI::Models::VectorStores::FileBatchRetrieveParams def retrieve(batch_id, params) parsed, options = OpenAI::Models::VectorStores::FileBatchRetrieveParams.dump_request(params) vector_store_id = @@ -74,6 +78,8 @@ def retrieve(batch_id, params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::VectorStores::VectorStoreFileBatch] + # + # @see OpenAI::Models::VectorStores::FileBatchCancelParams def cancel(batch_id, params) parsed, options = OpenAI::Models::VectorStores::FileBatchCancelParams.dump_request(params) vector_store_id = @@ -118,6 +124,8 @@ def cancel(batch_id, params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::CursorPage] + # + # @see OpenAI::Models::VectorStores::FileBatchListFilesParams def list_files(batch_id, params) parsed, options = OpenAI::Models::VectorStores::FileBatchListFilesParams.dump_request(params) vector_store_id = @@ -134,6 +142,8 @@ def list_files(batch_id, params) ) end + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/lib/openai/resources/vector_stores/files.rb b/lib/openai/resources/vector_stores/files.rb index 57e9af60..6d94283d 100644 --- a/lib/openai/resources/vector_stores/files.rb +++ b/lib/openai/resources/vector_stores/files.rb @@ -28,6 +28,8 @@ class Files # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::VectorStores::VectorStoreFile] + # + # @see OpenAI::Models::VectorStores::FileCreateParams def create(vector_store_id, params) parsed, options = OpenAI::Models::VectorStores::FileCreateParams.dump_request(params) @client.request( @@ -50,6 +52,8 @@ def create(vector_store_id, params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::VectorStores::VectorStoreFile] + # + # @see OpenAI::Models::VectorStores::FileRetrieveParams def retrieve(file_id, params) parsed, options = OpenAI::Models::VectorStores::FileRetrieveParams.dump_request(params) vector_store_id = @@ -81,6 +85,8 @@ def retrieve(file_id, params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::VectorStores::VectorStoreFile] + # + # @see OpenAI::Models::VectorStores::FileUpdateParams def update(file_id, params) parsed, options = OpenAI::Models::VectorStores::FileUpdateParams.dump_request(params) vector_store_id = @@ -123,6 +129,8 @@ def update(file_id, params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::CursorPage] + # + # @see OpenAI::Models::VectorStores::FileListParams def list(vector_store_id, params = {}) parsed, options = OpenAI::Models::VectorStores::FileListParams.dump_request(params) @client.request( @@ -149,6 +157,8 @@ def list(vector_store_id, params = {}) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Models::VectorStores::VectorStoreFileDeleted] + # + # @see OpenAI::Models::VectorStores::FileDeleteParams def delete(file_id, params) parsed, options = OpenAI::Models::VectorStores::FileDeleteParams.dump_request(params) vector_store_id = @@ -174,6 +184,8 @@ def delete(file_id, params) # @option params [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil] :request_options # # @return [OpenAI::Page] + # + # @see OpenAI::Models::VectorStores::FileContentParams def content(file_id, params) parsed, options = OpenAI::Models::VectorStores::FileContentParams.dump_request(params) vector_store_id = @@ -189,6 +201,8 @@ def content(file_id, params) ) end + # @api private + # # @param client [OpenAI::Client] def initialize(client:) @client = client diff --git a/rbi/lib/openai/resources/audio.rbi b/rbi/lib/openai/resources/audio.rbi index 353012c6..1747c22c 100644 --- a/rbi/lib/openai/resources/audio.rbi +++ b/rbi/lib/openai/resources/audio.rbi @@ -12,6 +12,7 @@ module OpenAI sig { returns(OpenAI::Resources::Audio::Speech) } attr_reader :speech + # @api private sig { params(client: OpenAI::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/openai/resources/audio/speech.rbi b/rbi/lib/openai/resources/audio/speech.rbi index d17427d8..b662b954 100644 --- a/rbi/lib/openai/resources/audio/speech.rbi +++ b/rbi/lib/openai/resources/audio/speech.rbi @@ -41,6 +41,7 @@ module OpenAI ) end + # @api private sig { params(client: OpenAI::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/openai/resources/audio/transcriptions.rbi b/rbi/lib/openai/resources/audio/transcriptions.rbi index 0a0205db..688f6c9f 100644 --- a/rbi/lib/openai/resources/audio/transcriptions.rbi +++ b/rbi/lib/openai/resources/audio/transcriptions.rbi @@ -135,6 +135,7 @@ module OpenAI ) end + # @api private sig { params(client: OpenAI::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/openai/resources/audio/translations.rbi b/rbi/lib/openai/resources/audio/translations.rbi index c99220ed..178eaa7e 100644 --- a/rbi/lib/openai/resources/audio/translations.rbi +++ b/rbi/lib/openai/resources/audio/translations.rbi @@ -41,6 +41,7 @@ module OpenAI ) end + # @api private sig { params(client: OpenAI::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/openai/resources/batches.rbi b/rbi/lib/openai/resources/batches.rbi index 0e76d86b..fe814b47 100644 --- a/rbi/lib/openai/resources/batches.rbi +++ b/rbi/lib/openai/resources/batches.rbi @@ -108,6 +108,7 @@ module OpenAI ) end + # @api private sig { params(client: OpenAI::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/openai/resources/beta.rbi b/rbi/lib/openai/resources/beta.rbi index eebedd02..c53baf2b 100644 --- a/rbi/lib/openai/resources/beta.rbi +++ b/rbi/lib/openai/resources/beta.rbi @@ -9,6 +9,7 @@ module OpenAI sig { returns(OpenAI::Resources::Beta::Threads) } attr_reader :threads + # @api private sig { params(client: OpenAI::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/openai/resources/beta/assistants.rbi b/rbi/lib/openai/resources/beta/assistants.rbi index 5b415b26..58bd9abe 100644 --- a/rbi/lib/openai/resources/beta/assistants.rbi +++ b/rbi/lib/openai/resources/beta/assistants.rbi @@ -279,6 +279,7 @@ module OpenAI ) end + # @api private sig { params(client: OpenAI::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/openai/resources/beta/threads.rbi b/rbi/lib/openai/resources/beta/threads.rbi index 2c2ac7ef..d5a0da4b 100644 --- a/rbi/lib/openai/resources/beta/threads.rbi +++ b/rbi/lib/openai/resources/beta/threads.rbi @@ -416,6 +416,7 @@ module OpenAI ) end + # @api private sig { params(client: OpenAI::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/openai/resources/beta/threads/messages.rbi b/rbi/lib/openai/resources/beta/threads/messages.rbi index 24507cc6..b30ffe2f 100644 --- a/rbi/lib/openai/resources/beta/threads/messages.rbi +++ b/rbi/lib/openai/resources/beta/threads/messages.rbi @@ -157,6 +157,7 @@ module OpenAI ) end + # @api private sig { params(client: OpenAI::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/openai/resources/beta/threads/runs.rbi b/rbi/lib/openai/resources/beta/threads/runs.rbi index 71cf02b1..296929f4 100644 --- a/rbi/lib/openai/resources/beta/threads/runs.rbi +++ b/rbi/lib/openai/resources/beta/threads/runs.rbi @@ -565,6 +565,7 @@ module OpenAI ) end + # @api private sig { params(client: OpenAI::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/openai/resources/beta/threads/runs/steps.rbi b/rbi/lib/openai/resources/beta/threads/runs/steps.rbi index 36fc8b92..a048f9ce 100644 --- a/rbi/lib/openai/resources/beta/threads/runs/steps.rbi +++ b/rbi/lib/openai/resources/beta/threads/runs/steps.rbi @@ -85,6 +85,7 @@ module OpenAI ) end + # @api private sig { params(client: OpenAI::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/openai/resources/chat.rbi b/rbi/lib/openai/resources/chat.rbi index 98440959..45c92d55 100644 --- a/rbi/lib/openai/resources/chat.rbi +++ b/rbi/lib/openai/resources/chat.rbi @@ -6,6 +6,7 @@ module OpenAI 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 diff --git a/rbi/lib/openai/resources/chat/completions.rbi b/rbi/lib/openai/resources/chat/completions.rbi index 58bc7161..595d5865 100644 --- a/rbi/lib/openai/resources/chat/completions.rbi +++ b/rbi/lib/openai/resources/chat/completions.rbi @@ -631,6 +631,7 @@ module OpenAI ) end + # @api private sig { params(client: OpenAI::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/openai/resources/chat/completions/messages.rbi b/rbi/lib/openai/resources/chat/completions/messages.rbi index f86371f9..15b7617c 100644 --- a/rbi/lib/openai/resources/chat/completions/messages.rbi +++ b/rbi/lib/openai/resources/chat/completions/messages.rbi @@ -31,6 +31,7 @@ module OpenAI ) end + # @api private sig { params(client: OpenAI::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/openai/resources/completions.rbi b/rbi/lib/openai/resources/completions.rbi index 64b4c2ef..b5b3feeb 100644 --- a/rbi/lib/openai/resources/completions.rbi +++ b/rbi/lib/openai/resources/completions.rbi @@ -289,6 +289,7 @@ module OpenAI ) end + # @api private sig { params(client: OpenAI::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/openai/resources/embeddings.rbi b/rbi/lib/openai/resources/embeddings.rbi index 9c05cf33..992bfec4 100644 --- a/rbi/lib/openai/resources/embeddings.rbi +++ b/rbi/lib/openai/resources/embeddings.rbi @@ -45,6 +45,7 @@ module OpenAI ) end + # @api private sig { params(client: OpenAI::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/openai/resources/files.rbi b/rbi/lib/openai/resources/files.rbi index 9ddc3a8e..3a276b74 100644 --- a/rbi/lib/openai/resources/files.rbi +++ b/rbi/lib/openai/resources/files.rbi @@ -133,6 +133,7 @@ module OpenAI ) end + # @api private sig { params(client: OpenAI::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/openai/resources/fine_tuning.rbi b/rbi/lib/openai/resources/fine_tuning.rbi index f2743caa..d6d0b987 100644 --- a/rbi/lib/openai/resources/fine_tuning.rbi +++ b/rbi/lib/openai/resources/fine_tuning.rbi @@ -6,6 +6,7 @@ module OpenAI sig { returns(OpenAI::Resources::FineTuning::Jobs) } attr_reader :jobs + # @api private sig { params(client: OpenAI::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/openai/resources/fine_tuning/jobs.rbi b/rbi/lib/openai/resources/fine_tuning/jobs.rbi index 7d8544da..57cec0cd 100644 --- a/rbi/lib/openai/resources/fine_tuning/jobs.rbi +++ b/rbi/lib/openai/resources/fine_tuning/jobs.rbi @@ -169,6 +169,7 @@ module OpenAI ) end + # @api private sig { params(client: OpenAI::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/openai/resources/fine_tuning/jobs/checkpoints.rbi b/rbi/lib/openai/resources/fine_tuning/jobs/checkpoints.rbi index 5986546b..9049855c 100644 --- a/rbi/lib/openai/resources/fine_tuning/jobs/checkpoints.rbi +++ b/rbi/lib/openai/resources/fine_tuning/jobs/checkpoints.rbi @@ -26,6 +26,7 @@ module OpenAI ) end + # @api private sig { params(client: OpenAI::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/openai/resources/images.rbi b/rbi/lib/openai/resources/images.rbi index d36dd357..ea7194a0 100644 --- a/rbi/lib/openai/resources/images.rbi +++ b/rbi/lib/openai/resources/images.rbi @@ -136,6 +136,7 @@ module OpenAI ) end + # @api private sig { params(client: OpenAI::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/openai/resources/models.rbi b/rbi/lib/openai/resources/models.rbi index 505640bc..16962ff9 100644 --- a/rbi/lib/openai/resources/models.rbi +++ b/rbi/lib/openai/resources/models.rbi @@ -54,6 +54,7 @@ module OpenAI ) end + # @api private sig { params(client: OpenAI::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/openai/resources/moderations.rbi b/rbi/lib/openai/resources/moderations.rbi index 0fd74373..85abe41d 100644 --- a/rbi/lib/openai/resources/moderations.rbi +++ b/rbi/lib/openai/resources/moderations.rbi @@ -30,6 +30,7 @@ module OpenAI ) end + # @api private sig { params(client: OpenAI::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/openai/resources/responses.rbi b/rbi/lib/openai/resources/responses.rbi index 1c7a99ac..8a9352b4 100644 --- a/rbi/lib/openai/resources/responses.rbi +++ b/rbi/lib/openai/resources/responses.rbi @@ -433,6 +433,7 @@ module OpenAI ) end + # @api private sig { params(client: OpenAI::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/openai/resources/responses/input_items.rbi b/rbi/lib/openai/resources/responses/input_items.rbi index 35fb21c7..822e8463 100644 --- a/rbi/lib/openai/resources/responses/input_items.rbi +++ b/rbi/lib/openai/resources/responses/input_items.rbi @@ -52,6 +52,7 @@ module OpenAI ) end + # @api private sig { params(client: OpenAI::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/openai/resources/uploads.rbi b/rbi/lib/openai/resources/uploads.rbi index 55b2b24e..7677a58a 100644 --- a/rbi/lib/openai/resources/uploads.rbi +++ b/rbi/lib/openai/resources/uploads.rbi @@ -103,6 +103,7 @@ module OpenAI ) end + # @api private sig { params(client: OpenAI::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/openai/resources/uploads/parts.rbi b/rbi/lib/openai/resources/uploads/parts.rbi index b90746ff..14dffcb9 100644 --- a/rbi/lib/openai/resources/uploads/parts.rbi +++ b/rbi/lib/openai/resources/uploads/parts.rbi @@ -32,6 +32,7 @@ module OpenAI ) end + # @api private sig { params(client: OpenAI::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/openai/resources/vector_stores.rbi b/rbi/lib/openai/resources/vector_stores.rbi index 0c24ebc9..4aef839d 100644 --- a/rbi/lib/openai/resources/vector_stores.rbi +++ b/rbi/lib/openai/resources/vector_stores.rbi @@ -171,6 +171,7 @@ module OpenAI ) end + # @api private sig { params(client: OpenAI::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/openai/resources/vector_stores/file_batches.rbi b/rbi/lib/openai/resources/vector_stores/file_batches.rbi index 62bd27b1..ec63dcb2 100644 --- a/rbi/lib/openai/resources/vector_stores/file_batches.rbi +++ b/rbi/lib/openai/resources/vector_stores/file_batches.rbi @@ -118,6 +118,7 @@ module OpenAI ) end + # @api private sig { params(client: OpenAI::Client).returns(T.attached_class) } def self.new(client:) end diff --git a/rbi/lib/openai/resources/vector_stores/files.rbi b/rbi/lib/openai/resources/vector_stores/files.rbi index 37afdaf7..0cb2f053 100644 --- a/rbi/lib/openai/resources/vector_stores/files.rbi +++ b/rbi/lib/openai/resources/vector_stores/files.rbi @@ -161,6 +161,7 @@ module OpenAI ) end + # @api private sig { params(client: OpenAI::Client).returns(T.attached_class) } def self.new(client:) end