Class: OpenAI::Models::Responses::ResponseFileSearchToolCall::Result

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

Defined Under Namespace

Modules: Attribute

Instance Attribute Summary collapse

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

#attributes ⇒ Hash{Symbol=>String, Float, Boolean}?

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters, booleans, or numbers.

Returns:

  • (Hash{Symbol=>String, Float, Boolean}, nil) 


86
87
88
89
90
 
# File 'lib/openai/models/responses/response_file_search_tool_call.rb', line 86

optional :attributes,
-> {
  OpenAI::Internal::Type::HashOf[union: OpenAI::Responses::ResponseFileSearchToolCall::Result::Attribute]
},
nil?: true

#file_id ⇒ String?

The unique ID of the file.

Returns:

  • (String, nil) 


96
 
# File 'lib/openai/models/responses/response_file_search_tool_call.rb', line 96

optional :file_id, String

#filename ⇒ String?

The name of the file.

Returns:

  • (String, nil) 


102
 
# File 'lib/openai/models/responses/response_file_search_tool_call.rb', line 102

optional :filename, String

#score ⇒ Float?

The relevance score of the file - a value between 0 and 1.

Returns:

  • (Float, nil) 


108
 
# File 'lib/openai/models/responses/response_file_search_tool_call.rb', line 108

optional :score, Float

#text ⇒ String?

The text that was retrieved from the file.

Returns:

  • (String, nil) 


114
 
# File 'lib/openai/models/responses/response_file_search_tool_call.rb', line 114

optional :text, String