OciDatabaseConfig¶

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

Bases: oci.generative_ai_agent.models.index_config.IndexConfig

The details of the customer Database Connection.

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
`database_connection`	[Required] Gets the database_connection of this OciDatabaseConfig.
`database_functions`	[Required] Gets the database_functions of this OciDatabaseConfig.
`index_config_type`	[Required] Gets the index_config_type of this IndexConfig.

Methods

`__init__`(**kwargs)	Initializes a new OciDatabaseConfig 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 OciDatabaseConfig object with values from keyword arguments. The default value of the index_config_type attribute of this class is OCI_DATABASE_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 OciDatabaseConfig. Allowed values for this property are: “DEFAULT_INDEX_CONFIG”, “OCI_OPEN_SEARCH_INDEX_CONFIG”, “OCI_DATABASE_CONFIG”
database_connection (oci.generative_ai_agent.models.DatabaseConnection) – The value to assign to the database_connection property of this OciDatabaseConfig.
database_functions (list[oci.generative_ai_agent.models.DatabaseFunction]) – The value to assign to the database_functions property of this OciDatabaseConfig.

database_connection¶

[Required] Gets the database_connection of this OciDatabaseConfig.

Returns:	The database_connection of this OciDatabaseConfig.
Return type:	oci.generative_ai_agent.models.DatabaseConnection

database_functions¶

[Required] Gets the database_functions of this OciDatabaseConfig. Array of Database functions to be used.

Returns:	The database_functions of this OciDatabaseConfig.
Return type:	list[oci.generative_ai_agent.models.DatabaseFunction]

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