com.oracle.bmc.ailanguage

Interface AIServiceLanguage

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AIServiceLanguageClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210101")
public interface AIServiceLanguage
extends AutoCloseable

OCI Language Service solutions can help enterprise customers integrate AI into their products immediately using our proven, pre-trained and custom models or containers, without a need to set up an house team of AI and ML experts. This allows enterprises to focus on business drivers and development work rather than AI and ML operations, which shortens the time to market.

This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

Modifier and Type	Method and Description
BatchDetectDominantLanguageResponse	batchDetectDominantLanguage(BatchDetectDominantLanguageRequest request) Make a detect call to language detection pre-deployed model.
BatchDetectLanguageEntitiesResponse	batchDetectLanguageEntities(BatchDetectLanguageEntitiesRequest request) Make a batch detect call to entity pre-deployed model
BatchDetectLanguageKeyPhrasesResponse	batchDetectLanguageKeyPhrases(BatchDetectLanguageKeyPhrasesRequest request) Make a detect call to the keyPhrase pre-deployed model.
BatchDetectLanguageSentimentsResponse	batchDetectLanguageSentiments(BatchDetectLanguageSentimentsRequest request) Make a detect call to sentiment pre-deployed model.
BatchDetectLanguageTextClassificationResponse	batchDetectLanguageTextClassification(BatchDetectLanguageTextClassificationRequest request) Make a detect call to text classification from the pre-deployed model.
DetectDominantLanguageResponse	detectDominantLanguage(DetectDominantLanguageRequest request) Make a detect call to language detection pre-deployed model.
DetectLanguageEntitiesResponse	detectLanguageEntities(DetectLanguageEntitiesRequest request) Make a detect call to enitiy pre-deployed model
DetectLanguageKeyPhrasesResponse	detectLanguageKeyPhrases(DetectLanguageKeyPhrasesRequest request) Make a detect call to the keyPhrase pre-deployed model.
DetectLanguageSentimentsResponse	detectLanguageSentiments(DetectLanguageSentimentsRequest request) Make a detect call to sentiment pre-deployed model.
DetectLanguageTextClassificationResponse	detectLanguageTextClassification(DetectLanguageTextClassificationRequest request) Make a detect call to text classification from the pre-deployed model.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the service.

getEndpoint

String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

setRegion

void setRegion(Region region)

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

Parameters:

region - The region of the service.

setRegion

void setRegion(String regionId)

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Parameters:

regionId - The public region ID.

batchDetectDominantLanguage

BatchDetectDominantLanguageResponse batchDetectDominantLanguage(BatchDetectDominantLanguageRequest request)

Make a detect call to language detection pre-deployed model.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use BatchDetectDominantLanguage API.

batchDetectLanguageEntities

BatchDetectLanguageEntitiesResponse batchDetectLanguageEntities(BatchDetectLanguageEntitiesRequest request)

Make a batch detect call to entity pre-deployed model

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use BatchDetectLanguageEntities API.

batchDetectLanguageKeyPhrases

BatchDetectLanguageKeyPhrasesResponse batchDetectLanguageKeyPhrases(BatchDetectLanguageKeyPhrasesRequest request)

Make a detect call to the keyPhrase pre-deployed model.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use BatchDetectLanguageKeyPhrases API.

batchDetectLanguageSentiments

BatchDetectLanguageSentimentsResponse batchDetectLanguageSentiments(BatchDetectLanguageSentimentsRequest request)

Make a detect call to sentiment pre-deployed model.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use BatchDetectLanguageSentiments API.

batchDetectLanguageTextClassification

BatchDetectLanguageTextClassificationResponse batchDetectLanguageTextClassification(BatchDetectLanguageTextClassificationRequest request)

Make a detect call to text classification from the pre-deployed model.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use BatchDetectLanguageTextClassification API.

detectDominantLanguage

DetectDominantLanguageResponse detectDominantLanguage(DetectDominantLanguageRequest request)

Make a detect call to language detection pre-deployed model.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use DetectDominantLanguage API.

detectLanguageEntities

DetectLanguageEntitiesResponse detectLanguageEntities(DetectLanguageEntitiesRequest request)

Make a detect call to enitiy pre-deployed model

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use DetectLanguageEntities API.

detectLanguageKeyPhrases

DetectLanguageKeyPhrasesResponse detectLanguageKeyPhrases(DetectLanguageKeyPhrasesRequest request)

Make a detect call to the keyPhrase pre-deployed model.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use DetectLanguageKeyPhrases API.

detectLanguageSentiments

DetectLanguageSentimentsResponse detectLanguageSentiments(DetectLanguageSentimentsRequest request)

Make a detect call to sentiment pre-deployed model.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use DetectLanguageSentiments API.

detectLanguageTextClassification

DetectLanguageTextClassificationResponse detectLanguageTextClassification(DetectLanguageTextClassificationRequest request)

Make a detect call to text classification from the pre-deployed model.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use DetectLanguageTextClassification API.