Package com.oracle.bmc.ailanguage

Interface AIServiceLanguage

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    AIServiceLanguageClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20221001")
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 Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

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

      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        Determines whether realm specific endpoint should be used or not.

        Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

        Parameters:
        realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

      • batchDetectDominantLanguage

        BatchDetectDominantLanguageResponse batchDetectDominantLanguage​(BatchDetectDominantLanguageRequest request)
        The API returns the detected language and a related confidence score (between 0 and 1).

        It supports passing a batch of records.

        [List of supported languages.](https://docs.oracle.com/iaas/language/using/pretrain-models.htm#lang-detect)

        Limitations: - A batch may have up to 100 records. - A record may be up to 5000 characters long. - The total of characters to process in a request can be up to 20,000 characters.

        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/BatchDetectDominantLanguageExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use BatchDetectDominantLanguage API.

      • batchDetectHealthEntity

        BatchDetectHealthEntityResponse batchDetectHealthEntity​(BatchDetectHealthEntityRequest request)
        The API extracts health entities in text records.

        For each entity, its type and confidence score (between 0 and 1) is returned. It supports passing a batch of records.

        Limitations: - A batch may have up to 100 records. - A record may be up to 5000 characters long. - The total of characters to process in a request can be up to 20,000 characters.

        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/BatchDetectHealthEntityExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use BatchDetectHealthEntity API.

      • batchDetectLanguageEntities

        BatchDetectLanguageEntitiesResponse batchDetectLanguageEntities​(BatchDetectLanguageEntitiesRequest request)
        The API extracts entities in text records.

        For each entity, its type/subtype and confidence score (between 0 and 1) is returned. It supports passing a batch of records.

        [List of supported entities.](https://docs.oracle.com/iaas/language/using/pretrain-models.htm#ner__sup-ner-entity)

        Limitations: - A batch may have up to 100 records. - A record may be up to 5000 characters long. - The total of characters to process in a request can be up to 20,000 characters.

        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/BatchDetectLanguageEntitiesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use BatchDetectLanguageEntities API.

      • batchDetectLanguageKeyPhrases

        BatchDetectLanguageKeyPhrasesResponse batchDetectLanguageKeyPhrases​(BatchDetectLanguageKeyPhrasesRequest request)
        The API extracts key-phrases in text records.

        For each key-phrase, a score (between 0 and 1) is returned that highlights the importance of the key-phrase in the context of the text. It supports passing a batch of records.

        Limitations: - A batch may have up to 100 records. - A record may be up to 5000 characters long. - The total of characters to process in a request can be up to 20,000 characters.

        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/BatchDetectLanguageKeyPhrasesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use BatchDetectLanguageKeyPhrases API.

      • batchDetectLanguagePiiEntities

        BatchDetectLanguagePiiEntitiesResponse batchDetectLanguagePiiEntities​(BatchDetectLanguagePiiEntitiesRequest request)
        The API extracts pii entities in text records.

        For each entity, its type and confidence score (between 0 and 1) is returned. It supports passing a batch of records.

        Limitations: - A batch may have up to 100 records. - A record may be up to 5000 characters long. - The total of characters to process in a request can be up to 20,000 characters.

        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/BatchDetectLanguagePiiEntitiesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use BatchDetectLanguagePiiEntities API.

      • batchDetectLanguageSentiments

        BatchDetectLanguageSentimentsResponse batchDetectLanguageSentiments​(BatchDetectLanguageSentimentsRequest request)
        The API extracts aspect-based and sentence level sentiment in text records.

        For aspect-based sentiment analysis, a set of aspects and their respective sentiment is returned for each record. Similarly, for sentence-level sentiment analysis, the sentiment is returned at the sentence level.

        For sentiment analysis, confidence scores are provided for each of the classes (positive, negative, neutral and mixed).

        Learn more about sentiment analysis [here](https://docs.oracle.com/iaas/language/using/pretrain-models.htm#sentiment).

        Limitations: - A batch may have up to 100 records. - A record may be up to 5000 characters long. - The total of characters to process in a request can be up to 20,000 characters.

        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/BatchDetectLanguageSentimentsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use BatchDetectLanguageSentiments API.

      • batchDetectLanguageTextClassification

        BatchDetectLanguageTextClassificationResponse batchDetectLanguageTextClassification​(BatchDetectLanguageTextClassificationRequest request)
        The API automatically classifies text into a set of pre-determined classes and sub-classes.

        A single class/subclass is returned for each record classified.

        It supports passing a batch of records.

        Learn more about text classification [here](https://docs.oracle.com/iaas/language/using/pretrain-models.htm#text-class).

        Limitations: - A batch may have up to 100 records. - A record may be up to 5000 characters long. - The total of characters to process in a request can be up to 20,000 characters.

        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/BatchDetectLanguageTextClassificationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use BatchDetectLanguageTextClassification API.

      • batchLanguageTranslation

        BatchLanguageTranslationResponse batchLanguageTranslation​(BatchLanguageTranslationRequest request)
        Translates a batch of text documents from source to target language.

        A batch can contain: - up to 100 records. - documents length less than 5000 characters. - 20,000 characters in total as a sum of all documents length.

        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/BatchLanguageTranslationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use BatchLanguageTranslation API.

      • cancelJob

        CancelJobResponse cancelJob​(CancelJobRequest request)
        Canceling the job cancels all the tasks under it.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/CancelJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CancelJob API.

      • changeEndpointCompartment

        ChangeEndpointCompartmentResponse changeEndpointCompartment​(ChangeEndpointCompartmentRequest request)
        Moves a Endpoint into a different compartment.

        When provided, If-Match is checked against ETag values of the resource.

        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/ChangeEndpointCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeEndpointCompartment API.

      • changeJobCompartment

        ChangeJobCompartmentResponse changeJobCompartment​(ChangeJobCompartmentRequest request)
        Moves a Job into a different compartment.

        When provided, If-Match is checked against ETag values of the resource.

        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/ChangeJobCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeJobCompartment API.

      • changeModelCompartment

        ChangeModelCompartmentResponse changeModelCompartment​(ChangeModelCompartmentRequest request)
        Moves a Model into a different compartment.

        When provided, If-Match is checked against ETag values of the resource.

        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/ChangeModelCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeModelCompartment API.

      • changeProjectCompartment

        ChangeProjectCompartmentResponse changeProjectCompartment​(ChangeProjectCompartmentRequest request)
        Moves a Project into a different compartment.

        When provided, If-Match is checked against ETag values of the resource.

        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/ChangeProjectCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeProjectCompartment API.

      • createEndpoint

        CreateEndpointResponse createEndpoint​(CreateEndpointRequest request)
        Creates a new endpoint and deploy the trained 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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/CreateEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateEndpoint API.

      • createJob

        CreateJobResponse createJob​(CreateJobRequest request)
        Creates a new language service async job.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/CreateJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateJob API.

      • createModel

        CreateModelResponse createModel​(CreateModelRequest request)
        Creates a new model for training and train the model with date provided.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/CreateModelExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateModel API.

      • createProject

        CreateProjectResponse createProject​(CreateProjectRequest request)
        Creates a new Project.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/CreateProjectExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateProject API.

      • deleteEndpoint

        DeleteEndpointResponse deleteEndpoint​(DeleteEndpointRequest request)
        Deletes a provisioned endpoint resource by identifier.

        This operation fails with a 409 error unless all associated resources are in a DELETED state. You must delete all associated resources before deleting a 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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/DeleteEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteEndpoint API.

      • deleteJob

        DeleteJobResponse deleteJob​(DeleteJobRequest request)
        Deletes the language service async Job
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/DeleteJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteJob API.

      • deleteModel

        DeleteModelResponse deleteModel​(DeleteModelRequest request)
        Deletes a provisioned model resource by identifier.

        This operation fails with a 409 error unless all associated resources are in a DELETED state. You must delete all associated resources before deleting a 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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/DeleteModelExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteModel API.

      • deleteProject

        DeleteProjectResponse deleteProject​(DeleteProjectRequest request)
        Deletes a Project resource by identifier.

        This operation fails with a 409 error unless all associated resources (models deployments or data assets) are in a DELETED state. You must delete all associated resources before deleting a project.

        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/DeleteProjectExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteProject API.

      • detectDominantLanguage

        DetectDominantLanguageResponse detectDominantLanguage​(DetectDominantLanguageRequest request)
        Deprecated: This API will be retired Tuesday, 10 Oct 2023 00:00:00 GMT.

        We recommend you replace this API with the batch API, BatchDetectDominantLanguage.

        The DetectDominantLanguage API returns the detected language and a related confidence score (between 0 and 1).

        [List of supported languages](https://docs.oracle.com/iaas/language/using/pretrain-models.htm#lang-detect)

        Limitations: - A record may be up to 1000 characters long.

        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/DetectDominantLanguageExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DetectDominantLanguage API.

      • detectLanguageEntities

        DetectLanguageEntitiesResponse detectLanguageEntities​(DetectLanguageEntitiesRequest request)
        Deprecated: This API will be retired Tuesday, 10 Oct 2023 00:00:00 GMT.

        We recommend you replace this API with the batch API, BatchDetectLanguageEntities.

        The DetectLanguageEntities API extracts entities in text records. For each entity, its type and confidence score (between 0 and 1) is returned.

        Limitations: - A text may be up to 1000 characters long.

        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/DetectLanguageEntitiesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DetectLanguageEntities API.

      • detectLanguageKeyPhrases

        DetectLanguageKeyPhrasesResponse detectLanguageKeyPhrases​(DetectLanguageKeyPhrasesRequest request)
        Deprecated: This API will be retired Tuesday, 10 Oct 2023 00:00:00 GMT.

        We recommend you replace this API with the batch API, BatchDetectLanguageKeyPhrases.

        The DetectLanguageKeyPhrases API extracts key-phrases in text records. For each key-phrase, a score (between 0 and 1) is returned that highlights the importance of the key-phrase in the context of the text. Limitations: - A record may be up to 1000 characters long.

        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/DetectLanguageKeyPhrasesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DetectLanguageKeyPhrases API.

      • detectLanguageSentiments

        DetectLanguageSentimentsResponse detectLanguageSentiments​(DetectLanguageSentimentsRequest request)
        Deprecated: This API will be retired Tuesday, 10 Oct 2023 00:00:00 GMT.

        We recommend you replace this API with the batch API, BatchDetectLanguageSentiments.

        The DetectLanguageSentiments API extracts aspect-based in text records.

        For aspect-based sentiment analysis, a set of aspects and their respective sentiment is returned.

        For sentiment analysis, confidence scores are provided for each of the classes (positive, negative, neutral).

        Learn more about sentiment analysis [here](https://docs.oracle.com/iaas/language/using/pretrain-models.htm#sentiment).

        Limitations: - A record may be up to 1000 characters long.

        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/DetectLanguageSentimentsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DetectLanguageSentiments API.

      • detectLanguageTextClassification

        DetectLanguageTextClassificationResponse detectLanguageTextClassification​(DetectLanguageTextClassificationRequest request)
        Deprecated: This API will be retired Tuesday, 10 Oct 2023 00:00:00 GMT.

        We recommend you replace this API with the batch API, BatchDetectLanguageTextClassification.

        The DetectLanguageTextClassification API automatically classifies text into a set of pre-determined classes and sub-classes. A single class/subclass is returned for each record classified.

        Learn more about text classification [here](https://docs.oracle.com/iaas/language/using/pretrain-models.htm#text-class).

        Limitations: - A record may be up to 1000 characters long.

        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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/DetectLanguageTextClassificationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DetectLanguageTextClassification API.

      • getEndpoint

        GetEndpointResponse getEndpoint​(GetEndpointRequest request)
        Gets an endpoint by identifier
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/GetEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetEndpoint API.

      • getJob

        GetJobResponse getJob​(GetJobRequest request)
        Gets a language service async job
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/GetJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetJob API.

      • getModel

        GetModelResponse getModel​(GetModelRequest request)
        Gets a model by identifier
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/GetModelExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetModel API.

      • getModelType

        GetModelTypeResponse getModelType​(GetModelTypeRequest request)
        Gets model capabilities
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/GetModelTypeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetModelType API.

      • getProject

        GetProjectResponse getProject​(GetProjectRequest request)
        Gets a Project by identifier
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/GetProjectExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetProject API.

      • getWorkRequest

        GetWorkRequestResponse getWorkRequest​(GetWorkRequestRequest request)
        Gets the status of the work request with the given ID.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/GetWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetWorkRequest API.

      • listEndpoints

        ListEndpointsResponse listEndpoints​(ListEndpointsRequest request)
        Returns a list of Endpoints.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/ListEndpointsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListEndpoints API.

      • listEvaluationResults

        ListEvaluationResultsResponse listEvaluationResults​(ListEvaluationResultsRequest request)
        Get a (paginated) list of evaluation results for a given 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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/ListEvaluationResultsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListEvaluationResults API.

      • listJobs

        ListJobsResponse listJobs​(ListJobsRequest request)
        Returns a list of language service async Jobs.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/ListJobsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListJobs API.

      • listModels

        ListModelsResponse listModels​(ListModelsRequest request)
        Returns a list of models.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/ListModelsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListModels API.

      • listProjects

        ListProjectsResponse listProjects​(ListProjectsRequest request)
        Returns a list of Projects.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/ListProjectsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListProjects API.

      • listWorkRequestErrors

        ListWorkRequestErrorsResponse listWorkRequestErrors​(ListWorkRequestErrorsRequest request)
        Return a (paginated) list of errors for a given work request.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/ListWorkRequestErrorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestErrors API.

      • listWorkRequestLogs

        ListWorkRequestLogsResponse listWorkRequestLogs​(ListWorkRequestLogsRequest request)
        Return a (paginated) list of logs for a given work request.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/ListWorkRequestLogsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestLogs API.

      • listWorkRequests

        ListWorkRequestsResponse listWorkRequests​(ListWorkRequestsRequest request)
        Lists the work requests in a compartment.
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/ListWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequests API.

      • updateEndpoint

        UpdateEndpointResponse updateEndpoint​(UpdateEndpointRequest request)
        Update the Endpoint identified by the id
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/UpdateEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateEndpoint API.

      • updateJob

        UpdateJobResponse updateJob​(UpdateJobRequest request)
        Updates the language service async Job
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/UpdateJobExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateJob API.

      • updateModel

        UpdateModelResponse updateModel​(UpdateModelRequest request)
        Updates the 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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/UpdateModelExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateModel API.

      • updateProject

        UpdateProjectResponse updateProject​(UpdateProjectRequest request)
        Updates the Project
        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ailanguage/UpdateProjectExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateProject API.

      • getWaiters

        AIServiceLanguageWaiters getWaiters()
        Gets the pre-configured waiters available for resources for this service.
        Returns:
        The service waiters.

      • getPaginators

        AIServiceLanguagePaginators getPaginators()
        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.

        Returns:
        The service paginators.