Class: OpenAI::Models::Beta::Threads::FileCitationDeltaAnnotation

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

Defined Under Namespace

Classes: FileCitation

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(index: , end_index: nil, file_citation: nil, start_index: nil, text: nil, type: :file_citation) ⇒ Object

A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the “file_search” tool to search files.

Parameters:

  • index (Integer) (defaults to: ) —

    The index of the annotation in the text content part.

  • end_index (Integer) (defaults to: nil)
  • file_citation (OpenAI::Models::Beta::Threads::FileCitationDeltaAnnotation::FileCitation) (defaults to: nil)
  • start_index (Integer) (defaults to: nil)
  • text (String) (defaults to: nil) —

    The text in the message content that needs to be replaced.

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

    Always ‘file_citation`.




# File 'lib/openai/models/beta/threads/file_citation_delta_annotation.rb', line 41

Instance Attribute Details

#end_index ⇒ Integer?

Returns:

  • (Integer, nil) 


23
 
# File 'lib/openai/models/beta/threads/file_citation_delta_annotation.rb', line 23

optional :end_index, Integer

#file_citation ⇒ OpenAI::Models::Beta::Threads::FileCitationDeltaAnnotation::FileCitation?

Returns:



28
 
# File 'lib/openai/models/beta/threads/file_citation_delta_annotation.rb', line 28

optional :file_citation, -> { OpenAI::Beta::Threads::FileCitationDeltaAnnotation::FileCitation }

#index ⇒ Integer

The index of the annotation in the text content part.

Returns:

  • (Integer) 


12
 
# File 'lib/openai/models/beta/threads/file_citation_delta_annotation.rb', line 12

required :index, Integer

#start_index ⇒ Integer?

Returns:

  • (Integer, nil) 


33
 
# File 'lib/openai/models/beta/threads/file_citation_delta_annotation.rb', line 33

optional :start_index, Integer

#text ⇒ String?

The text in the message content that needs to be replaced.

Returns:

  • (String, nil) 


39
 
# File 'lib/openai/models/beta/threads/file_citation_delta_annotation.rb', line 39

optional :text, String

#type ⇒ Symbol, :file_citation

Always ‘file_citation`.

Returns:

  • (Symbol, :file_citation) 


18
 
# File 'lib/openai/models/beta/threads/file_citation_delta_annotation.rb', line 18

required :type, const: :file_citation