Class: OpenAI::Models::Responses::ResponseOutputText::Annotation::FilePath

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/responses/response_output_text.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, 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

#initialize(file_id: , index: , type: :file_path) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Responses::ResponseOutputText::Annotation::FilePath for more details.

A path to a file.

Parameters:

  • file_id (String) (defaults to: ) —

    The ID of the file.

  • index (Integer) (defaults to: ) —

    The index of the file in the list of files.

  • type (Symbol, :file_path) (defaults to: :file_path) —

    The type of the file path. Always ‘file_path`.




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

Instance Attribute Details

#file_id ⇒ String

The ID of the file.

Returns:

  • (String) 


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

required :file_id, String

#index ⇒ Integer

The index of the file in the list of files.

Returns:

  • (Integer) 


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

required :index, Integer

#type ⇒ Symbol, :file_path

The type of the file path. Always ‘file_path`.

Returns:

  • (Symbol, :file_path) 


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

required :type, const: :file_path