Namespace Oci.GenerativeaiagentService.Models
Classes
Agent
Agent
An agent is an LLM-based autonomous system that understands and generates human-like text, enabling natural-language processing interactions. OCI Generative AI Agents supports retrieval-augmented generation (RAG) agents. A RAG agent connects to a data source, retrieves data, and augments model responses with the information from the data sources to generate more relevant responses.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
AgentCollection
AgentCollection
Results of an agent search. Contains both AgentSummary items and other information, such as metadata.
AgentEndpoint
AgentEndpoint
The endpoint to access a deployed agent.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
AgentEndpointCollection
AgentEndpointCollection
Results of an agentEndpoint search. Contains both AgentEndpointSummary items and other information, such as metadata.
AgentEndpointSummary
AgentEndpointSummary
Summary information about an endpoint.
AgentSummary
AgentSummary
Summary information about an agent.
BasicAuthSecret
BasicAuthSecret
The details of Basic authentication configured as in OpenSearch.
ChangeAgentCompartmentDetails
ChangeAgentCompartmentDetails
The configuration details for the move operation.
ChangeAgentEndpointCompartmentDetails
ChangeAgentEndpointCompartmentDetails
The configuration details for the move operation.
ChangeKnowledgeBaseCompartmentDetails
ChangeKnowledgeBaseCompartmentDetails
The configuration details for the move operation.
ContentModerationConfig
The configuration details about whether to apply the content moderation feature to input and output. Content moderation removes toxic and biased content from responses. It is recommended to use content moderation.
CreateAgentDetails
CreateAgentDetails
The data to create an agent.
CreateAgentEndpointDetails
CreateAgentEndpointDetails
The data to create an endpoint.
CreateDataIngestionJobDetails
CreateDataIngestionJobDetails
The data to create a data ingestion job.
CreateDataSourceDetails
CreateDataSourceDetails
The data to create a data source.
CreateKnowledgeBaseDetails
CreateKnowledgeBaseDetails
The data to create a knowledge base.
DataIngestionJob
DataIngestionJob
When you create a data source, you specify the location of the data files. To make those files usable by an agent, you must download them into the agent's associated knowledge base, a process known as data ingestion. Data ingestion is a process that extracts data from data source documents, converts it into a structured format suitable for analysis, and then stores it in a knowledge base.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
DataIngestionJobCollection
DataIngestionJobCollection
Results of a data ingestion job search. Contains both DataIngestionJobSummary items and other information, such as metadata.
DataIngestionJobStatistics
DataIngestionJobStatistics
The statistics of data ingestion job.
DataIngestionJobSummary
DataIngestionJobSummary
Summary information about a data ingestion job.
DataSource
DataSource
A data source points to the source of your data. After you add a data source to a knowledge base, you must ingest the data source's data, so that agents using the knowledge base can refer to the data.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
DataSourceCollection
DataSourceCollection
Results of a dataSource search. Contains both DataSourceSummary items and other information, such as metadata.
DataSourceConfig
DataSourceConfig
The details of data source.
DataSourceConfigModelConverter
DataSourceSummary
DataSourceSummary
Summary information about a data source.
DatabaseConnection
DatabaseConnection
The connection type for Databases.
DatabaseConnectionModelConverter
DatabaseFunction
DatabaseFunction
The details of Database function.
DatabaseToolConnection
DatabaseToolConnection
The details of the customer Database Tools Connection.
DefaultIndexConfig
DefaultIndexConfig
The default index is service managed vector store on behalf of the customer.
IdcsSecret
IdcsSecret
The details of IDCS configured as OpenID setting in OpenSearch.
Index
Index
OCI OpenSearch index details.
IndexConfig
IndexConfig
The index configuration of Knowledge bases.
IndexConfigModelConverter
IndexSchema
IndexSchema
The index schema details.
KnowledgeBase
KnowledgeBase
A knowledge base is the base for all the data sources that an agent can use to retrieve information for its responses.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
KnowledgeBaseCollection
KnowledgeBaseCollection
Results of a knowledge base search. Contains both KnowledgeBaseSummary items and other information, such as metadata.
KnowledgeBaseSummary
KnowledgeBaseSummary
Summary information about a knowledge base.
ObjectStoragePrefix
ObjectStoragePrefix
The details of OCI Object Storage object.
OciDatabaseConfig
OciDatabaseConfig
The details of the customer Database Connection.
OciObjectStorageDataSourceConfig
OciObjectStorageDataSourceConfig
The details of OCI Search with OpenSearch data source information.
OciOpenSearchIndexConfig
OciOpenSearchIndexConfig
The details of customer managed OCI OpenSearch.
SecretDetail
SecretDetail
The details of configured security configuration on OpenSearch.
SecretDetailModelConverter
SessionConfig
SessionConfig
Session Configuration on AgentEndpoint.
UpdateAgentDetails
UpdateAgentDetails
The data to update an agent.
UpdateAgentEndpointDetails
UpdateAgentEndpointDetails
The data to update an endpoint.
UpdateDataSourceDetails
UpdateDataSourceDetails
The data to update a data source.
UpdateKnowledgeBaseDetails
UpdateKnowledgeBaseDetails
The data to update a knowledge base.
WorkRequest
WorkRequest
An asynchronous work request. Work requests help you monitor long-running operations. When you start a long-running operation,
the service creates a work request. A work request is an activity log that lets you track each step in the operation's
progress. Each work request has an OCID that lets you interact with it programmatically and use it for automation.
WorkRequestError
WorkRequestError
An error encountered while performing an operation that is tracked by a work request.
WorkRequestErrorCollection
WorkRequestErrorCollection
A list of work request errors. Can contain both errors and other information, such as metadata.
WorkRequestLogEntry
WorkRequestLogEntry
A log message from performing an operation that is tracked by a work request.
WorkRequestLogEntryCollection
WorkRequestLogEntryCollection
A list of work request logs. Can contain both logs and other information, such as metadata.
WorkRequestResource
WorkRequestResource
A resource created or operated on by a work request.
WorkRequestSummary
WorkRequestSummary
Summary information about an asynchronous work request.
WorkRequestSummaryCollection
WorkRequestSummaryCollection
A list of work requests. Can contain both work requests and other information, such as metadata.
Enums
ActionType
Possible types of actions.
Agent.LifecycleStateEnum
AgentEndpoint.LifecycleStateEnum
DataIngestionJob.LifecycleStateEnum
DataSource.LifecycleStateEnum
DataSourceConfig.DataSourceConfigTypeEnum
DatabaseConnection.ConnectionTypeEnum
IndexConfig.IndexConfigTypeEnum
KnowledgeBase.LifecycleStateEnum
OperationStatus
The status of the work request.
OperationType
The asynchronous operation tracked by the work request.
SecretDetail.TypeEnum
SortOrder
SortOrder
The sort order to use, either ascending (ASC
) or descending (DESC
). The displayName
sort order is case sensitive.
WorkRequestResourceMetadataKey
Possible metadata keys for work request resource metadata.