OciDatabaseSourceLocation¶
- class oci.generative_ai_agent_runtime.models.OciDatabaseSourceLocation(**kwargs)¶
Bases:
SourceLocationThe location of the OCI Database that the agent will use.
Attributes:
A constant which can be used with the source_location_type property of a SourceLocation.
A constant which can be used with the source_location_type property of a SourceLocation.
A constant which can be used with the source_location_type property of a SourceLocation.
Gets the function_name of this OciDatabaseSourceLocation.
Gets the id of this OciDatabaseSourceLocation.
[Required] Gets the source_location_type of this SourceLocation.
Gets the url of this OciDatabaseSourceLocation.
Methods:
__init__(**kwargs)Initializes a new OciDatabaseSourceLocation 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.
- SOURCE_LOCATION_TYPE_OCI_DATABASE = 'OCI_DATABASE'¶
A constant which can be used with the source_location_type property of a SourceLocation. This constant has a value of “OCI_DATABASE”
- SOURCE_LOCATION_TYPE_OCI_OBJECT_STORAGE = 'OCI_OBJECT_STORAGE'¶
A constant which can be used with the source_location_type property of a SourceLocation. This constant has a value of “OCI_OBJECT_STORAGE”
- SOURCE_LOCATION_TYPE_OCI_OPEN_SEARCH = 'OCI_OPEN_SEARCH'¶
A constant which can be used with the source_location_type property of a SourceLocation. This constant has a value of “OCI_OPEN_SEARCH”
- __init__(**kwargs)¶
Initializes a new OciDatabaseSourceLocation object with values from keyword arguments. The default value of the
source_location_typeattribute of this class isOCI_DATABASEand it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):- Parameters
source_location_type (str) – The value to assign to the source_location_type property of this OciDatabaseSourceLocation. Allowed values for this property are: “OCI_OBJECT_STORAGE”, “OCI_OPEN_SEARCH”, “OCI_DATABASE”
id (str) – The value to assign to the id property of this OciDatabaseSourceLocation.
function_name (str) – The value to assign to the function_name property of this OciDatabaseSourceLocation.
url (str) – The value to assign to the url property of this OciDatabaseSourceLocation.
- property function_name¶
Gets the function_name of this OciDatabaseSourceLocation. The name of the function that returns source text.
- Returns
The function_name of this OciDatabaseSourceLocation.
- 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.
- property id¶
Gets the id of this OciDatabaseSourceLocation. The OCID of the OCI Database Tools Connection.
- Returns
The id of this OciDatabaseSourceLocation.
- Return type
str
- property source_location_type¶
[Required] Gets the source_location_type of this SourceLocation. The type of the data source that contains data files for the agent.
Allowed values for this property are: “OCI_OBJECT_STORAGE”, “OCI_OPEN_SEARCH”, “OCI_DATABASE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The source_location_type of this SourceLocation.
- Return type
str
- property url¶
Gets the url of this OciDatabaseSourceLocation. The URL of the retrieved document, if available.
- Returns
The url of this OciDatabaseSourceLocation.
- Return type
str