TextAnalyticsClient.AnalyzeActionsAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| AnalyzeActionsAsync(WaitUntil, IEnumerable<TextDocumentInput>, TextAnalyticsActions, AnalyzeActionsOptions, CancellationToken) |
Performs one or more text analysis actions on a set of documents. The list of supported actions includes:
For document length limits, maximum batch size, and supported text encoding, see here. |
| AnalyzeActionsAsync(WaitUntil, IEnumerable<String>, TextAnalyticsActions, String, AnalyzeActionsOptions, CancellationToken) |
Performs one or more text analysis actions on a set of documents. The list of supported actions includes:
For document length limits, maximum batch size, and supported text encoding, see more information here. |
AnalyzeActionsAsync(WaitUntil, IEnumerable<TextDocumentInput>, TextAnalyticsActions, AnalyzeActionsOptions, CancellationToken)
- Source:
- TextAnalyticsClient.cs
Performs one or more text analysis actions on a set of documents. The list of supported actions includes:
- Entity Recognition (Named, Linked, and Personally Identifiable Information (PII) entities)
- Key Phrases Extraction
- Sentiment Analysis
- Custom Entity Recognition
- Custom Single and Multi Label Classification
- Extractive Summarization
- Abstractive Summarization
For document length limits, maximum batch size, and supported text encoding, see here.
public virtual System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeActionsOperation> AnalyzeActionsAsync (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, Azure.AI.TextAnalytics.TextAnalyticsActions actions, Azure.AI.TextAnalytics.AnalyzeActionsOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member AnalyzeActionsAsync : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.TextAnalyticsActions * Azure.AI.TextAnalytics.AnalyzeActionsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeActionsOperation>
override this.AnalyzeActionsAsync : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.TextAnalyticsActions * Azure.AI.TextAnalytics.AnalyzeActionsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeActionsOperation>Public Overridable Function AnalyzeActionsAsync (waitUntil As WaitUntil, documents As IEnumerable(Of TextDocumentInput), actions As TextAnalyticsActions, Optional options As AnalyzeActionsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AnalyzeActionsOperation)Parameters
- waitUntil
- WaitUntil
Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation.
- documents
- IEnumerable<TextDocumentInput>
The list of documents to analyze.
- actions
- TextAnalyticsActions
The TextAnalyticsActions to perform on the list of documents.
- options
- AnalyzeActionsOptions
The AnalyzeActionsOptions used to configure the operation.
- cancellationToken
- CancellationToken
The CancellationToken controlling the lifetime of the request.
Returns
Exceptions
This method is only supported in service API version v3.1 and newer. The AnalyzeHealthcareEntitiesAction, MultiLabelClassifyAction, RecognizeCustomEntitiesAction, and SingleLabelClassifyAction are only supported in service API version 2022-05-01 and newer. The ExtractiveSummarizeAction and AbstractiveSummarizeAction are only supported in service API version 2023-04-01 and newer.
Service returned a non-success status code.
Remarks
This method is only available for V3_1, V2022_05_01, and newer. See the service documentation for regional support of custom action features.
Applies to
AnalyzeActionsAsync(WaitUntil, IEnumerable<String>, TextAnalyticsActions, String, AnalyzeActionsOptions, CancellationToken)
- Source:
- TextAnalyticsClient.cs
Performs one or more text analysis actions on a set of documents. The list of supported actions includes:
- Entity Recognition (Named, Linked, and Personally Identifiable Information (PII) entities)
- Key Phrases Extraction
- Sentiment Analysis
- Custom Entity Recognition
- Custom Single and Multi Label Classification
- Extractive Summarization
- Abstractive Summarization
For document length limits, maximum batch size, and supported text encoding, see more information here.
public virtual System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeActionsOperation> AnalyzeActionsAsync (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<string> documents, Azure.AI.TextAnalytics.TextAnalyticsActions actions, string language = default, Azure.AI.TextAnalytics.AnalyzeActionsOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member AnalyzeActionsAsync : Azure.WaitUntil * seq<string> * Azure.AI.TextAnalytics.TextAnalyticsActions * string * Azure.AI.TextAnalytics.AnalyzeActionsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeActionsOperation>
override this.AnalyzeActionsAsync : Azure.WaitUntil * seq<string> * Azure.AI.TextAnalytics.TextAnalyticsActions * string * Azure.AI.TextAnalytics.AnalyzeActionsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeActionsOperation>Public Overridable Function AnalyzeActionsAsync (waitUntil As WaitUntil, documents As IEnumerable(Of String), actions As TextAnalyticsActions, Optional language As String = Nothing, Optional options As AnalyzeActionsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AnalyzeActionsOperation)Parameters
- waitUntil
- WaitUntil
Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation.
- documents
- IEnumerable<String>
The list of documents to analyze.
- actions
- TextAnalyticsActions
The TextAnalyticsActions to perform on the list of documents.
- language
- String
The language that the document is written in.
- options
- AnalyzeActionsOptions
The AnalyzeActionsOptions used to configure the operation.
- cancellationToken
- CancellationToken
The CancellationToken controlling the lifetime of the request.
Returns
Exceptions
This method is only supported in service API version v3.1 and newer. The AnalyzeHealthcareEntitiesAction, MultiLabelClassifyAction, RecognizeCustomEntitiesAction, and SingleLabelClassifyAction are only supported in service API version 2022-05-01 and newer. The ExtractiveSummarizeAction and AbstractiveSummarizeAction are only supported in service API version 2023-04-01 and newer.
Service returned a non-success status code.
Remarks
This method is only available for V3_1, V2022_05_01, and newer. See the service documentation for regional support of custom action features.
Applies to
Azure SDK for .NET