com.oracle.bmc.generativeaiagent

Class GenerativeAiAgentClient

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 and Description
static class	GenerativeAiAgentClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and 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 and 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

Modifier and Type	Method and Description
static GenerativeAiAgentClient.Builder	builder() Create a builder for this client.
CancelWorkRequestResponse	cancelWorkRequest(CancelWorkRequestRequest request) CancelWorkRequest
ChangeAgentCompartmentResponse	changeAgentCompartment(ChangeAgentCompartmentRequest request) ChangeAgentCompartment
ChangeAgentEndpointCompartmentResponse	changeAgentEndpointCompartment(ChangeAgentEndpointCompartmentRequest request) ChangeAgentEndpointCompartment
ChangeKnowledgeBaseCompartmentResponse	changeKnowledgeBaseCompartment(ChangeKnowledgeBaseCompartmentRequest request) ChangeKnowledgeBaseCompartment
void	close()
CreateAgentResponse	createAgent(CreateAgentRequest request) CreateAgent
CreateAgentEndpointResponse	createAgentEndpoint(CreateAgentEndpointRequest request) CreateAgentEndpoint
CreateDataIngestionJobResponse	createDataIngestionJob(CreateDataIngestionJobRequest request) CreateDataIngestionJob
CreateDataSourceResponse	createDataSource(CreateDataSourceRequest request) CreateDataSource
CreateKnowledgeBaseResponse	createKnowledgeBase(CreateKnowledgeBaseRequest request) CreateKnowledgeBase
DeleteAgentResponse	deleteAgent(DeleteAgentRequest request) DeleteAgent
DeleteAgentEndpointResponse	deleteAgentEndpoint(DeleteAgentEndpointRequest request) DeleteAgentEndpoint
DeleteDataIngestionJobResponse	deleteDataIngestionJob(DeleteDataIngestionJobRequest request) DeleteDataIngestionJob
DeleteDataSourceResponse	deleteDataSource(DeleteDataSourceRequest request) DeleteDataSource
DeleteKnowledgeBaseResponse	deleteKnowledgeBase(DeleteKnowledgeBaseRequest request) DeleteKnowledgeBase
GetAgentResponse	getAgent(GetAgentRequest request) GetAgent
GetAgentEndpointResponse	getAgentEndpoint(GetAgentEndpointRequest request) GetAgentEndpoint
String	getClientCommonLibraryVersion()
GetDataIngestionJobResponse	getDataIngestionJob(GetDataIngestionJobRequest request) GetDataIngestionJob
GetDataIngestionJobLogContentResponse	getDataIngestionJobLogContent(GetDataIngestionJobLogContentRequest request) GetDataIngestionJobLogContent
GetDataSourceResponse	getDataSource(GetDataSourceRequest request) GetDataSource
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
GetKnowledgeBaseResponse	getKnowledgeBase(GetKnowledgeBaseRequest request) GetKnowledgeBase
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
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) GetWorkRequest
ListAgentEndpointsResponse	listAgentEndpoints(ListAgentEndpointsRequest request) ListAgentEndpoints
ListAgentsResponse	listAgents(ListAgentsRequest request) ListAgents
ListDataIngestionJobsResponse	listDataIngestionJobs(ListDataIngestionJobsRequest request) ListDataIngestionJobs
ListDataSourcesResponse	listDataSources(ListDataSourcesRequest request) ListDataSources
ListKnowledgeBasesResponse	listKnowledgeBases(ListKnowledgeBasesRequest request) ListKnowledgeBases
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request) ListWorkRequestErrors
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request) ListWorkRequestLogs
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request) ListWorkRequests
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) UpdateAgent
UpdateAgentEndpointResponse	updateAgentEndpoint(UpdateAgentEndpointRequest request) UpdateAgentEndpoint
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
UpdateDataSourceResponse	updateDataSource(UpdateDataSourceRequest request) UpdateDataSource
UpdateKnowledgeBaseResponse	updateKnowledgeBase(UpdateKnowledgeBaseRequest request) UpdateKnowledgeBase
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 com.oracle.bmc.generativeaiagent.GenerativeAiAgent

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

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

CancelWorkRequest

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

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).

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

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).

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

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).

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

CreateAgent

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

CreateAgentEndpoint

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

CreateDataIngestionJob

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

CreateDataSource

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

CreateKnowledgeBase

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

deleteAgent

public DeleteAgentResponse deleteAgent(DeleteAgentRequest request)

Description copied from interface: GenerativeAiAgent

DeleteAgent

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

DeleteAgentEndpoint

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

DeleteDataIngestionJob

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

DeleteDataSource

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

DeleteKnowledgeBase

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

getAgent

public GetAgentResponse getAgent(GetAgentRequest request)

Description copied from interface: GenerativeAiAgent

GetAgent

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

GetAgentEndpoint

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

GetDataIngestionJob

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

GetDataIngestionJobLogContent

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

GetDataSource

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

GetKnowledgeBase

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

getWorkRequest

public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

Description copied from interface: GenerativeAiAgent

GetWorkRequest

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

ListAgentEndpoints

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

ListAgents

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

ListDataIngestionJobs

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

ListDataSources

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

ListKnowledgeBases

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

listWorkRequestErrors

public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

Description copied from interface: GenerativeAiAgent

ListWorkRequestErrors

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

ListWorkRequestLogs

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

ListWorkRequests

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

UpdateAgent

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

UpdateAgentEndpoint

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

UpdateDataSource

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

UpdateKnowledgeBase

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

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()