AIServiceLanguageAsync (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AIServiceLanguageAsyncClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20221001")
public interface AIServiceLanguageAsync
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.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Future<BatchDetectDominantLanguageResponse>`	`batchDetectDominantLanguage(BatchDetectDominantLanguageRequest request, AsyncHandler<BatchDetectDominantLanguageRequest,BatchDetectDominantLanguageResponse> handler)` The API returns the detected language and a related confidence score (between 0 and 1).
`Future<BatchDetectHealthEntityResponse>`	`batchDetectHealthEntity(BatchDetectHealthEntityRequest request, AsyncHandler<BatchDetectHealthEntityRequest,BatchDetectHealthEntityResponse> handler)` The API extracts health entities in text records.
`Future<BatchDetectLanguageEntitiesResponse>`	`batchDetectLanguageEntities(BatchDetectLanguageEntitiesRequest request, AsyncHandler<BatchDetectLanguageEntitiesRequest,BatchDetectLanguageEntitiesResponse> handler)` The API extracts entities in text records.
`Future<BatchDetectLanguageKeyPhrasesResponse>`	`batchDetectLanguageKeyPhrases(BatchDetectLanguageKeyPhrasesRequest request, AsyncHandler<BatchDetectLanguageKeyPhrasesRequest,BatchDetectLanguageKeyPhrasesResponse> handler)` The API extracts key-phrases in text records.
`Future<BatchDetectLanguagePiiEntitiesResponse>`	`batchDetectLanguagePiiEntities(BatchDetectLanguagePiiEntitiesRequest request, AsyncHandler<BatchDetectLanguagePiiEntitiesRequest,BatchDetectLanguagePiiEntitiesResponse> handler)` The API extracts pii entities in text records.
`Future<BatchDetectLanguageSentimentsResponse>`	`batchDetectLanguageSentiments(BatchDetectLanguageSentimentsRequest request, AsyncHandler<BatchDetectLanguageSentimentsRequest,BatchDetectLanguageSentimentsResponse> handler)` The API extracts aspect-based and sentence level sentiment in text records.
`Future<BatchDetectLanguageTextClassificationResponse>`	`batchDetectLanguageTextClassification(BatchDetectLanguageTextClassificationRequest request, AsyncHandler<BatchDetectLanguageTextClassificationRequest,BatchDetectLanguageTextClassificationResponse> handler)` The API automatically classifies text into a set of pre-determined classes and sub-classes.
`Future<BatchLanguageTranslationResponse>`	`batchLanguageTranslation(BatchLanguageTranslationRequest request, AsyncHandler<BatchLanguageTranslationRequest,BatchLanguageTranslationResponse> handler)` Translates a batch of text documents from source to target language.
`Future<CancelJobResponse>`	`cancelJob(CancelJobRequest request, AsyncHandler<CancelJobRequest,CancelJobResponse> handler)` Canceling the job cancels all the tasks under it.
`Future<ChangeEndpointCompartmentResponse>`	`changeEndpointCompartment(ChangeEndpointCompartmentRequest request, AsyncHandler<ChangeEndpointCompartmentRequest,ChangeEndpointCompartmentResponse> handler)` Moves a Endpoint into a different compartment.
`Future<ChangeJobCompartmentResponse>`	`changeJobCompartment(ChangeJobCompartmentRequest request, AsyncHandler<ChangeJobCompartmentRequest,ChangeJobCompartmentResponse> handler)` Moves a Job into a different compartment.
`Future<ChangeModelCompartmentResponse>`	`changeModelCompartment(ChangeModelCompartmentRequest request, AsyncHandler<ChangeModelCompartmentRequest,ChangeModelCompartmentResponse> handler)` Moves a Model into a different compartment.
`Future<ChangeProjectCompartmentResponse>`	`changeProjectCompartment(ChangeProjectCompartmentRequest request, AsyncHandler<ChangeProjectCompartmentRequest,ChangeProjectCompartmentResponse> handler)` Moves a Project into a different compartment.
`Future<CreateEndpointResponse>`	`createEndpoint(CreateEndpointRequest request, AsyncHandler<CreateEndpointRequest,CreateEndpointResponse> handler)` Creates a new endpoint and deploy the trained model
`Future<CreateJobResponse>`	`createJob(CreateJobRequest request, AsyncHandler<CreateJobRequest,CreateJobResponse> handler)` Creates a new language service async job.
`Future<CreateModelResponse>`	`createModel(CreateModelRequest request, AsyncHandler<CreateModelRequest,CreateModelResponse> handler)` Creates a new model for training and train the model with date provided.
`Future<CreateProjectResponse>`	`createProject(CreateProjectRequest request, AsyncHandler<CreateProjectRequest,CreateProjectResponse> handler)` Creates a new Project.
`Future<DeleteEndpointResponse>`	`deleteEndpoint(DeleteEndpointRequest request, AsyncHandler<DeleteEndpointRequest,DeleteEndpointResponse> handler)` Deletes a provisioned endpoint resource by identifier.
`Future<DeleteJobResponse>`	`deleteJob(DeleteJobRequest request, AsyncHandler<DeleteJobRequest,DeleteJobResponse> handler)` Deletes the language service async Job
`Future<DeleteModelResponse>`	`deleteModel(DeleteModelRequest request, AsyncHandler<DeleteModelRequest,DeleteModelResponse> handler)` Deletes a provisioned model resource by identifier.
`Future<DeleteProjectResponse>`	`deleteProject(DeleteProjectRequest request, AsyncHandler<DeleteProjectRequest,DeleteProjectResponse> handler)` Deletes a Project resource by identifier.
`Future<DetectDominantLanguageResponse>`	`detectDominantLanguage(DetectDominantLanguageRequest request, AsyncHandler<DetectDominantLanguageRequest,DetectDominantLanguageResponse> handler)` Deprecated: This API will be retired Tuesday, 10 Oct 2023 00:00:00 GMT.
`Future<DetectLanguageEntitiesResponse>`	`detectLanguageEntities(DetectLanguageEntitiesRequest request, AsyncHandler<DetectLanguageEntitiesRequest,DetectLanguageEntitiesResponse> handler)` Deprecated: This API will be retired Tuesday, 10 Oct 2023 00:00:00 GMT.
`Future<DetectLanguageKeyPhrasesResponse>`	`detectLanguageKeyPhrases(DetectLanguageKeyPhrasesRequest request, AsyncHandler<DetectLanguageKeyPhrasesRequest,DetectLanguageKeyPhrasesResponse> handler)` Deprecated: This API will be retired Tuesday, 10 Oct 2023 00:00:00 GMT.
`Future<DetectLanguageSentimentsResponse>`	`detectLanguageSentiments(DetectLanguageSentimentsRequest request, AsyncHandler<DetectLanguageSentimentsRequest,DetectLanguageSentimentsResponse> handler)` Deprecated: This API will be retired Tuesday, 10 Oct 2023 00:00:00 GMT.
`Future<DetectLanguageTextClassificationResponse>`	`detectLanguageTextClassification(DetectLanguageTextClassificationRequest request, AsyncHandler<DetectLanguageTextClassificationRequest,DetectLanguageTextClassificationResponse> handler)` Deprecated: This API will be retired Tuesday, 10 Oct 2023 00:00:00 GMT.
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`Future<GetEndpointResponse>`	`getEndpoint(GetEndpointRequest request, AsyncHandler<GetEndpointRequest,GetEndpointResponse> handler)` Gets an endpoint by identifier
`Future<GetJobResponse>`	`getJob(GetJobRequest request, AsyncHandler<GetJobRequest,GetJobResponse> handler)` Gets a language service async job
`Future<GetModelResponse>`	`getModel(GetModelRequest request, AsyncHandler<GetModelRequest,GetModelResponse> handler)` Gets a model by identifier
`Future<GetModelTypeResponse>`	`getModelType(GetModelTypeRequest request, AsyncHandler<GetModelTypeRequest,GetModelTypeResponse> handler)` Gets model capabilities
`Future<GetProjectResponse>`	`getProject(GetProjectRequest request, AsyncHandler<GetProjectRequest,GetProjectResponse> handler)` Gets a Project by identifier
`Future<GetWorkRequestResponse>`	`getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)` Gets the status of the work request with the given ID.
`Future<ListEndpointsResponse>`	`listEndpoints(ListEndpointsRequest request, AsyncHandler<ListEndpointsRequest,ListEndpointsResponse> handler)` Returns a list of Endpoints.
`Future<ListEvaluationResultsResponse>`	`listEvaluationResults(ListEvaluationResultsRequest request, AsyncHandler<ListEvaluationResultsRequest,ListEvaluationResultsResponse> handler)` Get a (paginated) list of evaluation results for a given model.
`Future<ListJobsResponse>`	`listJobs(ListJobsRequest request, AsyncHandler<ListJobsRequest,ListJobsResponse> handler)` Returns a list of language service async Jobs.
`Future<ListModelsResponse>`	`listModels(ListModelsRequest request, AsyncHandler<ListModelsRequest,ListModelsResponse> handler)` Returns a list of models.
`Future<ListProjectsResponse>`	`listProjects(ListProjectsRequest request, AsyncHandler<ListProjectsRequest,ListProjectsResponse> handler)` Returns a list of Projects.
`Future<ListWorkRequestErrorsResponse>`	`listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)` Return a (paginated) list of errors for a given work request.
`Future<ListWorkRequestLogsResponse>`	`listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)` Return a (paginated) list of logs for a given work request.
`Future<ListWorkRequestsResponse>`	`listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)` Lists the work requests in a compartment.
`void`	`refreshClient()` Rebuilds the client from scratch.
`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’).
`Future<UpdateEndpointResponse>`	`updateEndpoint(UpdateEndpointRequest request, AsyncHandler<UpdateEndpointRequest,UpdateEndpointResponse> handler)` Update the Endpoint identified by the id
`Future<UpdateJobResponse>`	`updateJob(UpdateJobRequest request, AsyncHandler<UpdateJobRequest,UpdateJobResponse> handler)` Updates the language service async Job
`Future<UpdateModelResponse>`	`updateModel(UpdateModelRequest request, AsyncHandler<UpdateModelRequest,UpdateModelResponse> handler)` Updates the model
`Future<UpdateProjectResponse>`	`updateProject(UpdateProjectRequest request, AsyncHandler<UpdateProjectRequest,UpdateProjectResponse> handler)` Updates the Project
`void`	`useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)` Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable
close

- 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 serice.
  - 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
```
Future<BatchDetectDominantLanguageResponse> batchDetectDominantLanguage(BatchDetectDominantLanguageRequest request,
                                                                        AsyncHandler<BatchDetectDominantLanguageRequest,BatchDetectDominantLanguageResponse> handler)
```
    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.cloud.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
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - batchDetectHealthEntity
```
Future<BatchDetectHealthEntityResponse> batchDetectHealthEntity(BatchDetectHealthEntityRequest request,
                                                                AsyncHandler<BatchDetectHealthEntityRequest,BatchDetectHealthEntityResponse> handler)
```
    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
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - batchDetectLanguageEntities
```
Future<BatchDetectLanguageEntitiesResponse> batchDetectLanguageEntities(BatchDetectLanguageEntitiesRequest request,
                                                                        AsyncHandler<BatchDetectLanguageEntitiesRequest,BatchDetectLanguageEntitiesResponse> handler)
```
    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.cloud.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
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - batchDetectLanguageKeyPhrases
```
Future<BatchDetectLanguageKeyPhrasesResponse> batchDetectLanguageKeyPhrases(BatchDetectLanguageKeyPhrasesRequest request,
                                                                            AsyncHandler<BatchDetectLanguageKeyPhrasesRequest,BatchDetectLanguageKeyPhrasesResponse> handler)
```
    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
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - batchDetectLanguagePiiEntities
```
Future<BatchDetectLanguagePiiEntitiesResponse> batchDetectLanguagePiiEntities(BatchDetectLanguagePiiEntitiesRequest request,
                                                                              AsyncHandler<BatchDetectLanguagePiiEntitiesRequest,BatchDetectLanguagePiiEntitiesResponse> handler)
```
    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
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - batchDetectLanguageSentiments
```
Future<BatchDetectLanguageSentimentsResponse> batchDetectLanguageSentiments(BatchDetectLanguageSentimentsRequest request,
                                                                            AsyncHandler<BatchDetectLanguageSentimentsRequest,BatchDetectLanguageSentimentsResponse> handler)
```
    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.cloud.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
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - batchDetectLanguageTextClassification
```
Future<BatchDetectLanguageTextClassificationResponse> batchDetectLanguageTextClassification(BatchDetectLanguageTextClassificationRequest request,
                                                                                            AsyncHandler<BatchDetectLanguageTextClassificationRequest,BatchDetectLanguageTextClassificationResponse> handler)
```
    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.cloud.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
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - batchLanguageTranslation
```
Future<BatchLanguageTranslationResponse> batchLanguageTranslation(BatchLanguageTranslationRequest request,
                                                                  AsyncHandler<BatchLanguageTranslationRequest,BatchLanguageTranslationResponse> handler)
```
    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
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - cancelJob
```
Future<CancelJobResponse> cancelJob(CancelJobRequest request,
                                    AsyncHandler<CancelJobRequest,CancelJobResponse> handler)
```
    Canceling the job cancels all the tasks under it.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - changeEndpointCompartment
```
Future<ChangeEndpointCompartmentResponse> changeEndpointCompartment(ChangeEndpointCompartmentRequest request,
                                                                    AsyncHandler<ChangeEndpointCompartmentRequest,ChangeEndpointCompartmentResponse> handler)
```
    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
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - changeJobCompartment
```
Future<ChangeJobCompartmentResponse> changeJobCompartment(ChangeJobCompartmentRequest request,
                                                          AsyncHandler<ChangeJobCompartmentRequest,ChangeJobCompartmentResponse> handler)
```
    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
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - changeModelCompartment
```
Future<ChangeModelCompartmentResponse> changeModelCompartment(ChangeModelCompartmentRequest request,
                                                              AsyncHandler<ChangeModelCompartmentRequest,ChangeModelCompartmentResponse> handler)
```
    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
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - changeProjectCompartment
```
Future<ChangeProjectCompartmentResponse> changeProjectCompartment(ChangeProjectCompartmentRequest request,
                                                                  AsyncHandler<ChangeProjectCompartmentRequest,ChangeProjectCompartmentResponse> handler)
```
    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
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - createEndpoint
```
Future<CreateEndpointResponse> createEndpoint(CreateEndpointRequest request,
                                              AsyncHandler<CreateEndpointRequest,CreateEndpointResponse> handler)
```
    Creates a new endpoint and deploy the trained model
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - createJob
```
Future<CreateJobResponse> createJob(CreateJobRequest request,
                                    AsyncHandler<CreateJobRequest,CreateJobResponse> handler)
```
    Creates a new language service async job.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - createModel
```
Future<CreateModelResponse> createModel(CreateModelRequest request,
                                        AsyncHandler<CreateModelRequest,CreateModelResponse> handler)
```
    Creates a new model for training and train the model with date provided.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - createProject
```
Future<CreateProjectResponse> createProject(CreateProjectRequest request,
                                            AsyncHandler<CreateProjectRequest,CreateProjectResponse> handler)
```
    Creates a new Project.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - deleteEndpoint
```
Future<DeleteEndpointResponse> deleteEndpoint(DeleteEndpointRequest request,
                                              AsyncHandler<DeleteEndpointRequest,DeleteEndpointResponse> handler)
```
    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
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - deleteJob
```
Future<DeleteJobResponse> deleteJob(DeleteJobRequest request,
                                    AsyncHandler<DeleteJobRequest,DeleteJobResponse> handler)
```
    Deletes the language service async Job
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - deleteModel
```
Future<DeleteModelResponse> deleteModel(DeleteModelRequest request,
                                        AsyncHandler<DeleteModelRequest,DeleteModelResponse> handler)
```
    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
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - deleteProject
```
Future<DeleteProjectResponse> deleteProject(DeleteProjectRequest request,
                                            AsyncHandler<DeleteProjectRequest,DeleteProjectResponse> handler)
```
    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
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - detectDominantLanguage
```
Future<DetectDominantLanguageResponse> detectDominantLanguage(DetectDominantLanguageRequest request,
                                                              AsyncHandler<DetectDominantLanguageRequest,DetectDominantLanguageResponse> handler)
```
    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.cloud.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
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - detectLanguageEntities
```
Future<DetectLanguageEntitiesResponse> detectLanguageEntities(DetectLanguageEntitiesRequest request,
                                                              AsyncHandler<DetectLanguageEntitiesRequest,DetectLanguageEntitiesResponse> handler)
```
    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
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - detectLanguageKeyPhrases
```
Future<DetectLanguageKeyPhrasesResponse> detectLanguageKeyPhrases(DetectLanguageKeyPhrasesRequest request,
                                                                  AsyncHandler<DetectLanguageKeyPhrasesRequest,DetectLanguageKeyPhrasesResponse> handler)
```
    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
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - detectLanguageSentiments
```
Future<DetectLanguageSentimentsResponse> detectLanguageSentiments(DetectLanguageSentimentsRequest request,
                                                                  AsyncHandler<DetectLanguageSentimentsRequest,DetectLanguageSentimentsResponse> handler)
```
    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.cloud.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
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - detectLanguageTextClassification
```
Future<DetectLanguageTextClassificationResponse> detectLanguageTextClassification(DetectLanguageTextClassificationRequest request,
                                                                                  AsyncHandler<DetectLanguageTextClassificationRequest,DetectLanguageTextClassificationResponse> handler)
```
    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.cloud.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
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - getEndpoint
```
Future<GetEndpointResponse> getEndpoint(GetEndpointRequest request,
                                        AsyncHandler<GetEndpointRequest,GetEndpointResponse> handler)
```
    Gets an endpoint by identifier
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - getJob
```
Future<GetJobResponse> getJob(GetJobRequest request,
                              AsyncHandler<GetJobRequest,GetJobResponse> handler)
```
    Gets a language service async job
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - getModel
```
Future<GetModelResponse> getModel(GetModelRequest request,
                                  AsyncHandler<GetModelRequest,GetModelResponse> handler)
```
    Gets a model by identifier
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - getModelType
```
Future<GetModelTypeResponse> getModelType(GetModelTypeRequest request,
                                          AsyncHandler<GetModelTypeRequest,GetModelTypeResponse> handler)
```
    Gets model capabilities
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - getProject
```
Future<GetProjectResponse> getProject(GetProjectRequest request,
                                      AsyncHandler<GetProjectRequest,GetProjectResponse> handler)
```
    Gets a Project by identifier
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - getWorkRequest
```
Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                              AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
```
    Gets the status of the work request with the given ID.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listEndpoints
```
Future<ListEndpointsResponse> listEndpoints(ListEndpointsRequest request,
                                            AsyncHandler<ListEndpointsRequest,ListEndpointsResponse> handler)
```
    Returns a list of Endpoints.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listEvaluationResults
```
Future<ListEvaluationResultsResponse> listEvaluationResults(ListEvaluationResultsRequest request,
                                                            AsyncHandler<ListEvaluationResultsRequest,ListEvaluationResultsResponse> handler)
```
    Get a (paginated) list of evaluation results for a given model.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listJobs
```
Future<ListJobsResponse> listJobs(ListJobsRequest request,
                                  AsyncHandler<ListJobsRequest,ListJobsResponse> handler)
```
    Returns a list of language service async Jobs.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listModels
```
Future<ListModelsResponse> listModels(ListModelsRequest request,
                                      AsyncHandler<ListModelsRequest,ListModelsResponse> handler)
```
    Returns a list of models.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listProjects
```
Future<ListProjectsResponse> listProjects(ListProjectsRequest request,
                                          AsyncHandler<ListProjectsRequest,ListProjectsResponse> handler)
```
    Returns a list of Projects.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listWorkRequestErrors
```
Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request,
                                                            AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
```
    Return a (paginated) list of errors for a given work request.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listWorkRequestLogs
```
Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request,
                                                        AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
```
    Return a (paginated) list of logs for a given work request.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listWorkRequests
```
Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request,
                                                  AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
```
    Lists the work requests in a compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - updateEndpoint
```
Future<UpdateEndpointResponse> updateEndpoint(UpdateEndpointRequest request,
                                              AsyncHandler<UpdateEndpointRequest,UpdateEndpointResponse> handler)
```
    Update the Endpoint identified by the id
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - updateJob
```
Future<UpdateJobResponse> updateJob(UpdateJobRequest request,
                                    AsyncHandler<UpdateJobRequest,UpdateJobResponse> handler)
```
    Updates the language service async Job
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - updateModel
```
Future<UpdateModelResponse> updateModel(UpdateModelRequest request,
                                        AsyncHandler<UpdateModelRequest,UpdateModelResponse> handler)
```
    Updates the model
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - updateProject
```
Future<UpdateProjectResponse> updateProject(UpdateProjectRequest request,
                                            AsyncHandler<UpdateProjectRequest,UpdateProjectResponse> handler)
```
    Updates the Project
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

Interface AIServiceLanguageAsync

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

batchDetectDominantLanguage

batchDetectHealthEntity

batchDetectLanguageEntities

batchDetectLanguageKeyPhrases

batchDetectLanguagePiiEntities

batchDetectLanguageSentiments

batchDetectLanguageTextClassification

batchLanguageTranslation

cancelJob

changeEndpointCompartment

changeJobCompartment

changeModelCompartment

changeProjectCompartment

createEndpoint

createJob

createModel

createProject

deleteEndpoint

deleteJob

deleteModel

deleteProject

detectDominantLanguage

detectLanguageEntities

detectLanguageKeyPhrases

detectLanguageSentiments

detectLanguageTextClassification

getEndpoint

getJob

getModel

getModelType

getProject

getWorkRequest

listEndpoints

listEvaluationResults

listJobs

listModels

listProjects

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

updateEndpoint

updateJob

updateModel

updateProject