java.lang.Object
- com.oracle.bmc.http.internal.BaseSyncClient
- - com.oracle.bmc.generativeaiagent.GenerativeAiAgentClient

All Implemented Interfaces:: GenerativeAiAgent, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20240531")
public class GenerativeAiAgentClient
extends BaseSyncClient
implements GenerativeAiAgent

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class GenerativeAiAgentClient.Builder
Builder class for this client.

Field Summary

Fields
Modifier and Type	Field	Description
`String`	`clientCommonLibraryVersion`	Compatible SDK version, provided by the codegen.
`Optional<String>`	`minimumClientCommonLibraryVersionFromClient`	Minimum compatible SDK version, maybe provided by the codegen.
`static Service`	`SERVICE`	Service instance for GenerativeAiAgent.

Constructor Summary

Constructors
Constructor	Description
`GenerativeAiAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)`	Deprecated. Use the `builder` instead.
`GenerativeAiAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)`	Deprecated. Use the `builder` instead.
`GenerativeAiAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`GenerativeAiAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`GenerativeAiAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)`	Deprecated. Use the `builder` instead.
`GenerativeAiAgentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)`	Deprecated. Use the `builder` instead.
`GenerativeAiAgentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)`	Deprecated. Use the `builder` instead.
`GenerativeAiAgentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)`	Deprecated. Use the `builder` instead.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static GenerativeAiAgentClient.Builder`	`builder()`	Create a builder for this client.
`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.
`void`	`close()`
`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.
`CreateToolResponse`	`createTool(CreateToolRequest request)`	Creates a tool.
`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.
`DeleteToolResponse`	`deleteTool(DeleteToolRequest request)`	Deletes a tool.
`GetAgentResponse`	`getAgent(GetAgentRequest request)`	Gets information about an agent.
`GetAgentEndpointResponse`	`getAgentEndpoint(GetAgentEndpointRequest request)`	Gets information about an endpoint.
`String`	`getClientCommonLibraryVersion()`
`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.
`protected ClientConfigurator`	`getDefaultConfigurator()`
`String`	`getEndpoint()`
`GetKnowledgeBaseResponse`	`getKnowledgeBase(GetKnowledgeBaseRequest request)`	Gets information about a knowledge base.
`Optional<String>`	`getMinimumClientCommonLibraryVersionFromClient()`
`GenerativeAiAgentPaginators`	`getPaginators()`	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`GetToolResponse`	`getTool(GetToolRequest request)`	Gets information about a tool.
`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.
`ListToolsResponse`	`listTools(ListToolsRequest request)`	Gets a list of tools.
`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`	`populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)`	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
`void`	`refreshClient()`	Rebuild the backing `HttpClient`.
`void`	`setEndpoint(String endpoint)`
`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.
`void`	`updateBaseEndpoint(String endpoint)`	This method should be used for parameterized endpoint templates only.
`UpdateDataSourceResponse`	`updateDataSource(UpdateDataSourceRequest request)`	Updates a data source.
`UpdateKnowledgeBaseResponse`	`updateKnowledgeBase(UpdateKnowledgeBaseRequest request)`	Updates a knowledge base.
`UpdateToolResponse`	`updateTool(UpdateToolRequest request)`	Updates a tool.
`void`	`useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)`	This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable
close

Methods inherited from interface com.oracle.bmc.generativeaiagent.GenerativeAiAgent
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for GenerativeAiAgent.
  - clientCommonLibraryVersion
```
public final String clientCommonLibraryVersion
```
    Compatible SDK version, provided by the codegen.
  - minimumClientCommonLibraryVersionFromClient
```
public final Optional<String> minimumClientCommonLibraryVersionFromClient
```
    Minimum compatible SDK version, maybe provided by the codegen.
- Constructor Detail
  - GenerativeAiAgentClient
```
@Deprecated
public GenerativeAiAgentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GenerativeAiAgentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
  - GenerativeAiAgentClient
```
@Deprecated
public GenerativeAiAgentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GenerativeAiAgentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
  - GenerativeAiAgentClient
```
@Deprecated
public GenerativeAiAgentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GenerativeAiAgentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
  - GenerativeAiAgentClient
```
@Deprecated
public GenerativeAiAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator,
                               RequestSignerFactory defaultRequestSignerFactory)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GenerativeAiAgentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
  - GenerativeAiAgentClient
```
@Deprecated
public GenerativeAiAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator,
                               RequestSignerFactory defaultRequestSignerFactory,
                               List<ClientConfigurator> additionalClientConfigurators)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GenerativeAiAgentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
  - GenerativeAiAgentClient
```
@Deprecated
public GenerativeAiAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator,
                               RequestSignerFactory defaultRequestSignerFactory,
                               List<ClientConfigurator> additionalClientConfigurators,
                               String endpoint)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GenerativeAiAgentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
    
    endpoint - ClientBuilderBase.endpoint(java.lang.String)
  - GenerativeAiAgentClient
```
@Deprecated
public GenerativeAiAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator,
                               RequestSignerFactory defaultRequestSignerFactory,
                               Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                               List<ClientConfigurator> additionalClientConfigurators,
                               String endpoint)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GenerativeAiAgentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
    
    endpoint - ClientBuilderBase.endpoint(java.lang.String)
    
    signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories
  - GenerativeAiAgentClient
```
@Deprecated
public GenerativeAiAgentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator,
                               RequestSignerFactory defaultRequestSignerFactory,
                               Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                               List<ClientConfigurator> additionalClientConfigurators,
                               String endpoint,
                               ExecutorService executorService)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GenerativeAiAgentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
    
    endpoint - ClientBuilderBase.endpoint(java.lang.String)
    
    signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories
    
    executorService - GenerativeAiAgentClient.Builder.executorService
- Method Detail
  - builder
```
public static GenerativeAiAgentClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: GenerativeAiAgent
    
    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.
    
    Specified by:
    
    setRegion in interface GenerativeAiAgent
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: GenerativeAiAgent
    
    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.
    
    Specified by:
    
    setRegion in interface GenerativeAiAgent
    
    Parameters:
    
    regionId - The public region ID.
  - cancelWorkRequest
```
public CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Cancels a work request.
    
    Specified by:
    
    cancelWorkRequest in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - changeAgentCompartment
```
public ChangeAgentCompartmentResponse changeAgentCompartment(ChangeAgentCompartmentRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    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.
    
    Specified by:
    
    changeAgentCompartment in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - changeAgentEndpointCompartment
```
public ChangeAgentEndpointCompartmentResponse changeAgentEndpointCompartment(ChangeAgentEndpointCompartmentRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    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.
    
    Specified by:
    
    changeAgentEndpointCompartment in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - changeKnowledgeBaseCompartment
```
public ChangeKnowledgeBaseCompartmentResponse changeKnowledgeBaseCompartment(ChangeKnowledgeBaseCompartmentRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    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.
    
    Specified by:
    
    changeKnowledgeBaseCompartment in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createAgent
```
public CreateAgentResponse createAgent(CreateAgentRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Creates an agent.
    
    Specified by:
    
    createAgent in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createAgentEndpoint
```
public CreateAgentEndpointResponse createAgentEndpoint(CreateAgentEndpointRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Creates an endpoint.
    
    Specified by:
    
    createAgentEndpoint in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createDataIngestionJob
```
public CreateDataIngestionJobResponse createDataIngestionJob(CreateDataIngestionJobRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Creates a data ingestion job.
    
    Specified by:
    
    createDataIngestionJob in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createDataSource
```
public CreateDataSourceResponse createDataSource(CreateDataSourceRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Creates a data source.
    
    Specified by:
    
    createDataSource in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createKnowledgeBase
```
public CreateKnowledgeBaseResponse createKnowledgeBase(CreateKnowledgeBaseRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Creates a knowledge base.
    
    Specified by:
    
    createKnowledgeBase in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createTool
```
public CreateToolResponse createTool(CreateToolRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Creates a tool.
    
    Specified by:
    
    createTool in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteAgent
```
public DeleteAgentResponse deleteAgent(DeleteAgentRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Deletes an agent.
    
    Specified by:
    
    deleteAgent in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteAgentEndpoint
```
public DeleteAgentEndpointResponse deleteAgentEndpoint(DeleteAgentEndpointRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Deletes an endpoint.
    
    Specified by:
    
    deleteAgentEndpoint in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteDataIngestionJob
```
public DeleteDataIngestionJobResponse deleteDataIngestionJob(DeleteDataIngestionJobRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Deletes a data ingestion job.
    
    Specified by:
    
    deleteDataIngestionJob in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteDataSource
```
public DeleteDataSourceResponse deleteDataSource(DeleteDataSourceRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Deletes a data source.
    
    Specified by:
    
    deleteDataSource in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteKnowledgeBase
```
public DeleteKnowledgeBaseResponse deleteKnowledgeBase(DeleteKnowledgeBaseRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Deletes a knowledge base.
    
    Specified by:
    
    deleteKnowledgeBase in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteTool
```
public DeleteToolResponse deleteTool(DeleteToolRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Deletes a tool.
    
    Specified by:
    
    deleteTool in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getAgent
```
public GetAgentResponse getAgent(GetAgentRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Gets information about an agent.
    
    Specified by:
    
    getAgent in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getAgentEndpoint
```
public GetAgentEndpointResponse getAgentEndpoint(GetAgentEndpointRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Gets information about an endpoint.
    
    Specified by:
    
    getAgentEndpoint in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getDataIngestionJob
```
public GetDataIngestionJobResponse getDataIngestionJob(GetDataIngestionJobRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Gets information about a data ingestion job.
    
    Specified by:
    
    getDataIngestionJob in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getDataIngestionJobLogContent
```
public GetDataIngestionJobLogContentResponse getDataIngestionJobLogContent(GetDataIngestionJobLogContentRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Returns the raw log file for the specified data ingestion job in text format.
    
    Specified by:
    
    getDataIngestionJobLogContent in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getDataSource
```
public GetDataSourceResponse getDataSource(GetDataSourceRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Gets information about a data source.
    
    Specified by:
    
    getDataSource in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getKnowledgeBase
```
public GetKnowledgeBaseResponse getKnowledgeBase(GetKnowledgeBaseRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Gets information about a knowledge base.
    
    Specified by:
    
    getKnowledgeBase in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getTool
```
public GetToolResponse getTool(GetToolRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Gets information about a tool.
    
    Specified by:
    
    getTool in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWorkRequest
```
public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Gets the details of a work request.
    
    Specified by:
    
    getWorkRequest in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listAgentEndpoints
```
public ListAgentEndpointsResponse listAgentEndpoints(ListAgentEndpointsRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Gets a list of endpoints.
    
    Specified by:
    
    listAgentEndpoints in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listAgents
```
public ListAgentsResponse listAgents(ListAgentsRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Gets a list of agents.
    
    Specified by:
    
    listAgents in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listDataIngestionJobs
```
public ListDataIngestionJobsResponse listDataIngestionJobs(ListDataIngestionJobsRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Gets a list of data ingestion jobs.
    
    Specified by:
    
    listDataIngestionJobs in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listDataSources
```
public ListDataSourcesResponse listDataSources(ListDataSourcesRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Gets a list of data sources.
    
    Specified by:
    
    listDataSources in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listKnowledgeBases
```
public ListKnowledgeBasesResponse listKnowledgeBases(ListKnowledgeBasesRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Gets a list of knowledge bases.
    
    Specified by:
    
    listKnowledgeBases in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listTools
```
public ListToolsResponse listTools(ListToolsRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Gets a list of tools.
    
    Specified by:
    
    listTools in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequestErrors
```
public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Lists the errors for a work request.
    
    Specified by:
    
    listWorkRequestErrors in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequestLogs
```
public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Lists the logs for a work request.
    
    Specified by:
    
    listWorkRequestLogs in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequests
```
public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Lists the work requests in a compartment.
    
    Specified by:
    
    listWorkRequests in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateAgent
```
public UpdateAgentResponse updateAgent(UpdateAgentRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Updates an agent.
    
    Specified by:
    
    updateAgent in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateAgentEndpoint
```
public UpdateAgentEndpointResponse updateAgentEndpoint(UpdateAgentEndpointRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Updates an endpoint.
    
    Specified by:
    
    updateAgentEndpoint in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateDataSource
```
public UpdateDataSourceResponse updateDataSource(UpdateDataSourceRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Updates a data source.
    
    Specified by:
    
    updateDataSource in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateKnowledgeBase
```
public UpdateKnowledgeBaseResponse updateKnowledgeBase(UpdateKnowledgeBaseRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Updates a knowledge base.
    
    Specified by:
    
    updateKnowledgeBase in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateTool
```
public UpdateToolResponse updateTool(UpdateToolRequest request)
```
    Description copied from interface: GenerativeAiAgent
    
    Updates a tool.
    
    Specified by:
    
    updateTool in interface GenerativeAiAgent
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWaiters
```
public GenerativeAiAgentWaiters getWaiters()
```
    Description copied from interface: GenerativeAiAgent
    
    Gets the pre-configured waiters available for resources for this service.
    
    Specified by:
    
    getWaiters in interface GenerativeAiAgent
    
    Returns:
    
    The service waiters.
  - getPaginators
```
public GenerativeAiAgentPaginators getPaginators()
```
    Description copied from interface: GenerativeAiAgent
    
    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.
    
    Specified by:
    
    getPaginators in interface GenerativeAiAgent
    
    Returns:
    
    The service paginators.
  - getDefaultConfigurator
```
protected ClientConfigurator getDefaultConfigurator()
```
  - useRealmSpecificEndpointTemplate
```
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
```
    This method should be used to enable or disable the use of realm-specific endpoint template.
    The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
    
    Parameters:
    
    useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
  - populateServiceParametersInEndpoint
```
public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)
```
    Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
    The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.
    
    Parameters:
    
    endpoint - The endpoint template in use
    
    requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value
  - updateBaseEndpoint
```
public final void updateBaseEndpoint(String endpoint)
```
    This method should be used for parameterized endpoint templates only.
    This does not include {region} and {secondLevelDomain} parameters.
    
    Parameters:
    
    endpoint - The updated endpoint to use
  - setEndpoint
```
public final void setEndpoint(String endpoint)
```
  - getEndpoint
```
public final String getEndpoint()
```
  - refreshClient
```
public final void refreshClient()
```
    Rebuild the backing HttpClient.
    This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
  - close
```
public final void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - getClientCommonLibraryVersion
```
public String getClientCommonLibraryVersion()
```
  - getMinimumClientCommonLibraryVersionFromClient
```
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
```

Class GenerativeAiAgentClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.AutoCloseable

Methods inherited from interface com.oracle.bmc.generativeaiagent.GenerativeAiAgent

Field Detail

SERVICE

clientCommonLibraryVersion

minimumClientCommonLibraryVersionFromClient

Constructor Detail

GenerativeAiAgentClient

GenerativeAiAgentClient

GenerativeAiAgentClient

GenerativeAiAgentClient

GenerativeAiAgentClient

GenerativeAiAgentClient

GenerativeAiAgentClient

GenerativeAiAgentClient

Method Detail

builder

setRegion

setRegion

cancelWorkRequest

changeAgentCompartment

changeAgentEndpointCompartment

changeKnowledgeBaseCompartment

createAgent

createAgentEndpoint

createDataIngestionJob

createDataSource

createKnowledgeBase

createTool

deleteAgent

deleteAgentEndpoint

deleteDataIngestionJob

deleteDataSource

deleteKnowledgeBase

deleteTool

getAgent

getAgentEndpoint

getDataIngestionJob

getDataIngestionJobLogContent

getDataSource

getKnowledgeBase

getTool

getWorkRequest

listAgentEndpoints

listAgents

listDataIngestionJobs

listDataSources

listKnowledgeBases

listTools

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

updateAgent

updateAgentEndpoint

updateDataSource

updateKnowledgeBase

updateTool

getWaiters

getPaginators

getDefaultConfigurator

useRealmSpecificEndpointTemplate

populateServiceParametersInEndpoint

updateBaseEndpoint

setEndpoint

getEndpoint

refreshClient

close

getClientCommonLibraryVersion

getMinimumClientCommonLibraryVersionFromClient