GenerativeAiAgent (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

GenerativeAiAgentClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240531")
public interface GenerativeAiAgent
extends AutoCloseable
```
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).
This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CancelWorkRequestResponse`	`cancelWorkRequest(CancelWorkRequestRequest request)` Cancels a work request.
`ChangeAgentCompartmentResponse`	`changeAgentCompartment(ChangeAgentCompartmentRequest request)` Moves an agent into a different compartment within the same tenancy.
`ChangeAgentEndpointCompartmentResponse`	`changeAgentEndpointCompartment(ChangeAgentEndpointCompartmentRequest request)` Moves an endpoint into a different compartment within the same tenancy.
`ChangeKnowledgeBaseCompartmentResponse`	`changeKnowledgeBaseCompartment(ChangeKnowledgeBaseCompartmentRequest request)` Moves a knowledge base into a different compartment within the same tenancy.
`CreateAgentResponse`	`createAgent(CreateAgentRequest request)` Creates an agent.
`CreateAgentEndpointResponse`	`createAgentEndpoint(CreateAgentEndpointRequest request)` Creates an endpoint.
`CreateDataIngestionJobResponse`	`createDataIngestionJob(CreateDataIngestionJobRequest request)` Creates a data ingestion job.
`CreateDataSourceResponse`	`createDataSource(CreateDataSourceRequest request)` Creates a data source.
`CreateKnowledgeBaseResponse`	`createKnowledgeBase(CreateKnowledgeBaseRequest request)` Creates a knowledge base.
`DeleteAgentResponse`	`deleteAgent(DeleteAgentRequest request)` Deletes an agent.
`DeleteAgentEndpointResponse`	`deleteAgentEndpoint(DeleteAgentEndpointRequest request)` Deletes an endpoint.
`DeleteDataIngestionJobResponse`	`deleteDataIngestionJob(DeleteDataIngestionJobRequest request)` Deletes a data ingestion job.
`DeleteDataSourceResponse`	`deleteDataSource(DeleteDataSourceRequest request)` Deletes a data source.
`DeleteKnowledgeBaseResponse`	`deleteKnowledgeBase(DeleteKnowledgeBaseRequest request)` Deletes a knowledge base.
`GetAgentResponse`	`getAgent(GetAgentRequest request)` Gets information about an agent.
`GetAgentEndpointResponse`	`getAgentEndpoint(GetAgentEndpointRequest request)` Gets information about an endpoint.
`GetDataIngestionJobResponse`	`getDataIngestionJob(GetDataIngestionJobRequest request)` Gets information about a data ingestion job.
`GetDataIngestionJobLogContentResponse`	`getDataIngestionJobLogContent(GetDataIngestionJobLogContentRequest request)` Returns the raw log file for the specified data ingestion job in text format.
`GetDataSourceResponse`	`getDataSource(GetDataSourceRequest request)` Gets information about a data source.
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`GetKnowledgeBaseResponse`	`getKnowledgeBase(GetKnowledgeBaseRequest request)` Gets information about a knowledge base.
`GenerativeAiAgentPaginators`	`getPaginators()` Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`GenerativeAiAgentWaiters`	`getWaiters()` Gets the pre-configured waiters available for resources for this service.
`GetWorkRequestResponse`	`getWorkRequest(GetWorkRequestRequest request)` Gets the details of a work request.
`ListAgentEndpointsResponse`	`listAgentEndpoints(ListAgentEndpointsRequest request)` Gets a list of endpoints.
`ListAgentsResponse`	`listAgents(ListAgentsRequest request)` Gets a list of agents.
`ListDataIngestionJobsResponse`	`listDataIngestionJobs(ListDataIngestionJobsRequest request)` Gets a list of data ingestion jobs.
`ListDataSourcesResponse`	`listDataSources(ListDataSourcesRequest request)` Gets a list of data sources.
`ListKnowledgeBasesResponse`	`listKnowledgeBases(ListKnowledgeBasesRequest request)` Gets a list of knowledge bases.
`ListWorkRequestErrorsResponse`	`listWorkRequestErrors(ListWorkRequestErrorsRequest request)` Lists the errors for a work request.
`ListWorkRequestLogsResponse`	`listWorkRequestLogs(ListWorkRequestLogsRequest request)` Lists the logs for a work request.
`ListWorkRequestsResponse`	`listWorkRequests(ListWorkRequestsRequest request)` Lists the work requests in a compartment.
`void`	`refreshClient()` Rebuilds the client from scratch.
`void`	`setEndpoint(String endpoint)` Sets the endpoint to call (ex, https://www.example.com).
`void`	`setRegion(Region region)` Sets the region to call (ex, Region.US_PHOENIX_1).
`void`	`setRegion(String regionId)` Sets the region to call (ex, ‘us-phoenix-1’).
`UpdateAgentResponse`	`updateAgent(UpdateAgentRequest request)` Updates an agent.
`UpdateAgentEndpointResponse`	`updateAgentEndpoint(UpdateAgentEndpointRequest request)` Updates an endpoint.
`UpdateDataSourceResponse`	`updateDataSource(UpdateDataSourceRequest request)` Updates a data source.
`UpdateKnowledgeBaseResponse`	`updateKnowledgeBase(UpdateKnowledgeBaseRequest request)` Updates a knowledge base.
`void`	`useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)` Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable
close

- Method Detail
  - refreshClient
```
void refreshClient()
```
    Rebuilds the client from scratch. Useful to refresh certificates.
  - setEndpoint
```
void setEndpoint(String endpoint)
```
    Sets the endpoint to call (ex, https://www.example.com).
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
String getEndpoint()
```
    Gets the set endpoint for REST call (ex, https://www.example.com)
  - setRegion
```
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.
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
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.
    
    Parameters:
    
    regionId - The public region ID.
  - useRealmSpecificEndpointTemplate
```
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”
    
    Parameters:
    
    realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template
  - cancelWorkRequest
```
CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)
```
    Cancels a work request.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CancelWorkRequest API.
  - changeAgentCompartment
```
ChangeAgentCompartmentResponse changeAgentCompartment(ChangeAgentCompartmentRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ChangeAgentCompartment API.
  - changeAgentEndpointCompartment
```
ChangeAgentEndpointCompartmentResponse changeAgentEndpointCompartment(ChangeAgentEndpointCompartmentRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ChangeAgentEndpointCompartment API.
  - changeKnowledgeBaseCompartment
```
ChangeKnowledgeBaseCompartmentResponse changeKnowledgeBaseCompartment(ChangeKnowledgeBaseCompartmentRequest request)
```
    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.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ChangeKnowledgeBaseCompartment API.
  - createAgent
```
CreateAgentResponse createAgent(CreateAgentRequest request)
```
    Creates an agent.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateAgent API.
  - createAgentEndpoint
```
CreateAgentEndpointResponse createAgentEndpoint(CreateAgentEndpointRequest request)
```
    Creates an endpoint.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateAgentEndpoint API.
  - createDataIngestionJob
```
CreateDataIngestionJobResponse createDataIngestionJob(CreateDataIngestionJobRequest request)
```
    Creates a data ingestion job.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateDataIngestionJob API.
  - createDataSource
```
CreateDataSourceResponse createDataSource(CreateDataSourceRequest request)
```
    Creates a data source.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateDataSource API.
  - createKnowledgeBase
```
CreateKnowledgeBaseResponse createKnowledgeBase(CreateKnowledgeBaseRequest request)
```
    Creates a knowledge base.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateKnowledgeBase API.
  - deleteAgent
```
DeleteAgentResponse deleteAgent(DeleteAgentRequest request)
```
    Deletes an agent.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteAgent API.
  - deleteAgentEndpoint
```
DeleteAgentEndpointResponse deleteAgentEndpoint(DeleteAgentEndpointRequest request)
```
    Deletes an endpoint.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteAgentEndpoint API.
  - deleteDataIngestionJob
```
DeleteDataIngestionJobResponse deleteDataIngestionJob(DeleteDataIngestionJobRequest request)
```
    Deletes a data ingestion job.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteDataIngestionJob API.
  - deleteDataSource
```
DeleteDataSourceResponse deleteDataSource(DeleteDataSourceRequest request)
```
    Deletes a data source.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteDataSource API.
  - deleteKnowledgeBase
```
DeleteKnowledgeBaseResponse deleteKnowledgeBase(DeleteKnowledgeBaseRequest request)
```
    Deletes a knowledge base.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteKnowledgeBase API.
  - getAgent
```
GetAgentResponse getAgent(GetAgentRequest request)
```
    Gets information about an agent.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetAgent API.
  - getAgentEndpoint
```
GetAgentEndpointResponse getAgentEndpoint(GetAgentEndpointRequest request)
```
    Gets information about an endpoint.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetAgentEndpoint API.
  - getDataIngestionJob
```
GetDataIngestionJobResponse getDataIngestionJob(GetDataIngestionJobRequest request)
```
    Gets information about a data ingestion job.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetDataIngestionJob API.
  - getDataIngestionJobLogContent
```
GetDataIngestionJobLogContentResponse getDataIngestionJobLogContent(GetDataIngestionJobLogContentRequest request)
```
    Returns the raw log file for the specified data ingestion job in text format.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetDataIngestionJobLogContent API.
  - getDataSource
```
GetDataSourceResponse getDataSource(GetDataSourceRequest request)
```
    Gets information about a data source.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetDataSource API.
  - getKnowledgeBase
```
GetKnowledgeBaseResponse getKnowledgeBase(GetKnowledgeBaseRequest request)
```
    Gets information about a knowledge base.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetKnowledgeBase API.
  - getWorkRequest
```
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
```
    Gets the details of a work request.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetWorkRequest API.
  - listAgentEndpoints
```
ListAgentEndpointsResponse listAgentEndpoints(ListAgentEndpointsRequest request)
```
    Gets a list of endpoints.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListAgentEndpoints API.
  - listAgents
```
ListAgentsResponse listAgents(ListAgentsRequest request)
```
    Gets a list of agents.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListAgents API.
  - listDataIngestionJobs
```
ListDataIngestionJobsResponse listDataIngestionJobs(ListDataIngestionJobsRequest request)
```
    Gets a list of data ingestion jobs.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListDataIngestionJobs API.
  - listDataSources
```
ListDataSourcesResponse listDataSources(ListDataSourcesRequest request)
```
    Gets a list of data sources.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListDataSources API.
  - listKnowledgeBases
```
ListKnowledgeBasesResponse listKnowledgeBases(ListKnowledgeBasesRequest request)
```
    Gets a list of knowledge bases.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListKnowledgeBases API.
  - listWorkRequestErrors
```
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
```
    Lists the errors for a work request.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListWorkRequestErrors API.
  - listWorkRequestLogs
```
ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
```
    Lists the logs for a work request.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListWorkRequestLogs API.
  - listWorkRequests
```
ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
```
    Lists the work requests in a compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListWorkRequests API.
  - updateAgent
```
UpdateAgentResponse updateAgent(UpdateAgentRequest request)
```
    Updates an agent.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateAgent API.
  - updateAgentEndpoint
```
UpdateAgentEndpointResponse updateAgentEndpoint(UpdateAgentEndpointRequest request)
```
    Updates an endpoint.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateAgentEndpoint API.
  - updateDataSource
```
UpdateDataSourceResponse updateDataSource(UpdateDataSourceRequest request)
```
    Updates a data source.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateDataSource API.
  - updateKnowledgeBase
```
UpdateKnowledgeBaseResponse updateKnowledgeBase(UpdateKnowledgeBaseRequest request)
```
    Updates a knowledge base.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateKnowledgeBase API.
  - getWaiters
```
GenerativeAiAgentWaiters getWaiters()
```
    Gets the pre-configured waiters available for resources for this service.
    
    Returns:
    
    The service waiters.
  - getPaginators
```
GenerativeAiAgentPaginators getPaginators()
```
    Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.
    
    Returns:
    
    The service paginators.

Interface GenerativeAiAgent

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

cancelWorkRequest

changeAgentCompartment

changeAgentEndpointCompartment

changeKnowledgeBaseCompartment

createAgent

createAgentEndpoint

createDataIngestionJob

createDataSource

createKnowledgeBase

deleteAgent

deleteAgentEndpoint

deleteDataIngestionJob

deleteDataSource

deleteKnowledgeBase

getAgent

getAgentEndpoint

getDataIngestionJob

getDataIngestionJobLogContent

getDataSource

getKnowledgeBase

getWorkRequest

listAgentEndpoints

listAgents

listDataIngestionJobs

listDataSources

listKnowledgeBases

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

updateAgent

updateAgentEndpoint

updateDataSource

updateKnowledgeBase

getWaiters

getPaginators