DefaultIndexConfig¶
- class oci.generative_ai_agent.models.DefaultIndexConfig(**kwargs)¶
Bases:
IndexConfigThe default index is service managed vector store on behalf of the customer.
Attributes:
A constant which can be used with the index_config_type property of a IndexConfig.
A constant which can be used with the index_config_type property of a IndexConfig.
A constant which can be used with the index_config_type property of a IndexConfig.
[Required] Gets the index_config_type of this IndexConfig.
Gets the should_enable_hybrid_search of this DefaultIndexConfig.
Methods:
__init__(**kwargs)Initializes a new DefaultIndexConfig 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 DefaultIndexConfig object with values from keyword arguments. The default value of the
index_config_typeattribute of this class isDEFAULT_INDEX_CONFIGand 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 DefaultIndexConfig. Allowed values for this property are: “DEFAULT_INDEX_CONFIG”, “OCI_OPEN_SEARCH_INDEX_CONFIG”, “OCI_DATABASE_CONFIG”
should_enable_hybrid_search (bool) – The value to assign to the should_enable_hybrid_search property of this DefaultIndexConfig.
- 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.
- property index_config_type¶
[Required] Gets the index_config_type of this IndexConfig. The type of index.
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
- property should_enable_hybrid_search¶
Gets the should_enable_hybrid_search of this DefaultIndexConfig. Whether to enable Hybrid search in service managed OpenSearch.
- Returns
The should_enable_hybrid_search of this DefaultIndexConfig.
- Return type
bool