Package com.oracle.bmc.generativeaiagentruntime

Class GenerativeAiAgentRuntimeClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.generativeaiagentruntime.GenerativeAiAgentRuntimeClient

All Implemented Interfaces:

GenerativeAiAgentRuntime, AutoCloseable

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GenerativeAiAgentRuntimeClient.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 GenerativeAiAgentRuntime.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static GenerativeAiAgentRuntimeClient.Builder	builder()	Create a builder for this client.
ChatResponse	chat(ChatRequest request)	Chat on endpoint with provided messages.
void	close()
CreateSessionResponse	createSession(CreateSessionRequest request)	A session represents an interactive conversation initiated by a user through an API to engage with an agent.
DeleteSessionResponse	deleteSession(DeleteSessionRequest request)	Delete a session and all its associated information.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
GetSessionResponse	getSession(GetSessionRequest request)	Return the session resource identified by the session ID.
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.
RetrieveMetadataResponse	retrieveMetadata(RetrieveMetadataRequest request)	Returns metadata of provided knowledgeBase.
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’).
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
UpdateSessionResponse	updateSession(UpdateSessionRequest request)	Update session metadata, including but not limited to description, tags.
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.generativeaiagentruntime.GenerativeAiAgentRuntime

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for GenerativeAiAgentRuntime.

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

GenerativeAiAgentRuntimeClient

@Deprecated
public GenerativeAiAgentRuntimeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GenerativeAiAgentRuntimeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

GenerativeAiAgentRuntimeClient

@Deprecated
public GenerativeAiAgentRuntimeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                      ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GenerativeAiAgentRuntimeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

GenerativeAiAgentRuntimeClient

@Deprecated
public GenerativeAiAgentRuntimeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                      ClientConfiguration configuration,
                                      ClientConfigurator clientConfigurator)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GenerativeAiAgentRuntimeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

GenerativeAiAgentRuntimeClient

@Deprecated
public GenerativeAiAgentRuntimeClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                      ClientConfiguration configuration,
                                      ClientConfigurator clientConfigurator,
                                      RequestSignerFactory defaultRequestSignerFactory)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GenerativeAiAgentRuntimeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

GenerativeAiAgentRuntimeClient

@Deprecated
public GenerativeAiAgentRuntimeClient(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 GenerativeAiAgentRuntimeClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

GenerativeAiAgentRuntimeClient

@Deprecated
public GenerativeAiAgentRuntimeClient(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 GenerativeAiAgentRuntimeClient.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)

GenerativeAiAgentRuntimeClient

@Deprecated
public GenerativeAiAgentRuntimeClient(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 GenerativeAiAgentRuntimeClient.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

Method Detail

builder

public static GenerativeAiAgentRuntimeClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: GenerativeAiAgentRuntime

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 GenerativeAiAgentRuntime

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: GenerativeAiAgentRuntime

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 GenerativeAiAgentRuntime

Parameters:

regionId - The public region ID.

chat

public ChatResponse chat(ChatRequest request)

Description copied from interface: GenerativeAiAgentRuntime

Chat on endpoint with provided messages.

Specified by:

chat in interface GenerativeAiAgentRuntime

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createSession

public CreateSessionResponse createSession(CreateSessionRequest request)

Description copied from interface: GenerativeAiAgentRuntime

A session represents an interactive conversation initiated by a user through an API to engage with an agent.

It involves a series of exchanges where the user sends queries or prompts, and the agent responds with relevant information, actions, or assistance based on the user’s input. The session persists for the duration of the interaction, maintaining context and continuity to provide coherent and meaningful responses throughout the conversation.Creates an agent session.

Use this API to create an agent session.

Specified by:

createSession in interface GenerativeAiAgentRuntime

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteSession

public DeleteSessionResponse deleteSession(DeleteSessionRequest request)

Description copied from interface: GenerativeAiAgentRuntime

Delete a session and all its associated information.

Specified by:

deleteSession in interface GenerativeAiAgentRuntime

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getSession

public GetSessionResponse getSession(GetSessionRequest request)

Description copied from interface: GenerativeAiAgentRuntime

Return the session resource identified by the session ID.

Specified by:

getSession in interface GenerativeAiAgentRuntime

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

retrieveMetadata

public RetrieveMetadataResponse retrieveMetadata(RetrieveMetadataRequest request)

Description copied from interface: GenerativeAiAgentRuntime

Returns metadata of provided knowledgeBase.

Return available metadata with information of field names, their types, supported operations, and possible values.

Specified by:

retrieveMetadata in interface GenerativeAiAgentRuntime

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateSession

public UpdateSessionResponse updateSession(UpdateSessionRequest request)

Description copied from interface: GenerativeAiAgentRuntime

Update session metadata, including but not limited to description, tags.

Specified by:

updateSession in interface GenerativeAiAgentRuntime

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

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