CreateVectorStoreConnectorDetails¶

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

Bases: object

The data to create a VectorStoreConnector.

Methods:

__init__(**kwargs)

Initializes a new CreateVectorStoreConnectorDetails object with values from keyword arguments.

Attributes:

`compartment_id`	[Required] Gets the compartment_id of this CreateVectorStoreConnectorDetails.
`configuration`	[Required] Gets the configuration of this CreateVectorStoreConnectorDetails.
`defined_tags`	Gets the defined_tags of this CreateVectorStoreConnectorDetails.
`description`	Gets the description of this CreateVectorStoreConnectorDetails.
`display_name`	[Required] Gets the display_name of this CreateVectorStoreConnectorDetails.
`freeform_tags`	Gets the freeform_tags of this CreateVectorStoreConnectorDetails.
`schedule_config`	Gets the schedule_config of this CreateVectorStoreConnectorDetails.
`vault_secret_id`	Gets the vault_secret_id of this CreateVectorStoreConnectorDetails.
`vector_store_id`	[Required] Gets the vector_store_id of this CreateVectorStoreConnectorDetails.

__init__(**kwargs)¶

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

Parameters

compartment_id (str) – The value to assign to the compartment_id property of this CreateVectorStoreConnectorDetails.
vector_store_id (str) – The value to assign to the vector_store_id property of this CreateVectorStoreConnectorDetails.
display_name (str) – The value to assign to the display_name property of this CreateVectorStoreConnectorDetails.
description (str) – The value to assign to the description property of this CreateVectorStoreConnectorDetails.
schedule_config (oci.generative_ai.models.ScheduleConfig) – The value to assign to the schedule_config property of this CreateVectorStoreConnectorDetails.
configuration (oci.generative_ai.models.ConnectorConfiguration) – The value to assign to the configuration property of this CreateVectorStoreConnectorDetails.
vault_secret_id (str) – The value to assign to the vault_secret_id property of this CreateVectorStoreConnectorDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateVectorStoreConnectorDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateVectorStoreConnectorDetails.

property compartment_id¶

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

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

property configuration¶

[Required] Gets the configuration of this CreateVectorStoreConnectorDetails.

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

property defined_tags¶

Gets the defined_tags of this CreateVectorStoreConnectorDetails. 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 CreateVectorStoreConnectorDetails.
Return type: dict(str, dict(str, object))

property description¶

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

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

property display_name¶

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

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

property freeform_tags¶

Gets the freeform_tags of this CreateVectorStoreConnectorDetails. 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 CreateVectorStoreConnectorDetails.
Return type: dict(str, str)

property schedule_config¶

Gets the schedule_config of this CreateVectorStoreConnectorDetails.

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

property vault_secret_id¶

Gets the vault_secret_id of this CreateVectorStoreConnectorDetails. 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 CreateVectorStoreConnectorDetails.
Return type: str

property vector_store_id¶

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

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