OciOpenSearchSourceLocation¶

class oci.generative_ai_agent_runtime.models.OciOpenSearchSourceLocation(**kwargs)¶

Bases: oci.generative_ai_agent_runtime.models.source_location.SourceLocation

The location of the OCI Search with OpenSearch that the agent will use.

Attributes

`SOURCE_LOCATION_TYPE_OCI_DATABASE`	str(object=’’) -> str
`SOURCE_LOCATION_TYPE_OCI_OBJECT_STORAGE`	str(object=’’) -> str
`SOURCE_LOCATION_TYPE_OCI_OPEN_SEARCH`	str(object=’’) -> str
`id`	Gets the id of this OciOpenSearchSourceLocation.
`index_name`	Gets the index_name of this OciOpenSearchSourceLocation.
`source_location_type`	[Required] Gets the source_location_type of this SourceLocation.
`url`	Gets the url of this OciOpenSearchSourceLocation.

Methods

`__init__`(**kwargs)	Initializes a new OciOpenSearchSourceLocation 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'¶

SOURCE_LOCATION_TYPE_OCI_OBJECT_STORAGE = 'OCI_OBJECT_STORAGE'¶

SOURCE_LOCATION_TYPE_OCI_OPEN_SEARCH = 'OCI_OPEN_SEARCH'¶

__init__(**kwargs)¶

Initializes a new OciOpenSearchSourceLocation object with values from keyword arguments. The default value of the source_location_type attribute of this class is OCI_OPEN_SEARCH and 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 OciOpenSearchSourceLocation. 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 OciOpenSearchSourceLocation.
index_name (str) – The value to assign to the index_name property of this OciOpenSearchSourceLocation.
url (str) – The value to assign to the url property of this OciOpenSearchSourceLocation.

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.

id¶

Gets the id of this OciOpenSearchSourceLocation. The OCID of the OCI OpenSearch cluster.

Returns:	The id of this OciOpenSearchSourceLocation.
Return type:	str

index_name¶

Gets the index_name of this OciOpenSearchSourceLocation. The name of the index in OpenSearch that contains the source text.

Returns:	The index_name of this OciOpenSearchSourceLocation.
Return type:	str

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

url¶

Gets the url of this OciOpenSearchSourceLocation. The URL of the retrieved document, if available.

Returns:	The url of this OciOpenSearchSourceLocation.
Return type:	str