Class: OCI::GenerativeAi::Models::VectorStoreConnector

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

Overview

A VectorStore Connector offers a lightweight and configurable mechanism to continuously synchronize data from external systems into the VectorStore at scale. It captures the configuration of the datasource for data ingestion.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VectorStoreConnector

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/oci/generative_ai/models/vector_store_connector.rb', line 169

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.id = attributes[:'id'] if attributes[:'id']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

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

  self.vector_store_id = attributes[:'vectorStoreId'] if attributes[:'vectorStoreId']

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.tenant_id = attributes[:'tenantId'] if attributes[:'tenantId']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.vault_secret_id = attributes[:'vaultSecretId'] if attributes[:'vaultSecretId']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

  self.schedule_config = attributes[:'scheduleConfig'] if attributes[:'scheduleConfig']

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

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

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

  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

#compartment_id ⇒ String

[Required] Owning compartment OCID for a VectorStoreConnector.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#configuration ⇒ OCI::GenerativeAi::Models::ConnectorConfiguration

This attribute is required.

Returns:



74
75
76
 
# File 'lib/oci/generative_ai/models/vector_store_connector.rb', line 74

def configuration
  @configuration
end

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

[Required] 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>>) 


90
91
92
 
# File 'lib/oci/generative_ai/models/vector_store_connector.rb', line 90

def defined_tags
  @defined_tags
end

#description ⇒ String

An optional description of the VectorStoreConnector

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

[Required] A user-friendly name

Returns:

  • (String) 


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

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

[Required] 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>) 


82
83
84
 
# File 'lib/oci/generative_ai/models/vector_store_connector.rb', line 82

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] An OCID that uniquely identifies a VectorStoreConnector

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_details ⇒ String

A message describing the current state in more detail that can provide actionable information.

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/generative_ai/models/vector_store_connector.rb', line 67

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The lifecycle state of a VectorStoreConnector.

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/generative_ai/models/vector_store_connector.rb', line 63

def lifecycle_state
  @lifecycle_state
end

#schedule_config ⇒ OCI::GenerativeAi::Models::ScheduleConfig

Returns:



70
71
72
 
# File 'lib/oci/generative_ai/models/vector_store_connector.rb', line 70

def schedule_config
  @schedule_config
end

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

[Required] 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>>) 


97
98
99
 
# File 'lib/oci/generative_ai/models/vector_store_connector.rb', line 97

def system_tags
  @system_tags
end

#tenant_id ⇒ String

[Required] Owning tenant OCID for a VectorStoreConnector

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/generative_ai/models/vector_store_connector.rb', line 47

def tenant_id
  @tenant_id
end

#time_created ⇒ DateTime

[Required] The date and time that the VectorStoreConnector was created in the format of an RFC3339 datetime string.

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time that the VectorStoreConnector was updated in the format of an RFC3339 datetime string.

Returns:

  • (DateTime) 


55
56
57
 
# File 'lib/oci/generative_ai/models/vector_store_connector.rb', line 55

def time_updated
  @time_updated
end

#vault_secret_id ⇒ String

An optional customer Encryption Key stored in OCI Vault that can be used to decrypt the data downloaded from the data source.

Returns:

  • (String) 


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

def vault_secret_id
  @vault_secret_id
end

#vector_store_id ⇒ String

[Required] An OCID that identifies the Vector Store to which this connector is connected.

Returns:

  • (String) 


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

def vector_store_id
  @vector_store_id
end

Class Method Details

.attribute_map ⇒ Object

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



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/oci/generative_ai/models/vector_store_connector.rb', line 100

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'vector_store_id': :'vectorStoreId',
    'compartment_id': :'compartmentId',
    'tenant_id': :'tenantId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'vault_secret_id': :'vaultSecretId',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'schedule_config': :'scheduleConfig',
    'configuration': :'configuration',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/generative_ai/models/vector_store_connector.rb', line 124

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'vector_store_id': :'String',
    'compartment_id': :'String',
    'tenant_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'vault_secret_id': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'schedule_config': :'OCI::GenerativeAi::Models::ScheduleConfig',
    'configuration': :'OCI::GenerativeAi::Models::ConnectorConfiguration',
    '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



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/oci/generative_ai/models/vector_store_connector.rb', line 280

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    vector_store_id == other.vector_store_id &&
    compartment_id == other.compartment_id &&
    tenant_id == other.tenant_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    vault_secret_id == other.vault_secret_id &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    schedule_config == other.schedule_config &&
    configuration == other.configuration &&
    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



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/oci/generative_ai/models/vector_store_connector.rb', line 325

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


305
306
307
 
# File 'lib/oci/generative_ai/models/vector_store_connector.rb', line 305

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



314
315
316
 
# File 'lib/oci/generative_ai/models/vector_store_connector.rb', line 314

def hash
  [id, display_name, description, vector_store_id, compartment_id, tenant_id, time_created, time_updated, vault_secret_id, lifecycle_state, lifecycle_details, schedule_config, configuration, 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



358
359
360
361
362
363
364
365
366
367
 
# File 'lib/oci/generative_ai/models/vector_store_connector.rb', line 358

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



352
353
354
 
# File 'lib/oci/generative_ai/models/vector_store_connector.rb', line 352

def to_s
  to_hash.to_s
end