OciOpenSearchIndexConfig¶

class oci.generative_ai_agent.models.OciOpenSearchIndexConfig(**kwargs)¶

Bases: oci.generative_ai_agent.models.index_config.IndexConfig

OciOpenSearchIndexConfig

The details of customer managed OCI OpenSearch.

Attributes

`INDEX_CONFIG_TYPE_DEFAULT_INDEX_CONFIG`	str(object=’’) -> str
`INDEX_CONFIG_TYPE_OCI_DATABASE_CONFIG`	str(object=’’) -> str
`INDEX_CONFIG_TYPE_OCI_OPEN_SEARCH_INDEX_CONFIG`	str(object=’’) -> str
`cluster_id`	[Required] Gets the cluster_id of this OciOpenSearchIndexConfig.
`index_config_type`	[Required] Gets the index_config_type of this IndexConfig.
`indexes`	[Required] Gets the indexes of this OciOpenSearchIndexConfig.
`secret_detail`	[Required] Gets the secret_detail of this OciOpenSearchIndexConfig.

Methods

`__init__`(**kwargs)	Initializes a new OciOpenSearchIndexConfig object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

INDEX_CONFIG_TYPE_DEFAULT_INDEX_CONFIG = 'DEFAULT_INDEX_CONFIG'¶

INDEX_CONFIG_TYPE_OCI_DATABASE_CONFIG = 'OCI_DATABASE_CONFIG'¶

INDEX_CONFIG_TYPE_OCI_OPEN_SEARCH_INDEX_CONFIG = 'OCI_OPEN_SEARCH_INDEX_CONFIG'¶

__init__(**kwargs)¶

Initializes a new OciOpenSearchIndexConfig object with values from keyword arguments. The default value of the index_config_type attribute of this class is OCI_OPEN_SEARCH_INDEX_CONFIG and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

index_config_type (str) – The value to assign to the index_config_type property of this OciOpenSearchIndexConfig. Allowed values for this property are: “DEFAULT_INDEX_CONFIG”, “OCI_OPEN_SEARCH_INDEX_CONFIG”, “OCI_DATABASE_CONFIG”
cluster_id (str) – The value to assign to the cluster_id property of this OciOpenSearchIndexConfig.
secret_detail (oci.generative_ai_agent.models.SecretDetail) – The value to assign to the secret_detail property of this OciOpenSearchIndexConfig.
indexes (list[oci.generative_ai_agent.models.Index]) – The value to assign to the indexes property of this OciOpenSearchIndexConfig.

cluster_id¶

[Required] Gets the cluster_id of this OciOpenSearchIndexConfig. The OCID of the OpenSearch Cluster.

Returns:	The cluster_id of this OciOpenSearchIndexConfig.
Return type:	str

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

index_config_type¶

[Required] Gets the index_config_type of this IndexConfig. The type of index. The allowed values are: - DEFAULT_INDEX_CONFIG: DefaultIndexConfig allows the service to create and manage vector store on behalf of the customer. - OCI_OPEN_SEARCH_INDEX_CONFIG: OciOpenSearchIndexConfig allows customer to configure their OpenSearch cluster. - OCI_DATABASE_CONFIG: OciDatabaseConfig allows customer to configure their Database.

Allowed values for this property are: “DEFAULT_INDEX_CONFIG”, “OCI_OPEN_SEARCH_INDEX_CONFIG”, “OCI_DATABASE_CONFIG”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The index_config_type of this IndexConfig.
Return type:	str

indexes¶

[Required] Gets the indexes of this OciOpenSearchIndexConfig. Index configuration for open search.

Returns:	The indexes of this OciOpenSearchIndexConfig.
Return type:	list[oci.generative_ai_agent.models.Index]

secret_detail¶

[Required] Gets the secret_detail of this OciOpenSearchIndexConfig.

Returns:	The secret_detail of this OciOpenSearchIndexConfig.
Return type:	oci.generative_ai_agent.models.SecretDetail