Class: OpenApiOpenAIClient::MessageDeltaContentTextAnnotationsFileCitationObject

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/openapi_openai/models/message_delta_content_text_annotations_file_citation_object.rb

Overview

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.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ MessageDeltaContentTextAnnotationsFileCitationObject

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/openapi_openai/models/message_delta_content_text_annotations_file_citation_object.rb', line 98

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenApiOpenAIClient::MessageDeltaContentTextAnnotationsFileCitationObject` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OpenApiOpenAIClient::MessageDeltaContentTextAnnotationsFileCitationObject`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'index')
    self.index = attributes[:'index']
  else
    self.index = nil
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = nil
  end

  if attributes.key?(:'text')
    self.text = attributes[:'text']
  end

  if attributes.key?(:'file_citation')
    self.file_citation = attributes[:'file_citation']
  end

  if attributes.key?(:'start_index')
    self.start_index = attributes[:'start_index']
  end

  if attributes.key?(:'end_index')
    self.end_index = attributes[:'end_index']
  end
end

Instance Attribute Details

#end_index ⇒ Object

Returns the value of attribute end_index.



32
33
34
 
# File 'lib/openapi_openai/models/message_delta_content_text_annotations_file_citation_object.rb', line 32

def end_index
  @end_index
end

#file_citation ⇒ Object

Returns the value of attribute file_citation.



28
29
30
 
# File 'lib/openapi_openai/models/message_delta_content_text_annotations_file_citation_object.rb', line 28

def file_citation
  @file_citation
end

#index ⇒ Object

The index of the annotation in the text content part.



20
21
22
 
# File 'lib/openapi_openai/models/message_delta_content_text_annotations_file_citation_object.rb', line 20

def index
  @index
end

#start_index ⇒ Object

Returns the value of attribute start_index.



30
31
32
 
# File 'lib/openapi_openai/models/message_delta_content_text_annotations_file_citation_object.rb', line 30

def start_index
  @start_index
end

#text ⇒ Object

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



26
27
28
 
# File 'lib/openapi_openai/models/message_delta_content_text_annotations_file_citation_object.rb', line 26

def text
  @text
end

#type ⇒ Object

Always file_citation.



23
24
25
 
# File 'lib/openapi_openai/models/message_delta_content_text_annotations_file_citation_object.rb', line 23

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



69
70
71
 
# File 'lib/openapi_openai/models/message_delta_content_text_annotations_file_citation_object.rb', line 69

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



74
75
76
 
# File 'lib/openapi_openai/models/message_delta_content_text_annotations_file_citation_object.rb', line 74

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



57
58
59
60
61
62
63
64
65
66
 
# File 'lib/openapi_openai/models/message_delta_content_text_annotations_file_citation_object.rb', line 57

def self.attribute_map
  {
    :'index' => :'index',
    :'type' => :'type',
    :'text' => :'text',
    :'file_citation' => :'file_citation',
    :'start_index' => :'start_index',
    :'end_index' => :'end_index'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/openapi_openai/models/message_delta_content_text_annotations_file_citation_object.rb', line 254

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



91
92
93
94
 
# File 'lib/openapi_openai/models/message_delta_content_text_annotations_file_citation_object.rb', line 91

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
 
# File 'lib/openapi_openai/models/message_delta_content_text_annotations_file_citation_object.rb', line 79

def self.openapi_types
  {
    :'index' => :'Integer',
    :'type' => :'String',
    :'text' => :'String',
    :'file_citation' => :'MessageDeltaContentTextAnnotationsFileCitationObjectFileCitation',
    :'start_index' => :'Integer',
    :'end_index' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



228
229
230
231
232
233
234
235
236
237
 
# File 'lib/openapi_openai/models/message_delta_content_text_annotations_file_citation_object.rb', line 228

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      index == o.index &&
      type == o.type &&
      text == o.text &&
      file_citation == o.file_citation &&
      start_index == o.start_index &&
      end_index == o.end_index
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


241
242
243
 
# File 'lib/openapi_openai/models/message_delta_content_text_annotations_file_citation_object.rb', line 241

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



247
248
249
 
# File 'lib/openapi_openai/models/message_delta_content_text_annotations_file_citation_object.rb', line 247

def hash
  [index, type, text, file_citation, start_index, end_index].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/openapi_openai/models/message_delta_content_text_annotations_file_citation_object.rb', line 143

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @index.nil?
    invalid_properties.push('invalid value for "index", index cannot be nil.')
  end

  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  if !@start_index.nil? && @start_index < 0
    invalid_properties.push('invalid value for "start_index", must be greater than or equal to 0.')
  end

  if !@end_index.nil? && @end_index < 0
    invalid_properties.push('invalid value for "end_index", must be greater than or equal to 0.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/openapi_openai/models/message_delta_content_text_annotations_file_citation_object.rb', line 276

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



167
168
169
170
171
172
173
174
175
176
 
# File 'lib/openapi_openai/models/message_delta_content_text_annotations_file_citation_object.rb', line 167

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @index.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["file_citation"])
  return false unless type_validator.valid?(@type)
  return false if !@start_index.nil? && @start_index < 0
  return false if !@end_index.nil? && @end_index < 0
  true
end