Class: OpenAI::Models::Beta::Threads::Runs::FileSearchToolCall::FileSearch::Result

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/threads/runs/file_search_tool_call.rb

Defined Under Namespace

Classes: Content

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

#content ⇒ Array<OpenAI::Models::Beta::Threads::Runs::FileSearchToolCall::FileSearch::Result::Content>?

The content of the result that was found. The content is only included if requested via the include query parameter.

Returns:



133
134
135
136
 
# File 'lib/openai/models/beta/threads/runs/file_search_tool_call.rb', line 133

optional :content,
-> {
  OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::Threads::Runs::FileSearchToolCall::FileSearch::Result::Content]
}

#file_id ⇒ String

The ID of the file that result was found in.

Returns:

  • (String) 


113
 
# File 'lib/openai/models/beta/threads/runs/file_search_tool_call.rb', line 113

required :file_id, String

#file_name ⇒ String

The name of the file that result was found in.

Returns:

  • (String) 


119
 
# File 'lib/openai/models/beta/threads/runs/file_search_tool_call.rb', line 119

required :file_name, String

#score ⇒ Float

The score of the result. All values must be a floating point number between 0 and 1.

Returns:

  • (Float) 


126
 
# File 'lib/openai/models/beta/threads/runs/file_search_tool_call.rb', line 126

required :score, Float