Class: OpenAI::Models::Responses::ResponseOutputText::Annotation::FileCitation

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Responses::ResponseOutputText::Annotation::FileCitation

Defined in:

lib/openai/models/responses/response_output_text.rb

Instance Attribute Summary

• #file_id ⇒ String

  The ID of the file.

• #index ⇒ Integer

  The index of the file in the list of files.

• #type ⇒ Symbol, :file_citation

  The type of the file citation.

Method Summary

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

This class inherits a constructor from OpenAI::Internal::Type::BaseModel

Instance Attribute Details

#file_id ⇒ String

The ID of the file.

Returns:

• (String)

# File 'lib/openai/models/responses/response_output_text.rb', line 73

required :file_id, String

#index ⇒ Integer

The index of the file in the list of files.

Returns:

• (Integer)

# File 'lib/openai/models/responses/response_output_text.rb', line 79

required :index, Integer

#type ⇒ Symbol, :file_citation

The type of the file citation. Always ‘file_citation`.

Returns:

• (Symbol, :file_citation)

# File 'lib/openai/models/responses/response_output_text.rb', line 85

required :type, const: :file_citation