Class AIServiceLanguageClient
Service client instance for AIServiceLanguage.
Implements
Inherited Members
Namespace: Oci.AilanguageService
Assembly: OCI.DotNetSDK.Ailanguage.dll
Syntax
public class AIServiceLanguageClient : RegionalClientBase, IDisposable
Constructors
AIServiceLanguageClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)
Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.
Declaration
public AIServiceLanguageClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type | Name | Description |
---|---|---|
IBasicAuthenticationDetailsProvider | authenticationDetailsProvider | The authentication details provider. Required. |
ClientConfiguration | clientConfiguration | The client configuration that contains settings to adjust REST client behaviors. Optional. |
string | endpoint | The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional. |
Properties
Paginators
Declaration
public AIServiceLanguagePaginators Paginators { get; }
Property Value
Type | Description |
---|---|
AIServiceLanguagePaginators |
Waiters
Declaration
public AIServiceLanguageWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
AIServiceLanguageWaiters |
Methods
BatchDetectDominantLanguage(BatchDetectDominantLanguageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
The API returns the detected language and a related confidence score (between 0 and 1). It supports passing a batch of records. <br/> List of supported languages. <br/> 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.
Declaration
public Task<BatchDetectDominantLanguageResponse> BatchDetectDominantLanguage(BatchDetectDominantLanguageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
BatchDetectDominantLanguageRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<BatchDetectDominantLanguageResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use BatchDetectDominantLanguage API.
BatchDetectHealthEntity(BatchDetectHealthEntityRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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. <br/> 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.
Declaration
public Task<BatchDetectHealthEntityResponse> BatchDetectHealthEntity(BatchDetectHealthEntityRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
BatchDetectHealthEntityRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<BatchDetectHealthEntityResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use BatchDetectHealthEntity API.
BatchDetectLanguageEntities(BatchDetectLanguageEntitiesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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. <br/> List of supported entities. <br/> 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.
Declaration
public Task<BatchDetectLanguageEntitiesResponse> BatchDetectLanguageEntities(BatchDetectLanguageEntitiesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
BatchDetectLanguageEntitiesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<BatchDetectLanguageEntitiesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use BatchDetectLanguageEntities API.
BatchDetectLanguageKeyPhrases(BatchDetectLanguageKeyPhrasesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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. <br/> 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.
Declaration
public Task<BatchDetectLanguageKeyPhrasesResponse> BatchDetectLanguageKeyPhrases(BatchDetectLanguageKeyPhrasesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
BatchDetectLanguageKeyPhrasesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<BatchDetectLanguageKeyPhrasesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use BatchDetectLanguageKeyPhrases API.
BatchDetectLanguagePiiEntities(BatchDetectLanguagePiiEntitiesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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. <br/> 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.
Declaration
public Task<BatchDetectLanguagePiiEntitiesResponse> BatchDetectLanguagePiiEntities(BatchDetectLanguagePiiEntitiesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
BatchDetectLanguagePiiEntitiesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<BatchDetectLanguagePiiEntitiesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use BatchDetectLanguagePiiEntities API.
BatchDetectLanguageSentiments(BatchDetectLanguageSentimentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
The API extracts aspect-based and sentence level sentiment in text records. <br/> 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. <br/> For sentiment analysis, confidence scores are provided for each of the classes (positive, negative, neutral and mixed). <br/> Learn more about sentiment analysis here. <br/> 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.
Declaration
public Task<BatchDetectLanguageSentimentsResponse> BatchDetectLanguageSentiments(BatchDetectLanguageSentimentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
BatchDetectLanguageSentimentsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<BatchDetectLanguageSentimentsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use BatchDetectLanguageSentiments API.
BatchDetectLanguageTextClassification(BatchDetectLanguageTextClassificationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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. <br/> It supports passing a batch of records. <br/> Learn more about text classification here. <br/> 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.
Declaration
public Task<BatchDetectLanguageTextClassificationResponse> BatchDetectLanguageTextClassification(BatchDetectLanguageTextClassificationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
BatchDetectLanguageTextClassificationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<BatchDetectLanguageTextClassificationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use BatchDetectLanguageTextClassification API.
BatchLanguageTranslation(BatchLanguageTranslationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<BatchLanguageTranslationResponse> BatchLanguageTranslation(BatchLanguageTranslationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
BatchLanguageTranslationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<BatchLanguageTranslationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use BatchLanguageTranslation API.
CancelJob(CancelJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Canceling the job cancels all the tasks under it.
Declaration
public Task<CancelJobResponse> CancelJob(CancelJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CancelJobRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CancelJobResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CancelJob API.
ChangeEndpointCompartment(ChangeEndpointCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a Endpoint into a different compartment. When provided, If-Match is checked against ETag values of the resource.
Declaration
public Task<ChangeEndpointCompartmentResponse> ChangeEndpointCompartment(ChangeEndpointCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeEndpointCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeEndpointCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeEndpointCompartment API.
ChangeJobCompartment(ChangeJobCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a Job into a different compartment. When provided, If-Match is checked against ETag values of the resource.
Declaration
public Task<ChangeJobCompartmentResponse> ChangeJobCompartment(ChangeJobCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeJobCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeJobCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeJobCompartment API.
ChangeModelCompartment(ChangeModelCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a Model into a different compartment. When provided, If-Match is checked against ETag values of the resource.
Declaration
public Task<ChangeModelCompartmentResponse> ChangeModelCompartment(ChangeModelCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeModelCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeModelCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeModelCompartment API.
ChangeProjectCompartment(ChangeProjectCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a Project into a different compartment. When provided, If-Match is checked against ETag values of the resource.
Declaration
public Task<ChangeProjectCompartmentResponse> ChangeProjectCompartment(ChangeProjectCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeProjectCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeProjectCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeProjectCompartment API.
CreateEndpoint(CreateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new endpoint and deploy the trained model
Declaration
public Task<CreateEndpointResponse> CreateEndpoint(CreateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateEndpoint API.
CreateJob(CreateJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new language service async job.
Declaration
public Task<CreateJobResponse> CreateJob(CreateJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateJobRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateJobResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateJob API.
CreateModel(CreateModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new model for training and train the model with date provided.
Declaration
public Task<CreateModelResponse> CreateModel(CreateModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateModelRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateModelResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateModel API.
CreateProject(CreateProjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new Project.
Declaration
public Task<CreateProjectResponse> CreateProject(CreateProjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateProjectRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateProjectResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateProject API.
DeleteEndpoint(DeleteEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<DeleteEndpointResponse> DeleteEndpoint(DeleteEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteEndpoint API.
DeleteJob(DeleteJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the language service async Job
Declaration
public Task<DeleteJobResponse> DeleteJob(DeleteJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteJobRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteJobResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteJob API.
DeleteModel(DeleteModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<DeleteModelResponse> DeleteModel(DeleteModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteModelRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteModelResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteModel API.
DeleteProject(DeleteProjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<DeleteProjectResponse> DeleteProject(DeleteProjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteProjectRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteProjectResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteProject API.
DetectDominantLanguage(DetectDominantLanguageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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. <br/> The DetectDominantLanguage API returns the detected language and a related confidence score (between 0 and 1). <br/> List of supported languages <br/> Limitations:
- A record may be up to 1000 characters long.
Declaration
public Task<DetectDominantLanguageResponse> DetectDominantLanguage(DetectDominantLanguageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DetectDominantLanguageRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DetectDominantLanguageResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DetectDominantLanguage API.
DetectLanguageEntities(DetectLanguageEntitiesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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. <br/> The DetectLanguageEntities API extracts entities in text records. For each entity, its type and confidence score (between 0 and 1) is returned. <br/> Limitations:
- A text may be up to 1000 characters long.
Declaration
public Task<DetectLanguageEntitiesResponse> DetectLanguageEntities(DetectLanguageEntitiesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DetectLanguageEntitiesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DetectLanguageEntitiesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DetectLanguageEntities API.
DetectLanguageKeyPhrases(DetectLanguageKeyPhrasesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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. <br/> 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.
Declaration
public Task<DetectLanguageKeyPhrasesResponse> DetectLanguageKeyPhrases(DetectLanguageKeyPhrasesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DetectLanguageKeyPhrasesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DetectLanguageKeyPhrasesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DetectLanguageKeyPhrases API.
DetectLanguageSentiments(DetectLanguageSentimentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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. <br/> The DetectLanguageSentiments API extracts aspect-based in text records. <br/> For aspect-based sentiment analysis, a set of aspects and their respective sentiment is returned. <br/> For sentiment analysis, confidence scores are provided for each of the classes (positive, negative, neutral). <br/> Learn more about sentiment analysis here. <br/> Limitations:
- A record may be up to 1000 characters long.
Declaration
public Task<DetectLanguageSentimentsResponse> DetectLanguageSentiments(DetectLanguageSentimentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DetectLanguageSentimentsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DetectLanguageSentimentsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DetectLanguageSentiments API.
DetectLanguageTextClassification(DetectLanguageTextClassificationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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. <br/> 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. <br/> Learn more about text classification here. <br/> Limitations:
- A record may be up to 1000 characters long.
Declaration
public Task<DetectLanguageTextClassificationResponse> DetectLanguageTextClassification(DetectLanguageTextClassificationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DetectLanguageTextClassificationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DetectLanguageTextClassificationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DetectLanguageTextClassification API.
GetEndpoint(GetEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets an endpoint by identifier
Declaration
public Task<GetEndpointResponse> GetEndpoint(GetEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetEndpoint API.
GetJob(GetJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a language service async job
Declaration
public Task<GetJobResponse> GetJob(GetJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetJobRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetJobResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetJob API.
GetModel(GetModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a model by identifier
Declaration
public Task<GetModelResponse> GetModel(GetModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetModelRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetModelResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetModel API.
GetModelType(GetModelTypeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets model capabilities
Declaration
public Task<GetModelTypeResponse> GetModelType(GetModelTypeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetModelTypeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetModelTypeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetModelType API.
GetProject(GetProjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a Project by identifier
Declaration
public Task<GetProjectResponse> GetProject(GetProjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetProjectRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetProjectResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetProject API.
GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the status of the work request with the given ID.
Declaration
public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetWorkRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetWorkRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetWorkRequest API.
ListEndpoints(ListEndpointsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of Endpoints.
Declaration
public Task<ListEndpointsResponse> ListEndpoints(ListEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListEndpointsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListEndpointsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListEndpoints API.
ListEvaluationResults(ListEvaluationResultsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Get a (paginated) list of evaluation results for a given model.
Declaration
public Task<ListEvaluationResultsResponse> ListEvaluationResults(ListEvaluationResultsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListEvaluationResultsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListEvaluationResultsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListEvaluationResults API.
ListJobs(ListJobsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of language service async Jobs.
Declaration
public Task<ListJobsResponse> ListJobs(ListJobsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListJobsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListJobsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListJobs API.
ListModels(ListModelsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of models.
Declaration
public Task<ListModelsResponse> ListModels(ListModelsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListModelsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListModelsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListModels API.
ListProjects(ListProjectsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of Projects.
Declaration
public Task<ListProjectsResponse> ListProjects(ListProjectsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListProjectsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListProjectsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListProjects API.
ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Return a (paginated) list of errors for a given work request.
Declaration
public Task<ListWorkRequestErrorsResponse> ListWorkRequestErrors(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestErrorsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestErrorsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequestErrors API.
ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Return a (paginated) list of logs for a given work request.
Declaration
public Task<ListWorkRequestLogsResponse> ListWorkRequestLogs(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestLogsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestLogsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequestLogs API.
ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the work requests in a compartment.
Declaration
public Task<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequests API.
UpdateEndpoint(UpdateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Update the Endpoint identified by the id
Declaration
public Task<UpdateEndpointResponse> UpdateEndpoint(UpdateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateEndpoint API.
UpdateJob(UpdateJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the language service async Job
Declaration
public Task<UpdateJobResponse> UpdateJob(UpdateJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateJobRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateJobResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateJob API.
UpdateModel(UpdateModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the model
Declaration
public Task<UpdateModelResponse> UpdateModel(UpdateModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateModelRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateModelResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateModel API.
UpdateProject(UpdateProjectRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the Project
Declaration
public Task<UpdateProjectResponse> UpdateProject(UpdateProjectRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateProjectRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateProjectResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateProject API.