@Generated(value="OracleSDKGenerator", comments="API Version: 20240531") public interface GenerativeAiAgentAsync extends AutoCloseable
Generative AI Agents API
OCI Generative AI Agents is a fully managed service that combines the power of large language models (LLMs) with an intelligent retrieval system to create contextually relevant answers by searching your knowledge base, making your AI applications smart and efficient.
OCI Generative AI Agents supports several ways to onboard your data and then allows you and your customers to interact with your data using a chat interface or API.
Use the Generative AI Agents API to create and manage agents, knowledge bases, data sources, endpoints, data ingestion jobs, and work requests.
For creating and managing client chat sessions see the eNGenerative-ai-agents-clientLatest
.
To learn more about the service, see the [Generative AI Agents documentation](https://docs.cloud.oracle.com/iaas/Content/generative-ai-agents/home.htm).
close
void refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the serice.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
void setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint
after resolving the
endpoint. If the service is not available in this region, however, an
IllegalArgumentException will be raised.
region
- The region of the service.void setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call setRegion
.
If no known Region could be determined, it will create an endpoint based on the default
endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint
.
regionId
- The public region ID.void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint
templateFuture<CancelWorkRequestResponse> cancelWorkRequest(CancelWorkRequestRequest request, AsyncHandler<CancelWorkRequestRequest,CancelWorkRequestResponse> handler)
CancelWorkRequest
Cancels a work request.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ChangeAgentCompartmentResponse> changeAgentCompartment(ChangeAgentCompartmentRequest request, AsyncHandler<ChangeAgentCompartmentRequest,ChangeAgentCompartmentResponse> handler)
ChangeAgentCompartment
Moves an agent into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ChangeAgentEndpointCompartmentResponse> changeAgentEndpointCompartment(ChangeAgentEndpointCompartmentRequest request, AsyncHandler<ChangeAgentEndpointCompartmentRequest,ChangeAgentEndpointCompartmentResponse> handler)
ChangeAgentEndpointCompartment
Moves an endpoint into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ChangeKnowledgeBaseCompartmentResponse> changeKnowledgeBaseCompartment(ChangeKnowledgeBaseCompartmentRequest request, AsyncHandler<ChangeKnowledgeBaseCompartmentRequest,ChangeKnowledgeBaseCompartmentResponse> handler)
ChangeKnowledgeBaseCompartment
Moves a knowledge base into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateAgentResponse> createAgent(CreateAgentRequest request, AsyncHandler<CreateAgentRequest,CreateAgentResponse> handler)
CreateAgent
Creates an agent.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateAgentEndpointResponse> createAgentEndpoint(CreateAgentEndpointRequest request, AsyncHandler<CreateAgentEndpointRequest,CreateAgentEndpointResponse> handler)
CreateAgentEndpoint
Creates an endpoint.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateDataIngestionJobResponse> createDataIngestionJob(CreateDataIngestionJobRequest request, AsyncHandler<CreateDataIngestionJobRequest,CreateDataIngestionJobResponse> handler)
CreateDataIngestionJob
Creates a data ingestion job.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateDataSourceResponse> createDataSource(CreateDataSourceRequest request, AsyncHandler<CreateDataSourceRequest,CreateDataSourceResponse> handler)
CreateDataSource
Creates a data source.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateKnowledgeBaseResponse> createKnowledgeBase(CreateKnowledgeBaseRequest request, AsyncHandler<CreateKnowledgeBaseRequest,CreateKnowledgeBaseResponse> handler)
CreateKnowledgeBase
Creates a knowledge base.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteAgentResponse> deleteAgent(DeleteAgentRequest request, AsyncHandler<DeleteAgentRequest,DeleteAgentResponse> handler)
DeleteAgent
Deletes an agent.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteAgentEndpointResponse> deleteAgentEndpoint(DeleteAgentEndpointRequest request, AsyncHandler<DeleteAgentEndpointRequest,DeleteAgentEndpointResponse> handler)
DeleteAgentEndpoint
Deletes an endpoint.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteDataIngestionJobResponse> deleteDataIngestionJob(DeleteDataIngestionJobRequest request, AsyncHandler<DeleteDataIngestionJobRequest,DeleteDataIngestionJobResponse> handler)
DeleteDataIngestionJob
Deletes a data ingestion job.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteDataSourceResponse> deleteDataSource(DeleteDataSourceRequest request, AsyncHandler<DeleteDataSourceRequest,DeleteDataSourceResponse> handler)
DeleteDataSource
Deletes a data source.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteKnowledgeBaseResponse> deleteKnowledgeBase(DeleteKnowledgeBaseRequest request, AsyncHandler<DeleteKnowledgeBaseRequest,DeleteKnowledgeBaseResponse> handler)
DeleteKnowledgeBase
Deletes a knowledge base.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetAgentResponse> getAgent(GetAgentRequest request, AsyncHandler<GetAgentRequest,GetAgentResponse> handler)
GetAgent
Gets information about an agent.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetAgentEndpointResponse> getAgentEndpoint(GetAgentEndpointRequest request, AsyncHandler<GetAgentEndpointRequest,GetAgentEndpointResponse> handler)
GetAgentEndpoint
Gets information about an endpoint.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetDataIngestionJobResponse> getDataIngestionJob(GetDataIngestionJobRequest request, AsyncHandler<GetDataIngestionJobRequest,GetDataIngestionJobResponse> handler)
GetDataIngestionJob
Gets information about a data ingestion job.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetDataIngestionJobLogContentResponse> getDataIngestionJobLogContent(GetDataIngestionJobLogContentRequest request, AsyncHandler<GetDataIngestionJobLogContentRequest,GetDataIngestionJobLogContentResponse> handler)
GetDataIngestionJobLogContent
Returns the raw log file for the specified data ingestion job in text format.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetDataSourceResponse> getDataSource(GetDataSourceRequest request, AsyncHandler<GetDataSourceRequest,GetDataSourceResponse> handler)
GetDataSource
Gets information about a data source.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetKnowledgeBaseResponse> getKnowledgeBase(GetKnowledgeBaseRequest request, AsyncHandler<GetKnowledgeBaseRequest,GetKnowledgeBaseResponse> handler)
GetKnowledgeBase
Gets information about a knowledge base.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
GetWorkRequest
Gets the details of a work request.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListAgentEndpointsResponse> listAgentEndpoints(ListAgentEndpointsRequest request, AsyncHandler<ListAgentEndpointsRequest,ListAgentEndpointsResponse> handler)
ListAgentEndpoints
Gets a list of endpoints.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListAgentsResponse> listAgents(ListAgentsRequest request, AsyncHandler<ListAgentsRequest,ListAgentsResponse> handler)
ListAgents
Gets a list of agents.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListDataIngestionJobsResponse> listDataIngestionJobs(ListDataIngestionJobsRequest request, AsyncHandler<ListDataIngestionJobsRequest,ListDataIngestionJobsResponse> handler)
ListDataIngestionJobs
Gets a list of data ingestion jobs.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListDataSourcesResponse> listDataSources(ListDataSourcesRequest request, AsyncHandler<ListDataSourcesRequest,ListDataSourcesResponse> handler)
ListDataSources
Gets a list of data sources.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListKnowledgeBasesResponse> listKnowledgeBases(ListKnowledgeBasesRequest request, AsyncHandler<ListKnowledgeBasesRequest,ListKnowledgeBasesResponse> handler)
ListKnowledgeBases
Gets a list of knowledge bases.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
ListWorkRequestErrors
Lists the errors for a work request.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
ListWorkRequestLogs
Lists the logs for a work request.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
ListWorkRequests
Lists the work requests in a compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateAgentResponse> updateAgent(UpdateAgentRequest request, AsyncHandler<UpdateAgentRequest,UpdateAgentResponse> handler)
UpdateAgent
Updates an agent.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateAgentEndpointResponse> updateAgentEndpoint(UpdateAgentEndpointRequest request, AsyncHandler<UpdateAgentEndpointRequest,UpdateAgentEndpointResponse> handler)
UpdateAgentEndpoint
Updates an endpoint.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateDataSourceResponse> updateDataSource(UpdateDataSourceRequest request, AsyncHandler<UpdateDataSourceRequest,UpdateDataSourceResponse> handler)
UpdateDataSource
Updates a data source.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateKnowledgeBaseResponse> updateKnowledgeBase(UpdateKnowledgeBaseRequest request, AsyncHandler<UpdateKnowledgeBaseRequest,UpdateKnowledgeBaseResponse> handler)
UpdateKnowledgeBase
Updates a knowledge base.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Copyright © 2016–2024. All rights reserved.