TextAnalyticsClient.AnalyzeHealthcareEntities 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
| AnalyzeHealthcareEntities(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. |
| AnalyzeHealthcareEntities(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. |
AnalyzeHealthcareEntities(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 Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation AnalyzeHealthcareEntities (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions options, System.Threading.CancellationToken cancellationToken = default);abstract member AnalyzeHealthcareEntities : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation
override this.AnalyzeHealthcareEntities : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperationPublic Overridable Function AnalyzeHealthcareEntities (waitUntil As WaitUntil, documents As IEnumerable(Of TextDocumentInput), options As AnalyzeHealthcareEntitiesOptions, Optional cancellationToken As CancellationToken = Nothing) As AnalyzeHealthcareEntitiesOperationParameters
- 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
AnalyzeHealthcareEntities(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 Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation AnalyzeHealthcareEntities (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 AnalyzeHealthcareEntities : Azure.WaitUntil * seq<string> * string * Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation
override this.AnalyzeHealthcareEntities : Azure.WaitUntil * seq<string> * string * Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperationPublic Overridable Function AnalyzeHealthcareEntities (waitUntil As WaitUntil, documents As IEnumerable(Of String), Optional language As String = Nothing, Optional options As AnalyzeHealthcareEntitiesOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AnalyzeHealthcareEntitiesOperationParameters
- 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. If unspecified, this value will be set to the default language in TextAnalyticsClientOptions in the request sent to the service. If set to an empty string, the service will apply a model where the language is explicitly set to "None".
- options
- AnalyzeHealthcareEntitiesOptions
The additional configurable optionsAnalyzeHealthcareEntitiesOptions
- cancellationToken
- CancellationToken
A CancellationToken controlling the request lifetime.
Returns
A result containing the collection of entities identified for each of the documents, as well as scores indicating the confidence that a given entity correctly matches the identified substring.
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.
