Share via


TextAnalyticsClient.AnalyzeHealthcareEntitiesAsync Method

Definition

Overloads

AnalyzeHealthcareEntitiesAsync(WaitUntil, IEnumerable<TextDocumentInput>, AnalyzeHealthcareEntitiesOptions, CancellationToken)

Runs a predictive model to identify a collection of healthcare entities found in the passed-in document, and include information linking the entities to their corresponding entries in a well-known knowledge base. For a list of languages supported by this operation, see https://aka.ms/talangs. For document length limits, maximum batch size, and supported text encoding, see https://aka.ms/azsdk/textanalytics/data-limits.

AnalyzeHealthcareEntitiesAsync(WaitUntil, IEnumerable<String>, String, AnalyzeHealthcareEntitiesOptions, CancellationToken)

Runs a predictive model to identify a collection of healthcare entities found in the passed-in document, and include information linking the entities to their corresponding entries in a well-known knowledge base. For a list of languages supported by this operation, see https://aka.ms/talangs. For document length limits, maximum batch size, and supported text encoding, see https://aka.ms/azsdk/textanalytics/data-limits.

AnalyzeHealthcareEntitiesAsync(WaitUntil, IEnumerable<TextDocumentInput>, AnalyzeHealthcareEntitiesOptions, CancellationToken)

Source:
TextAnalyticsClient.cs

Runs a predictive model to identify a collection of healthcare entities found in the passed-in document, and include information linking the entities to their corresponding entries in a well-known knowledge base. For a list of languages supported by this operation, see https://aka.ms/talangs. For document length limits, maximum batch size, and supported text encoding, see https://aka.ms/azsdk/textanalytics/data-limits.

public virtual System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation> AnalyzeHealthcareEntitiesAsync (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member AnalyzeHealthcareEntitiesAsync : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation>
override this.AnalyzeHealthcareEntitiesAsync : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation>
Public Overridable Function AnalyzeHealthcareEntitiesAsync (waitUntil As WaitUntil, documents As IEnumerable(Of TextDocumentInput), Optional options As AnalyzeHealthcareEntitiesOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AnalyzeHealthcareEntitiesOperation)

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 documents to analyze.

options
AnalyzeHealthcareEntitiesOptions

The additional configurable optionsAnalyzeHealthcareEntitiesOptions

cancellationToken
CancellationToken

A CancellationToken controlling the request lifetime.

Returns

A AnalyzeHealthcareEntitiesOperation to wait on this long-running operation. Its Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation.Value upon successful completion will contain layout elements extracted from the form.

Exceptions

This method is only supported in service API version v3.1 and newer.

Service returned a non-success status code.

Remarks

This method is only available for V3_1, V2022_05_01, and newer.

Applies to

AnalyzeHealthcareEntitiesAsync(WaitUntil, IEnumerable<String>, String, AnalyzeHealthcareEntitiesOptions, CancellationToken)

Source:
TextAnalyticsClient.cs

Runs a predictive model to identify a collection of healthcare entities found in the passed-in document, and include information linking the entities to their corresponding entries in a well-known knowledge base. For a list of languages supported by this operation, see https://aka.ms/talangs. For document length limits, maximum batch size, and supported text encoding, see https://aka.ms/azsdk/textanalytics/data-limits.

public virtual System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation> AnalyzeHealthcareEntitiesAsync (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<string> documents, string language = default, Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member AnalyzeHealthcareEntitiesAsync : Azure.WaitUntil * seq<string> * string * Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation>
override this.AnalyzeHealthcareEntitiesAsync : Azure.WaitUntil * seq<string> * string * Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation>
Public Overridable Function AnalyzeHealthcareEntitiesAsync (waitUntil As WaitUntil, documents As IEnumerable(Of String), Optional language As String = Nothing, Optional options As AnalyzeHealthcareEntitiesOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AnalyzeHealthcareEntitiesOperation)

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 documents to analyze.

language
String

The language that the document is written in.

cancellationToken
CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Exceptions

This method is only supported in service API version v3.1 and newer.

Service returned a non-success status code.

Remarks

This method is only available for V3_1, V2022_05_01, and newer.

Applies to