IndexConfig¶

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

Bases: object

The index configuration of Knowledge bases.

Attributes

`INDEX_CONFIG_TYPE_DEFAULT_INDEX_CONFIG`	A constant which can be used with the index_config_type property of a IndexConfig.
`INDEX_CONFIG_TYPE_OCI_DATABASE_CONFIG`	A constant which can be used with the index_config_type property of a IndexConfig.
`INDEX_CONFIG_TYPE_OCI_OPEN_SEARCH_INDEX_CONFIG`	A constant which can be used with the index_config_type property of a IndexConfig.
`index_config_type`	[Required] Gets the index_config_type of this IndexConfig.

Methods

`__init__`(**kwargs)	Initializes a new IndexConfig 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'¶: A constant which can be used with the index_config_type property of a IndexConfig. This constant has a value of “DEFAULT_INDEX_CONFIG”

INDEX_CONFIG_TYPE_OCI_DATABASE_CONFIG = 'OCI_DATABASE_CONFIG'¶: A constant which can be used with the index_config_type property of a IndexConfig. This constant has a value of “OCI_DATABASE_CONFIG”

INDEX_CONFIG_TYPE_OCI_OPEN_SEARCH_INDEX_CONFIG = 'OCI_OPEN_SEARCH_INDEX_CONFIG'¶: A constant which can be used with the index_config_type property of a IndexConfig. This constant has a value of “OCI_OPEN_SEARCH_INDEX_CONFIG”

__init__(**kwargs)¶

Initializes a new IndexConfig object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

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 IndexConfig. 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’.

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