OciDatabaseConfig

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

Bases: IndexConfig

The details of the customer Database Connection.

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.

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'

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

property 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

property 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.

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