Package com.oracle.bmc.generativeaiinference

Class GenerativeAiInferenceClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.generativeaiinference.GenerativeAiInferenceClient

All Implemented Interfaces:

GenerativeAiInference, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20231130")
public class GenerativeAiInferenceClient
extends BaseSyncClient
implements GenerativeAiInference

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ApplyGuardrailsResponse	applyGuardrails(ApplyGuardrailsRequest request)	Applies guardrails to the input text, including content moderation, PII detection, and prompt injection protection.
static GenerativeAiInferenceClient.Builder	builder()	Create a builder for this client.
ChatResponse	chat(ChatRequest request)	Creates a response for the given conversation.
void	close()
EmbedTextResponse	embedText(EmbedTextRequest request)	Produces embeddings for the inputs.
GenerateTextResponse	generateText(GenerateTextRequest request)	Generates a text response based on the user prompt.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
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.
RerankTextResponse	rerankText(RerankTextRequest request)	Reranks the text responses based on the input documents and a prompt.
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’).
SummarizeTextResponse	summarizeText(SummarizeTextRequest request)	Summarizes the input text.
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
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.generativeaiinference.GenerativeAiInference

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for GenerativeAiInference.

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

GenerativeAiInferenceClient

@Deprecated
public GenerativeAiInferenceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

GenerativeAiInferenceClient

@Deprecated
public GenerativeAiInferenceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                   ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

GenerativeAiInferenceClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

GenerativeAiInferenceClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

GenerativeAiInferenceClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

GenerativeAiInferenceClient

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

GenerativeAiInferenceClient

@Deprecated
public GenerativeAiInferenceClient(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 GenerativeAiInferenceClient.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 GenerativeAiInferenceClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: GenerativeAiInference

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 GenerativeAiInference

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: GenerativeAiInference

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 GenerativeAiInference

Parameters:

regionId - The public region ID.

applyGuardrails

public ApplyGuardrailsResponse applyGuardrails(ApplyGuardrailsRequest request)

Description copied from interface: GenerativeAiInference

Applies guardrails to the input text, including content moderation, PII detection, and prompt injection protection.

Specified by:

applyGuardrails in interface GenerativeAiInference

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

chat

public ChatResponse chat(ChatRequest request)

Description copied from interface: GenerativeAiInference

Creates a response for the given conversation.

Specified by:

chat in interface GenerativeAiInference

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

embedText

public EmbedTextResponse embedText(EmbedTextRequest request)

Description copied from interface: GenerativeAiInference

Produces embeddings for the inputs.

An embedding is numeric representation of a piece of text. This text can be a phrase, a sentence, or one or more paragraphs. The Generative AI embedding model transforms each phrase, sentence, or paragraph that you input, into an array with 1024 numbers. You can use these embeddings for finding similarity in your input text such as finding phrases that are similar in context or category. Embeddings are mostly used for semantic searches where the search function focuses on the meaning of the text that it's searching through rather than finding results based on keywords.

Specified by:

embedText in interface GenerativeAiInference

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

generateText

public GenerateTextResponse generateText(GenerateTextRequest request)

Description copied from interface: GenerativeAiInference

Generates a text response based on the user prompt.

Specified by:

generateText in interface GenerativeAiInference

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

rerankText

public RerankTextResponse rerankText(RerankTextRequest request)

Description copied from interface: GenerativeAiInference

Reranks the text responses based on the input documents and a prompt.

Rerank assigns an index and a relevance score to each document, indicating which document is most related to the prompt.

Specified by:

rerankText in interface GenerativeAiInference

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

summarizeText

public SummarizeTextResponse summarizeText(SummarizeTextRequest request)

Description copied from interface: GenerativeAiInference

Summarizes the input text.

Specified by:

summarizeText in interface GenerativeAiInference

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