openai 0.23.3 → 0.25.0

data/sig/openai/models/evals/run_create_params.rbs

@@ -422,6 +422,7 @@ module OpenAI
             type sampling_params =
               {
                 max_completion_tokens: Integer,
+                reasoning_effort: OpenAI::Models::reasoning_effort?,
                 seed: Integer,
                 temperature: Float,
                 text: OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::SamplingParams::Text,
@@ -434,6 +435,8 @@ module OpenAI
 
               def max_completion_tokens=: (Integer) -> Integer
 
+              attr_accessor reasoning_effort: OpenAI::Models::reasoning_effort?
+
               attr_reader seed: Integer?
 
               def seed=: (Integer) -> Integer
@@ -460,6 +463,7 @@ module OpenAI
 
               def initialize: (
                 ?max_completion_tokens: Integer,
+                ?reasoning_effort: OpenAI::Models::reasoning_effort?,
                 ?seed: Integer,
                 ?temperature: Float,
                 ?text: OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::SamplingParams::Text,
@@ -469,6 +473,7 @@ module OpenAI
 
               def to_hash: -> {
                 max_completion_tokens: Integer,
+                reasoning_effort: OpenAI::Models::reasoning_effort?,
                 seed: Integer,
                 temperature: Float,
                 text: OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::SamplingParams::Text,

data/sig/openai/models/evals/run_create_response.rbs

@@ -459,6 +459,7 @@ module OpenAI
             type sampling_params =
               {
                 max_completion_tokens: Integer,
+                reasoning_effort: OpenAI::Models::reasoning_effort?,
                 seed: Integer,
                 temperature: Float,
                 text: OpenAI::Models::Evals::RunCreateResponse::DataSource::Responses::SamplingParams::Text,
@@ -471,6 +472,8 @@ module OpenAI
 
               def max_completion_tokens=: (Integer) -> Integer
 
+              attr_accessor reasoning_effort: OpenAI::Models::reasoning_effort?
+
               attr_reader seed: Integer?
 
               def seed=: (Integer) -> Integer
@@ -497,6 +500,7 @@ module OpenAI
 
               def initialize: (
                 ?max_completion_tokens: Integer,
+                ?reasoning_effort: OpenAI::Models::reasoning_effort?,
                 ?seed: Integer,
                 ?temperature: Float,
                 ?text: OpenAI::Models::Evals::RunCreateResponse::DataSource::Responses::SamplingParams::Text,
@@ -506,6 +510,7 @@ module OpenAI
 
               def to_hash: -> {
                 max_completion_tokens: Integer,
+                reasoning_effort: OpenAI::Models::reasoning_effort?,
                 seed: Integer,
                 temperature: Float,
                 text: OpenAI::Models::Evals::RunCreateResponse::DataSource::Responses::SamplingParams::Text,

data/sig/openai/models/evals/run_list_response.rbs

@@ -459,6 +459,7 @@ module OpenAI
             type sampling_params =
               {
                 max_completion_tokens: Integer,
+                reasoning_effort: OpenAI::Models::reasoning_effort?,
                 seed: Integer,
                 temperature: Float,
                 text: OpenAI::Models::Evals::RunListResponse::DataSource::Responses::SamplingParams::Text,
@@ -471,6 +472,8 @@ module OpenAI
 
               def max_completion_tokens=: (Integer) -> Integer
 
+              attr_accessor reasoning_effort: OpenAI::Models::reasoning_effort?
+
               attr_reader seed: Integer?
 
               def seed=: (Integer) -> Integer
@@ -497,6 +500,7 @@ module OpenAI
 
               def initialize: (
                 ?max_completion_tokens: Integer,
+                ?reasoning_effort: OpenAI::Models::reasoning_effort?,
                 ?seed: Integer,
                 ?temperature: Float,
                 ?text: OpenAI::Models::Evals::RunListResponse::DataSource::Responses::SamplingParams::Text,
@@ -506,6 +510,7 @@ module OpenAI
 
               def to_hash: -> {
                 max_completion_tokens: Integer,
+                reasoning_effort: OpenAI::Models::reasoning_effort?,
                 seed: Integer,
                 temperature: Float,
                 text: OpenAI::Models::Evals::RunListResponse::DataSource::Responses::SamplingParams::Text,

data/sig/openai/models/evals/run_retrieve_response.rbs

@@ -459,6 +459,7 @@ module OpenAI
             type sampling_params =
               {
                 max_completion_tokens: Integer,
+                reasoning_effort: OpenAI::Models::reasoning_effort?,
                 seed: Integer,
                 temperature: Float,
                 text: OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::SamplingParams::Text,
@@ -471,6 +472,8 @@ module OpenAI
 
               def max_completion_tokens=: (Integer) -> Integer
 
+              attr_accessor reasoning_effort: OpenAI::Models::reasoning_effort?
+
               attr_reader seed: Integer?
 
               def seed=: (Integer) -> Integer
@@ -497,6 +500,7 @@ module OpenAI
 
               def initialize: (
                 ?max_completion_tokens: Integer,
+                ?reasoning_effort: OpenAI::Models::reasoning_effort?,
                 ?seed: Integer,
                 ?temperature: Float,
                 ?text: OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::SamplingParams::Text,
@@ -506,6 +510,7 @@ module OpenAI
 
               def to_hash: -> {
                 max_completion_tokens: Integer,
+                reasoning_effort: OpenAI::Models::reasoning_effort?,
                 seed: Integer,
                 temperature: Float,
                 text: OpenAI::Models::Evals::RunRetrieveResponse::DataSource::Responses::SamplingParams::Text,

data/sig/openai/models/evals/runs/output_item_list_response.rbs

@@ -10,7 +10,7 @@ module OpenAI
             datasource_item_id: Integer,
             eval_id: String,
             object: :"eval.run.output_item",
-            results: ::Array[::Hash[Symbol, top]],
+            results: ::Array[OpenAI::Models::Evals::Runs::OutputItemListResponse::Result],
             run_id: String,
             sample: OpenAI::Models::Evals::Runs::OutputItemListResponse::Sample,
             status: String
@@ -29,7 +29,7 @@ module OpenAI
 
           attr_accessor object: :"eval.run.output_item"
 
-          attr_accessor results: ::Array[::Hash[Symbol, top]]
+          attr_accessor results: ::Array[OpenAI::Models::Evals::Runs::OutputItemListResponse::Result]
 
           attr_accessor run_id: String
 
@@ -43,7 +43,7 @@ module OpenAI
             datasource_item: ::Hash[Symbol, top],
             datasource_item_id: Integer,
             eval_id: String,
-            results: ::Array[::Hash[Symbol, top]],
+            results: ::Array[OpenAI::Models::Evals::Runs::OutputItemListResponse::Result],
             run_id: String,
             sample: OpenAI::Models::Evals::Runs::OutputItemListResponse::Sample,
             status: String,
@@ -57,12 +57,51 @@ module OpenAI
             datasource_item_id: Integer,
             eval_id: String,
             object: :"eval.run.output_item",
-            results: ::Array[::Hash[Symbol, top]],
+            results: ::Array[OpenAI::Models::Evals::Runs::OutputItemListResponse::Result],
             run_id: String,
             sample: OpenAI::Models::Evals::Runs::OutputItemListResponse::Sample,
             status: String
           }
 
+          type result =
+            {
+              name: String,
+              passed: bool,
+              score: Float,
+              sample: ::Hash[Symbol, top]?,
+              type: String
+            }
+
+          class Result < OpenAI::Internal::Type::BaseModel
+            attr_accessor name: String
+
+            attr_accessor passed: bool
+
+            attr_accessor score: Float
+
+            attr_accessor sample: ::Hash[Symbol, top]?
+
+            attr_reader type: String?
+
+            def type=: (String) -> String
+
+            def initialize: (
+              name: String,
+              passed: bool,
+              score: Float,
+              ?sample: ::Hash[Symbol, top]?,
+              ?type: String
+            ) -> void
+
+            def to_hash: -> {
+              name: String,
+              passed: bool,
+              score: Float,
+              sample: ::Hash[Symbol, top]?,
+              type: String
+            }
+          end
+
           type sample =
             {
               error: OpenAI::Evals::EvalAPIError,

data/sig/openai/models/evals/runs/output_item_retrieve_response.rbs

@@ -10,7 +10,7 @@ module OpenAI
             datasource_item_id: Integer,
             eval_id: String,
             object: :"eval.run.output_item",
-            results: ::Array[::Hash[Symbol, top]],
+            results: ::Array[OpenAI::Models::Evals::Runs::OutputItemRetrieveResponse::Result],
             run_id: String,
             sample: OpenAI::Models::Evals::Runs::OutputItemRetrieveResponse::Sample,
             status: String
@@ -29,7 +29,7 @@ module OpenAI
 
           attr_accessor object: :"eval.run.output_item"
 
-          attr_accessor results: ::Array[::Hash[Symbol, top]]
+          attr_accessor results: ::Array[OpenAI::Models::Evals::Runs::OutputItemRetrieveResponse::Result]
 
           attr_accessor run_id: String
 
@@ -43,7 +43,7 @@ module OpenAI
             datasource_item: ::Hash[Symbol, top],
             datasource_item_id: Integer,
             eval_id: String,
-            results: ::Array[::Hash[Symbol, top]],
+            results: ::Array[OpenAI::Models::Evals::Runs::OutputItemRetrieveResponse::Result],
             run_id: String,
             sample: OpenAI::Models::Evals::Runs::OutputItemRetrieveResponse::Sample,
             status: String,
@@ -57,12 +57,51 @@ module OpenAI
             datasource_item_id: Integer,
             eval_id: String,
             object: :"eval.run.output_item",
-            results: ::Array[::Hash[Symbol, top]],
+            results: ::Array[OpenAI::Models::Evals::Runs::OutputItemRetrieveResponse::Result],
             run_id: String,
             sample: OpenAI::Models::Evals::Runs::OutputItemRetrieveResponse::Sample,
             status: String
           }
 
+          type result =
+            {
+              name: String,
+              passed: bool,
+              score: Float,
+              sample: ::Hash[Symbol, top]?,
+              type: String
+            }
+
+          class Result < OpenAI::Internal::Type::BaseModel
+            attr_accessor name: String
+
+            attr_accessor passed: bool
+
+            attr_accessor score: Float
+
+            attr_accessor sample: ::Hash[Symbol, top]?
+
+            attr_reader type: String?
+
+            def type=: (String) -> String
+
+            def initialize: (
+              name: String,
+              passed: bool,
+              score: Float,
+              ?sample: ::Hash[Symbol, top]?,
+              ?type: String
+            ) -> void
+
+            def to_hash: -> {
+              name: String,
+              passed: bool,
+              score: Float,
+              sample: ::Hash[Symbol, top]?,
+              type: String
+            }
+          end
+
           type sample =
             {
               error: OpenAI::Evals::EvalAPIError,

data/sig/openai/models/graders/score_model_grader.rbs

@@ -10,7 +10,7 @@ module OpenAI
           name: String,
           type: :score_model,
           range: ::Array[Float],
-          sampling_params: top
+          sampling_params: OpenAI::Graders::ScoreModelGrader::SamplingParams
         }
 
       class ScoreModelGrader < OpenAI::Internal::Type::BaseModel
@@ -26,16 +26,18 @@ module OpenAI
 
         def range=: (::Array[Float]) -> ::Array[Float]
 
-        attr_reader sampling_params: top?
+        attr_reader sampling_params: OpenAI::Graders::ScoreModelGrader::SamplingParams?
 
-        def sampling_params=: (top) -> top
+        def sampling_params=: (
+          OpenAI::Graders::ScoreModelGrader::SamplingParams
+        ) -> OpenAI::Graders::ScoreModelGrader::SamplingParams
 
         def initialize: (
           input: ::Array[OpenAI::Graders::ScoreModelGrader::Input],
           model: String,
           name: String,
           ?range: ::Array[Float],
-          ?sampling_params: top,
+          ?sampling_params: OpenAI::Graders::ScoreModelGrader::SamplingParams,
           ?type: :score_model
         ) -> void
 
@@ -45,7 +47,7 @@ module OpenAI
           name: String,
           type: :score_model,
           range: ::Array[Float],
-          sampling_params: top
+          sampling_params: OpenAI::Graders::ScoreModelGrader::SamplingParams
         }
 
         type input =
@@ -154,6 +156,43 @@ module OpenAI
             def self?.values: -> ::Array[OpenAI::Models::Graders::ScoreModelGrader::Input::type_]
           end
         end
+
+        type sampling_params =
+          {
+            max_completions_tokens: Integer?,
+            reasoning_effort: OpenAI::Models::reasoning_effort?,
+            seed: Integer?,
+            temperature: Float?,
+            top_p: Float?
+          }
+
+        class SamplingParams < OpenAI::Internal::Type::BaseModel
+          attr_accessor max_completions_tokens: Integer?
+
+          attr_accessor reasoning_effort: OpenAI::Models::reasoning_effort?
+
+          attr_accessor seed: Integer?
+
+          attr_accessor temperature: Float?
+
+          attr_accessor top_p: Float?
+
+          def initialize: (
+            ?max_completions_tokens: Integer?,
+            ?reasoning_effort: OpenAI::Models::reasoning_effort?,
+            ?seed: Integer?,
+            ?temperature: Float?,
+            ?top_p: Float?
+          ) -> void
+
+          def to_hash: -> {
+            max_completions_tokens: Integer?,
+            reasoning_effort: OpenAI::Models::reasoning_effort?,
+            seed: Integer?,
+            temperature: Float?,
+            top_p: Float?
+          }
+        end
       end
     end
   end

data/sig/openai/models/responses/response_content.rbs

@@ -8,10 +8,23 @@ module OpenAI
         | OpenAI::Responses::ResponseInputAudio
         | OpenAI::Responses::ResponseOutputText
         | OpenAI::Responses::ResponseOutputRefusal
+        | OpenAI::Responses::ResponseContent::ReasoningTextContent
 
       module ResponseContent
         extend OpenAI::Internal::Type::Union
 
+        type reasoning_text_content = { text: String, type: :reasoning_text }
+
+        class ReasoningTextContent < OpenAI::Internal::Type::BaseModel
+          attr_accessor text: String
+
+          attr_accessor type: :reasoning_text
+
+          def initialize: (text: String, ?type: :reasoning_text) -> void
+
+          def to_hash: -> { text: String, type: :reasoning_text }
+        end
+
         def self?.variants: -> ::Array[OpenAI::Models::Responses::response_content]
       end
     end

data/sig/openai/models/responses/response_content_part_added_event.rbs

@@ -45,10 +45,23 @@ module OpenAI
         type part =
           OpenAI::Responses::ResponseOutputText
           | OpenAI::Responses::ResponseOutputRefusal
+          | OpenAI::Responses::ResponseContentPartAddedEvent::Part::ReasoningText
 
         module Part
           extend OpenAI::Internal::Type::Union
 
+          type reasoning_text = { text: String, type: :reasoning_text }
+
+          class ReasoningText < OpenAI::Internal::Type::BaseModel
+            attr_accessor text: String
+
+            attr_accessor type: :reasoning_text
+
+            def initialize: (text: String, ?type: :reasoning_text) -> void
+
+            def to_hash: -> { text: String, type: :reasoning_text }
+          end
+
           def self?.variants: -> ::Array[OpenAI::Models::Responses::ResponseContentPartAddedEvent::part]
         end
       end

data/sig/openai/models/responses/response_content_part_done_event.rbs

@@ -45,10 +45,23 @@ module OpenAI
         type part =
           OpenAI::Responses::ResponseOutputText
           | OpenAI::Responses::ResponseOutputRefusal
+          | OpenAI::Responses::ResponseContentPartDoneEvent::Part::ReasoningText
 
         module Part
           extend OpenAI::Internal::Type::Union
 
+          type reasoning_text = { text: String, type: :reasoning_text }
+
+          class ReasoningText < OpenAI::Internal::Type::BaseModel
+            attr_accessor text: String
+
+            attr_accessor type: :reasoning_text
+
+            def initialize: (text: String, ?type: :reasoning_text) -> void
+
+            def to_hash: -> { text: String, type: :reasoning_text }
+          end
+
           def self?.variants: -> ::Array[OpenAI::Models::Responses::ResponseContentPartDoneEvent::part]
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openai
 version: !ruby/object:Gem::Version
-  version: 0.23.3
+  version: 0.25.0
 platform: ruby
 authors:
 - OpenAI
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-09-15 00:00:00.000000000 Z
+date: 2025-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -252,7 +252,6 @@ files:
 - lib/openai/models/containers/file_retrieve_response.rb
 - lib/openai/models/containers/files/content_retrieve_params.rb
 - lib/openai/models/conversations/computer_screenshot_content.rb
-- lib/openai/models/conversations/container_file_citation_body.rb
 - lib/openai/models/conversations/conversation.rb
 - lib/openai/models/conversations/conversation_create_params.rb
 - lib/openai/models/conversations/conversation_delete_params.rb
@@ -262,7 +261,6 @@ files:
 - lib/openai/models/conversations/conversation_item_list.rb
 - lib/openai/models/conversations/conversation_retrieve_params.rb
 - lib/openai/models/conversations/conversation_update_params.rb
-- lib/openai/models/conversations/file_citation_body.rb
 - lib/openai/models/conversations/input_file_content.rb
 - lib/openai/models/conversations/input_image_content.rb
 - lib/openai/models/conversations/input_text_content.rb
@@ -270,14 +268,11 @@ files:
 - lib/openai/models/conversations/item_delete_params.rb
 - lib/openai/models/conversations/item_list_params.rb
 - lib/openai/models/conversations/item_retrieve_params.rb
-- lib/openai/models/conversations/lob_prob.rb
 - lib/openai/models/conversations/message.rb
 - lib/openai/models/conversations/output_text_content.rb
 - lib/openai/models/conversations/refusal_content.rb
 - lib/openai/models/conversations/summary_text_content.rb
 - lib/openai/models/conversations/text_content.rb
-- lib/openai/models/conversations/top_log_prob.rb
-- lib/openai/models/conversations/url_citation_body.rb
 - lib/openai/models/create_embedding_response.rb
 - lib/openai/models/custom_tool_input_format.rb
 - lib/openai/models/embedding.rb
@@ -931,7 +926,6 @@ files:
 - rbi/openai/models/containers/file_retrieve_response.rbi
 - rbi/openai/models/containers/files/content_retrieve_params.rbi
 - rbi/openai/models/conversations/computer_screenshot_content.rbi
-- rbi/openai/models/conversations/container_file_citation_body.rbi
 - rbi/openai/models/conversations/conversation.rbi
 - rbi/openai/models/conversations/conversation_create_params.rbi
 - rbi/openai/models/conversations/conversation_delete_params.rbi
@@ -941,7 +935,6 @@ files:
 - rbi/openai/models/conversations/conversation_item_list.rbi
 - rbi/openai/models/conversations/conversation_retrieve_params.rbi
 - rbi/openai/models/conversations/conversation_update_params.rbi
-- rbi/openai/models/conversations/file_citation_body.rbi
 - rbi/openai/models/conversations/input_file_content.rbi
 - rbi/openai/models/conversations/input_image_content.rbi
 - rbi/openai/models/conversations/input_text_content.rbi
@@ -949,14 +942,11 @@ files:
 - rbi/openai/models/conversations/item_delete_params.rbi
 - rbi/openai/models/conversations/item_list_params.rbi
 - rbi/openai/models/conversations/item_retrieve_params.rbi
-- rbi/openai/models/conversations/lob_prob.rbi
 - rbi/openai/models/conversations/message.rbi
 - rbi/openai/models/conversations/output_text_content.rbi
 - rbi/openai/models/conversations/refusal_content.rbi
 - rbi/openai/models/conversations/summary_text_content.rbi
 - rbi/openai/models/conversations/text_content.rbi
-- rbi/openai/models/conversations/top_log_prob.rbi
-- rbi/openai/models/conversations/url_citation_body.rbi
 - rbi/openai/models/create_embedding_response.rbi
 - rbi/openai/models/custom_tool_input_format.rbi
 - rbi/openai/models/embedding.rbi
@@ -1600,7 +1590,6 @@ files:
 - sig/openai/models/containers/file_retrieve_response.rbs
 - sig/openai/models/containers/files/content_retrieve_params.rbs
 - sig/openai/models/conversations/computer_screenshot_content.rbs
-- sig/openai/models/conversations/container_file_citation_body.rbs
 - sig/openai/models/conversations/conversation.rbs
 - sig/openai/models/conversations/conversation_create_params.rbs
 - sig/openai/models/conversations/conversation_delete_params.rbs
@@ -1610,7 +1599,6 @@ files:
 - sig/openai/models/conversations/conversation_item_list.rbs
 - sig/openai/models/conversations/conversation_retrieve_params.rbs
 - sig/openai/models/conversations/conversation_update_params.rbs
-- sig/openai/models/conversations/file_citation_body.rbs
 - sig/openai/models/conversations/input_file_content.rbs
 - sig/openai/models/conversations/input_image_content.rbs
 - sig/openai/models/conversations/input_text_content.rbs
@@ -1618,14 +1606,11 @@ files:
 - sig/openai/models/conversations/item_delete_params.rbs
 - sig/openai/models/conversations/item_list_params.rbs
 - sig/openai/models/conversations/item_retrieve_params.rbs
-- sig/openai/models/conversations/lob_prob.rbs
 - sig/openai/models/conversations/message.rbs
 - sig/openai/models/conversations/output_text_content.rbs
 - sig/openai/models/conversations/refusal_content.rbs
 - sig/openai/models/conversations/summary_text_content.rbs
 - sig/openai/models/conversations/text_content.rbs
-- sig/openai/models/conversations/top_log_prob.rbs
-- sig/openai/models/conversations/url_citation_body.rbs
 - sig/openai/models/create_embedding_response.rbs
 - sig/openai/models/custom_tool_input_format.rbs
 - sig/openai/models/embedding.rbs

data/lib/openai/models/conversations/container_file_citation_body.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Conversations
-      class ContainerFileCitationBody < OpenAI::Internal::Type::BaseModel
-        # @!attribute container_id
-        #   The ID of the container file.
-        #
-        #   @return [String]
-        required :container_id, String
-
-        # @!attribute end_index
-        #   The index of the last character of the container file citation in the message.
-        #
-        #   @return [Integer]
-        required :end_index, Integer
-
-        # @!attribute file_id
-        #   The ID of the file.
-        #
-        #   @return [String]
-        required :file_id, String
-
-        # @!attribute filename
-        #   The filename of the container file cited.
-        #
-        #   @return [String]
-        required :filename, String
-
-        # @!attribute start_index
-        #   The index of the first character of the container file citation in the message.
-        #
-        #   @return [Integer]
-        required :start_index, Integer
-
-        # @!attribute type
-        #   The type of the container file citation. Always `container_file_citation`.
-        #
-        #   @return [Symbol, :container_file_citation]
-        required :type, const: :container_file_citation
-
-        # @!method initialize(container_id:, end_index:, file_id:, filename:, start_index:, type: :container_file_citation)
-        #   @param container_id [String] The ID of the container file.
-        #
-        #   @param end_index [Integer] The index of the last character of the container file citation in the message.
-        #
-        #   @param file_id [String] The ID of the file.
-        #
-        #   @param filename [String] The filename of the container file cited.
-        #
-        #   @param start_index [Integer] The index of the first character of the container file citation in the message.
-        #
-        #   @param type [Symbol, :container_file_citation] The type of the container file citation. Always `container_file_citation`.
-      end
-    end
-  end
-end

data/lib/openai/models/conversations/file_citation_body.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module OpenAI
-  module Models
-    module Conversations
-      class FileCitationBody < OpenAI::Internal::Type::BaseModel
-        # @!attribute file_id
-        #   The ID of the file.
-        #
-        #   @return [String]
-        required :file_id, String
-
-        # @!attribute filename
-        #   The filename of the file cited.
-        #
-        #   @return [String]
-        required :filename, String
-
-        # @!attribute index
-        #   The index of the file in the list of files.
-        #
-        #   @return [Integer]
-        required :index, Integer
-
-        # @!attribute type
-        #   The type of the file citation. Always `file_citation`.
-        #
-        #   @return [Symbol, :file_citation]
-        required :type, const: :file_citation
-
-        # @!method initialize(file_id:, filename:, index:, type: :file_citation)
-        #   @param file_id [String] The ID of the file.
-        #
-        #   @param filename [String] The filename of the file cited.
-        #
-        #   @param index [Integer] The index of the file in the list of files.
-        #
-        #   @param type [Symbol, :file_citation] The type of the file citation. Always `file_citation`.
-      end
-    end
-  end
-end