VectorStoreConnector¶

class oci.generative_ai.models.VectorStoreConnector(**kwargs)¶

Bases: object

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.

Attributes:

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a VectorStoreConnector.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a VectorStoreConnector.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a VectorStoreConnector.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a VectorStoreConnector.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a VectorStoreConnector.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a VectorStoreConnector.
`compartment_id`	[Required] Gets the compartment_id of this VectorStoreConnector.
`configuration`	[Required] Gets the configuration of this VectorStoreConnector.
`defined_tags`	[Required] Gets the defined_tags of this VectorStoreConnector.
`description`	Gets the description of this VectorStoreConnector.
`display_name`	[Required] Gets the display_name of this VectorStoreConnector.
`freeform_tags`	[Required] Gets the freeform_tags of this VectorStoreConnector.
`id`	[Required] Gets the id of this VectorStoreConnector.
`lifecycle_details`	Gets the lifecycle_details of this VectorStoreConnector.
`lifecycle_state`	[Required] Gets the lifecycle_state of this VectorStoreConnector.
`schedule_config`	Gets the schedule_config of this VectorStoreConnector.
`system_tags`	[Required] Gets the system_tags of this VectorStoreConnector.
`tenant_id`	[Required] Gets the tenant_id of this VectorStoreConnector.
`time_created`	[Required] Gets the time_created of this VectorStoreConnector.
`time_updated`	Gets the time_updated of this VectorStoreConnector.
`vault_secret_id`	Gets the vault_secret_id of this VectorStoreConnector.
`vector_store_id`	[Required] Gets the vector_store_id of this VectorStoreConnector.

Methods:

__init__(**kwargs)

Initializes a new VectorStoreConnector object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a VectorStoreConnector. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a VectorStoreConnector. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a VectorStoreConnector. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a VectorStoreConnector. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a VectorStoreConnector. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a VectorStoreConnector. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new VectorStoreConnector object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

id (str) – The value to assign to the id property of this VectorStoreConnector.
display_name (str) – The value to assign to the display_name property of this VectorStoreConnector.
description (str) – The value to assign to the description property of this VectorStoreConnector.
vector_store_id (str) – The value to assign to the vector_store_id property of this VectorStoreConnector.
compartment_id (str) – The value to assign to the compartment_id property of this VectorStoreConnector.
tenant_id (str) – The value to assign to the tenant_id property of this VectorStoreConnector.
time_created (datetime) – The value to assign to the time_created property of this VectorStoreConnector.
time_updated (datetime) – The value to assign to the time_updated property of this VectorStoreConnector.
vault_secret_id (str) – The value to assign to the vault_secret_id property of this VectorStoreConnector.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this VectorStoreConnector. Allowed values for this property are: “ACTIVE”, “CREATING”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this VectorStoreConnector.
schedule_config (oci.generative_ai.models.ScheduleConfig) – The value to assign to the schedule_config property of this VectorStoreConnector.
configuration (oci.generative_ai.models.ConnectorConfiguration) – The value to assign to the configuration property of this VectorStoreConnector.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this VectorStoreConnector.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this VectorStoreConnector.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this VectorStoreConnector.

property compartment_id¶

[Required] Gets the compartment_id of this VectorStoreConnector. Owning compartment OCID for a VectorStoreConnector.

Returns: The compartment_id of this VectorStoreConnector.
Return type: str

property configuration¶

[Required] Gets the configuration of this VectorStoreConnector.

Returns: The configuration of this VectorStoreConnector.
Return type: oci.generative_ai.models.ConnectorConfiguration

property defined_tags¶

[Required] Gets the defined_tags of this VectorStoreConnector. 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: The defined_tags of this VectorStoreConnector.
Return type: dict(str, dict(str, object))

property description¶

Gets the description of this VectorStoreConnector. An optional description of the VectorStoreConnector

Returns: The description of this VectorStoreConnector.
Return type: str

property display_name¶

[Required] Gets the display_name of this VectorStoreConnector. A user-friendly name

Returns: The display_name of this VectorStoreConnector.
Return type: str

property freeform_tags¶

[Required] Gets the freeform_tags of this VectorStoreConnector. 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: The freeform_tags of this VectorStoreConnector.
Return type: dict(str, str)

property id¶

[Required] Gets the id of this VectorStoreConnector. An OCID that uniquely identifies a VectorStoreConnector

Returns: The id of this VectorStoreConnector.
Return type: str

property lifecycle_details¶

Gets the lifecycle_details of this VectorStoreConnector. A message describing the current state in more detail that can provide actionable information.

Returns: The lifecycle_details of this VectorStoreConnector.
Return type: str

property lifecycle_state¶

[Required] Gets the lifecycle_state of this VectorStoreConnector. The lifecycle state of a VectorStoreConnector.

Allowed values for this property are: “ACTIVE”, “CREATING”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The lifecycle_state of this VectorStoreConnector.
Return type: str

property schedule_config¶

Gets the schedule_config of this VectorStoreConnector.

Returns: The schedule_config of this VectorStoreConnector.
Return type: oci.generative_ai.models.ScheduleConfig

property system_tags¶

[Required] Gets the system_tags of this VectorStoreConnector. System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns: The system_tags of this VectorStoreConnector.
Return type: dict(str, dict(str, object))

property tenant_id¶

[Required] Gets the tenant_id of this VectorStoreConnector. Owning tenant OCID for a VectorStoreConnector

Returns: The tenant_id of this VectorStoreConnector.
Return type: str

property time_created¶

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

Returns: The time_created of this VectorStoreConnector.
Return type: datetime

property time_updated¶

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

Returns: The time_updated of this VectorStoreConnector.
Return type: datetime

property vault_secret_id¶

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

Returns: The vault_secret_id of this VectorStoreConnector.
Return type: str

property vector_store_id¶

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

Returns: The vector_store_id of this VectorStoreConnector.
Return type: str