VectorStoreConnectorSummary¶

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

Bases: object

Summary information for a VectorStoreConnector

Methods:

__init__(**kwargs)

Initializes a new VectorStoreConnectorSummary object with values from keyword arguments.

Attributes:

`compartment_id`	[Required] Gets the compartment_id of this VectorStoreConnectorSummary.
`configuration`	[Required] Gets the configuration of this VectorStoreConnectorSummary.
`defined_tags`	[Required] Gets the defined_tags of this VectorStoreConnectorSummary.
`description`	Gets the description of this VectorStoreConnectorSummary.
`display_name`	[Required] Gets the display_name of this VectorStoreConnectorSummary.
`freeform_tags`	[Required] Gets the freeform_tags of this VectorStoreConnectorSummary.
`id`	[Required] Gets the id of this VectorStoreConnectorSummary.
`lifecycle_details`	Gets the lifecycle_details of this VectorStoreConnectorSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this VectorStoreConnectorSummary.
`schedule_config`	Gets the schedule_config of this VectorStoreConnectorSummary.
`system_tags`	[Required] Gets the system_tags of this VectorStoreConnectorSummary.
`tenant_id`	[Required] Gets the tenant_id of this VectorStoreConnectorSummary.
`time_created`	[Required] Gets the time_created of this VectorStoreConnectorSummary.
`time_updated`	Gets the time_updated of this VectorStoreConnectorSummary.
`vector_store_id`	[Required] Gets the vector_store_id of this VectorStoreConnectorSummary.

__init__(**kwargs)¶

Initializes a new VectorStoreConnectorSummary 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 VectorStoreConnectorSummary.
display_name (str) – The value to assign to the display_name property of this VectorStoreConnectorSummary.
description (str) – The value to assign to the description property of this VectorStoreConnectorSummary.
vector_store_id (str) – The value to assign to the vector_store_id property of this VectorStoreConnectorSummary.
compartment_id (str) – The value to assign to the compartment_id property of this VectorStoreConnectorSummary.
tenant_id (str) – The value to assign to the tenant_id property of this VectorStoreConnectorSummary.
time_created (datetime) – The value to assign to the time_created property of this VectorStoreConnectorSummary.
time_updated (datetime) – The value to assign to the time_updated property of this VectorStoreConnectorSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this VectorStoreConnectorSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this VectorStoreConnectorSummary.
schedule_config (oci.generative_ai.models.ScheduleConfig) – The value to assign to the schedule_config property of this VectorStoreConnectorSummary.
configuration (oci.generative_ai.models.ConnectorConfiguration) – The value to assign to the configuration property of this VectorStoreConnectorSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this VectorStoreConnectorSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this VectorStoreConnectorSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this VectorStoreConnectorSummary.

property compartment_id¶

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

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

property configuration¶

[Required] Gets the configuration of this VectorStoreConnectorSummary.

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

property defined_tags¶

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

property description¶

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

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

property display_name¶

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

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

property freeform_tags¶

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

property id¶

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

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

property lifecycle_details¶

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

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

property lifecycle_state¶

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

Allowed values are: - ACTIVE - CREATING - UPDATING - DELETING - DELETED - FAILED

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

property schedule_config¶

Gets the schedule_config of this VectorStoreConnectorSummary.

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

property system_tags¶

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

property tenant_id¶

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

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

property time_created¶

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

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

property time_updated¶

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

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

property vector_store_id¶

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

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