com.oracle.bmc.generativeaiagent.GenerativeAiAgentAsync Maven / Gradle / Ivy
Show all versions of oci-java-sdk-generativeaiagent Show documentation
/**
* Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved.
* This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
*/
package com.oracle.bmc.generativeaiagent;
import com.oracle.bmc.generativeaiagent.requests.*;
import com.oracle.bmc.generativeaiagent.responses.*;
/**
* **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 {@link
* #eNGenerative-ai-agents-clientLatest(ENGenerative-ai-agents-clientLatestRequest)
* 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).
*/
@jakarta.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20240531")
public interface GenerativeAiAgentAsync extends AutoCloseable {
/** Rebuilds the client from scratch. Useful to refresh certificates. */
void refreshClient();
/**
* Sets the endpoint to call (ex, https://www.example.com).
*
* @param endpoint The endpoint of the serice.
*/
void setEndpoint(String endpoint);
/** Gets the set endpoint for REST call (ex, https://www.example.com) */
String getEndpoint();
/**
* Sets the region to call (ex, Region.US_PHOENIX_1).
*
*
Note, this will call {@link #setEndpoint(String) setEndpoint} after resolving the
* endpoint. If the service is not available in this region, however, an
* IllegalArgumentException will be raised.
*
* @param region The region of the service.
*/
void setRegion(com.oracle.bmc.Region region);
/**
* 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 {@link
* #setRegion(Region) setRegion}.
*
*
If no known Region could be determined, it will create an endpoint based on the default
* endpoint format ({@link com.oracle.bmc.Region#formatDefaultRegionEndpoint(Service, String)}
* and then call {@link #setEndpoint(String) setEndpoint}.
*
* @param regionId The public region ID.
*/
void setRegion(String regionId);
/**
* 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"
*
* @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint
* template
*/
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled);
/**
* **CancelWorkRequest**
*
*
Cancels a work request.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future cancelWorkRequest(
CancelWorkRequestRequest request,
com.oracle.bmc.responses.AsyncHandler<
CancelWorkRequestRequest, CancelWorkRequestResponse>
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).
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future changeAgentCompartment(
ChangeAgentCompartmentRequest request,
com.oracle.bmc.responses.AsyncHandler<
ChangeAgentCompartmentRequest, ChangeAgentCompartmentResponse>
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).
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future
changeAgentEndpointCompartment(
ChangeAgentEndpointCompartmentRequest request,
com.oracle.bmc.responses.AsyncHandler<
ChangeAgentEndpointCompartmentRequest,
ChangeAgentEndpointCompartmentResponse>
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).
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future
changeKnowledgeBaseCompartment(
ChangeKnowledgeBaseCompartmentRequest request,
com.oracle.bmc.responses.AsyncHandler<
ChangeKnowledgeBaseCompartmentRequest,
ChangeKnowledgeBaseCompartmentResponse>
handler);
/**
* **CreateAgent**
*
* Creates an agent.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future createAgent(
CreateAgentRequest request,
com.oracle.bmc.responses.AsyncHandler handler);
/**
* **CreateAgentEndpoint**
*
* Creates an endpoint.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future createAgentEndpoint(
CreateAgentEndpointRequest request,
com.oracle.bmc.responses.AsyncHandler<
CreateAgentEndpointRequest, CreateAgentEndpointResponse>
handler);
/**
* **CreateDataIngestionJob**
*
* Creates a data ingestion job.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future createDataIngestionJob(
CreateDataIngestionJobRequest request,
com.oracle.bmc.responses.AsyncHandler<
CreateDataIngestionJobRequest, CreateDataIngestionJobResponse>
handler);
/**
* **CreateDataSource**
*
* Creates a data source.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future createDataSource(
CreateDataSourceRequest request,
com.oracle.bmc.responses.AsyncHandler
handler);
/**
* **CreateKnowledgeBase**
*
* Creates a knowledge base.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future createKnowledgeBase(
CreateKnowledgeBaseRequest request,
com.oracle.bmc.responses.AsyncHandler<
CreateKnowledgeBaseRequest, CreateKnowledgeBaseResponse>
handler);
/**
* **DeleteAgent**
*
* Deletes an agent.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future deleteAgent(
DeleteAgentRequest request,
com.oracle.bmc.responses.AsyncHandler handler);
/**
* **DeleteAgentEndpoint**
*
* Deletes an endpoint.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future deleteAgentEndpoint(
DeleteAgentEndpointRequest request,
com.oracle.bmc.responses.AsyncHandler<
DeleteAgentEndpointRequest, DeleteAgentEndpointResponse>
handler);
/**
* **DeleteDataIngestionJob**
*
* Deletes a data ingestion job.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future deleteDataIngestionJob(
DeleteDataIngestionJobRequest request,
com.oracle.bmc.responses.AsyncHandler<
DeleteDataIngestionJobRequest, DeleteDataIngestionJobResponse>
handler);
/**
* **DeleteDataSource**
*
* Deletes a data source.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future deleteDataSource(
DeleteDataSourceRequest request,
com.oracle.bmc.responses.AsyncHandler
handler);
/**
* **DeleteKnowledgeBase**
*
* Deletes a knowledge base.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future deleteKnowledgeBase(
DeleteKnowledgeBaseRequest request,
com.oracle.bmc.responses.AsyncHandler<
DeleteKnowledgeBaseRequest, DeleteKnowledgeBaseResponse>
handler);
/**
* **GetAgent**
*
* Gets information about an agent.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future getAgent(
GetAgentRequest request,
com.oracle.bmc.responses.AsyncHandler handler);
/**
* **GetAgentEndpoint**
*
* Gets information about an endpoint.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future getAgentEndpoint(
GetAgentEndpointRequest request,
com.oracle.bmc.responses.AsyncHandler
handler);
/**
* **GetDataIngestionJob**
*
* Gets information about a data ingestion job.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future getDataIngestionJob(
GetDataIngestionJobRequest request,
com.oracle.bmc.responses.AsyncHandler<
GetDataIngestionJobRequest, GetDataIngestionJobResponse>
handler);
/**
* **GetDataIngestionJobLogContent**
*
* Returns the raw log file for the specified data ingestion job in text format.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future
getDataIngestionJobLogContent(
GetDataIngestionJobLogContentRequest request,
com.oracle.bmc.responses.AsyncHandler<
GetDataIngestionJobLogContentRequest,
GetDataIngestionJobLogContentResponse>
handler);
/**
* **GetDataSource**
*
* Gets information about a data source.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future getDataSource(
GetDataSourceRequest request,
com.oracle.bmc.responses.AsyncHandler
handler);
/**
* **GetKnowledgeBase**
*
* Gets information about a knowledge base.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future getKnowledgeBase(
GetKnowledgeBaseRequest request,
com.oracle.bmc.responses.AsyncHandler
handler);
/**
* **GetWorkRequest**
*
* Gets the details of a work request.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future getWorkRequest(
GetWorkRequestRequest request,
com.oracle.bmc.responses.AsyncHandler
handler);
/**
* **ListAgentEndpoints**
*
* Gets a list of endpoints.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future listAgentEndpoints(
ListAgentEndpointsRequest request,
com.oracle.bmc.responses.AsyncHandler<
ListAgentEndpointsRequest, ListAgentEndpointsResponse>
handler);
/**
* **ListAgents**
*
* Gets a list of agents.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future listAgents(
ListAgentsRequest request,
com.oracle.bmc.responses.AsyncHandler handler);
/**
* **ListDataIngestionJobs**
*
* Gets a list of data ingestion jobs.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future listDataIngestionJobs(
ListDataIngestionJobsRequest request,
com.oracle.bmc.responses.AsyncHandler<
ListDataIngestionJobsRequest, ListDataIngestionJobsResponse>
handler);
/**
* **ListDataSources**
*
* Gets a list of data sources.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future listDataSources(
ListDataSourcesRequest request,
com.oracle.bmc.responses.AsyncHandler
handler);
/**
* **ListKnowledgeBases**
*
* Gets a list of knowledge bases.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future listKnowledgeBases(
ListKnowledgeBasesRequest request,
com.oracle.bmc.responses.AsyncHandler<
ListKnowledgeBasesRequest, ListKnowledgeBasesResponse>
handler);
/**
* **ListWorkRequestErrors**
*
* Lists the errors for a work request.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future listWorkRequestErrors(
ListWorkRequestErrorsRequest request,
com.oracle.bmc.responses.AsyncHandler<
ListWorkRequestErrorsRequest, ListWorkRequestErrorsResponse>
handler);
/**
* **ListWorkRequestLogs**
*
* Lists the logs for a work request.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future listWorkRequestLogs(
ListWorkRequestLogsRequest request,
com.oracle.bmc.responses.AsyncHandler<
ListWorkRequestLogsRequest, ListWorkRequestLogsResponse>
handler);
/**
* **ListWorkRequests**
*
* Lists the work requests in a compartment.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future listWorkRequests(
ListWorkRequestsRequest request,
com.oracle.bmc.responses.AsyncHandler
handler);
/**
* **UpdateAgent**
*
* Updates an agent.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future updateAgent(
UpdateAgentRequest request,
com.oracle.bmc.responses.AsyncHandler handler);
/**
* **UpdateAgentEndpoint**
*
* Updates an endpoint.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future updateAgentEndpoint(
UpdateAgentEndpointRequest request,
com.oracle.bmc.responses.AsyncHandler<
UpdateAgentEndpointRequest, UpdateAgentEndpointResponse>
handler);
/**
* **UpdateDataSource**
*
* Updates a data source.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future updateDataSource(
UpdateDataSourceRequest request,
com.oracle.bmc.responses.AsyncHandler
handler);
/**
* **UpdateKnowledgeBase**
*
* Updates a knowledge base.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future updateKnowledgeBase(
UpdateKnowledgeBaseRequest request,
com.oracle.bmc.responses.AsyncHandler<
UpdateKnowledgeBaseRequest, UpdateKnowledgeBaseResponse>
handler);
}