From 66a1b40cfeeed10e58aaa89b6df684df7a345a36 Mon Sep 17 00:00:00 2001
From: "stainless-app[bot]"
 <142633134+stainless-app[bot]@users.noreply.github.com>
Date: Tue, 1 Apr 2025 17:46:55 +0000
Subject: [PATCH] feat: link response models to their methods in yard doc

---
 lib/openai/models/audio/transcription_create_response.rb      | 4 ++++
 lib/openai/models/audio/translation_create_response.rb        | 1 +
 lib/openai/models/batch.rb                                    | 1 +
 lib/openai/models/beta/assistant.rb                           | 1 +
 lib/openai/models/beta/assistant_deleted.rb                   | 1 +
 lib/openai/models/beta/thread.rb                              | 1 +
 lib/openai/models/beta/thread_deleted.rb                      | 1 +
 lib/openai/models/beta/threads/message.rb                     | 1 +
 lib/openai/models/beta/threads/message_deleted.rb             | 1 +
 lib/openai/models/beta/threads/run.rb                         | 3 +++
 lib/openai/models/beta/threads/runs/run_step.rb               | 1 +
 lib/openai/models/chat/chat_completion.rb                     | 3 +++
 lib/openai/models/chat/chat_completion_deleted.rb             | 1 +
 lib/openai/models/completion.rb                               | 3 +++
 lib/openai/models/create_embedding_response.rb                | 1 +
 lib/openai/models/file_deleted.rb                             | 1 +
 lib/openai/models/file_object.rb                              | 1 +
 lib/openai/models/fine_tuning/fine_tuning_job.rb              | 1 +
 lib/openai/models/fine_tuning/fine_tuning_job_event.rb        | 1 +
 .../models/fine_tuning/jobs/fine_tuning_job_checkpoint.rb     | 1 +
 lib/openai/models/images_response.rb                          | 1 +
 lib/openai/models/model.rb                                    | 1 +
 lib/openai/models/model_deleted.rb                            | 1 +
 lib/openai/models/moderation_create_response.rb               | 1 +
 lib/openai/models/responses/response.rb                       | 3 +++
 lib/openai/models/upload.rb                                   | 1 +
 lib/openai/models/uploads/upload_part.rb                      | 1 +
 lib/openai/models/vector_store.rb                             | 1 +
 lib/openai/models/vector_store_deleted.rb                     | 1 +
 lib/openai/models/vector_store_search_response.rb             | 1 +
 lib/openai/models/vector_stores/file_content_response.rb      | 1 +
 lib/openai/models/vector_stores/vector_store_file.rb          | 1 +
 lib/openai/models/vector_stores/vector_store_file_batch.rb    | 1 +
 lib/openai/models/vector_stores/vector_store_file_deleted.rb  | 1 +
 34 files changed, 45 insertions(+)

diff --git a/lib/openai/models/audio/transcription_create_response.rb b/lib/openai/models/audio/transcription_create_response.rb
index fe9d6a25..be3c624c 100644
--- a/lib/openai/models/audio/transcription_create_response.rb
+++ b/lib/openai/models/audio/transcription_create_response.rb
@@ -5,6 +5,10 @@ module Models
     module Audio
       # Represents a transcription response returned by model, based on the provided
       #   input.
+      #
+      # @see OpenAI::Resources::Audio::Transcriptions#create
+      #
+      # @see OpenAI::Resources::Audio::Transcriptions#create_streaming
       module TranscriptionCreateResponse
         extend OpenAI::Union
 
diff --git a/lib/openai/models/audio/translation_create_response.rb b/lib/openai/models/audio/translation_create_response.rb
index 2511f059..3beab227 100644
--- a/lib/openai/models/audio/translation_create_response.rb
+++ b/lib/openai/models/audio/translation_create_response.rb
@@ -3,6 +3,7 @@
 module OpenAI
   module Models
     module Audio
+      # @see OpenAI::Resources::Audio::Translations#create
       module TranslationCreateResponse
         extend OpenAI::Union
 
diff --git a/lib/openai/models/batch.rb b/lib/openai/models/batch.rb
index e41efffb..5d59baff 100644
--- a/lib/openai/models/batch.rb
+++ b/lib/openai/models/batch.rb
@@ -2,6 +2,7 @@
 
 module OpenAI
   module Models
+    # @see OpenAI::Resources::Batches#create
     class Batch < OpenAI::BaseModel
       # @!attribute id
       #
diff --git a/lib/openai/models/beta/assistant.rb b/lib/openai/models/beta/assistant.rb
index 5b56453e..9adc23a7 100644
--- a/lib/openai/models/beta/assistant.rb
+++ b/lib/openai/models/beta/assistant.rb
@@ -3,6 +3,7 @@
 module OpenAI
   module Models
     module Beta
+      # @see OpenAI::Resources::Beta::Assistants#create
       class Assistant < OpenAI::BaseModel
         # @!attribute id
         #   The identifier, which can be referenced in API endpoints.
diff --git a/lib/openai/models/beta/assistant_deleted.rb b/lib/openai/models/beta/assistant_deleted.rb
index 1e02cf88..4793b0ae 100644
--- a/lib/openai/models/beta/assistant_deleted.rb
+++ b/lib/openai/models/beta/assistant_deleted.rb
@@ -3,6 +3,7 @@
 module OpenAI
   module Models
     module Beta
+      # @see OpenAI::Resources::Beta::Assistants#delete
       class AssistantDeleted < OpenAI::BaseModel
         # @!attribute id
         #
diff --git a/lib/openai/models/beta/thread.rb b/lib/openai/models/beta/thread.rb
index 737cbf81..c651e7c2 100644
--- a/lib/openai/models/beta/thread.rb
+++ b/lib/openai/models/beta/thread.rb
@@ -3,6 +3,7 @@
 module OpenAI
   module Models
     module Beta
+      # @see OpenAI::Resources::Beta::Threads#create
       class Thread < OpenAI::BaseModel
         # @!attribute id
         #   The identifier, which can be referenced in API endpoints.
diff --git a/lib/openai/models/beta/thread_deleted.rb b/lib/openai/models/beta/thread_deleted.rb
index f27336b9..35289d1b 100644
--- a/lib/openai/models/beta/thread_deleted.rb
+++ b/lib/openai/models/beta/thread_deleted.rb
@@ -3,6 +3,7 @@
 module OpenAI
   module Models
     module Beta
+      # @see OpenAI::Resources::Beta::Threads#delete
       class ThreadDeleted < OpenAI::BaseModel
         # @!attribute id
         #
diff --git a/lib/openai/models/beta/threads/message.rb b/lib/openai/models/beta/threads/message.rb
index 3d07bbd7..ded2bdd4 100644
--- a/lib/openai/models/beta/threads/message.rb
+++ b/lib/openai/models/beta/threads/message.rb
@@ -4,6 +4,7 @@ module OpenAI
   module Models
     module Beta
       module Threads
+        # @see OpenAI::Resources::Beta::Threads::Messages#create
         class Message < OpenAI::BaseModel
           # @!attribute id
           #   The identifier, which can be referenced in API endpoints.
diff --git a/lib/openai/models/beta/threads/message_deleted.rb b/lib/openai/models/beta/threads/message_deleted.rb
index a3329fce..488ddb42 100644
--- a/lib/openai/models/beta/threads/message_deleted.rb
+++ b/lib/openai/models/beta/threads/message_deleted.rb
@@ -4,6 +4,7 @@ module OpenAI
   module Models
     module Beta
       module Threads
+        # @see OpenAI::Resources::Beta::Threads::Messages#delete
         class MessageDeleted < OpenAI::BaseModel
           # @!attribute id
           #
diff --git a/lib/openai/models/beta/threads/run.rb b/lib/openai/models/beta/threads/run.rb
index f104ddeb..66e2e6a8 100644
--- a/lib/openai/models/beta/threads/run.rb
+++ b/lib/openai/models/beta/threads/run.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 Run < OpenAI::BaseModel
           # @!attribute id
           #   The identifier, which can be referenced in API endpoints.
diff --git a/lib/openai/models/beta/threads/runs/run_step.rb b/lib/openai/models/beta/threads/runs/run_step.rb
index 2c9449fe..21084d23 100644
--- a/lib/openai/models/beta/threads/runs/run_step.rb
+++ b/lib/openai/models/beta/threads/runs/run_step.rb
@@ -5,6 +5,7 @@ module Models
     module Beta
       module Threads
         module Runs
+          # @see OpenAI::Resources::Beta::Threads::Runs::Steps#retrieve
           class RunStep < OpenAI::BaseModel
             # @!attribute id
             #   The identifier of the run step, which can be referenced in API endpoints.
diff --git a/lib/openai/models/chat/chat_completion.rb b/lib/openai/models/chat/chat_completion.rb
index 2cdec571..2dcdfd05 100644
--- a/lib/openai/models/chat/chat_completion.rb
+++ b/lib/openai/models/chat/chat_completion.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 ChatCompletion < OpenAI::BaseModel
         # @!attribute id
         #   A unique identifier for the chat completion.
diff --git a/lib/openai/models/chat/chat_completion_deleted.rb b/lib/openai/models/chat/chat_completion_deleted.rb
index 22274c71..844e2cab 100644
--- a/lib/openai/models/chat/chat_completion_deleted.rb
+++ b/lib/openai/models/chat/chat_completion_deleted.rb
@@ -3,6 +3,7 @@
 module OpenAI
   module Models
     module Chat
+      # @see OpenAI::Resources::Chat::Completions#delete
       class ChatCompletionDeleted < OpenAI::BaseModel
         # @!attribute id
         #   The ID of the chat completion that was deleted.
diff --git a/lib/openai/models/completion.rb b/lib/openai/models/completion.rb
index 751e0dc8..8e3ad52a 100644
--- a/lib/openai/models/completion.rb
+++ b/lib/openai/models/completion.rb
@@ -2,6 +2,9 @@
 
 module OpenAI
   module Models
+    # @see OpenAI::Resources::Completions#create
+    #
+    # @see OpenAI::Resources::Completions#create_streaming
     class Completion < OpenAI::BaseModel
       # @!attribute id
       #   A unique identifier for the completion.
diff --git a/lib/openai/models/create_embedding_response.rb b/lib/openai/models/create_embedding_response.rb
index 2679c15d..3fbd7bc4 100644
--- a/lib/openai/models/create_embedding_response.rb
+++ b/lib/openai/models/create_embedding_response.rb
@@ -2,6 +2,7 @@
 
 module OpenAI
   module Models
+    # @see OpenAI::Resources::Embeddings#create
     class CreateEmbeddingResponse < OpenAI::BaseModel
       # @!attribute data
       #   The list of embeddings generated by the model.
diff --git a/lib/openai/models/file_deleted.rb b/lib/openai/models/file_deleted.rb
index 9eb014a2..c9841f7e 100644
--- a/lib/openai/models/file_deleted.rb
+++ b/lib/openai/models/file_deleted.rb
@@ -2,6 +2,7 @@
 
 module OpenAI
   module Models
+    # @see OpenAI::Resources::Files#delete
     class FileDeleted < OpenAI::BaseModel
       # @!attribute id
       #
diff --git a/lib/openai/models/file_object.rb b/lib/openai/models/file_object.rb
index e85f9017..1b6ca589 100644
--- a/lib/openai/models/file_object.rb
+++ b/lib/openai/models/file_object.rb
@@ -2,6 +2,7 @@
 
 module OpenAI
   module Models
+    # @see OpenAI::Resources::Files#create
     class FileObject < OpenAI::BaseModel
       # @!attribute id
       #   The file identifier, which can be referenced in the API endpoints.
diff --git a/lib/openai/models/fine_tuning/fine_tuning_job.rb b/lib/openai/models/fine_tuning/fine_tuning_job.rb
index 07a3dd60..cce986bc 100644
--- a/lib/openai/models/fine_tuning/fine_tuning_job.rb
+++ b/lib/openai/models/fine_tuning/fine_tuning_job.rb
@@ -3,6 +3,7 @@
 module OpenAI
   module Models
     module FineTuning
+      # @see OpenAI::Resources::FineTuning::Jobs#create
       class FineTuningJob < OpenAI::BaseModel
         # @!attribute id
         #   The object identifier, which can be referenced in the API endpoints.
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 c6bd2025..60995c3b 100644
--- a/lib/openai/models/fine_tuning/fine_tuning_job_event.rb
+++ b/lib/openai/models/fine_tuning/fine_tuning_job_event.rb
@@ -3,6 +3,7 @@
 module OpenAI
   module Models
     module FineTuning
+      # @see OpenAI::Resources::FineTuning::Jobs#list_events
       class FineTuningJobEvent < OpenAI::BaseModel
         # @!attribute id
         #   The object identifier.
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 0390e0c6..75874793 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
@@ -4,6 +4,7 @@ module OpenAI
   module Models
     module FineTuning
       module Jobs
+        # @see OpenAI::Resources::FineTuning::Jobs::Checkpoints#list
         class FineTuningJobCheckpoint < OpenAI::BaseModel
           # @!attribute id
           #   The checkpoint identifier, which can be referenced in the API endpoints.
diff --git a/lib/openai/models/images_response.rb b/lib/openai/models/images_response.rb
index 3f3f3b00..fb015bb2 100644
--- a/lib/openai/models/images_response.rb
+++ b/lib/openai/models/images_response.rb
@@ -2,6 +2,7 @@
 
 module OpenAI
   module Models
+    # @see OpenAI::Resources::Images#create_variation
     class ImagesResponse < OpenAI::BaseModel
       # @!attribute created
       #
diff --git a/lib/openai/models/model.rb b/lib/openai/models/model.rb
index 1827ed7b..3e17e2d3 100644
--- a/lib/openai/models/model.rb
+++ b/lib/openai/models/model.rb
@@ -2,6 +2,7 @@
 
 module OpenAI
   module Models
+    # @see OpenAI::Resources::Models#retrieve
     class Model < OpenAI::BaseModel
       # @!attribute id
       #   The model identifier, which can be referenced in the API endpoints.
diff --git a/lib/openai/models/model_deleted.rb b/lib/openai/models/model_deleted.rb
index 72d0b807..f269390a 100644
--- a/lib/openai/models/model_deleted.rb
+++ b/lib/openai/models/model_deleted.rb
@@ -2,6 +2,7 @@
 
 module OpenAI
   module Models
+    # @see OpenAI::Resources::Models#delete
     class ModelDeleted < OpenAI::BaseModel
       # @!attribute id
       #
diff --git a/lib/openai/models/moderation_create_response.rb b/lib/openai/models/moderation_create_response.rb
index 2e9e3828..c06f6c57 100644
--- a/lib/openai/models/moderation_create_response.rb
+++ b/lib/openai/models/moderation_create_response.rb
@@ -2,6 +2,7 @@
 
 module OpenAI
   module Models
+    # @see OpenAI::Resources::Moderations#create
     class ModerationCreateResponse < OpenAI::BaseModel
       # @!attribute id
       #   The unique identifier for the moderation request.
diff --git a/lib/openai/models/responses/response.rb b/lib/openai/models/responses/response.rb
index 9f71b7aa..280ce639 100644
--- a/lib/openai/models/responses/response.rb
+++ b/lib/openai/models/responses/response.rb
@@ -3,6 +3,9 @@
 module OpenAI
   module Models
     module Responses
+      # @see OpenAI::Resources::Responses#create
+      #
+      # @see OpenAI::Resources::Responses#create_streaming
       class Response < OpenAI::BaseModel
         # @!attribute id
         #   Unique identifier for this Response.
diff --git a/lib/openai/models/upload.rb b/lib/openai/models/upload.rb
index a1652e79..a905f9ff 100644
--- a/lib/openai/models/upload.rb
+++ b/lib/openai/models/upload.rb
@@ -2,6 +2,7 @@
 
 module OpenAI
   module Models
+    # @see OpenAI::Resources::Uploads#create
     class Upload < OpenAI::BaseModel
       # @!attribute id
       #   The Upload unique identifier, which can be referenced in API endpoints.
diff --git a/lib/openai/models/uploads/upload_part.rb b/lib/openai/models/uploads/upload_part.rb
index 8edf74ce..e0566eb9 100644
--- a/lib/openai/models/uploads/upload_part.rb
+++ b/lib/openai/models/uploads/upload_part.rb
@@ -3,6 +3,7 @@
 module OpenAI
   module Models
     module Uploads
+      # @see OpenAI::Resources::Uploads::Parts#create
       class UploadPart < OpenAI::BaseModel
         # @!attribute id
         #   The upload Part unique identifier, which can be referenced in API endpoints.
diff --git a/lib/openai/models/vector_store.rb b/lib/openai/models/vector_store.rb
index 8832fca7..29391d3a 100644
--- a/lib/openai/models/vector_store.rb
+++ b/lib/openai/models/vector_store.rb
@@ -2,6 +2,7 @@
 
 module OpenAI
   module Models
+    # @see OpenAI::Resources::VectorStores#create
     class VectorStore < OpenAI::BaseModel
       # @!attribute id
       #   The identifier, which can be referenced in API endpoints.
diff --git a/lib/openai/models/vector_store_deleted.rb b/lib/openai/models/vector_store_deleted.rb
index 018837f0..84da9461 100644
--- a/lib/openai/models/vector_store_deleted.rb
+++ b/lib/openai/models/vector_store_deleted.rb
@@ -2,6 +2,7 @@
 
 module OpenAI
   module Models
+    # @see OpenAI::Resources::VectorStores#delete
     class VectorStoreDeleted < OpenAI::BaseModel
       # @!attribute id
       #
diff --git a/lib/openai/models/vector_store_search_response.rb b/lib/openai/models/vector_store_search_response.rb
index c4914147..71b724a2 100644
--- a/lib/openai/models/vector_store_search_response.rb
+++ b/lib/openai/models/vector_store_search_response.rb
@@ -2,6 +2,7 @@
 
 module OpenAI
   module Models
+    # @see OpenAI::Resources::VectorStores#search
     class VectorStoreSearchResponse < OpenAI::BaseModel
       # @!attribute attributes
       #   Set of 16 key-value pairs that can be attached to an object. This can be useful
diff --git a/lib/openai/models/vector_stores/file_content_response.rb b/lib/openai/models/vector_stores/file_content_response.rb
index a2450a19..6f667726 100644
--- a/lib/openai/models/vector_stores/file_content_response.rb
+++ b/lib/openai/models/vector_stores/file_content_response.rb
@@ -3,6 +3,7 @@
 module OpenAI
   module Models
     module VectorStores
+      # @see OpenAI::Resources::VectorStores::Files#content
       class FileContentResponse < OpenAI::BaseModel
         # @!attribute [r] text
         #   The text content
diff --git a/lib/openai/models/vector_stores/vector_store_file.rb b/lib/openai/models/vector_stores/vector_store_file.rb
index a1a631ed..7c64487b 100644
--- a/lib/openai/models/vector_stores/vector_store_file.rb
+++ b/lib/openai/models/vector_stores/vector_store_file.rb
@@ -3,6 +3,7 @@
 module OpenAI
   module Models
     module VectorStores
+      # @see OpenAI::Resources::VectorStores::Files#create
       class VectorStoreFile < OpenAI::BaseModel
         # @!attribute id
         #   The identifier, which can be referenced in API endpoints.
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 dfc5192d..b08f672c 100644
--- a/lib/openai/models/vector_stores/vector_store_file_batch.rb
+++ b/lib/openai/models/vector_stores/vector_store_file_batch.rb
@@ -3,6 +3,7 @@
 module OpenAI
   module Models
     module VectorStores
+      # @see OpenAI::Resources::VectorStores::FileBatches#create
       class VectorStoreFileBatch < OpenAI::BaseModel
         # @!attribute id
         #   The identifier, which can be referenced in API endpoints.
diff --git a/lib/openai/models/vector_stores/vector_store_file_deleted.rb b/lib/openai/models/vector_stores/vector_store_file_deleted.rb
index 9a226ad7..26fa7214 100644
--- a/lib/openai/models/vector_stores/vector_store_file_deleted.rb
+++ b/lib/openai/models/vector_stores/vector_store_file_deleted.rb
@@ -3,6 +3,7 @@
 module OpenAI
   module Models
     module VectorStores
+      # @see OpenAI::Resources::VectorStores::Files#delete
       class VectorStoreFileDeleted < OpenAI::BaseModel
         # @!attribute id
         #