Class: OCI::GenerativeAi::Models::FileSyncIngestionLogs

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/generative_ai/models/file_sync_ingestion_logs.rb

Overview

A Log object that gives the ingestion status of a File from a datasource read by a VectorStoreConnector

Constant Summary collapse

STATUS_ENUM = 
[
  STATUS_COMPLETED = 'COMPLETED'.freeze,
  STATUS_CANCELLED = 'CANCELLED'.freeze,
  STATUS_FAILED = 'FAILED'.freeze,
  STATUS_QUEUED = 'QUEUED'.freeze,
  STATUS_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FileSyncIngestionLogs

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :file_id (String) —

    The value to assign to the #file_id property

  • :file_path (String) —

    The value to assign to the #file_path property

  • :file_size_in_bytes (Integer) —

    The value to assign to the #file_size_in_bytes property

  • :total_chunks_created (Integer) —

    The value to assign to the #total_chunks_created property

  • :duration_in_seconds (Integer) —

    The value to assign to the #duration_in_seconds property

  • :status (String) —

    The value to assign to the #status property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/oci/generative_ai/models/file_sync_ingestion_logs.rb', line 117

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.file_id = attributes[:'fileId'] if attributes[:'fileId']

  raise 'You cannot provide both :fileId and :file_id' if attributes.key?(:'fileId') && attributes.key?(:'file_id')

  self.file_id = attributes[:'file_id'] if attributes[:'file_id']

  self.file_path = attributes[:'filePath'] if attributes[:'filePath']

  raise 'You cannot provide both :filePath and :file_path' if attributes.key?(:'filePath') && attributes.key?(:'file_path')

  self.file_path = attributes[:'file_path'] if attributes[:'file_path']

  self.file_size_in_bytes = attributes[:'fileSizeInBytes'] if attributes[:'fileSizeInBytes']

  raise 'You cannot provide both :fileSizeInBytes and :file_size_in_bytes' if attributes.key?(:'fileSizeInBytes') && attributes.key?(:'file_size_in_bytes')

  self.file_size_in_bytes = attributes[:'file_size_in_bytes'] if attributes[:'file_size_in_bytes']

  self.total_chunks_created = attributes[:'totalChunksCreated'] if attributes[:'totalChunksCreated']

  raise 'You cannot provide both :totalChunksCreated and :total_chunks_created' if attributes.key?(:'totalChunksCreated') && attributes.key?(:'total_chunks_created')

  self.total_chunks_created = attributes[:'total_chunks_created'] if attributes[:'total_chunks_created']

  self.duration_in_seconds = attributes[:'durationInSeconds'] if attributes[:'durationInSeconds']

  raise 'You cannot provide both :durationInSeconds and :duration_in_seconds' if attributes.key?(:'durationInSeconds') && attributes.key?(:'duration_in_seconds')

  self.duration_in_seconds = attributes[:'duration_in_seconds'] if attributes[:'duration_in_seconds']

  self.status = attributes[:'status'] if attributes[:'status']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

  raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags')

  self.system_tags = attributes[:'system_tags'] if attributes[:'system_tags']
end

Instance Attribute Details

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


59
60
61
 
# File 'lib/oci/generative_ai/models/file_sync_ingestion_logs.rb', line 59

def defined_tags
  @defined_tags
end

#duration_in_seconds ⇒ Integer

The duration taken(in seconds) to ingest the File.

Returns:

  • (Integer) 


39
40
41
 
# File 'lib/oci/generative_ai/models/file_sync_ingestion_logs.rb', line 39

def duration_in_seconds
  @duration_in_seconds
end

#file_id ⇒ String

[Required] An identifier that identifies a File ingested to a VectorStore.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/generative_ai/models/file_sync_ingestion_logs.rb', line 23

def file_id
  @file_id
end

#file_path ⇒ String

[Required] The path where the file was located in the datasource.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/generative_ai/models/file_sync_ingestion_logs.rb', line 27

def file_path
  @file_path
end

#file_size_in_bytes ⇒ Integer

The size of the file.

Returns:

  • (Integer) 


31
32
33
 
# File 'lib/oci/generative_ai/models/file_sync_ingestion_logs.rb', line 31

def file_size_in_bytes
  @file_size_in_bytes
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


51
52
53
 
# File 'lib/oci/generative_ai/models/file_sync_ingestion_logs.rb', line 51

def freeform_tags
  @freeform_tags
end

#status ⇒ String

[Required] The current status of ingestion for the File

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/generative_ai/models/file_sync_ingestion_logs.rb', line 43

def status
  @status
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


66
67
68
 
# File 'lib/oci/generative_ai/models/file_sync_ingestion_logs.rb', line 66

def system_tags
  @system_tags
end

#total_chunks_created ⇒ Integer

The total number of chunks created from the File.

Returns:

  • (Integer) 


35
36
37
 
# File 'lib/oci/generative_ai/models/file_sync_ingestion_logs.rb', line 35

def total_chunks_created
  @total_chunks_created
end

Class Method Details

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/oci/generative_ai/models/file_sync_ingestion_logs.rb', line 69

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'file_id': :'fileId',
    'file_path': :'filePath',
    'file_size_in_bytes': :'fileSizeInBytes',
    'total_chunks_created': :'totalChunksCreated',
    'duration_in_seconds': :'durationInSeconds',
    'status': :'status',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/oci/generative_ai/models/file_sync_ingestion_logs.rb', line 86

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'file_id': :'String',
    'file_path': :'String',
    'file_size_in_bytes': :'Integer',
    'total_chunks_created': :'Integer',
    'duration_in_seconds': :'Integer',
    'status': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/oci/generative_ai/models/file_sync_ingestion_logs.rb', line 194

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    file_id == other.file_id &&
    file_path == other.file_path &&
    file_size_in_bytes == other.file_size_in_bytes &&
    total_chunks_created == other.total_chunks_created &&
    duration_in_seconds == other.duration_in_seconds &&
    status == other.status &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/oci/generative_ai/models/file_sync_ingestion_logs.rb', line 232

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


212
213
214
 
# File 'lib/oci/generative_ai/models/file_sync_ingestion_logs.rb', line 212

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



221
222
223
 
# File 'lib/oci/generative_ai/models/file_sync_ingestion_logs.rb', line 221

def hash
  [file_id, file_path, file_size_in_bytes, total_chunks_created, duration_in_seconds, status, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



265
266
267
268
269
270
271
272
273
274
 
# File 'lib/oci/generative_ai/models/file_sync_ingestion_logs.rb', line 265

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



259
260
261
 
# File 'lib/oci/generative_ai/models/file_sync_ingestion_logs.rb', line 259

def to_s
  to_hash.to_s
end