xml/Azure.AI.TextAnalytics/TextAnalyticsClient.xml

<Type Name="TextAnalyticsClient" FullName="Azure.AI.TextAnalytics.TextAnalyticsClient"> <TypeSignature Language="C#" Value="public class TextAnalyticsClient" /> <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit TextAnalyticsClient extends System.Object" /> <TypeSignature Language="DocId" Value="T:Azure.AI.TextAnalytics.TextAnalyticsClient" /> <TypeSignature Language="VB.NET" Value="Public Class TextAnalyticsClient" /> <TypeSignature Language="F#" Value="type TextAnalyticsClient = class" /> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.0.0.0</AssemblyVersion> <AssemblyVersion>5.1.0.0</AssemblyVersion> <AssemblyVersion>5.1.1.0</AssemblyVersion> <AssemblyVersion>5.2.0.0</AssemblyVersion> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Base> <BaseTypeName>System.Object</BaseTypeName> </Base> <Interfaces /> <Docs> <summary> The client to use for interacting with the Azure Cognitive Service for Language, which includes Text Analytics. </summary> <remarks>To be added.</remarks> </Docs> <Members> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="protected TextAnalyticsClient ();" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.#ctor" /> <MemberSignature Language="VB.NET" Value="Protected Sub New ()" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Parameters /> <Docs> <summary> Protected constructor to allow mocking. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public TextAnalyticsClient (Uri endpoint, Azure.AzureKeyCredential credential);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.AzureKeyCredential credential) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.#ctor(System.Uri,Azure.AzureKeyCredential)" /> <MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As AzureKeyCredential)" /> <MemberSignature Language="F#" Value="new Azure.AI.TextAnalytics.TextAnalyticsClient : Uri * Azure.AzureKeyCredential -> Azure.AI.TextAnalytics.TextAnalyticsClient" Usage="new Azure.AI.TextAnalytics.TextAnalyticsClient (endpoint, credential)" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Parameters> <Parameter Name="endpoint" Type="System.Uri" /> <Parameter Name="credential" Type="Azure.AzureKeyCredential" /> </Parameters> <Docs> <param name="endpoint">A <see cref="T:System.Uri" /> to the service the client sends requests to. Endpoint can be found in the Azure portal.</param> <param name="credential">The API key used to access the service. This will allow you to update the API key without creating a new client.</param> <summary> Initializes a new instance of the <see cref="T:Azure.AzureKeyCredential" /> class for the specified service instance. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public TextAnalyticsClient (Uri endpoint, Azure.Core.TokenCredential credential);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.Core.TokenCredential credential) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.#ctor(System.Uri,Azure.Core.TokenCredential)" /> <MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As TokenCredential)" /> <MemberSignature Language="F#" Value="new Azure.AI.TextAnalytics.TextAnalyticsClient : Uri * Azure.Core.TokenCredential -> Azure.AI.TextAnalytics.TextAnalyticsClient" Usage="new Azure.AI.TextAnalytics.TextAnalyticsClient (endpoint, credential)" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Parameters> <Parameter Name="endpoint" Type="System.Uri" /> <Parameter Name="credential" Type="Azure.Core.TokenCredential" /> </Parameters> <Docs> <param name="endpoint">A <see cref="T:System.Uri" /> to the service the client sends requests to. Endpoint can be found in the Azure portal.</param> <param name="credential">A <see cref="T:Azure.Core.TokenCredential" /> used to authenticate requests to the service, such as DefaultAzureCredential.</param> <summary> Initializes a new instance of the <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsClient" /> class for the specified service instance. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public TextAnalyticsClient (Uri endpoint, Azure.AzureKeyCredential credential, Azure.AI.TextAnalytics.TextAnalyticsClientOptions options);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.AzureKeyCredential credential, class Azure.AI.TextAnalytics.TextAnalyticsClientOptions options) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.#ctor(System.Uri,Azure.AzureKeyCredential,Azure.AI.TextAnalytics.TextAnalyticsClientOptions)" /> <MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As AzureKeyCredential, options As TextAnalyticsClientOptions)" /> <MemberSignature Language="F#" Value="new Azure.AI.TextAnalytics.TextAnalyticsClient : Uri * Azure.AzureKeyCredential * Azure.AI.TextAnalytics.TextAnalyticsClientOptions -> Azure.AI.TextAnalytics.TextAnalyticsClient" Usage="new Azure.AI.TextAnalytics.TextAnalyticsClient (endpoint, credential, options)" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Parameters> <Parameter Name="endpoint" Type="System.Uri" /> <Parameter Name="credential" Type="Azure.AzureKeyCredential" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.TextAnalyticsClientOptions" /> </Parameters> <Docs> <param name="endpoint">A <see cref="T:System.Uri" /> to the service the client sends requests to. Endpoint can be found in the Azure portal.</param> <param name="credential">The API key used to access the service. This will allow you to update the API key without creating a new client.</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsClientOptions" /> that allow callers to configure how requests are sent to the service.</param> <summary> Initializes a new instance of the <see cref="T:Azure.AzureKeyCredential" /> class for the specified service instance. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public TextAnalyticsClient (Uri endpoint, Azure.Core.TokenCredential credential, Azure.AI.TextAnalytics.TextAnalyticsClientOptions options);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.Core.TokenCredential credential, class Azure.AI.TextAnalytics.TextAnalyticsClientOptions options) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.#ctor(System.Uri,Azure.Core.TokenCredential,Azure.AI.TextAnalytics.TextAnalyticsClientOptions)" /> <MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As TokenCredential, options As TextAnalyticsClientOptions)" /> <MemberSignature Language="F#" Value="new Azure.AI.TextAnalytics.TextAnalyticsClient : Uri * Azure.Core.TokenCredential * Azure.AI.TextAnalytics.TextAnalyticsClientOptions -> Azure.AI.TextAnalytics.TextAnalyticsClient" Usage="new Azure.AI.TextAnalytics.TextAnalyticsClient (endpoint, credential, options)" /> <MemberType>Constructor</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Parameters> <Parameter Name="endpoint" Type="System.Uri" /> <Parameter Name="credential" Type="Azure.Core.TokenCredential" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.TextAnalyticsClientOptions" /> </Parameters> <Docs> <param name="endpoint">A <see cref="T:System.Uri" /> to the service the client sends requests to. Endpoint can be found in the Azure portal.</param> <param name="credential">A <see cref="T:Azure.Core.TokenCredential" /> used to authenticate requests to the service, such as DefaultAzureCredential.</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsClientOptions" /> that allow callers to configure how requests are sent to the service.</param> <summary> Initializes a new instance of the <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsClient" /> class for the specified service instance. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="AbstractiveSummarize"> <MemberSignature Language="C#" Value="public virtual Azure.AI.TextAnalytics.AbstractiveSummarizeOperation AbstractiveSummarize (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, Azure.AI.TextAnalytics.AbstractiveSummarizeOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.TextAnalytics.AbstractiveSummarizeOperation AbstractiveSummarize(valuetype Azure.WaitUntil waitUntil, class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, class Azure.AI.TextAnalytics.AbstractiveSummarizeOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.AbstractiveSummarize(Azure.WaitUntil,System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},Azure.AI.TextAnalytics.AbstractiveSummarizeOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AbstractiveSummarize (waitUntil As WaitUntil, documents As IEnumerable(Of TextDocumentInput), Optional options As AbstractiveSummarizeOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AbstractiveSummarizeOperation" /> <MemberSignature Language="F#" Value="abstract member AbstractiveSummarize : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.AbstractiveSummarizeOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.AbstractiveSummarizeOperation
override this.AbstractiveSummarize : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.AbstractiveSummarizeOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.AbstractiveSummarizeOperation" Usage="textAnalyticsClient.AbstractiveSummarize (waitUntil, documents, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.AI.TextAnalytics.AbstractiveSummarizeOperation</ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.AbstractiveSummarizeOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. </param> <param name="documents">The documents to analyze.</param> <param name="options">The additional <see cref="T:Azure.AI.TextAnalytics.AbstractiveSummarizeOptions" /> used to configure the operation.</param> <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> controlling the lifetime of the request.</param> <summary> Performs abstractive summarization on a given set of documents, which consists of generating a summary with concise, coherent sentences or words which are not simply extract sentences from the original document. For a list of languages supported by this operation, see <see href="https://learn.microsoft.com/azure/cognitive-services/language-service/summarization/language-support" />. For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />. </summary> <returns> An <see cref="T:Azure.AI.TextAnalytics.AbstractiveSummarizeOperation" /> that can be used to monitor the status of the abstractive summarization. Upon completion, the operation will contain the collections of summaries that were generated for each document that was successfully analyzed. </returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2023_04_01" />, and newer. </remarks> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2023-04-01 and newer.</exception> <exception cref="T:Azure.RequestFailedException">The service returned a non-success status code.</exception> <exception cref="T:System.ArgumentException"> <paramref name="documents" /> is an empty collection.</exception> <exception cref="T:System.ArgumentNullException"> <paramref name="documents" /> is null.</exception> </Docs> </Member> <Member MemberName="AbstractiveSummarize"> <MemberSignature Language="C#" Value="public virtual Azure.AI.TextAnalytics.AbstractiveSummarizeOperation AbstractiveSummarize (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<string> documents, string language = default, Azure.AI.TextAnalytics.AbstractiveSummarizeOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.TextAnalytics.AbstractiveSummarizeOperation AbstractiveSummarize(valuetype Azure.WaitUntil waitUntil, class System.Collections.Generic.IEnumerable`1<string> documents, string language, class Azure.AI.TextAnalytics.AbstractiveSummarizeOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.AbstractiveSummarize(Azure.WaitUntil,System.Collections.Generic.IEnumerable{System.String},System.String,Azure.AI.TextAnalytics.AbstractiveSummarizeOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AbstractiveSummarize (waitUntil As WaitUntil, documents As IEnumerable(Of String), Optional language As String = Nothing, Optional options As AbstractiveSummarizeOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AbstractiveSummarizeOperation" /> <MemberSignature Language="F#" Value="abstract member AbstractiveSummarize : Azure.WaitUntil * seq<string> * string * Azure.AI.TextAnalytics.AbstractiveSummarizeOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.AbstractiveSummarizeOperation
override this.AbstractiveSummarize : Azure.WaitUntil * seq<string> * string * Azure.AI.TextAnalytics.AbstractiveSummarizeOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.AbstractiveSummarizeOperation" Usage="textAnalyticsClient.AbstractiveSummarize (waitUntil, documents, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.AI.TextAnalytics.AbstractiveSummarizeOperation</ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.AbstractiveSummarizeOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. </param> <param name="documents">The documents to analyze.</param> <param name="language">The language that the documents are written in.</param> <param name="options">The additional <see cref="T:Azure.AI.TextAnalytics.AbstractiveSummarizeOptions" /> used to configure the operation.</param> <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> controlling the lifetime of the request.</param> <summary> Performs abstractive summarization on a given set of documents, which consists of generating a summary with concise, coherent sentences or words which are not simply extract sentences from the original document. For a list of languages supported by this operation, see <see href="https://learn.microsoft.com/azure/cognitive-services/language-service/summarization/language-support" />. For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />. </summary> <returns> An <see cref="T:Azure.AI.TextAnalytics.AbstractiveSummarizeOperation" /> that can be used to monitor the status of the abstractive summarization. Upon completion, the operation will contain the collections of summaries that were generated for each document that was successfully analyzed. </returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2023_04_01" />, and newer. </remarks> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2023-04-01 and newer.</exception> <exception cref="T:Azure.RequestFailedException">The service returned a non-success status code.</exception> <exception cref="T:System.ArgumentException"> <paramref name="documents" /> is an empty collection.</exception> <exception cref="T:System.ArgumentNullException"> <paramref name="documents" /> is null.</exception> </Docs> </Member> <Member MemberName="AbstractiveSummarizeAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AbstractiveSummarizeOperation> AbstractiveSummarizeAsync (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, Azure.AI.TextAnalytics.AbstractiveSummarizeOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.AI.TextAnalytics.AbstractiveSummarizeOperation> AbstractiveSummarizeAsync(valuetype Azure.WaitUntil waitUntil, class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, class Azure.AI.TextAnalytics.AbstractiveSummarizeOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.AbstractiveSummarizeAsync(Azure.WaitUntil,System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},Azure.AI.TextAnalytics.AbstractiveSummarizeOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AbstractiveSummarizeAsync (waitUntil As WaitUntil, documents As IEnumerable(Of TextDocumentInput), Optional options As AbstractiveSummarizeOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AbstractiveSummarizeOperation)" /> <MemberSignature Language="F#" Value="abstract member AbstractiveSummarizeAsync : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.AbstractiveSummarizeOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AbstractiveSummarizeOperation>
override this.AbstractiveSummarizeAsync : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.AbstractiveSummarizeOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AbstractiveSummarizeOperation>" Usage="textAnalyticsClient.AbstractiveSummarizeAsync (waitUntil, documents, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AbstractiveSummarizeOperation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.AbstractiveSummarizeOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. </param> <param name="documents">The documents to analyze.</param> <param name="options">The additional <see cref="T:Azure.AI.TextAnalytics.AbstractiveSummarizeOptions" /> used to configure the operation.</param> <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> controlling the lifetime of the request.</param> <summary> Performs abstractive summarization on a given set of documents, which consists of generating a summary with concise, coherent sentences or words which are not simply extract sentences from the original document. For a list of languages supported by this operation, see <see href="https://learn.microsoft.com/azure/cognitive-services/language-service/summarization/language-support" />. For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />. </summary> <returns> A <see cref="T:System.Threading.Tasks.Task`1" /> that can be used to monitor the status of the abstractive summarization. Upon completion, the operation will contain the collections of summaries that were generated for each document that was successfully analyzed. </returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2023_04_01" />, and newer. </remarks> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2023-04-01 and newer.</exception> <exception cref="T:Azure.RequestFailedException">The service returned a non-success status code.</exception> <exception cref="T:System.ArgumentException"> <paramref name="documents" /> is an empty collection.</exception> <exception cref="T:System.ArgumentNullException"> <paramref name="documents" /> is null.</exception> </Docs> </Member> <Member MemberName="AbstractiveSummarizeAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AbstractiveSummarizeOperation> AbstractiveSummarizeAsync (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<string> documents, string language = default, Azure.AI.TextAnalytics.AbstractiveSummarizeOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.AI.TextAnalytics.AbstractiveSummarizeOperation> AbstractiveSummarizeAsync(valuetype Azure.WaitUntil waitUntil, class System.Collections.Generic.IEnumerable`1<string> documents, string language, class Azure.AI.TextAnalytics.AbstractiveSummarizeOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.AbstractiveSummarizeAsync(Azure.WaitUntil,System.Collections.Generic.IEnumerable{System.String},System.String,Azure.AI.TextAnalytics.AbstractiveSummarizeOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AbstractiveSummarizeAsync (waitUntil As WaitUntil, documents As IEnumerable(Of String), Optional language As String = Nothing, Optional options As AbstractiveSummarizeOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AbstractiveSummarizeOperation)" /> <MemberSignature Language="F#" Value="abstract member AbstractiveSummarizeAsync : Azure.WaitUntil * seq<string> * string * Azure.AI.TextAnalytics.AbstractiveSummarizeOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AbstractiveSummarizeOperation>
override this.AbstractiveSummarizeAsync : Azure.WaitUntil * seq<string> * string * Azure.AI.TextAnalytics.AbstractiveSummarizeOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AbstractiveSummarizeOperation>" Usage="textAnalyticsClient.AbstractiveSummarizeAsync (waitUntil, documents, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AbstractiveSummarizeOperation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.AbstractiveSummarizeOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. </param> <param name="documents">The documents to analyze.</param> <param name="language">The language that the documents are written in.</param> <param name="options">The additional <see cref="T:Azure.AI.TextAnalytics.AbstractiveSummarizeOptions" /> used to configure the operation.</param> <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> controlling the lifetime of the request.</param> <summary> Performs abstractive summarization on a given set of documents, which consists of generating a summary with concise, coherent sentences or words which are not simply extract sentences from the original document. For a list of languages supported by this operation, see <see href="https://learn.microsoft.com/azure/cognitive-services/language-service/summarization/language-support" />. For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />. </summary> <returns> A <see cref="T:System.Threading.Tasks.Task`1" /> that can be used to monitor the status of the abstractive summarization. Upon completion, the operation will contain the collections of summaries that were generated for each document that was successfully analyzed. </returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2023_04_01" />, and newer. </remarks> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2023-04-01 and newer.</exception> <exception cref="T:Azure.RequestFailedException">The service returned a non-success status code.</exception> <exception cref="T:System.ArgumentException"> <paramref name="documents" /> is an empty collection.</exception> <exception cref="T:System.ArgumentNullException"> <paramref name="documents" /> is null.</exception> </Docs> </Member> <Member MemberName="AnalyzeActions"> <MemberSignature Language="C#" Value="public virtual Azure.AI.TextAnalytics.AnalyzeActionsOperation AnalyzeActions (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);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.TextAnalytics.AnalyzeActionsOperation AnalyzeActions(valuetype Azure.WaitUntil waitUntil, class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, class Azure.AI.TextAnalytics.TextAnalyticsActions actions, class Azure.AI.TextAnalytics.AnalyzeActionsOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.AnalyzeActions(Azure.WaitUntil,System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},Azure.AI.TextAnalytics.TextAnalyticsActions,Azure.AI.TextAnalytics.AnalyzeActionsOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeActions (waitUntil As WaitUntil, documents As IEnumerable(Of TextDocumentInput), actions As TextAnalyticsActions, Optional options As AnalyzeActionsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AnalyzeActionsOperation" /> <MemberSignature Language="F#" Value="abstract member AnalyzeActions : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.TextAnalyticsActions * Azure.AI.TextAnalytics.AnalyzeActionsOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.AnalyzeActionsOperation
override this.AnalyzeActions : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.TextAnalyticsActions * Azure.AI.TextAnalytics.AnalyzeActionsOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.AnalyzeActionsOperation" Usage="textAnalyticsClient.AnalyzeActions (waitUntil, documents, actions, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.AI.TextAnalytics.AnalyzeActionsOperation</ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="actions" Type="Azure.AI.TextAnalytics.TextAnalyticsActions" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.AnalyzeActionsOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. </param> <param name="documents">The list of documents to analyze.</param> <param name="actions"> The <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsActions" /> to perform on the list of documents.</param> <param name="options">The <see cref="T:Azure.AI.TextAnalytics.AnalyzeActionsOptions" /> used to configure the operation.</param> <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> controlling the lifetime of the request.</param> <summary> Performs one or more text analysis actions on a set of documents. The list of supported actions includes: <list type="bullet"><item><description>Entity Recognition (Named, Linked, and Personally Identifiable Information (PII) entities)</description></item><item><description>Key Phrases Extraction</description></item><item><description>Sentiment Analysis</description></item><item><description>Custom Entity Recognition</description></item><item><description>Custom Single and Multi Label Classification</description></item><item><description>Extractive Summarization</description></item><item><description>Abstractive Summarization</description></item></list><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits">here</see>. </para></summary> <returns>To be added.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V3_1" />, <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" />, and newer. See the service <see href="https://aka.ms/azsdk/textanalytics/customfunctionalities">documentation</see> for regional support of custom action features. </remarks> <exception cref="T:System.NotSupportedException"> This method is only supported in service API version v3.1 and newer. The <see cref="T:Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesAction" />, <see cref="T:Azure.AI.TextAnalytics.MultiLabelClassifyAction" />, <see cref="T:Azure.AI.TextAnalytics.RecognizeCustomEntitiesAction" />, and <see cref="T:Azure.AI.TextAnalytics.SingleLabelClassifyAction" /> are only supported in service API version 2022-05-01 and newer. The <see cref="T:Azure.AI.TextAnalytics.ExtractiveSummarizeAction" /> and <see cref="T:Azure.AI.TextAnalytics.AbstractiveSummarizeAction" /> are only supported in service API version 2023-04-01 and newer. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> </Docs> </Member> <Member MemberName="AnalyzeActions"> <MemberSignature Language="C#" Value="public virtual Azure.AI.TextAnalytics.AnalyzeActionsOperation AnalyzeActions (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);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.TextAnalytics.AnalyzeActionsOperation AnalyzeActions(valuetype Azure.WaitUntil waitUntil, class System.Collections.Generic.IEnumerable`1<string> documents, class Azure.AI.TextAnalytics.TextAnalyticsActions actions, string language, class Azure.AI.TextAnalytics.AnalyzeActionsOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.AnalyzeActions(Azure.WaitUntil,System.Collections.Generic.IEnumerable{System.String},Azure.AI.TextAnalytics.TextAnalyticsActions,System.String,Azure.AI.TextAnalytics.AnalyzeActionsOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeActions (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 AnalyzeActionsOperation" /> <MemberSignature Language="F#" Value="abstract member AnalyzeActions : Azure.WaitUntil * seq<string> * Azure.AI.TextAnalytics.TextAnalyticsActions * string * Azure.AI.TextAnalytics.AnalyzeActionsOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.AnalyzeActionsOperation
override this.AnalyzeActions : Azure.WaitUntil * seq<string> * Azure.AI.TextAnalytics.TextAnalyticsActions * string * Azure.AI.TextAnalytics.AnalyzeActionsOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.AnalyzeActionsOperation" Usage="textAnalyticsClient.AnalyzeActions (waitUntil, documents, actions, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.AI.TextAnalytics.AnalyzeActionsOperation</ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="actions" Type="Azure.AI.TextAnalytics.TextAnalyticsActions" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.AnalyzeActionsOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. </param> <param name="documents">The list of documents to analyze.</param> <param name="actions"> The <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsActions" /> to perform on the list of documents.</param> <param name="language">The language that the document is written in.</param> <param name="options">The <see cref="T:Azure.AI.TextAnalytics.AnalyzeActionsOptions" /> used to configure the operation.</param> <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> controlling the lifetime of the request.</param> <summary> Performs one or more text analysis actions on a set of documents. The list of supported actions includes: <list type="bullet"><item><description>Entity Recognition (Named, Linked, and Personally Identifiable Information (PII) entities)</description></item><item><description>Key Phrases Extraction</description></item><item><description>Sentiment Analysis</description></item><item><description>Custom Entity Recognition</description></item><item><description>Custom Single and Multi Label Classification</description></item><item><description>Extractive Summarization</description></item><item><description>Abstractive Summarization</description></item></list><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits">here</see>. </para></summary> <returns>To be added.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V3_1" />, <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" />, and newer. See the service <see href="https://aka.ms/azsdk/textanalytics/customfunctionalities">documentation</see> for regional support of custom action features. </remarks> <exception cref="T:System.NotSupportedException"> This method is only supported in service API version v3.1 and newer. The <see cref="T:Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesAction" />, <see cref="T:Azure.AI.TextAnalytics.MultiLabelClassifyAction" />, <see cref="T:Azure.AI.TextAnalytics.RecognizeCustomEntitiesAction" />, and <see cref="T:Azure.AI.TextAnalytics.SingleLabelClassifyAction" /> are only supported in service API version 2022-05-01 and newer. The <see cref="T:Azure.AI.TextAnalytics.ExtractiveSummarizeAction" /> and <see cref="T:Azure.AI.TextAnalytics.AbstractiveSummarizeAction" /> are only supported in service API version 2023-04-01 and newer. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> </Docs> </Member> <Member MemberName="AnalyzeActionsAsync"> <MemberSignature Language="C#" Value="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);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.AI.TextAnalytics.AnalyzeActionsOperation> AnalyzeActionsAsync(valuetype Azure.WaitUntil waitUntil, class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, class Azure.AI.TextAnalytics.TextAnalyticsActions actions, class Azure.AI.TextAnalytics.AnalyzeActionsOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.AnalyzeActionsAsync(Azure.WaitUntil,System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},Azure.AI.TextAnalytics.TextAnalyticsActions,Azure.AI.TextAnalytics.AnalyzeActionsOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="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)" /> <MemberSignature Language="F#" Value="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>" Usage="textAnalyticsClient.AnalyzeActionsAsync (waitUntil, documents, actions, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeActionsOperation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="actions" Type="Azure.AI.TextAnalytics.TextAnalyticsActions" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.AnalyzeActionsOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. </param> <param name="documents">The list of documents to analyze.</param> <param name="actions"> The <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsActions" /> to perform on the list of documents.</param> <param name="options">The <see cref="T:Azure.AI.TextAnalytics.AnalyzeActionsOptions" /> used to configure the operation.</param> <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> controlling the lifetime of the request.</param> <summary> Performs one or more text analysis actions on a set of documents. The list of supported actions includes: <list type="bullet"><item><description>Entity Recognition (Named, Linked, and Personally Identifiable Information (PII) entities)</description></item><item><description>Key Phrases Extraction</description></item><item><description>Sentiment Analysis</description></item><item><description>Custom Entity Recognition</description></item><item><description>Custom Single and Multi Label Classification</description></item><item><description>Extractive Summarization</description></item><item><description>Abstractive Summarization</description></item></list><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits">here</see>. </para></summary> <returns>To be added.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V3_1" />, <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" />, and newer. See the service <see href="https://aka.ms/azsdk/textanalytics/customfunctionalities">documentation</see> for regional support of custom action features. </remarks> <exception cref="T:System.NotSupportedException"> This method is only supported in service API version v3.1 and newer. The <see cref="T:Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesAction" />, <see cref="T:Azure.AI.TextAnalytics.MultiLabelClassifyAction" />, <see cref="T:Azure.AI.TextAnalytics.RecognizeCustomEntitiesAction" />, and <see cref="T:Azure.AI.TextAnalytics.SingleLabelClassifyAction" /> are only supported in service API version 2022-05-01 and newer. The <see cref="T:Azure.AI.TextAnalytics.ExtractiveSummarizeAction" /> and <see cref="T:Azure.AI.TextAnalytics.AbstractiveSummarizeAction" /> are only supported in service API version 2023-04-01 and newer. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> </Docs> </Member> <Member MemberName="AnalyzeActionsAsync"> <MemberSignature Language="C#" Value="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);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.AI.TextAnalytics.AnalyzeActionsOperation> AnalyzeActionsAsync(valuetype Azure.WaitUntil waitUntil, class System.Collections.Generic.IEnumerable`1<string> documents, class Azure.AI.TextAnalytics.TextAnalyticsActions actions, string language, class Azure.AI.TextAnalytics.AnalyzeActionsOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.AnalyzeActionsAsync(Azure.WaitUntil,System.Collections.Generic.IEnumerable{System.String},Azure.AI.TextAnalytics.TextAnalyticsActions,System.String,Azure.AI.TextAnalytics.AnalyzeActionsOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="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)" /> <MemberSignature Language="F#" Value="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>" Usage="textAnalyticsClient.AnalyzeActionsAsync (waitUntil, documents, actions, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeActionsOperation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="actions" Type="Azure.AI.TextAnalytics.TextAnalyticsActions" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.AnalyzeActionsOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. </param> <param name="documents">The list of documents to analyze.</param> <param name="actions">The <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsActions" /> to perform on the list of documents.</param> <param name="language">The language that the document is written in.</param> <param name="options">The <see cref="T:Azure.AI.TextAnalytics.AnalyzeActionsOptions" /> used to configure the operation.</param> <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> controlling the lifetime of the request.</param> <summary> Performs one or more text analysis actions on a set of documents. The list of supported actions includes: <list type="bullet"><item><description>Entity Recognition (Named, Linked, and Personally Identifiable Information (PII) entities)</description></item><item><description>Key Phrases Extraction</description></item><item><description>Sentiment Analysis</description></item><item><description>Custom Entity Recognition</description></item><item><description>Custom Single and Multi Label Classification</description></item><item><description>Extractive Summarization</description></item><item><description>Abstractive Summarization</description></item></list><para>For document length limits, maximum batch size, and supported text encoding, see more information <see href="https://aka.ms/azsdk/textanalytics/data-limits">here</see>. </para></summary> <returns>To be added.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V3_1" />, <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" />, and newer. See the service <see href="https://aka.ms/azsdk/textanalytics/customfunctionalities">documentation</see> for regional support of custom action features. </remarks> <exception cref="T:System.NotSupportedException"> This method is only supported in service API version v3.1 and newer. The <see cref="T:Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesAction" />, <see cref="T:Azure.AI.TextAnalytics.MultiLabelClassifyAction" />, <see cref="T:Azure.AI.TextAnalytics.RecognizeCustomEntitiesAction" />, and <see cref="T:Azure.AI.TextAnalytics.SingleLabelClassifyAction" /> are only supported in service API version 2022-05-01 and newer. The <see cref="T:Azure.AI.TextAnalytics.ExtractiveSummarizeAction" /> and <see cref="T:Azure.AI.TextAnalytics.AbstractiveSummarizeAction" /> are only supported in service API version 2023-04-01 and newer. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> </Docs> </Member> <Member MemberName="AnalyzeHealthcareEntities"> <MemberSignature Language="C#" Value="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);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation AnalyzeHealthcareEntities(valuetype Azure.WaitUntil waitUntil, class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, class Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.AnalyzeHealthcareEntities(Azure.WaitUntil,System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeHealthcareEntities (waitUntil As WaitUntil, documents As IEnumerable(Of TextDocumentInput), options As AnalyzeHealthcareEntitiesOptions, Optional cancellationToken As CancellationToken = Nothing) As AnalyzeHealthcareEntitiesOperation" /> <MemberSignature Language="F#" Value="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.AnalyzeHealthcareEntitiesOperation" Usage="textAnalyticsClient.AnalyzeHealthcareEntities (waitUntil, documents, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation</ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. </param> <param name="documents">The documents to analyze.</param> <param name="options">The additional configurable options<see cref="T:Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions" /></param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> 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 <see href="https://aka.ms/talangs" />. For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />. </summary> <returns>A <see cref="T:Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation.Value" /> upon successful completion will contain layout elements extracted from the form.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V3_1" />, <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" />, and newer. </remarks> <exception cref="T:System.NotSupportedException">This method is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="AnalyzeHealthcareEntities"> <MemberSignature Language="C#" Value="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);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation AnalyzeHealthcareEntities(valuetype Azure.WaitUntil waitUntil, class System.Collections.Generic.IEnumerable`1<string> documents, string language, class Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.AnalyzeHealthcareEntities(Azure.WaitUntil,System.Collections.Generic.IEnumerable{System.String},System.String,Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public 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 AnalyzeHealthcareEntitiesOperation" /> <MemberSignature Language="F#" Value="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.AnalyzeHealthcareEntitiesOperation" Usage="textAnalyticsClient.AnalyzeHealthcareEntities (waitUntil, documents, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation</ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. </param> <param name="documents">The documents to analyze.</param> <param name="language">The language that the document is written in. If unspecified, this value will be set to the default language in <see cref="T:Azure.AI.TextAnalytics.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".</param> <param name="options">The additional configurable options<see cref="T:Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions" /></param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> 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 <see href="https://aka.ms/talangs" />. For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />. </summary> <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.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V3_1" />, <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" />, and newer. </remarks> <exception cref="T:System.NotSupportedException">This method is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="AnalyzeHealthcareEntitiesAsync"> <MemberSignature Language="C#" Value="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);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation> AnalyzeHealthcareEntitiesAsync(valuetype Azure.WaitUntil waitUntil, class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, class Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.AnalyzeHealthcareEntitiesAsync(Azure.WaitUntil,System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="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)" /> <MemberSignature Language="F#" Value="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>" Usage="textAnalyticsClient.AnalyzeHealthcareEntitiesAsync (waitUntil, documents, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. </param> <param name="documents">The documents to analyze.</param> <param name="options">The additional configurable options<see cref="T:Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions" /></param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> 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 <see href="https://aka.ms/talangs" />. For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />. </summary> <returns>A <see cref="T:Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation.Value" /> upon successful completion will contain layout elements extracted from the form.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V3_1" />, <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" />, and newer. </remarks> <exception cref="T:System.NotSupportedException">This method is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="AnalyzeHealthcareEntitiesAsync"> <MemberSignature Language="C#" Value="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);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation> AnalyzeHealthcareEntitiesAsync(valuetype Azure.WaitUntil waitUntil, class System.Collections.Generic.IEnumerable`1<string> documents, string language, class Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.AnalyzeHealthcareEntitiesAsync(Azure.WaitUntil,System.Collections.Generic.IEnumerable{System.String},System.String,Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="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)" /> <MemberSignature Language="F#" Value="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>" Usage="textAnalyticsClient.AnalyzeHealthcareEntitiesAsync (waitUntil, documents, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. </param> <param name="documents">The documents to analyze.</param> <param name="language">The language that the document is written in.</param> <param name="options">The additional configurable <see cref="T:Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions" /></param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> 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 <see href="https://aka.ms/talangs" />. For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />. </summary> <returns>To be added.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V3_1" />, <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" />, and newer. </remarks> <exception cref="T:System.NotSupportedException">This method is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="AnalyzeSentiment"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.TextAnalytics.DocumentSentiment> AnalyzeSentiment (string document, string language, System.Threading.CancellationToken cancellationToken);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.TextAnalytics.DocumentSentiment> AnalyzeSentiment(string document, string language, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.AnalyzeSentiment(System.String,System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeSentiment (document As String, language As String, cancellationToken As CancellationToken) As Response(Of DocumentSentiment)" /> <MemberSignature Language="F#" Value="abstract member AnalyzeSentiment : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.DocumentSentiment>
override this.AnalyzeSentiment : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.DocumentSentiment>" Usage="textAnalyticsClient.AnalyzeSentiment (document, language, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>Azure.Response<Azure.AI.TextAnalytics.DocumentSentiment></ReturnType> </ReturnValue> <Parameters> <Parameter Name="document" Type="System.String" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="document">The text to analyze.</param> <param name="language">The language that the document is written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify the positive, negative or neutral sentiment contained in the document, as well as a score indicating the model's confidence in the predicted sentiment. <para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing sentiment predictions for the document and each of the sentences it contains.</returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="AnalyzeSentiment"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.TextAnalytics.DocumentSentiment> AnalyzeSentiment (string document, string language = default, Azure.AI.TextAnalytics.AnalyzeSentimentOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.TextAnalytics.DocumentSentiment> AnalyzeSentiment(string document, string language, class Azure.AI.TextAnalytics.AnalyzeSentimentOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.AnalyzeSentiment(System.String,System.String,Azure.AI.TextAnalytics.AnalyzeSentimentOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeSentiment (document As String, Optional language As String = Nothing, Optional options As AnalyzeSentimentOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of DocumentSentiment)" /> <MemberSignature Language="F#" Value="abstract member AnalyzeSentiment : string * string * Azure.AI.TextAnalytics.AnalyzeSentimentOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.DocumentSentiment>
override this.AnalyzeSentiment : string * string * Azure.AI.TextAnalytics.AnalyzeSentimentOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.DocumentSentiment>" Usage="textAnalyticsClient.AnalyzeSentiment (document, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.AI.TextAnalytics.DocumentSentiment></ReturnType> </ReturnValue> <Parameters> <Parameter Name="document" Type="System.String" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.AnalyzeSentimentOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="document">The text to analyze.</param> <param name="language">The language that the document is written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="options">The additional configurable <see cref="T:Azure.AI.TextAnalytics.AnalyzeSentimentOptions" /> that may be passed when analyzing sentiments. Options include Opinion mining, model version, and more.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify the positive, negative or neutral sentiment contained in the document, as well as a score indicating the model's confidence in the predicted sentiment. <para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing sentiment predictions for the document and each of the sentences it contains.</returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="AnalyzeSentimentAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.DocumentSentiment>> AnalyzeSentimentAsync (string document, string language, System.Threading.CancellationToken cancellationToken);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.TextAnalytics.DocumentSentiment>> AnalyzeSentimentAsync(string document, string language, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.AnalyzeSentimentAsync(System.String,System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeSentimentAsync (document As String, language As String, cancellationToken As CancellationToken) As Task(Of Response(Of DocumentSentiment))" /> <MemberSignature Language="F#" Value="abstract member AnalyzeSentimentAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.DocumentSentiment>>
override this.AnalyzeSentimentAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.DocumentSentiment>>" Usage="textAnalyticsClient.AnalyzeSentimentAsync (document, language, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.DocumentSentiment>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="document" Type="System.String" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="document">The document to analyze.</param> <param name="language">The language that the document is written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify the positive, negative, neutral or mixed sentiment contained in the document, as well as a score indicating the model's confidence in the predicted sentiment. <para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing sentiment predictions for the document and each of the sentences it contains.</returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="AnalyzeSentimentAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.DocumentSentiment>> AnalyzeSentimentAsync (string document, string language = default, Azure.AI.TextAnalytics.AnalyzeSentimentOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.TextAnalytics.DocumentSentiment>> AnalyzeSentimentAsync(string document, string language, class Azure.AI.TextAnalytics.AnalyzeSentimentOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.AnalyzeSentimentAsync(System.String,System.String,Azure.AI.TextAnalytics.AnalyzeSentimentOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeSentimentAsync (document As String, Optional language As String = Nothing, Optional options As AnalyzeSentimentOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DocumentSentiment))" /> <MemberSignature Language="F#" Value="abstract member AnalyzeSentimentAsync : string * string * Azure.AI.TextAnalytics.AnalyzeSentimentOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.DocumentSentiment>>
override this.AnalyzeSentimentAsync : string * string * Azure.AI.TextAnalytics.AnalyzeSentimentOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.DocumentSentiment>>" Usage="textAnalyticsClient.AnalyzeSentimentAsync (document, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.DocumentSentiment>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="document" Type="System.String" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.AnalyzeSentimentOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="document">The document to analyze.</param> <param name="language">The language that the document is written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="options">The additional configurable <see cref="T:Azure.AI.TextAnalytics.AnalyzeSentimentOptions" /> that may be passed when analyzing sentiments. Options include Opinion mining, model version, and more.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify the positive, negative, neutral or mixed sentiment contained in the document, as well as a score indicating the model's confidence in the predicted sentiment. <para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing sentiment predictions for the document and each of the sentences it contains.</returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="AnalyzeSentimentBatch"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection> AnalyzeSentimentBatch (System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, Azure.AI.TextAnalytics.AnalyzeSentimentOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection> AnalyzeSentimentBatch(class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, class Azure.AI.TextAnalytics.AnalyzeSentimentOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.AnalyzeSentimentBatch(System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},Azure.AI.TextAnalytics.AnalyzeSentimentOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeSentimentBatch (documents As IEnumerable(Of TextDocumentInput), Optional options As AnalyzeSentimentOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of AnalyzeSentimentResultCollection)" /> <MemberSignature Language="F#" Value="abstract member AnalyzeSentimentBatch : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.AnalyzeSentimentOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection>
override this.AnalyzeSentimentBatch : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.AnalyzeSentimentOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection>" Usage="textAnalyticsClient.AnalyzeSentimentBatch (documents, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.AnalyzeSentimentOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="options">The additional configurable <see cref="T:Azure.AI.TextAnalytics.AnalyzeSentimentOptions" /> that may be passed when analyzing sentiments. Options include Opinion mining, model version, and more.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify the positive, negative or neutral sentiment contained in the documents, as well as scores indicating the model's confidence in each of the predicted sentiments. <para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing sentiment predictions for each of the documents and predictions for each of the sentences each document contains.</returns> <remarks>To be added.</remarks> <exception cref="T:System.NotSupportedException"> <see cref="P:Azure.AI.TextAnalytics.AnalyzeSentimentOptions.IncludeOpinionMining" /> and <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions.DisableServiceLogs" /> are only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="AnalyzeSentimentBatch"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection> AnalyzeSentimentBatch (System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection> AnalyzeSentimentBatch(class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, class Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.AnalyzeSentimentBatch(System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},Azure.AI.TextAnalytics.TextAnalyticsRequestOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeSentimentBatch (documents As IEnumerable(Of TextDocumentInput), options As TextAnalyticsRequestOptions, Optional cancellationToken As CancellationToken = Nothing) As Response(Of AnalyzeSentimentResultCollection)" /> <MemberSignature Language="F#" Value="abstract member AnalyzeSentimentBatch : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection>
override this.AnalyzeSentimentBatch : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection>" Usage="textAnalyticsClient.AnalyzeSentimentBatch (documents, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify the positive, negative or neutral sentiment contained in the documents, as well as scores indicating the model's confidence in each of the predicted sentiments. <para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing sentiment predictions for each of the documents and predictions for each of the sentences each document contains.</returns> <remarks>To be added.</remarks> <exception cref="T:System.NotSupportedException"> <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions.DisableServiceLogs" /> is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="AnalyzeSentimentBatch"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection> AnalyzeSentimentBatch (System.Collections.Generic.IEnumerable<string> documents, string language = default, Azure.AI.TextAnalytics.AnalyzeSentimentOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection> AnalyzeSentimentBatch(class System.Collections.Generic.IEnumerable`1<string> documents, string language, class Azure.AI.TextAnalytics.AnalyzeSentimentOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.AnalyzeSentimentBatch(System.Collections.Generic.IEnumerable{System.String},System.String,Azure.AI.TextAnalytics.AnalyzeSentimentOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeSentimentBatch (documents As IEnumerable(Of String), Optional language As String = Nothing, Optional options As AnalyzeSentimentOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of AnalyzeSentimentResultCollection)" /> <MemberSignature Language="F#" Value="abstract member AnalyzeSentimentBatch : seq<string> * string * Azure.AI.TextAnalytics.AnalyzeSentimentOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection>
override this.AnalyzeSentimentBatch : seq<string> * string * Azure.AI.TextAnalytics.AnalyzeSentimentOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection>" Usage="textAnalyticsClient.AnalyzeSentimentBatch (documents, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.AnalyzeSentimentOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="language">The language that all of the documents are written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="options">The additional configurable <see cref="T:Azure.AI.TextAnalytics.AnalyzeSentimentOptions" /> that may be passed when analyzing sentiments. Options include Opinion mining, model version, and more.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify the positive, negative or neutral sentiment contained in the documents, as well as scores indicating the model's confidence in each of the predicted sentiments. <para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing sentiment predictions for each of the documents and predictions for each of the sentences each document contains.</returns> <remarks>To be added.</remarks> <exception cref="T:System.NotSupportedException"> <see cref="P:Azure.AI.TextAnalytics.AnalyzeSentimentOptions.IncludeOpinionMining" /> and <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions.DisableServiceLogs" /> are only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="AnalyzeSentimentBatch"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection> AnalyzeSentimentBatch (System.Collections.Generic.IEnumerable<string> documents, string language, Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection> AnalyzeSentimentBatch(class System.Collections.Generic.IEnumerable`1<string> documents, string language, class Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.AnalyzeSentimentBatch(System.Collections.Generic.IEnumerable{System.String},System.String,Azure.AI.TextAnalytics.TextAnalyticsRequestOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeSentimentBatch (documents As IEnumerable(Of String), language As String, options As TextAnalyticsRequestOptions, Optional cancellationToken As CancellationToken = Nothing) As Response(Of AnalyzeSentimentResultCollection)" /> <MemberSignature Language="F#" Value="abstract member AnalyzeSentimentBatch : seq<string> * string * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection>
override this.AnalyzeSentimentBatch : seq<string> * string * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection>" Usage="textAnalyticsClient.AnalyzeSentimentBatch (documents, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="language">The language that all of the documents are written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify the positive, negative or neutral sentiment contained in the documents, as well as scores indicating the model's confidence in each of the predicted sentiments. <para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing sentiment predictions for each of the documents and predictions for each of the sentences each document contains.</returns> <remarks>To be added.</remarks> <exception cref="T:System.NotSupportedException"> <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions.DisableServiceLogs" /> is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="AnalyzeSentimentBatchAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection>> AnalyzeSentimentBatchAsync (System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, Azure.AI.TextAnalytics.AnalyzeSentimentOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection>> AnalyzeSentimentBatchAsync(class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, class Azure.AI.TextAnalytics.AnalyzeSentimentOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.AnalyzeSentimentBatchAsync(System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},Azure.AI.TextAnalytics.AnalyzeSentimentOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeSentimentBatchAsync (documents As IEnumerable(Of TextDocumentInput), Optional options As AnalyzeSentimentOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AnalyzeSentimentResultCollection))" /> <MemberSignature Language="F#" Value="abstract member AnalyzeSentimentBatchAsync : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.AnalyzeSentimentOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection>>
override this.AnalyzeSentimentBatchAsync : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.AnalyzeSentimentOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection>>" Usage="textAnalyticsClient.AnalyzeSentimentBatchAsync (documents, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.AnalyzeSentimentOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="options">The additional configurable <see cref="T:Azure.AI.TextAnalytics.AnalyzeSentimentOptions" /> that may be passed when analyzing sentiments. Options include Opinion mining, model version, and more.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify the positive, negative or neutral sentiment contained in the documents, as well as scores indicating the model's confidence in each of the predicted sentiments. <para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing sentiment predictions for each of the documents and predictions for each of the sentences each document contains.</returns> <remarks>To be added.</remarks> <exception cref="T:System.NotSupportedException"> <see cref="P:Azure.AI.TextAnalytics.AnalyzeSentimentOptions.IncludeOpinionMining" /> and <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions.DisableServiceLogs" /> are only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="AnalyzeSentimentBatchAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection>> AnalyzeSentimentBatchAsync (System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection>> AnalyzeSentimentBatchAsync(class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, class Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.AnalyzeSentimentBatchAsync(System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},Azure.AI.TextAnalytics.TextAnalyticsRequestOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeSentimentBatchAsync (documents As IEnumerable(Of TextDocumentInput), options As TextAnalyticsRequestOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AnalyzeSentimentResultCollection))" /> <MemberSignature Language="F#" Value="abstract member AnalyzeSentimentBatchAsync : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection>>
override this.AnalyzeSentimentBatchAsync : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection>>" Usage="textAnalyticsClient.AnalyzeSentimentBatchAsync (documents, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify the positive, negative or neutral sentiment contained in the documents, as well as scores indicating the model's confidence in each of the predicted sentiments. <para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing sentiment predictions for each of the documents and predictions for each of the sentences each document contains.</returns> <remarks>To be added.</remarks> <exception cref="T:System.NotSupportedException"> <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions.DisableServiceLogs" /> is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="AnalyzeSentimentBatchAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection>> AnalyzeSentimentBatchAsync (System.Collections.Generic.IEnumerable<string> documents, string language = default, Azure.AI.TextAnalytics.AnalyzeSentimentOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection>> AnalyzeSentimentBatchAsync(class System.Collections.Generic.IEnumerable`1<string> documents, string language, class Azure.AI.TextAnalytics.AnalyzeSentimentOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.AnalyzeSentimentBatchAsync(System.Collections.Generic.IEnumerable{System.String},System.String,Azure.AI.TextAnalytics.AnalyzeSentimentOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeSentimentBatchAsync (documents As IEnumerable(Of String), Optional language As String = Nothing, Optional options As AnalyzeSentimentOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AnalyzeSentimentResultCollection))" /> <MemberSignature Language="F#" Value="abstract member AnalyzeSentimentBatchAsync : seq<string> * string * Azure.AI.TextAnalytics.AnalyzeSentimentOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection>>
override this.AnalyzeSentimentBatchAsync : seq<string> * string * Azure.AI.TextAnalytics.AnalyzeSentimentOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection>>" Usage="textAnalyticsClient.AnalyzeSentimentBatchAsync (documents, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.AnalyzeSentimentOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="language">The language that all of the documents are written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="options">The additional configurable <see cref="T:Azure.AI.TextAnalytics.AnalyzeSentimentOptions" /> that may be passed when analyzing sentiments. Options include Opinion mining, model version, and more.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify the positive, negative or neutral sentiment contained in the documents, as well as scores indicating the model's confidence in each of the predicted sentiments. <para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing sentiment predictions for each of the documents and predictions for each of the sentences each document contains.</returns> <remarks>To be added.</remarks> <exception cref="T:System.NotSupportedException"> <see cref="P:Azure.AI.TextAnalytics.AnalyzeSentimentOptions.IncludeOpinionMining" /> and <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions.DisableServiceLogs" /> are only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="AnalyzeSentimentBatchAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection>> AnalyzeSentimentBatchAsync (System.Collections.Generic.IEnumerable<string> documents, string language, Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection>> AnalyzeSentimentBatchAsync(class System.Collections.Generic.IEnumerable`1<string> documents, string language, class Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.AnalyzeSentimentBatchAsync(System.Collections.Generic.IEnumerable{System.String},System.String,Azure.AI.TextAnalytics.TextAnalyticsRequestOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeSentimentBatchAsync (documents As IEnumerable(Of String), language As String, options As TextAnalyticsRequestOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AnalyzeSentimentResultCollection))" /> <MemberSignature Language="F#" Value="abstract member AnalyzeSentimentBatchAsync : seq<string> * string * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection>>
override this.AnalyzeSentimentBatchAsync : seq<string> * string * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection>>" Usage="textAnalyticsClient.AnalyzeSentimentBatchAsync (documents, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.AnalyzeSentimentResultCollection>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="language">The language that all of the documents are written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify the positive, negative or neutral sentiment contained in the documents, as well as scores indicating the model's confidence in each of the predicted sentiments. <para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing sentiment predictions for each of the documents and predictions for each of the sentences each document contains.</returns> <remarks>To be added.</remarks> <exception cref="T:System.NotSupportedException"> <see cref="P:Azure.AI.TextAnalytics.AnalyzeSentimentOptions.IncludeOpinionMining" /> and <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions.DisableServiceLogs" /> are only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="DetectLanguage"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.TextAnalytics.DetectedLanguage> DetectLanguage (string document, string countryHint = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<valuetype Azure.AI.TextAnalytics.DetectedLanguage> DetectLanguage(string document, string countryHint, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.DetectLanguage(System.String,System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DetectLanguage (document As String, Optional countryHint As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of DetectedLanguage)" /> <MemberSignature Language="F#" Value="abstract member DetectLanguage : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.DetectedLanguage>
override this.DetectLanguage : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.DetectedLanguage>" Usage="textAnalyticsClient.DetectLanguage (document, countryHint, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.AI.TextAnalytics.DetectedLanguage></ReturnType> </ReturnValue> <Parameters> <Parameter Name="document" Type="System.String" /> <Parameter Name="countryHint" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="document">The document to analyze.</param> <param name="countryHint">Indicates the country of origin of the document to assist the model in predicting the language it is written in. If unspecified, this value will be set to the default country hint in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultCountryHint" /> in the request sent to the service. To remove this behavior, set to <see cref="F:Azure.AI.TextAnalytics.DetectLanguageInput.None" />.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to determine the language the passed-in document is written in, and returns the detected language as well as a score indicating the model's confidence that the inferred language is correct. Scores close to 1 indicate high certainty in the result. <para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing the detected language or an error if the model could not analyze the document.</returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="DetectLanguageAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.DetectedLanguage>> DetectLanguageAsync (string document, string countryHint = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<valuetype Azure.AI.TextAnalytics.DetectedLanguage>> DetectLanguageAsync(string document, string countryHint, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.DetectLanguageAsync(System.String,System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DetectLanguageAsync (document As String, Optional countryHint As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DetectedLanguage))" /> <MemberSignature Language="F#" Value="abstract member DetectLanguageAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.DetectedLanguage>>
override this.DetectLanguageAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.DetectedLanguage>>" Usage="textAnalyticsClient.DetectLanguageAsync (document, countryHint, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.DetectedLanguage>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="document" Type="System.String" /> <Parameter Name="countryHint" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="document">The document to analyze.</param> <param name="countryHint">Indicates the country of origin of the document to assist the model in predicting the language it is written in. If unspecified, this value will be set to the default country hint in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultCountryHint" /> in the request sent to the service. To remove this behavior, set to <see cref="F:Azure.AI.TextAnalytics.DetectLanguageInput.None" />.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to determine the language the passed-in document is written in, and returns the detected language as well as a score indicating the model's confidence that the inferred language is correct. Scores close to 1 indicate high certainty in the result. <para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing the detected language or an error if the model could not analyze the document.</returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="DetectLanguageBatch"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.TextAnalytics.DetectLanguageResultCollection> DetectLanguageBatch (System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.DetectLanguageInput> documents, Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.TextAnalytics.DetectLanguageResultCollection> DetectLanguageBatch(class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.DetectLanguageInput> documents, class Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.DetectLanguageBatch(System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.DetectLanguageInput},Azure.AI.TextAnalytics.TextAnalyticsRequestOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DetectLanguageBatch (documents As IEnumerable(Of DetectLanguageInput), Optional options As TextAnalyticsRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of DetectLanguageResultCollection)" /> <MemberSignature Language="F#" Value="abstract member DetectLanguageBatch : seq<Azure.AI.TextAnalytics.DetectLanguageInput> * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.DetectLanguageResultCollection>
override this.DetectLanguageBatch : seq<Azure.AI.TextAnalytics.DetectLanguageInput> * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.DetectLanguageResultCollection>" Usage="textAnalyticsClient.DetectLanguageBatch (documents, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.AI.TextAnalytics.DetectLanguageResultCollection></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.DetectLanguageInput>" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">A collection of documents to analyze.</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to determine the language the passed-in documents are written in, and returns, for each one, the detected language as well as a score indicating the model's confidence that the inferred language is correct. Scores close to 1 indicate high certainty in the result. <para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing the detected language or an error if the model could not analyze the document.</returns> <remarks>To be added.</remarks> <exception cref="T:System.NotSupportedException"> <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions.DisableServiceLogs" /> is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="DetectLanguageBatch"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.TextAnalytics.DetectLanguageResultCollection> DetectLanguageBatch (System.Collections.Generic.IEnumerable<string> documents, string countryHint = default, Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.TextAnalytics.DetectLanguageResultCollection> DetectLanguageBatch(class System.Collections.Generic.IEnumerable`1<string> documents, string countryHint, class Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.DetectLanguageBatch(System.Collections.Generic.IEnumerable{System.String},System.String,Azure.AI.TextAnalytics.TextAnalyticsRequestOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DetectLanguageBatch (documents As IEnumerable(Of String), Optional countryHint As String = Nothing, Optional options As TextAnalyticsRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of DetectLanguageResultCollection)" /> <MemberSignature Language="F#" Value="abstract member DetectLanguageBatch : seq<string> * string * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.DetectLanguageResultCollection>
override this.DetectLanguageBatch : seq<string> * string * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.DetectLanguageResultCollection>" Usage="textAnalyticsClient.DetectLanguageBatch (documents, countryHint, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.AI.TextAnalytics.DetectLanguageResultCollection></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="countryHint" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">A collection of documents to analyze.</param> <param name="countryHint">Indicates the country of origin of all of the documents to assist the model in predicting the language they are written in. If unspecified, this value will be set to the default country hint in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultCountryHint" /> in the request sent to the service. To remove this behavior, set to <see cref="F:Azure.AI.TextAnalytics.DetectLanguageInput.None" />.</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to determine the language the passed-in documents are written in, and returns, for each one, the detected language as well as a score indicating the model's confidence that the inferred language is correct. Scores close to 1 indicate high certainty in the result. <para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing the detected language or an error if the model could not analyze the documents.</returns> <remarks>To be added.</remarks> <exception cref="T:System.NotSupportedException"> <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions.DisableServiceLogs" /> is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="DetectLanguageBatchAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.DetectLanguageResultCollection>> DetectLanguageBatchAsync (System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.DetectLanguageInput> documents, Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.TextAnalytics.DetectLanguageResultCollection>> DetectLanguageBatchAsync(class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.DetectLanguageInput> documents, class Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.DetectLanguageBatchAsync(System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.DetectLanguageInput},Azure.AI.TextAnalytics.TextAnalyticsRequestOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DetectLanguageBatchAsync (documents As IEnumerable(Of DetectLanguageInput), Optional options As TextAnalyticsRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DetectLanguageResultCollection))" /> <MemberSignature Language="F#" Value="abstract member DetectLanguageBatchAsync : seq<Azure.AI.TextAnalytics.DetectLanguageInput> * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.DetectLanguageResultCollection>>
override this.DetectLanguageBatchAsync : seq<Azure.AI.TextAnalytics.DetectLanguageInput> * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.DetectLanguageResultCollection>>" Usage="textAnalyticsClient.DetectLanguageBatchAsync (documents, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.DetectLanguageResultCollection>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.DetectLanguageInput>" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">A collection of documents to analyze.</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to determine the language the passed-in documents are written in, and returns, for each one, the detected language as well as a score indicating the model's confidence that the inferred language is correct. Scores close to 1 indicate high certainty in the result. <para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing the detected language or an error if the model could not analyze the documents.</returns> <remarks>To be added.</remarks> <exception cref="T:System.NotSupportedException"> <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions.DisableServiceLogs" /> is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="DetectLanguageBatchAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.DetectLanguageResultCollection>> DetectLanguageBatchAsync (System.Collections.Generic.IEnumerable<string> documents, string countryHint = default, Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.TextAnalytics.DetectLanguageResultCollection>> DetectLanguageBatchAsync(class System.Collections.Generic.IEnumerable`1<string> documents, string countryHint, class Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.DetectLanguageBatchAsync(System.Collections.Generic.IEnumerable{System.String},System.String,Azure.AI.TextAnalytics.TextAnalyticsRequestOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DetectLanguageBatchAsync (documents As IEnumerable(Of String), Optional countryHint As String = Nothing, Optional options As TextAnalyticsRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DetectLanguageResultCollection))" /> <MemberSignature Language="F#" Value="abstract member DetectLanguageBatchAsync : seq<string> * string * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.DetectLanguageResultCollection>>
override this.DetectLanguageBatchAsync : seq<string> * string * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.DetectLanguageResultCollection>>" Usage="textAnalyticsClient.DetectLanguageBatchAsync (documents, countryHint, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.DetectLanguageResultCollection>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="countryHint" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">A collection of documents to analyze.</param> <param name="countryHint">Indicates the country of origin of all of the documents to assist the model in predicting the language they are written in. If unspecified, this value will be set to the default country hint in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultCountryHint" /> in the request sent to the service. To remove this behavior, set to <see cref="F:Azure.AI.TextAnalytics.DetectLanguageInput.None" />.</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to determine the language the passed-in documents are written in, and returns, for each one, the detected language as well as a score indicating the model's confidence that the inferred language is correct. Scores close to 1 indicate high certainty in the result. <para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing the detected language or an error if the model could not analyze the documents.</returns> <remarks>To be added.</remarks> <exception cref="T:System.NotSupportedException"> <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions.DisableServiceLogs" /> is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="Equals"> <MemberSignature Language="C#" Value="public override bool Equals (object obj);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.Equals(System.Object)" /> <MemberSignature Language="VB.NET" Value="Public Overrides Function Equals (obj As Object) As Boolean" /> <MemberSignature Language="F#" Value="override this.Equals : obj -> bool" Usage="textAnalyticsClient.Equals obj" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters> <Parameter Name="obj" Type="System.Object" /> </Parameters> <Docs> <param name="obj">The instance to compare to.</param> <summary> Check if two TextAnalyticsClient instances are equal. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="ExtractiveSummarize"> <MemberSignature Language="C#" Value="public virtual Azure.AI.TextAnalytics.ExtractiveSummarizeOperation ExtractiveSummarize (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, Azure.AI.TextAnalytics.ExtractiveSummarizeOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.TextAnalytics.ExtractiveSummarizeOperation ExtractiveSummarize(valuetype Azure.WaitUntil waitUntil, class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, class Azure.AI.TextAnalytics.ExtractiveSummarizeOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.ExtractiveSummarize(Azure.WaitUntil,System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},Azure.AI.TextAnalytics.ExtractiveSummarizeOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function ExtractiveSummarize (waitUntil As WaitUntil, documents As IEnumerable(Of TextDocumentInput), Optional options As ExtractiveSummarizeOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ExtractiveSummarizeOperation" /> <MemberSignature Language="F#" Value="abstract member ExtractiveSummarize : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.ExtractiveSummarizeOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.ExtractiveSummarizeOperation
override this.ExtractiveSummarize : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.ExtractiveSummarizeOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.ExtractiveSummarizeOperation" Usage="textAnalyticsClient.ExtractiveSummarize (waitUntil, documents, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.AI.TextAnalytics.ExtractiveSummarizeOperation</ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.ExtractiveSummarizeOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. </param> <param name="documents">The documents to analyze.</param> <param name="options">The additional <see cref="T:Azure.AI.TextAnalytics.ExtractiveSummarizeOptions" /> used to configure the operation.</param> <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> controlling the lifetime of the request.</param> <summary> Performs extractive summarization on the given documents, which consists of extracting sentences that collectively represent the most important or relevant information within the original content. For a list of languages supported by this operation, see <see href="https://learn.microsoft.com/azure/cognitive-services/language-service/summarization/language-support" />. For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />. </summary> <returns> An <see cref="T:Azure.AI.TextAnalytics.ExtractiveSummarizeOperation" /> that can be used to monitor the status of extractive summarization. Upon completion, the operation will contain the collections of extracted summary sentences for each document that was successfully analyzed. </returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2023_04_01" />, and newer. </remarks> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2023-04-01 and newer.</exception> <exception cref="T:Azure.RequestFailedException">The service returned a non-success status code.</exception> <exception cref="T:System.ArgumentException"> <paramref name="documents" /> is an empty collection.</exception> <exception cref="T:System.ArgumentNullException"> <paramref name="documents" /> is null.</exception> </Docs> </Member> <Member MemberName="ExtractiveSummarize"> <MemberSignature Language="C#" Value="public virtual Azure.AI.TextAnalytics.ExtractiveSummarizeOperation ExtractiveSummarize (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<string> documents, string language = default, Azure.AI.TextAnalytics.ExtractiveSummarizeOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.TextAnalytics.ExtractiveSummarizeOperation ExtractiveSummarize(valuetype Azure.WaitUntil waitUntil, class System.Collections.Generic.IEnumerable`1<string> documents, string language, class Azure.AI.TextAnalytics.ExtractiveSummarizeOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.ExtractiveSummarize(Azure.WaitUntil,System.Collections.Generic.IEnumerable{System.String},System.String,Azure.AI.TextAnalytics.ExtractiveSummarizeOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function ExtractiveSummarize (waitUntil As WaitUntil, documents As IEnumerable(Of String), Optional language As String = Nothing, Optional options As ExtractiveSummarizeOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ExtractiveSummarizeOperation" /> <MemberSignature Language="F#" Value="abstract member ExtractiveSummarize : Azure.WaitUntil * seq<string> * string * Azure.AI.TextAnalytics.ExtractiveSummarizeOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.ExtractiveSummarizeOperation
override this.ExtractiveSummarize : Azure.WaitUntil * seq<string> * string * Azure.AI.TextAnalytics.ExtractiveSummarizeOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.ExtractiveSummarizeOperation" Usage="textAnalyticsClient.ExtractiveSummarize (waitUntil, documents, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.AI.TextAnalytics.ExtractiveSummarizeOperation</ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.ExtractiveSummarizeOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. </param> <param name="documents">The documents to analyze.</param> <param name="language">The language that the documents are written in.</param> <param name="options">The additional <see cref="T:Azure.AI.TextAnalytics.ExtractiveSummarizeOptions" /> used to configure the operation.</param> <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> controlling the lifetime of the request.</param> <summary> Performs extractive summarization on the given documents, which consists of extracting sentences that collectively represent the most important or relevant information within the original content. For a list of languages supported by this operation, see <see href="https://learn.microsoft.com/azure/cognitive-services/language-service/summarization/language-support" />. For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />. </summary> <returns> An <see cref="T:Azure.AI.TextAnalytics.ExtractiveSummarizeOperation" /> that can be used to monitor the status of extractive summarization. Upon completion, the operation will contain the collections of extracted summary sentences for each document that was successfully analyzed. </returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2023_04_01" />, and newer. </remarks> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2023-04-01 and newer.</exception> <exception cref="T:Azure.RequestFailedException">The service returned a non-success status code.</exception> <exception cref="T:System.ArgumentException"> <paramref name="documents" /> is an empty collection.</exception> <exception cref="T:System.ArgumentNullException"> <paramref name="documents" /> is null.</exception> </Docs> </Member> <Member MemberName="ExtractiveSummarizeAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ExtractiveSummarizeOperation> ExtractiveSummarizeAsync (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, Azure.AI.TextAnalytics.ExtractiveSummarizeOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.AI.TextAnalytics.ExtractiveSummarizeOperation> ExtractiveSummarizeAsync(valuetype Azure.WaitUntil waitUntil, class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, class Azure.AI.TextAnalytics.ExtractiveSummarizeOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.ExtractiveSummarizeAsync(Azure.WaitUntil,System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},Azure.AI.TextAnalytics.ExtractiveSummarizeOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function ExtractiveSummarizeAsync (waitUntil As WaitUntil, documents As IEnumerable(Of TextDocumentInput), Optional options As ExtractiveSummarizeOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ExtractiveSummarizeOperation)" /> <MemberSignature Language="F#" Value="abstract member ExtractiveSummarizeAsync : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.ExtractiveSummarizeOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ExtractiveSummarizeOperation>
override this.ExtractiveSummarizeAsync : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.ExtractiveSummarizeOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ExtractiveSummarizeOperation>" Usage="textAnalyticsClient.ExtractiveSummarizeAsync (waitUntil, documents, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ExtractiveSummarizeOperation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.ExtractiveSummarizeOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. </param> <param name="documents">The documents to analyze.</param> <param name="options">The additional <see cref="T:Azure.AI.TextAnalytics.ExtractiveSummarizeOptions" /> used to configure the operation.</param> <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> controlling the lifetime of the request.</param> <summary> Performs extractive summarization on the given documents, which consists of extracting sentences that collectively represent the most important or relevant information within the original content. For a list of languages supported by this operation, see <see href="https://learn.microsoft.com/azure/cognitive-services/language-service/summarization/language-support" />. For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />. </summary> <returns> A <see cref="T:System.Threading.Tasks.Task`1" /> that can be used to monitor the status of the extractive summarization. Upon completion, the operation will contain the collections of extracted summary sentences for each document that was successfully analyzed. </returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2023_04_01" />, and newer. </remarks> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2023-04-01 and newer.</exception> <exception cref="T:Azure.RequestFailedException">The service returned a non-success status code.</exception> <exception cref="T:System.ArgumentException"> <paramref name="documents" /> is an empty collection.</exception> <exception cref="T:System.ArgumentNullException"> <paramref name="documents" /> is null.</exception> </Docs> </Member> <Member MemberName="ExtractiveSummarizeAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ExtractiveSummarizeOperation> ExtractiveSummarizeAsync (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<string> documents, string language = default, Azure.AI.TextAnalytics.ExtractiveSummarizeOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.AI.TextAnalytics.ExtractiveSummarizeOperation> ExtractiveSummarizeAsync(valuetype Azure.WaitUntil waitUntil, class System.Collections.Generic.IEnumerable`1<string> documents, string language, class Azure.AI.TextAnalytics.ExtractiveSummarizeOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.ExtractiveSummarizeAsync(Azure.WaitUntil,System.Collections.Generic.IEnumerable{System.String},System.String,Azure.AI.TextAnalytics.ExtractiveSummarizeOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function ExtractiveSummarizeAsync (waitUntil As WaitUntil, documents As IEnumerable(Of String), Optional language As String = Nothing, Optional options As ExtractiveSummarizeOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ExtractiveSummarizeOperation)" /> <MemberSignature Language="F#" Value="abstract member ExtractiveSummarizeAsync : Azure.WaitUntil * seq<string> * string * Azure.AI.TextAnalytics.ExtractiveSummarizeOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ExtractiveSummarizeOperation>
override this.ExtractiveSummarizeAsync : Azure.WaitUntil * seq<string> * string * Azure.AI.TextAnalytics.ExtractiveSummarizeOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ExtractiveSummarizeOperation>" Usage="textAnalyticsClient.ExtractiveSummarizeAsync (waitUntil, documents, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ExtractiveSummarizeOperation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.ExtractiveSummarizeOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. </param> <param name="documents">The documents to analyze.</param> <param name="language">The language that the documents are written in.</param> <param name="options">The additional <see cref="T:Azure.AI.TextAnalytics.ExtractiveSummarizeOptions" /> used to configure the operation.</param> <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> controlling the lifetime of the request.</param> <summary> Performs extractive summarization on the given documents, which consists of extracting sentences that collectively represent the most important or relevant information within the original content. For a list of languages supported by this operation, see <see href="https://learn.microsoft.com/azure/cognitive-services/language-service/summarization/language-support" />. For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />. </summary> <returns> A <see cref="T:System.Threading.Tasks.Task`1" /> that can be used to monitor the status of the extractive summarization. Upon completion, the operation will contain the collections of extracted summary sentences for each document that was successfully analyzed. </returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2023_04_01" />, and newer. </remarks> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2023-04-01 and newer.</exception> <exception cref="T:Azure.RequestFailedException">The service returned a non-success status code.</exception> <exception cref="T:System.ArgumentException"> <paramref name="documents" /> is an empty collection.</exception> <exception cref="T:System.ArgumentNullException"> <paramref name="documents" /> is null.</exception> </Docs> </Member> <Member MemberName="ExtractKeyPhrases"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.TextAnalytics.KeyPhraseCollection> ExtractKeyPhrases (string document, string language = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.TextAnalytics.KeyPhraseCollection> ExtractKeyPhrases(string document, string language, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.ExtractKeyPhrases(System.String,System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function ExtractKeyPhrases (document As String, Optional language As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of KeyPhraseCollection)" /> <MemberSignature Language="F#" Value="abstract member ExtractKeyPhrases : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.KeyPhraseCollection>
override this.ExtractKeyPhrases : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.KeyPhraseCollection>" Usage="textAnalyticsClient.ExtractKeyPhrases (document, language, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.AI.TextAnalytics.KeyPhraseCollection></ReturnType> </ReturnValue> <Parameters> <Parameter Name="document" Type="System.String" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="document">The document to analyze.</param> <param name="language">The language that the document is written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a model to identify a collection of significant phrases found in the passed-in document. <para>For example, for the document "The food was delicious and there were wonderful staff", the API returns the main talking points: "food" and "wonderful staff".</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing the collection of key phrases identified in the document.</returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="ExtractKeyPhrasesAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.KeyPhraseCollection>> ExtractKeyPhrasesAsync (string document, string language = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.TextAnalytics.KeyPhraseCollection>> ExtractKeyPhrasesAsync(string document, string language, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.ExtractKeyPhrasesAsync(System.String,System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function ExtractKeyPhrasesAsync (document As String, Optional language As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of KeyPhraseCollection))" /> <MemberSignature Language="F#" Value="abstract member ExtractKeyPhrasesAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.KeyPhraseCollection>>
override this.ExtractKeyPhrasesAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.KeyPhraseCollection>>" Usage="textAnalyticsClient.ExtractKeyPhrasesAsync (document, language, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.KeyPhraseCollection>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="document" Type="System.String" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="document">The document to analyze.</param> <param name="language">The language that the document is written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a model to identify a collection of significant phrases found in the passed-in document. <para>For example, for the document "The food was delicious and there were wonderful staff", the API returns the main talking points: "food" and "wonderful staff".</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing the collection of key phrases identified in the document.</returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="ExtractKeyPhrasesBatch"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.TextAnalytics.ExtractKeyPhrasesResultCollection> ExtractKeyPhrasesBatch (System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.TextAnalytics.ExtractKeyPhrasesResultCollection> ExtractKeyPhrasesBatch(class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, class Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.ExtractKeyPhrasesBatch(System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},Azure.AI.TextAnalytics.TextAnalyticsRequestOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function ExtractKeyPhrasesBatch (documents As IEnumerable(Of TextDocumentInput), Optional options As TextAnalyticsRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ExtractKeyPhrasesResultCollection)" /> <MemberSignature Language="F#" Value="abstract member ExtractKeyPhrasesBatch : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.ExtractKeyPhrasesResultCollection>
override this.ExtractKeyPhrasesBatch : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.ExtractKeyPhrasesResultCollection>" Usage="textAnalyticsClient.ExtractKeyPhrasesBatch (documents, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.AI.TextAnalytics.ExtractKeyPhrasesResultCollection></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a model to identify a collection of significant phrases found in the passed-in documents. <para>For example, for the document "The food was delicious and there were wonderful staff", the API returns the main talking points: "food" and "wonderful staff".</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing the collection of key phrases identified in each of the documents.</returns> <remarks>To be added.</remarks> <exception cref="T:System.NotSupportedException"> <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions.DisableServiceLogs" /> is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="ExtractKeyPhrasesBatch"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.TextAnalytics.ExtractKeyPhrasesResultCollection> ExtractKeyPhrasesBatch (System.Collections.Generic.IEnumerable<string> documents, string language = default, Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.TextAnalytics.ExtractKeyPhrasesResultCollection> ExtractKeyPhrasesBatch(class System.Collections.Generic.IEnumerable`1<string> documents, string language, class Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.ExtractKeyPhrasesBatch(System.Collections.Generic.IEnumerable{System.String},System.String,Azure.AI.TextAnalytics.TextAnalyticsRequestOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function ExtractKeyPhrasesBatch (documents As IEnumerable(Of String), Optional language As String = Nothing, Optional options As TextAnalyticsRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ExtractKeyPhrasesResultCollection)" /> <MemberSignature Language="F#" Value="abstract member ExtractKeyPhrasesBatch : seq<string> * string * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.ExtractKeyPhrasesResultCollection>
override this.ExtractKeyPhrasesBatch : seq<string> * string * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.ExtractKeyPhrasesResultCollection>" Usage="textAnalyticsClient.ExtractKeyPhrasesBatch (documents, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.AI.TextAnalytics.ExtractKeyPhrasesResultCollection></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="language">The language that all the documents are written in. If unspecified, this value will be set to the default language in <see cref="T:Azure.AI.TextAnalytics.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".</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a model to identify a collection of significant phrases found in the passed-in documents. <para>For example, for the document "The food was delicious and there were wonderful staff", the API returns the main talking points: "food" and "wonderful staff".</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing the collection of key phrases identified in each of the documents.</returns> <remarks>To be added.</remarks> <exception cref="T:System.NotSupportedException"> <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions.DisableServiceLogs" /> is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="ExtractKeyPhrasesBatchAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.ExtractKeyPhrasesResultCollection>> ExtractKeyPhrasesBatchAsync (System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.TextAnalytics.ExtractKeyPhrasesResultCollection>> ExtractKeyPhrasesBatchAsync(class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, class Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.ExtractKeyPhrasesBatchAsync(System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},Azure.AI.TextAnalytics.TextAnalyticsRequestOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function ExtractKeyPhrasesBatchAsync (documents As IEnumerable(Of TextDocumentInput), Optional options As TextAnalyticsRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ExtractKeyPhrasesResultCollection))" /> <MemberSignature Language="F#" Value="abstract member ExtractKeyPhrasesBatchAsync : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.ExtractKeyPhrasesResultCollection>>
override this.ExtractKeyPhrasesBatchAsync : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.ExtractKeyPhrasesResultCollection>>" Usage="textAnalyticsClient.ExtractKeyPhrasesBatchAsync (documents, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.ExtractKeyPhrasesResultCollection>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a model to identify a collection of significant phrases found in the passed-in documents. <para>For example, for the document "The food was delicious and there were wonderful staff", the API returns the main talking points: "food" and "wonderful staff".</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing the collection of key phrases identified in each of the documents.</returns> <remarks>To be added.</remarks> <exception cref="T:System.NotSupportedException"> <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions.DisableServiceLogs" /> is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="ExtractKeyPhrasesBatchAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.ExtractKeyPhrasesResultCollection>> ExtractKeyPhrasesBatchAsync (System.Collections.Generic.IEnumerable<string> documents, string language = default, Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.TextAnalytics.ExtractKeyPhrasesResultCollection>> ExtractKeyPhrasesBatchAsync(class System.Collections.Generic.IEnumerable`1<string> documents, string language, class Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.ExtractKeyPhrasesBatchAsync(System.Collections.Generic.IEnumerable{System.String},System.String,Azure.AI.TextAnalytics.TextAnalyticsRequestOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function ExtractKeyPhrasesBatchAsync (documents As IEnumerable(Of String), Optional language As String = Nothing, Optional options As TextAnalyticsRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ExtractKeyPhrasesResultCollection))" /> <MemberSignature Language="F#" Value="abstract member ExtractKeyPhrasesBatchAsync : seq<string> * string * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.ExtractKeyPhrasesResultCollection>>
override this.ExtractKeyPhrasesBatchAsync : seq<string> * string * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.ExtractKeyPhrasesResultCollection>>" Usage="textAnalyticsClient.ExtractKeyPhrasesBatchAsync (documents, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.ExtractKeyPhrasesResultCollection>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="language">The language that all the documents are written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a model to identify a collection of significant phrases found in the passed-in documents. <para>For example, for the document "The food was delicious and there were wonderful staff", the API returns the main talking points: "food" and "wonderful staff".</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing the collection of key phrases identified in each of the documents.</returns> <remarks>To be added.</remarks> <exception cref="T:System.NotSupportedException"> <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions.DisableServiceLogs" /> is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="GetHashCode"> <MemberSignature Language="C#" Value="public override int GetHashCode ();" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.GetHashCode" /> <MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" /> <MemberSignature Language="F#" Value="override this.GetHashCode : unit -> int" Usage="textAnalyticsClient.GetHashCode " /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Int32</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary> Get a hash code for the TextAnalyticsClient. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName="MultiLabelClassify"> <MemberSignature Language="C#" Value="public virtual Azure.AI.TextAnalytics.ClassifyDocumentOperation MultiLabelClassify (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, string projectName, string deploymentName, Azure.AI.TextAnalytics.MultiLabelClassifyOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.TextAnalytics.ClassifyDocumentOperation MultiLabelClassify(valuetype Azure.WaitUntil waitUntil, class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, string projectName, string deploymentName, class Azure.AI.TextAnalytics.MultiLabelClassifyOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.MultiLabelClassify(Azure.WaitUntil,System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},System.String,System.String,Azure.AI.TextAnalytics.MultiLabelClassifyOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function MultiLabelClassify (waitUntil As WaitUntil, documents As IEnumerable(Of TextDocumentInput), projectName As String, deploymentName As String, Optional options As MultiLabelClassifyOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ClassifyDocumentOperation" /> <MemberSignature Language="F#" Value="abstract member MultiLabelClassify : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * string * string * Azure.AI.TextAnalytics.MultiLabelClassifyOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.ClassifyDocumentOperation
override this.MultiLabelClassify : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * string * string * Azure.AI.TextAnalytics.MultiLabelClassifyOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.ClassifyDocumentOperation" Usage="textAnalyticsClient.MultiLabelClassify (waitUntil, documents, projectName, deploymentName, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.AI.TextAnalytics.ClassifyDocumentOperation</ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.MultiLabelClassifyOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. </param> <param name="documents">The documents to analyze.</param> <param name="projectName">The name of the project which owns the models being consumed.</param> <param name="deploymentName">The name of the deployment being consumed.</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a classify each document with multiple labels in the passed-in documents. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/custom-text-classification/overview" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" /> and newer. </remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2022-05-01 and newer.</exception> </Docs> </Member> <Member MemberName="MultiLabelClassify"> <MemberSignature Language="C#" Value="public virtual Azure.AI.TextAnalytics.ClassifyDocumentOperation MultiLabelClassify (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<string> documents, string projectName, string deploymentName, string language = default, Azure.AI.TextAnalytics.MultiLabelClassifyOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.TextAnalytics.ClassifyDocumentOperation MultiLabelClassify(valuetype Azure.WaitUntil waitUntil, class System.Collections.Generic.IEnumerable`1<string> documents, string projectName, string deploymentName, string language, class Azure.AI.TextAnalytics.MultiLabelClassifyOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.MultiLabelClassify(Azure.WaitUntil,System.Collections.Generic.IEnumerable{System.String},System.String,System.String,System.String,Azure.AI.TextAnalytics.MultiLabelClassifyOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function MultiLabelClassify (waitUntil As WaitUntil, documents As IEnumerable(Of String), projectName As String, deploymentName As String, Optional language As String = Nothing, Optional options As MultiLabelClassifyOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ClassifyDocumentOperation" /> <MemberSignature Language="F#" Value="abstract member MultiLabelClassify : Azure.WaitUntil * seq<string> * string * string * string * Azure.AI.TextAnalytics.MultiLabelClassifyOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.ClassifyDocumentOperation
override this.MultiLabelClassify : Azure.WaitUntil * seq<string> * string * string * string * Azure.AI.TextAnalytics.MultiLabelClassifyOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.ClassifyDocumentOperation" Usage="textAnalyticsClient.MultiLabelClassify (waitUntil, documents, projectName, deploymentName, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.AI.TextAnalytics.ClassifyDocumentOperation</ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.MultiLabelClassifyOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. </param> <param name="documents">The documents to analyze.</param> <param name="projectName">The name of the project which owns the models being consumed.</param> <param name="deploymentName">The name of the deployment being consumed.</param> <param name="language">The language that all the documents are written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a classify each document with multiple labels in the passed-in documents. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/custom-text-classification/overview" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" /> and newer. </remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2022-05-01 and newer.</exception> </Docs> </Member> <Member MemberName="MultiLabelClassifyAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation> MultiLabelClassifyAsync (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, string projectName, string deploymentName, Azure.AI.TextAnalytics.MultiLabelClassifyOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.AI.TextAnalytics.ClassifyDocumentOperation> MultiLabelClassifyAsync(valuetype Azure.WaitUntil waitUntil, class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, string projectName, string deploymentName, class Azure.AI.TextAnalytics.MultiLabelClassifyOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.MultiLabelClassifyAsync(Azure.WaitUntil,System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},System.String,System.String,Azure.AI.TextAnalytics.MultiLabelClassifyOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function MultiLabelClassifyAsync (waitUntil As WaitUntil, documents As IEnumerable(Of TextDocumentInput), projectName As String, deploymentName As String, Optional options As MultiLabelClassifyOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClassifyDocumentOperation)" /> <MemberSignature Language="F#" Value="abstract member MultiLabelClassifyAsync : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * string * string * Azure.AI.TextAnalytics.MultiLabelClassifyOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation>
override this.MultiLabelClassifyAsync : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * string * string * Azure.AI.TextAnalytics.MultiLabelClassifyOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation>" Usage="textAnalyticsClient.MultiLabelClassifyAsync (waitUntil, documents, projectName, deploymentName, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.MultiLabelClassifyOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. </param> <param name="documents">The documents to analyze.</param> <param name="projectName">The name of the project which owns the models being consumed.</param> <param name="deploymentName">The name of the deployment being consumed.</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a classify each document with multiple labels in the passed-in documents. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/custom-text-classification/overview" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" /> and newer. </remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2022-05-01 and newer.</exception> </Docs> </Member> <Member MemberName="MultiLabelClassifyAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation> MultiLabelClassifyAsync (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<string> documents, string projectName, string deploymentName, string language = default, Azure.AI.TextAnalytics.MultiLabelClassifyOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.AI.TextAnalytics.ClassifyDocumentOperation> MultiLabelClassifyAsync(valuetype Azure.WaitUntil waitUntil, class System.Collections.Generic.IEnumerable`1<string> documents, string projectName, string deploymentName, string language, class Azure.AI.TextAnalytics.MultiLabelClassifyOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.MultiLabelClassifyAsync(Azure.WaitUntil,System.Collections.Generic.IEnumerable{System.String},System.String,System.String,System.String,Azure.AI.TextAnalytics.MultiLabelClassifyOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function MultiLabelClassifyAsync (waitUntil As WaitUntil, documents As IEnumerable(Of String), projectName As String, deploymentName As String, Optional language As String = Nothing, Optional options As MultiLabelClassifyOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClassifyDocumentOperation)" /> <MemberSignature Language="F#" Value="abstract member MultiLabelClassifyAsync : Azure.WaitUntil * seq<string> * string * string * string * Azure.AI.TextAnalytics.MultiLabelClassifyOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation>
override this.MultiLabelClassifyAsync : Azure.WaitUntil * seq<string> * string * string * string * Azure.AI.TextAnalytics.MultiLabelClassifyOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation>" Usage="textAnalyticsClient.MultiLabelClassifyAsync (waitUntil, documents, projectName, deploymentName, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.MultiLabelClassifyOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. </param> <param name="documents">The documents to analyze.</param> <param name="projectName">The name of the project which owns the models being consumed.</param> <param name="deploymentName">The name of the deployment being consumed.</param> <param name="language">The language that all the documents are written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a classify each document with multiple labels in the passed-in documents. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/custom-text-classification/overview" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" /> and newer. </remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2022-05-01 and newer.</exception> </Docs> </Member> <Member MemberName="RecognizeCustomEntities"> <MemberSignature Language="C#" Value="public virtual Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation RecognizeCustomEntities (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, string projectName, string deploymentName, Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation RecognizeCustomEntities(valuetype Azure.WaitUntil waitUntil, class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, string projectName, string deploymentName, class Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.RecognizeCustomEntities(Azure.WaitUntil,System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},System.String,System.String,Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RecognizeCustomEntities (waitUntil As WaitUntil, documents As IEnumerable(Of TextDocumentInput), projectName As String, deploymentName As String, Optional options As RecognizeCustomEntitiesOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As RecognizeCustomEntitiesOperation" /> <MemberSignature Language="F#" Value="abstract member RecognizeCustomEntities : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * string * string * Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation
override this.RecognizeCustomEntities : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * string * string * Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation" Usage="textAnalyticsClient.RecognizeCustomEntities (waitUntil, documents, projectName, deploymentName, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation</ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. </param> <param name="documents">The documents to analyze.</param> <param name="projectName">The name of the project which owns the models being consumed.</param> <param name="deploymentName">The name of the deployment being consumed.</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a collection of custom named entities in the passed-in documents, and categorize those entities into custom types such as contracts or financial documents. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/custom-named-entity-recognition/overview" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2022-05-01 and newer.</exception> </Docs> </Member> <Member MemberName="RecognizeCustomEntities"> <MemberSignature Language="C#" Value="public virtual Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation RecognizeCustomEntities (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<string> documents, string projectName, string deploymentName, string language = default, Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation RecognizeCustomEntities(valuetype Azure.WaitUntil waitUntil, class System.Collections.Generic.IEnumerable`1<string> documents, string projectName, string deploymentName, string language, class Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.RecognizeCustomEntities(Azure.WaitUntil,System.Collections.Generic.IEnumerable{System.String},System.String,System.String,System.String,Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RecognizeCustomEntities (waitUntil As WaitUntil, documents As IEnumerable(Of String), projectName As String, deploymentName As String, Optional language As String = Nothing, Optional options As RecognizeCustomEntitiesOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As RecognizeCustomEntitiesOperation" /> <MemberSignature Language="F#" Value="abstract member RecognizeCustomEntities : Azure.WaitUntil * seq<string> * string * string * string * Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation
override this.RecognizeCustomEntities : Azure.WaitUntil * seq<string> * string * string * string * Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation" Usage="textAnalyticsClient.RecognizeCustomEntities (waitUntil, documents, projectName, deploymentName, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation</ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. </param> <param name="documents">The documents to analyze.</param> <param name="projectName">The name of the project which owns the models being consumed.</param> <param name="deploymentName">The name of the deployment being consumed.</param> <param name="language">The language that all the documents are written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a collection of custom named entities in the passed-in documents, and categorize those entities into custom types such as contracts or financial documents. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/custom-named-entity-recognition/overview" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2022-05-01 and newer.</exception> </Docs> </Member> <Member MemberName="RecognizeCustomEntitiesAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation> RecognizeCustomEntitiesAsync (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, string projectName, string deploymentName, Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation> RecognizeCustomEntitiesAsync(valuetype Azure.WaitUntil waitUntil, class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, string projectName, string deploymentName, class Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.RecognizeCustomEntitiesAsync(Azure.WaitUntil,System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},System.String,System.String,Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RecognizeCustomEntitiesAsync (waitUntil As WaitUntil, documents As IEnumerable(Of TextDocumentInput), projectName As String, deploymentName As String, Optional options As RecognizeCustomEntitiesOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of RecognizeCustomEntitiesOperation)" /> <MemberSignature Language="F#" Value="abstract member RecognizeCustomEntitiesAsync : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * string * string * Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation>
override this.RecognizeCustomEntitiesAsync : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * string * string * Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation>" Usage="textAnalyticsClient.RecognizeCustomEntitiesAsync (waitUntil, documents, projectName, deploymentName, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. </param> <param name="documents">The documents to analyze.</param> <param name="projectName">The name of the project which owns the models being consumed.</param> <param name="deploymentName">The name of the deployment being consumed.</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a collection of custom named entities in the passed-in documents, and categorize those entities into custom types such as contracts or financial documents. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/custom-named-entity-recognition/overview" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2022-05-01 and newer.</exception> </Docs> </Member> <Member MemberName="RecognizeCustomEntitiesAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation> RecognizeCustomEntitiesAsync (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<string> documents, string projectName, string deploymentName, string language = default, Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation> RecognizeCustomEntitiesAsync(valuetype Azure.WaitUntil waitUntil, class System.Collections.Generic.IEnumerable`1<string> documents, string projectName, string deploymentName, string language, class Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.RecognizeCustomEntitiesAsync(Azure.WaitUntil,System.Collections.Generic.IEnumerable{System.String},System.String,System.String,System.String,Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RecognizeCustomEntitiesAsync (waitUntil As WaitUntil, documents As IEnumerable(Of String), projectName As String, deploymentName As String, Optional language As String = Nothing, Optional options As RecognizeCustomEntitiesOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of RecognizeCustomEntitiesOperation)" /> <MemberSignature Language="F#" Value="abstract member RecognizeCustomEntitiesAsync : Azure.WaitUntil * seq<string> * string * string * string * Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation>
override this.RecognizeCustomEntitiesAsync : Azure.WaitUntil * seq<string> * string * string * string * Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation>" Usage="textAnalyticsClient.RecognizeCustomEntitiesAsync (waitUntil, documents, projectName, deploymentName, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. </param> <param name="documents">The documents to analyze.</param> <param name="projectName">The name of the project which owns the models being consumed.</param> <param name="deploymentName">The name of the deployment being consumed.</param> <param name="language">The language that all the documents are written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a collection of custom named entities in the passed-in documents, and categorize those entities into custom types such as contracts or financial documents. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/custom-named-entity-recognition/overview" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2022-05-01 and newer.</exception> </Docs> </Member> <Member MemberName="RecognizeEntities"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.TextAnalytics.CategorizedEntityCollection> RecognizeEntities (string document, string language = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.TextAnalytics.CategorizedEntityCollection> RecognizeEntities(string document, string language, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.RecognizeEntities(System.String,System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RecognizeEntities (document As String, Optional language As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of CategorizedEntityCollection)" /> <MemberSignature Language="F#" Value="abstract member RecognizeEntities : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.CategorizedEntityCollection>
override this.RecognizeEntities : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.CategorizedEntityCollection>" Usage="textAnalyticsClient.RecognizeEntities (document, language, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.AI.TextAnalytics.CategorizedEntityCollection></ReturnType> </ReturnValue> <Parameters> <Parameter Name="document" Type="System.String" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="document">The document to analyze.</param> <param name="language">The language that the document is written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a collection of named entities in the passed-in document, and categorize those entities into types such as person, location, or organization. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/named-entity-recognition/concepts/named-entity-categories" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing the collection of entities identified in the document, as well as a score indicating the confidence that the entity correctly matches the identified substring.</returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="RecognizeEntitiesAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.CategorizedEntityCollection>> RecognizeEntitiesAsync (string document, string language = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.TextAnalytics.CategorizedEntityCollection>> RecognizeEntitiesAsync(string document, string language, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.RecognizeEntitiesAsync(System.String,System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RecognizeEntitiesAsync (document As String, Optional language As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of CategorizedEntityCollection))" /> <MemberSignature Language="F#" Value="abstract member RecognizeEntitiesAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.CategorizedEntityCollection>>
override this.RecognizeEntitiesAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.CategorizedEntityCollection>>" Usage="textAnalyticsClient.RecognizeEntitiesAsync (document, language, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.CategorizedEntityCollection>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="document" Type="System.String" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="document">The document to analyze.</param> <param name="language">The language that the document is written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a collection of named entities in the passed-in document, and categorize those entities into types such as person, location, or organization. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/named-entity-recognition/concepts/named-entity-categories" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing the collection of entities identified in the document, as well as a score indicating the confidence that the entity correctly matches the identified substring.</returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="RecognizeEntitiesBatch"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.TextAnalytics.RecognizeEntitiesResultCollection> RecognizeEntitiesBatch (System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.TextAnalytics.RecognizeEntitiesResultCollection> RecognizeEntitiesBatch(class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, class Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.RecognizeEntitiesBatch(System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},Azure.AI.TextAnalytics.TextAnalyticsRequestOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RecognizeEntitiesBatch (documents As IEnumerable(Of TextDocumentInput), Optional options As TextAnalyticsRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of RecognizeEntitiesResultCollection)" /> <MemberSignature Language="F#" Value="abstract member RecognizeEntitiesBatch : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.RecognizeEntitiesResultCollection>
override this.RecognizeEntitiesBatch : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.RecognizeEntitiesResultCollection>" Usage="textAnalyticsClient.RecognizeEntitiesBatch (documents, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.AI.TextAnalytics.RecognizeEntitiesResultCollection></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a collection of named entities in the passed-in documents, and categorize those entities into types such as person, location, or organization. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/named-entity-recognition/concepts/named-entity-categories" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks>To be added.</remarks> <exception cref="T:System.NotSupportedException"> <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions.DisableServiceLogs" /> is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="RecognizeEntitiesBatch"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.TextAnalytics.RecognizeEntitiesResultCollection> RecognizeEntitiesBatch (System.Collections.Generic.IEnumerable<string> documents, string language = default, Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.TextAnalytics.RecognizeEntitiesResultCollection> RecognizeEntitiesBatch(class System.Collections.Generic.IEnumerable`1<string> documents, string language, class Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.RecognizeEntitiesBatch(System.Collections.Generic.IEnumerable{System.String},System.String,Azure.AI.TextAnalytics.TextAnalyticsRequestOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RecognizeEntitiesBatch (documents As IEnumerable(Of String), Optional language As String = Nothing, Optional options As TextAnalyticsRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of RecognizeEntitiesResultCollection)" /> <MemberSignature Language="F#" Value="abstract member RecognizeEntitiesBatch : seq<string> * string * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.RecognizeEntitiesResultCollection>
override this.RecognizeEntitiesBatch : seq<string> * string * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.RecognizeEntitiesResultCollection>" Usage="textAnalyticsClient.RecognizeEntitiesBatch (documents, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.AI.TextAnalytics.RecognizeEntitiesResultCollection></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="language">The language that all the documents are written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a collection of named entities in the passed-in documents, and categorize those entities into types such as person, location, or organization. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/named-entity-recognition/concepts/named-entity-categories" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks>To be added.</remarks> <exception cref="T:System.NotSupportedException"> <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions.DisableServiceLogs" /> is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="RecognizeEntitiesBatchAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizeEntitiesResultCollection>> RecognizeEntitiesBatchAsync (System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.TextAnalytics.RecognizeEntitiesResultCollection>> RecognizeEntitiesBatchAsync(class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, class Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.RecognizeEntitiesBatchAsync(System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},Azure.AI.TextAnalytics.TextAnalyticsRequestOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RecognizeEntitiesBatchAsync (documents As IEnumerable(Of TextDocumentInput), Optional options As TextAnalyticsRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of RecognizeEntitiesResultCollection))" /> <MemberSignature Language="F#" Value="abstract member RecognizeEntitiesBatchAsync : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizeEntitiesResultCollection>>
override this.RecognizeEntitiesBatchAsync : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizeEntitiesResultCollection>>" Usage="textAnalyticsClient.RecognizeEntitiesBatchAsync (documents, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizeEntitiesResultCollection>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a collection of named entities in the passed-in documents, and categorize those entities into types such as person, location, or organization. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/named-entity-recognition/concepts/named-entity-categories" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks>To be added.</remarks> <exception cref="T:System.NotSupportedException"> <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions.DisableServiceLogs" /> is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="RecognizeEntitiesBatchAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizeEntitiesResultCollection>> RecognizeEntitiesBatchAsync (System.Collections.Generic.IEnumerable<string> documents, string language = default, Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.TextAnalytics.RecognizeEntitiesResultCollection>> RecognizeEntitiesBatchAsync(class System.Collections.Generic.IEnumerable`1<string> documents, string language, class Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.RecognizeEntitiesBatchAsync(System.Collections.Generic.IEnumerable{System.String},System.String,Azure.AI.TextAnalytics.TextAnalyticsRequestOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RecognizeEntitiesBatchAsync (documents As IEnumerable(Of String), Optional language As String = Nothing, Optional options As TextAnalyticsRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of RecognizeEntitiesResultCollection))" /> <MemberSignature Language="F#" Value="abstract member RecognizeEntitiesBatchAsync : seq<string> * string * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizeEntitiesResultCollection>>
override this.RecognizeEntitiesBatchAsync : seq<string> * string * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizeEntitiesResultCollection>>" Usage="textAnalyticsClient.RecognizeEntitiesBatchAsync (documents, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizeEntitiesResultCollection>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="language">The language that all the documents are written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a collection of named entities in the passed-in documents, and categorize those entities into types such as person, location, or organization. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/named-entity-recognition/concepts/named-entity-categories" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks>To be added.</remarks> <exception cref="T:System.NotSupportedException"> <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions.DisableServiceLogs" /> is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="RecognizeLinkedEntities"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.TextAnalytics.LinkedEntityCollection> RecognizeLinkedEntities (string document, string language = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.TextAnalytics.LinkedEntityCollection> RecognizeLinkedEntities(string document, string language, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.RecognizeLinkedEntities(System.String,System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RecognizeLinkedEntities (document As String, Optional language As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of LinkedEntityCollection)" /> <MemberSignature Language="F#" Value="abstract member RecognizeLinkedEntities : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.LinkedEntityCollection>
override this.RecognizeLinkedEntities : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.LinkedEntityCollection>" Usage="textAnalyticsClient.RecognizeLinkedEntities (document, language, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.AI.TextAnalytics.LinkedEntityCollection></ReturnType> </ReturnValue> <Parameters> <Parameter Name="document" Type="System.String" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="document">The document to analyze.</param> <param name="language">The language that the document is written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a collection of entities found in the passed-in document, and include information linking the entities to their corresponding entries in a well-known knowledge base. <para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing the collection of linked entities identified in the document, as well as scores indicating the confidence that the entity correctly matches the identified substring.</returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="RecognizeLinkedEntitiesAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.LinkedEntityCollection>> RecognizeLinkedEntitiesAsync (string document, string language = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.TextAnalytics.LinkedEntityCollection>> RecognizeLinkedEntitiesAsync(string document, string language, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.RecognizeLinkedEntitiesAsync(System.String,System.String,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RecognizeLinkedEntitiesAsync (document As String, Optional language As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of LinkedEntityCollection))" /> <MemberSignature Language="F#" Value="abstract member RecognizeLinkedEntitiesAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.LinkedEntityCollection>>
override this.RecognizeLinkedEntitiesAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.LinkedEntityCollection>>" Usage="textAnalyticsClient.RecognizeLinkedEntitiesAsync (document, language, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.LinkedEntityCollection>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="document" Type="System.String" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="document">The document to analyze.</param> <param name="language">The language that the document is written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a collection of entities found in the passed-in document, and include information linking the entities to their corresponding entries in a well-known knowledge base. <para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing the collection of linked entities identified in the document, as well as scores indicating the confidence that the entity correctly matches the identified substring.</returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="RecognizeLinkedEntitiesBatch"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.TextAnalytics.RecognizeLinkedEntitiesResultCollection> RecognizeLinkedEntitiesBatch (System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.TextAnalytics.RecognizeLinkedEntitiesResultCollection> RecognizeLinkedEntitiesBatch(class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, class Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.RecognizeLinkedEntitiesBatch(System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},Azure.AI.TextAnalytics.TextAnalyticsRequestOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RecognizeLinkedEntitiesBatch (documents As IEnumerable(Of TextDocumentInput), Optional options As TextAnalyticsRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of RecognizeLinkedEntitiesResultCollection)" /> <MemberSignature Language="F#" Value="abstract member RecognizeLinkedEntitiesBatch : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.RecognizeLinkedEntitiesResultCollection>
override this.RecognizeLinkedEntitiesBatch : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.RecognizeLinkedEntitiesResultCollection>" Usage="textAnalyticsClient.RecognizeLinkedEntitiesBatch (documents, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.AI.TextAnalytics.RecognizeLinkedEntitiesResultCollection></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a collection of entities found in the passed-in documents, and include information linking the entities to their corresponding entries in a well-known knowledge base. <para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks>To be added.</remarks> <exception cref="T:System.NotSupportedException"> <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions.DisableServiceLogs" /> is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="RecognizeLinkedEntitiesBatch"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.TextAnalytics.RecognizeLinkedEntitiesResultCollection> RecognizeLinkedEntitiesBatch (System.Collections.Generic.IEnumerable<string> documents, string language = default, Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.TextAnalytics.RecognizeLinkedEntitiesResultCollection> RecognizeLinkedEntitiesBatch(class System.Collections.Generic.IEnumerable`1<string> documents, string language, class Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.RecognizeLinkedEntitiesBatch(System.Collections.Generic.IEnumerable{System.String},System.String,Azure.AI.TextAnalytics.TextAnalyticsRequestOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RecognizeLinkedEntitiesBatch (documents As IEnumerable(Of String), Optional language As String = Nothing, Optional options As TextAnalyticsRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of RecognizeLinkedEntitiesResultCollection)" /> <MemberSignature Language="F#" Value="abstract member RecognizeLinkedEntitiesBatch : seq<string> * string * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.RecognizeLinkedEntitiesResultCollection>
override this.RecognizeLinkedEntitiesBatch : seq<string> * string * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.RecognizeLinkedEntitiesResultCollection>" Usage="textAnalyticsClient.RecognizeLinkedEntitiesBatch (documents, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.AI.TextAnalytics.RecognizeLinkedEntitiesResultCollection></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="language">The language that the documents are written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a collection of entities found in the passed-in documents, and include information linking the entities to their corresponding entries in a well-known knowledge base. <para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks>To be added.</remarks> <exception cref="T:System.NotSupportedException"> <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions.DisableServiceLogs" /> is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="RecognizeLinkedEntitiesBatchAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizeLinkedEntitiesResultCollection>> RecognizeLinkedEntitiesBatchAsync (System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.TextAnalytics.RecognizeLinkedEntitiesResultCollection>> RecognizeLinkedEntitiesBatchAsync(class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, class Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.RecognizeLinkedEntitiesBatchAsync(System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},Azure.AI.TextAnalytics.TextAnalyticsRequestOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RecognizeLinkedEntitiesBatchAsync (documents As IEnumerable(Of TextDocumentInput), Optional options As TextAnalyticsRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of RecognizeLinkedEntitiesResultCollection))" /> <MemberSignature Language="F#" Value="abstract member RecognizeLinkedEntitiesBatchAsync : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizeLinkedEntitiesResultCollection>>
override this.RecognizeLinkedEntitiesBatchAsync : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizeLinkedEntitiesResultCollection>>" Usage="textAnalyticsClient.RecognizeLinkedEntitiesBatchAsync (documents, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizeLinkedEntitiesResultCollection>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a collection of entities found in the passed-in documents, and include information linking the entities to their corresponding entries in a well-known knowledge base. <para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks>To be added.</remarks> <exception cref="T:System.NotSupportedException"> <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions.DisableServiceLogs" /> is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="RecognizeLinkedEntitiesBatchAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizeLinkedEntitiesResultCollection>> RecognizeLinkedEntitiesBatchAsync (System.Collections.Generic.IEnumerable<string> documents, string language = default, Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.TextAnalytics.RecognizeLinkedEntitiesResultCollection>> RecognizeLinkedEntitiesBatchAsync(class System.Collections.Generic.IEnumerable`1<string> documents, string language, class Azure.AI.TextAnalytics.TextAnalyticsRequestOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.RecognizeLinkedEntitiesBatchAsync(System.Collections.Generic.IEnumerable{System.String},System.String,Azure.AI.TextAnalytics.TextAnalyticsRequestOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RecognizeLinkedEntitiesBatchAsync (documents As IEnumerable(Of String), Optional language As String = Nothing, Optional options As TextAnalyticsRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of RecognizeLinkedEntitiesResultCollection))" /> <MemberSignature Language="F#" Value="abstract member RecognizeLinkedEntitiesBatchAsync : seq<string> * string * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizeLinkedEntitiesResultCollection>>
override this.RecognizeLinkedEntitiesBatchAsync : seq<string> * string * Azure.AI.TextAnalytics.TextAnalyticsRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizeLinkedEntitiesResultCollection>>" Usage="textAnalyticsClient.RecognizeLinkedEntitiesBatchAsync (documents, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizeLinkedEntitiesResultCollection>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="language">The language that the documents are written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a collection of entities found in the passed-in documents, and include information linking the entities to their corresponding entries in a well-known knowledge base. <para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks>To be added.</remarks> <exception cref="T:System.NotSupportedException"> <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions.DisableServiceLogs" /> is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="RecognizePiiEntities"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.TextAnalytics.PiiEntityCollection> RecognizePiiEntities (string document, string language = default, Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.TextAnalytics.PiiEntityCollection> RecognizePiiEntities(string document, string language, class Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.RecognizePiiEntities(System.String,System.String,Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RecognizePiiEntities (document As String, Optional language As String = Nothing, Optional options As RecognizePiiEntitiesOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of PiiEntityCollection)" /> <MemberSignature Language="F#" Value="abstract member RecognizePiiEntities : string * string * Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.PiiEntityCollection>
override this.RecognizePiiEntities : string * string * Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.PiiEntityCollection>" Usage="textAnalyticsClient.RecognizePiiEntities (document, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.AI.TextAnalytics.PiiEntityCollection></ReturnType> </ReturnValue> <Parameters> <Parameter Name="document" Type="System.String" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="document">The document to analyze.</param> <param name="language">The language that the document is written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="options">The additional configurable <see cref="T:Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions" /> that may be passed when recognizing PII entities. Options include entity domain filters, model version, and more.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a collection of entities containing Personally Identifiable Information found in the passed-in document, and categorize those entities into types such as US social security number, drivers license number, or credit card number. <para>For more information on available categories, see <see href="https://aka.ms/azsdk/language/pii" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing the collection of entities identified in the document, as well as a score indicating the confidence that the entity correctly matches the identified substring.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V3_1" />, <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" />, and newer. </remarks> <exception cref="T:System.NotSupportedException">This method is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="RecognizePiiEntitiesAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.PiiEntityCollection>> RecognizePiiEntitiesAsync (string document, string language = default, Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.TextAnalytics.PiiEntityCollection>> RecognizePiiEntitiesAsync(string document, string language, class Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.RecognizePiiEntitiesAsync(System.String,System.String,Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RecognizePiiEntitiesAsync (document As String, Optional language As String = Nothing, Optional options As RecognizePiiEntitiesOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of PiiEntityCollection))" /> <MemberSignature Language="F#" Value="abstract member RecognizePiiEntitiesAsync : string * string * Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.PiiEntityCollection>>
override this.RecognizePiiEntitiesAsync : string * string * Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.PiiEntityCollection>>" Usage="textAnalyticsClient.RecognizePiiEntitiesAsync (document, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.PiiEntityCollection>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="document" Type="System.String" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="document">The document to analyze.</param> <param name="language">The language that the document is written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="options">The additional configurable <see cref="T:Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions" /> that may be passed when recognizing PII entities. Options include entity domain filters, model version, and more.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a collection of entities containing Personally Identifiable Information found in the passed-in document, and categorize those entities into types such as US social security number, drivers license number, or credit card number. <para>For more information on available categories, see <see href="https://aka.ms/azsdk/language/pii" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <returns>A result containing the collection of entities identified in the document, as well as a score indicating the confidence that the entity correctly matches the identified substring.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V3_1" />, <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" />, and newer. </remarks> <exception cref="T:System.NotSupportedException">This method is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="RecognizePiiEntitiesBatch"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.TextAnalytics.RecognizePiiEntitiesResultCollection> RecognizePiiEntitiesBatch (System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.TextAnalytics.RecognizePiiEntitiesResultCollection> RecognizePiiEntitiesBatch(class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, class Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.RecognizePiiEntitiesBatch(System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RecognizePiiEntitiesBatch (documents As IEnumerable(Of TextDocumentInput), Optional options As RecognizePiiEntitiesOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of RecognizePiiEntitiesResultCollection)" /> <MemberSignature Language="F#" Value="abstract member RecognizePiiEntitiesBatch : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.RecognizePiiEntitiesResultCollection>
override this.RecognizePiiEntitiesBatch : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.RecognizePiiEntitiesResultCollection>" Usage="textAnalyticsClient.RecognizePiiEntitiesBatch (documents, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.AI.TextAnalytics.RecognizePiiEntitiesResultCollection></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="options">The additional configurable <see cref="T:Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions" /> that may be passed when recognizing PII entities. Options include entity domain filters, model version, and more.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a collection of entities containing Personally Identifiable Information found in the passed-in document, and categorize those entities into types such as US social security number, drivers license number, or credit card number. <para>For more information on available categories, see <see href="https://aka.ms/azsdk/language/pii" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V3_1" />, <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" />, and newer. </remarks> <exception cref="T:System.NotSupportedException">This method is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="RecognizePiiEntitiesBatch"> <MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.TextAnalytics.RecognizePiiEntitiesResultCollection> RecognizePiiEntitiesBatch (System.Collections.Generic.IEnumerable<string> documents, string language = default, Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.TextAnalytics.RecognizePiiEntitiesResultCollection> RecognizePiiEntitiesBatch(class System.Collections.Generic.IEnumerable`1<string> documents, string language, class Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.RecognizePiiEntitiesBatch(System.Collections.Generic.IEnumerable{System.String},System.String,Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RecognizePiiEntitiesBatch (documents As IEnumerable(Of String), Optional language As String = Nothing, Optional options As RecognizePiiEntitiesOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of RecognizePiiEntitiesResultCollection)" /> <MemberSignature Language="F#" Value="abstract member RecognizePiiEntitiesBatch : seq<string> * string * Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.RecognizePiiEntitiesResultCollection>
override this.RecognizePiiEntitiesBatch : seq<string> * string * Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.TextAnalytics.RecognizePiiEntitiesResultCollection>" Usage="textAnalyticsClient.RecognizePiiEntitiesBatch (documents, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.Response<Azure.AI.TextAnalytics.RecognizePiiEntitiesResultCollection></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="language">The language that the document is written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="options">The additional configurable <see cref="T:Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions" /> that may be passed when recognizing PII entities. Options include entity domain filters, model version, and more.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a collection of entities containing Personally Identifiable Information found in the passed-in document, and categorize those entities into types such as US social security number, drivers license number, or credit card number. <para>For more information on available categories, see <see href="https://aka.ms/azsdk/language/pii" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V3_1" />, <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" />, and newer. </remarks> <exception cref="T:System.NotSupportedException">This method is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="RecognizePiiEntitiesBatchAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizePiiEntitiesResultCollection>> RecognizePiiEntitiesBatchAsync (System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.TextAnalytics.RecognizePiiEntitiesResultCollection>> RecognizePiiEntitiesBatchAsync(class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, class Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.RecognizePiiEntitiesBatchAsync(System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RecognizePiiEntitiesBatchAsync (documents As IEnumerable(Of TextDocumentInput), Optional options As RecognizePiiEntitiesOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of RecognizePiiEntitiesResultCollection))" /> <MemberSignature Language="F#" Value="abstract member RecognizePiiEntitiesBatchAsync : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizePiiEntitiesResultCollection>>
override this.RecognizePiiEntitiesBatchAsync : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizePiiEntitiesResultCollection>>" Usage="textAnalyticsClient.RecognizePiiEntitiesBatchAsync (documents, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizePiiEntitiesResultCollection>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="options">The additional configurable <see cref="T:Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions" /> that may be passed when recognizing PII entities. Options include entity domain filters, model version, and more.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a collection of entities containing Personally Identifiable Information found in the passed-in document, and categorize those entities into types such as US social security number, drivers license number, or credit card number. <para>For more information on available categories, see <see href="https://aka.ms/azsdk/language/pii" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V3_1" />, <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" />, and newer. </remarks> <exception cref="T:System.NotSupportedException">This method is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="RecognizePiiEntitiesBatchAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizePiiEntitiesResultCollection>> RecognizePiiEntitiesBatchAsync (System.Collections.Generic.IEnumerable<string> documents, string language = default, Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.AI.TextAnalytics.RecognizePiiEntitiesResultCollection>> RecognizePiiEntitiesBatchAsync(class System.Collections.Generic.IEnumerable`1<string> documents, string language, class Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.RecognizePiiEntitiesBatchAsync(System.Collections.Generic.IEnumerable{System.String},System.String,Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function RecognizePiiEntitiesBatchAsync (documents As IEnumerable(Of String), Optional language As String = Nothing, Optional options As RecognizePiiEntitiesOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of RecognizePiiEntitiesResultCollection))" /> <MemberSignature Language="F#" Value="abstract member RecognizePiiEntitiesBatchAsync : seq<string> * string * Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizePiiEntitiesResultCollection>>
override this.RecognizePiiEntitiesBatchAsync : seq<string> * string * Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizePiiEntitiesResultCollection>>" Usage="textAnalyticsClient.RecognizePiiEntitiesBatchAsync (documents, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.TextAnalytics.RecognizePiiEntitiesResultCollection>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="language">The language that the document is written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="options">The additional configurable <see cref="T:Azure.AI.TextAnalytics.RecognizePiiEntitiesOptions" /> that may be passed when recognizing PII entities. Options include entity domain filters, model version, and more.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a collection of entities containing Personally Identifiable Information found in the passed-in document, and categorize those entities into types such as US social security number, drivers license number, or credit card number. <para>For more information on available categories, see <see href="https://aka.ms/azsdk/language/pii" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V3_1" />, <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" />, and newer. </remarks> <exception cref="T:System.NotSupportedException">This method is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="SingleLabelClassify"> <MemberSignature Language="C#" Value="public virtual Azure.AI.TextAnalytics.ClassifyDocumentOperation SingleLabelClassify (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, string projectName, string deploymentName, Azure.AI.TextAnalytics.SingleLabelClassifyOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.TextAnalytics.ClassifyDocumentOperation SingleLabelClassify(valuetype Azure.WaitUntil waitUntil, class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, string projectName, string deploymentName, class Azure.AI.TextAnalytics.SingleLabelClassifyOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.SingleLabelClassify(Azure.WaitUntil,System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},System.String,System.String,Azure.AI.TextAnalytics.SingleLabelClassifyOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function SingleLabelClassify (waitUntil As WaitUntil, documents As IEnumerable(Of TextDocumentInput), projectName As String, deploymentName As String, Optional options As SingleLabelClassifyOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ClassifyDocumentOperation" /> <MemberSignature Language="F#" Value="abstract member SingleLabelClassify : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * string * string * Azure.AI.TextAnalytics.SingleLabelClassifyOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.ClassifyDocumentOperation
override this.SingleLabelClassify : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * string * string * Azure.AI.TextAnalytics.SingleLabelClassifyOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.ClassifyDocumentOperation" Usage="textAnalyticsClient.SingleLabelClassify (waitUntil, documents, projectName, deploymentName, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.AI.TextAnalytics.ClassifyDocumentOperation</ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.SingleLabelClassifyOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. </param> <param name="documents">The documents to analyze.</param> <param name="projectName">The name of the project which owns the models being consumed.</param> <param name="deploymentName">The name of the deployment being consumed.</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a classify each document with a single label in the passed-in documents. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/custom-text-classification/overview" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" /> and newer. </remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2022-05-01 and newer.</exception> </Docs> </Member> <Member MemberName="SingleLabelClassify"> <MemberSignature Language="C#" Value="public virtual Azure.AI.TextAnalytics.ClassifyDocumentOperation SingleLabelClassify (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<string> documents, string projectName, string deploymentName, string language = default, Azure.AI.TextAnalytics.SingleLabelClassifyOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.TextAnalytics.ClassifyDocumentOperation SingleLabelClassify(valuetype Azure.WaitUntil waitUntil, class System.Collections.Generic.IEnumerable`1<string> documents, string projectName, string deploymentName, string language, class Azure.AI.TextAnalytics.SingleLabelClassifyOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.SingleLabelClassify(Azure.WaitUntil,System.Collections.Generic.IEnumerable{System.String},System.String,System.String,System.String,Azure.AI.TextAnalytics.SingleLabelClassifyOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function SingleLabelClassify (waitUntil As WaitUntil, documents As IEnumerable(Of String), projectName As String, deploymentName As String, Optional language As String = Nothing, Optional options As SingleLabelClassifyOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ClassifyDocumentOperation" /> <MemberSignature Language="F#" Value="abstract member SingleLabelClassify : Azure.WaitUntil * seq<string> * string * string * string * Azure.AI.TextAnalytics.SingleLabelClassifyOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.ClassifyDocumentOperation
override this.SingleLabelClassify : Azure.WaitUntil * seq<string> * string * string * string * Azure.AI.TextAnalytics.SingleLabelClassifyOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.ClassifyDocumentOperation" Usage="textAnalyticsClient.SingleLabelClassify (waitUntil, documents, projectName, deploymentName, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>Azure.AI.TextAnalytics.ClassifyDocumentOperation</ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.SingleLabelClassifyOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. </param> <param name="documents">The documents to analyze.</param> <param name="projectName">The name of the project which owns the models being consumed.</param> <param name="deploymentName">The name of the deployment being consumed.</param> <param name="language">The language that all the documents are written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a classify each document with a single label in the passed-in documents. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/custom-text-classification/overview" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" /> and newer. </remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2022-05-01 and newer.</exception> </Docs> </Member> <Member MemberName="SingleLabelClassifyAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation> SingleLabelClassifyAsync (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, string projectName, string deploymentName, Azure.AI.TextAnalytics.SingleLabelClassifyOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.AI.TextAnalytics.ClassifyDocumentOperation> SingleLabelClassifyAsync(valuetype Azure.WaitUntil waitUntil, class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, string projectName, string deploymentName, class Azure.AI.TextAnalytics.SingleLabelClassifyOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.SingleLabelClassifyAsync(Azure.WaitUntil,System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},System.String,System.String,Azure.AI.TextAnalytics.SingleLabelClassifyOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function SingleLabelClassifyAsync (waitUntil As WaitUntil, documents As IEnumerable(Of TextDocumentInput), projectName As String, deploymentName As String, Optional options As SingleLabelClassifyOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClassifyDocumentOperation)" /> <MemberSignature Language="F#" Value="abstract member SingleLabelClassifyAsync : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * string * string * Azure.AI.TextAnalytics.SingleLabelClassifyOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation>
override this.SingleLabelClassifyAsync : Azure.WaitUntil * seq<Azure.AI.TextAnalytics.TextDocumentInput> * string * string * Azure.AI.TextAnalytics.SingleLabelClassifyOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation>" Usage="textAnalyticsClient.SingleLabelClassifyAsync (waitUntil, documents, projectName, deploymentName, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.SingleLabelClassifyOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. </param> <param name="documents">The documents to analyze.</param> <param name="projectName">The name of the project which owns the models being consumed.</param> <param name="deploymentName">The name of the deployment being consumed.</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a classify each document with a single label in the passed-in documents. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/custom-text-classification/overview" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" /> and newer. </remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2022-05-01 and newer.</exception> </Docs> </Member> <Member MemberName="SingleLabelClassifyAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation> SingleLabelClassifyAsync (Azure.WaitUntil waitUntil, System.Collections.Generic.IEnumerable<string> documents, string projectName, string deploymentName, string language = default, Azure.AI.TextAnalytics.SingleLabelClassifyOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.AI.TextAnalytics.ClassifyDocumentOperation> SingleLabelClassifyAsync(valuetype Azure.WaitUntil waitUntil, class System.Collections.Generic.IEnumerable`1<string> documents, string projectName, string deploymentName, string language, class Azure.AI.TextAnalytics.SingleLabelClassifyOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.SingleLabelClassifyAsync(Azure.WaitUntil,System.Collections.Generic.IEnumerable{System.String},System.String,System.String,System.String,Azure.AI.TextAnalytics.SingleLabelClassifyOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function SingleLabelClassifyAsync (waitUntil As WaitUntil, documents As IEnumerable(Of String), projectName As String, deploymentName As String, Optional language As String = Nothing, Optional options As SingleLabelClassifyOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClassifyDocumentOperation)" /> <MemberSignature Language="F#" Value="abstract member SingleLabelClassifyAsync : Azure.WaitUntil * seq<string> * string * string * string * Azure.AI.TextAnalytics.SingleLabelClassifyOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation>
override this.SingleLabelClassifyAsync : Azure.WaitUntil * seq<string> * string * string * string * Azure.AI.TextAnalytics.SingleLabelClassifyOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation>" Usage="textAnalyticsClient.SingleLabelClassifyAsync (waitUntil, documents, projectName, deploymentName, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.SingleLabelClassifyOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="waitUntil"> <see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. </param> <param name="documents">The documents to analyze.</param> <param name="projectName">The name of the project which owns the models being consumed.</param> <param name="deploymentName">The name of the deployment being consumed.</param> <param name="language">The language that all the documents are written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a classify each document with a single label in the passed-in documents. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/custom-text-classification/overview" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" /> and newer. </remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2022-05-01 and newer.</exception> </Docs> </Member> <Member MemberName="StartAnalyzeActions"> <MemberSignature Language="C#" Value="public virtual Azure.AI.TextAnalytics.AnalyzeActionsOperation StartAnalyzeActions (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);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.TextAnalytics.AnalyzeActionsOperation StartAnalyzeActions(class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, class Azure.AI.TextAnalytics.TextAnalyticsActions actions, class Azure.AI.TextAnalytics.AnalyzeActionsOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.StartAnalyzeActions(System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},Azure.AI.TextAnalytics.TextAnalyticsActions,Azure.AI.TextAnalytics.AnalyzeActionsOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function StartAnalyzeActions (documents As IEnumerable(Of TextDocumentInput), actions As TextAnalyticsActions, Optional options As AnalyzeActionsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AnalyzeActionsOperation" /> <MemberSignature Language="F#" Value="abstract member StartAnalyzeActions : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.TextAnalyticsActions * Azure.AI.TextAnalytics.AnalyzeActionsOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.AnalyzeActionsOperation
override this.StartAnalyzeActions : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.TextAnalyticsActions * Azure.AI.TextAnalytics.AnalyzeActionsOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.AnalyzeActionsOperation" Usage="textAnalyticsClient.StartAnalyzeActions (documents, actions, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>Azure.AI.TextAnalytics.AnalyzeActionsOperation</ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="actions" Type="Azure.AI.TextAnalytics.TextAnalyticsActions" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.AnalyzeActionsOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The list of documents to analyze.</param> <param name="actions"> The <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsActions" /> to perform on the list of documents.</param> <param name="options">The <see cref="T:Azure.AI.TextAnalytics.AnalyzeActionsOptions" /> used to configure the operation.</param> <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> controlling the lifetime of the request.</param> <summary> Performs one or more text analysis actions on a set of documents. The list of supported actions includes: <list type="bullet"><item><description>Entity Recognition (Named, Linked, and Personally Identifiable Information (PII) entities)</description></item><item><description>Key Phrases Extraction</description></item><item><description>Sentiment Analysis</description></item><item><description>Custom Entity Recognition</description></item><item><description>Custom Single and Multi Label Classification</description></item><item><description>Extractive Summarization</description></item><item><description>Abstractive Summarization</description></item></list><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits">here</see>. </para></summary> <returns>To be added.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V3_1" />, <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" />, and newer. See the service <see href="https://aka.ms/azsdk/textanalytics/customfunctionalities">documentation</see> for regional support of custom action features. </remarks> <exception cref="T:System.NotSupportedException"> This method is only supported in service API version v3.1 and newer. The <see cref="T:Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesAction" />, <see cref="T:Azure.AI.TextAnalytics.MultiLabelClassifyAction" />, <see cref="T:Azure.AI.TextAnalytics.RecognizeCustomEntitiesAction" />, and <see cref="T:Azure.AI.TextAnalytics.SingleLabelClassifyAction" /> are only supported in service API version 2022-05-01 and newer. The <see cref="T:Azure.AI.TextAnalytics.ExtractiveSummarizeAction" /> and <see cref="T:Azure.AI.TextAnalytics.AbstractiveSummarizeAction" /> are only supported in service API version 2023-04-01 and newer. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> </Docs> </Member> <Member MemberName="StartAnalyzeActions"> <MemberSignature Language="C#" Value="public virtual Azure.AI.TextAnalytics.AnalyzeActionsOperation StartAnalyzeActions (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);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.TextAnalytics.AnalyzeActionsOperation StartAnalyzeActions(class System.Collections.Generic.IEnumerable`1<string> documents, class Azure.AI.TextAnalytics.TextAnalyticsActions actions, string language, class Azure.AI.TextAnalytics.AnalyzeActionsOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.StartAnalyzeActions(System.Collections.Generic.IEnumerable{System.String},Azure.AI.TextAnalytics.TextAnalyticsActions,System.String,Azure.AI.TextAnalytics.AnalyzeActionsOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function StartAnalyzeActions (documents As IEnumerable(Of String), actions As TextAnalyticsActions, Optional language As String = Nothing, Optional options As AnalyzeActionsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AnalyzeActionsOperation" /> <MemberSignature Language="F#" Value="abstract member StartAnalyzeActions : seq<string> * Azure.AI.TextAnalytics.TextAnalyticsActions * string * Azure.AI.TextAnalytics.AnalyzeActionsOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.AnalyzeActionsOperation
override this.StartAnalyzeActions : seq<string> * Azure.AI.TextAnalytics.TextAnalyticsActions * string * Azure.AI.TextAnalytics.AnalyzeActionsOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.AnalyzeActionsOperation" Usage="textAnalyticsClient.StartAnalyzeActions (documents, actions, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>Azure.AI.TextAnalytics.AnalyzeActionsOperation</ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="actions" Type="Azure.AI.TextAnalytics.TextAnalyticsActions" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.AnalyzeActionsOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The list of documents to analyze.</param> <param name="actions"> The <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsActions" /> to perform on the list of documents.</param> <param name="language">The language that the document is written in.</param> <param name="options">The <see cref="T:Azure.AI.TextAnalytics.AnalyzeActionsOptions" /> used to configure the operation.</param> <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> controlling the lifetime of the request.</param> <summary> Performs one or more text analysis actions on a set of documents. The list of supported actions includes: <list type="bullet"><item><description>Entity Recognition (Named, Linked, and Personally Identifiable Information (PII) entities)</description></item><item><description>Key Phrases Extraction</description></item><item><description>Sentiment Analysis</description></item><item><description>Custom Entity Recognition</description></item><item><description>Custom Single and Multi Label Classification</description></item><item><description>Extractive Summarization</description></item><item><description>Abstractive Summarization</description></item></list><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits">here</see>. </para></summary> <returns>To be added.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V3_1" />, <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" />, and newer. See the service <see href="https://aka.ms/azsdk/textanalytics/customfunctionalities">documentation</see> for regional support of custom action features. </remarks> <exception cref="T:System.NotSupportedException"> This method is only supported in service API version v3.1 and newer. The <see cref="T:Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesAction" />, <see cref="T:Azure.AI.TextAnalytics.MultiLabelClassifyAction" />, <see cref="T:Azure.AI.TextAnalytics.RecognizeCustomEntitiesAction" />, and <see cref="T:Azure.AI.TextAnalytics.SingleLabelClassifyAction" /> are only supported in service API version 2022-05-01 and newer. The <see cref="T:Azure.AI.TextAnalytics.ExtractiveSummarizeAction" /> and <see cref="T:Azure.AI.TextAnalytics.AbstractiveSummarizeAction" /> are only supported in service API version 2023-04-01 and newer. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> </Docs> </Member> <Member MemberName="StartAnalyzeActionsAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeActionsOperation> StartAnalyzeActionsAsync (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);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.AI.TextAnalytics.AnalyzeActionsOperation> StartAnalyzeActionsAsync(class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, class Azure.AI.TextAnalytics.TextAnalyticsActions actions, class Azure.AI.TextAnalytics.AnalyzeActionsOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.StartAnalyzeActionsAsync(System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},Azure.AI.TextAnalytics.TextAnalyticsActions,Azure.AI.TextAnalytics.AnalyzeActionsOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function StartAnalyzeActionsAsync (documents As IEnumerable(Of TextDocumentInput), actions As TextAnalyticsActions, Optional options As AnalyzeActionsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AnalyzeActionsOperation)" /> <MemberSignature Language="F#" Value="abstract member StartAnalyzeActionsAsync : 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.StartAnalyzeActionsAsync : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.TextAnalyticsActions * Azure.AI.TextAnalytics.AnalyzeActionsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeActionsOperation>" Usage="textAnalyticsClient.StartAnalyzeActionsAsync (documents, actions, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeActionsOperation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="actions" Type="Azure.AI.TextAnalytics.TextAnalyticsActions" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.AnalyzeActionsOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The list of documents to analyze.</param> <param name="actions"> The <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsActions" /> to perform on the list of documents.</param> <param name="options">The <see cref="T:Azure.AI.TextAnalytics.AnalyzeActionsOptions" /> used to configure the operation.</param> <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> controlling the lifetime of the request.</param> <summary> Performs one or more text analysis actions on a set of documents. The list of supported actions includes: <list type="bullet"><item><description>Entity Recognition (Named, Linked, and Personally Identifiable Information (PII) entities)</description></item><item><description>Key Phrases Extraction</description></item><item><description>Sentiment Analysis</description></item><item><description>Custom Entity Recognition</description></item><item><description>Custom Single and Multi Label Classification</description></item><item><description>Extractive Summarization</description></item><item><description>Abstractive Summarization</description></item></list><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits">here</see>. </para></summary> <returns>To be added.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V3_1" />, <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" />, and newer. See the service <see href="https://aka.ms/azsdk/textanalytics/customfunctionalities">documentation</see> for regional support of custom action features. </remarks> <exception cref="T:System.NotSupportedException"> This method is only supported in service API version v3.1 and newer. The <see cref="T:Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesAction" />, <see cref="T:Azure.AI.TextAnalytics.MultiLabelClassifyAction" />, <see cref="T:Azure.AI.TextAnalytics.RecognizeCustomEntitiesAction" />, and <see cref="T:Azure.AI.TextAnalytics.SingleLabelClassifyAction" /> are only supported in service API version 2022-05-01 and newer. The <see cref="T:Azure.AI.TextAnalytics.ExtractiveSummarizeAction" /> and <see cref="T:Azure.AI.TextAnalytics.AbstractiveSummarizeAction" /> are only supported in service API version 2023-04-01 and newer. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> </Docs> </Member> <Member MemberName="StartAnalyzeActionsAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeActionsOperation> StartAnalyzeActionsAsync (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);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.AI.TextAnalytics.AnalyzeActionsOperation> StartAnalyzeActionsAsync(class System.Collections.Generic.IEnumerable`1<string> documents, class Azure.AI.TextAnalytics.TextAnalyticsActions actions, string language, class Azure.AI.TextAnalytics.AnalyzeActionsOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.StartAnalyzeActionsAsync(System.Collections.Generic.IEnumerable{System.String},Azure.AI.TextAnalytics.TextAnalyticsActions,System.String,Azure.AI.TextAnalytics.AnalyzeActionsOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function StartAnalyzeActionsAsync (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)" /> <MemberSignature Language="F#" Value="abstract member StartAnalyzeActionsAsync : seq<string> * Azure.AI.TextAnalytics.TextAnalyticsActions * string * Azure.AI.TextAnalytics.AnalyzeActionsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeActionsOperation>
override this.StartAnalyzeActionsAsync : seq<string> * Azure.AI.TextAnalytics.TextAnalyticsActions * string * Azure.AI.TextAnalytics.AnalyzeActionsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeActionsOperation>" Usage="textAnalyticsClient.StartAnalyzeActionsAsync (documents, actions, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeActionsOperation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="actions" Type="Azure.AI.TextAnalytics.TextAnalyticsActions" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.AnalyzeActionsOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The list of documents to analyze.</param> <param name="actions">The <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsActions" /> to perform on the list of documents.</param> <param name="language">The language that the document is written in.</param> <param name="options">The <see cref="T:Azure.AI.TextAnalytics.AnalyzeActionsOptions" /> used to configure the operation.</param> <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> controlling the lifetime of the request.</param> <summary> Performs one or more text analysis actions on a set of documents. The list of supported actions includes: <list type="bullet"><item><description>Entity Recognition (Named, Linked, and Personally Identifiable Information (PII) entities)</description></item><item><description>Key Phrases Extraction</description></item><item><description>Sentiment Analysis</description></item><item><description>Custom Entity Recognition</description></item><item><description>Custom Single and Multi Label Classification</description></item><item><description>Extractive Summarization</description></item><item><description>Abstractive Summarization</description></item></list><para>For document length limits, maximum batch size, and supported text encoding, see more information <see href="https://aka.ms/azsdk/textanalytics/data-limits">here</see>. </para></summary> <returns>To be added.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V3_1" />, <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" />, and newer. See the service <see href="https://aka.ms/azsdk/textanalytics/customfunctionalities">documentation</see> for regional support of custom action features. </remarks> <exception cref="T:System.NotSupportedException"> This method is only supported in service API version v3.1 and newer. The <see cref="T:Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesAction" />, <see cref="T:Azure.AI.TextAnalytics.MultiLabelClassifyAction" />, <see cref="T:Azure.AI.TextAnalytics.RecognizeCustomEntitiesAction" />, and <see cref="T:Azure.AI.TextAnalytics.SingleLabelClassifyAction" /> are only supported in service API version 2022-05-01 and newer. The <see cref="T:Azure.AI.TextAnalytics.ExtractiveSummarizeAction" /> and <see cref="T:Azure.AI.TextAnalytics.AbstractiveSummarizeAction" /> are only supported in service API version 2023-04-01 and newer. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> </Docs> </Member> <Member MemberName="StartAnalyzeHealthcareEntities"> <MemberSignature Language="C#" Value="public virtual Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation StartAnalyzeHealthcareEntities (System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions options, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation StartAnalyzeHealthcareEntities(class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, class Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.StartAnalyzeHealthcareEntities(System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function StartAnalyzeHealthcareEntities (documents As IEnumerable(Of TextDocumentInput), options As AnalyzeHealthcareEntitiesOptions, Optional cancellationToken As CancellationToken = Nothing) As AnalyzeHealthcareEntitiesOperation" /> <MemberSignature Language="F#" Value="abstract member StartAnalyzeHealthcareEntities : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation
override this.StartAnalyzeHealthcareEntities : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation" Usage="textAnalyticsClient.StartAnalyzeHealthcareEntities (documents, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation</ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="options">The additional configurable options<see cref="T:Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions" /></param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> 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 <see href="https://aka.ms/talangs" />. For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />. </summary> <returns>A <see cref="T:Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation.Value" /> upon successful completion will contain layout elements extracted from the form.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V3_1" />, <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" />, and newer. </remarks> <exception cref="T:System.NotSupportedException">This method is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="StartAnalyzeHealthcareEntities"> <MemberSignature Language="C#" Value="public virtual Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation StartAnalyzeHealthcareEntities (System.Collections.Generic.IEnumerable<string> documents, string language = default, Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation StartAnalyzeHealthcareEntities(class System.Collections.Generic.IEnumerable`1<string> documents, string language, class Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.StartAnalyzeHealthcareEntities(System.Collections.Generic.IEnumerable{System.String},System.String,Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function StartAnalyzeHealthcareEntities (documents As IEnumerable(Of String), Optional language As String = Nothing, Optional options As AnalyzeHealthcareEntitiesOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AnalyzeHealthcareEntitiesOperation" /> <MemberSignature Language="F#" Value="abstract member StartAnalyzeHealthcareEntities : seq<string> * string * Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation
override this.StartAnalyzeHealthcareEntities : seq<string> * string * Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation" Usage="textAnalyticsClient.StartAnalyzeHealthcareEntities (documents, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation</ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="language">The language that the document is written in. If unspecified, this value will be set to the default language in <see cref="T:Azure.AI.TextAnalytics.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".</param> <param name="options">The additional configurable options<see cref="T:Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions" /></param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> 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 <see href="https://aka.ms/talangs" />. For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />. </summary> <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.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V3_1" />, <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" />, and newer. </remarks> <exception cref="T:System.NotSupportedException">This method is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="StartAnalyzeHealthcareEntitiesAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation> StartAnalyzeHealthcareEntitiesAsync (System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation> StartAnalyzeHealthcareEntitiesAsync(class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, class Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.StartAnalyzeHealthcareEntitiesAsync(System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function StartAnalyzeHealthcareEntitiesAsync (documents As IEnumerable(Of TextDocumentInput), Optional options As AnalyzeHealthcareEntitiesOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AnalyzeHealthcareEntitiesOperation)" /> <MemberSignature Language="F#" Value="abstract member StartAnalyzeHealthcareEntitiesAsync : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation>
override this.StartAnalyzeHealthcareEntitiesAsync : seq<Azure.AI.TextAnalytics.TextDocumentInput> * Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation>" Usage="textAnalyticsClient.StartAnalyzeHealthcareEntitiesAsync (documents, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="options">The additional configurable options<see cref="T:Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions" /></param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> 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 <see href="https://aka.ms/talangs" />. For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />. </summary> <returns>A <see cref="T:Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation.Value" /> upon successful completion will contain layout elements extracted from the form.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V3_1" />, <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" />, and newer. </remarks> <exception cref="T:System.NotSupportedException">This method is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="StartAnalyzeHealthcareEntitiesAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation> StartAnalyzeHealthcareEntitiesAsync (System.Collections.Generic.IEnumerable<string> documents, string language = default, Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation> StartAnalyzeHealthcareEntitiesAsync(class System.Collections.Generic.IEnumerable`1<string> documents, string language, class Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.StartAnalyzeHealthcareEntitiesAsync(System.Collections.Generic.IEnumerable{System.String},System.String,Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function StartAnalyzeHealthcareEntitiesAsync (documents As IEnumerable(Of String), Optional language As String = Nothing, Optional options As AnalyzeHealthcareEntitiesOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AnalyzeHealthcareEntitiesOperation)" /> <MemberSignature Language="F#" Value="abstract member StartAnalyzeHealthcareEntitiesAsync : seq<string> * string * Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation>
override this.StartAnalyzeHealthcareEntitiesAsync : seq<string> * string * Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation>" Usage="textAnalyticsClient.StartAnalyzeHealthcareEntitiesAsync (documents, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOperation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="language">The language that the document is written in.</param> <param name="options">The additional configurable <see cref="T:Azure.AI.TextAnalytics.AnalyzeHealthcareEntitiesOptions" /></param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> 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 <see href="https://aka.ms/talangs" />. For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />. </summary> <returns>To be added.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V3_1" />, <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" />, and newer. </remarks> <exception cref="T:System.NotSupportedException">This method is only supported in service API version v3.1 and newer.</exception> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> </Docs> </Member> <Member MemberName="StartMultiLabelClassify"> <MemberSignature Language="C#" Value="public virtual Azure.AI.TextAnalytics.ClassifyDocumentOperation StartMultiLabelClassify (System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, string projectName, string deploymentName, Azure.AI.TextAnalytics.MultiLabelClassifyOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.TextAnalytics.ClassifyDocumentOperation StartMultiLabelClassify(class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, string projectName, string deploymentName, class Azure.AI.TextAnalytics.MultiLabelClassifyOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.StartMultiLabelClassify(System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},System.String,System.String,Azure.AI.TextAnalytics.MultiLabelClassifyOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function StartMultiLabelClassify (documents As IEnumerable(Of TextDocumentInput), projectName As String, deploymentName As String, Optional options As MultiLabelClassifyOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ClassifyDocumentOperation" /> <MemberSignature Language="F#" Value="abstract member StartMultiLabelClassify : seq<Azure.AI.TextAnalytics.TextDocumentInput> * string * string * Azure.AI.TextAnalytics.MultiLabelClassifyOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.ClassifyDocumentOperation
override this.StartMultiLabelClassify : seq<Azure.AI.TextAnalytics.TextDocumentInput> * string * string * Azure.AI.TextAnalytics.MultiLabelClassifyOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.ClassifyDocumentOperation" Usage="textAnalyticsClient.StartMultiLabelClassify (documents, projectName, deploymentName, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>Azure.AI.TextAnalytics.ClassifyDocumentOperation</ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.MultiLabelClassifyOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="projectName">The name of the project which owns the models being consumed.</param> <param name="deploymentName">The name of the deployment being consumed.</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a classify each document with multiple labels in the passed-in documents. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/custom-text-classification/overview" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" /> and newer. </remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2022-05-01 and newer.</exception> </Docs> </Member> <Member MemberName="StartMultiLabelClassify"> <MemberSignature Language="C#" Value="public virtual Azure.AI.TextAnalytics.ClassifyDocumentOperation StartMultiLabelClassify (System.Collections.Generic.IEnumerable<string> documents, string projectName, string deploymentName, string language = default, Azure.AI.TextAnalytics.MultiLabelClassifyOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.TextAnalytics.ClassifyDocumentOperation StartMultiLabelClassify(class System.Collections.Generic.IEnumerable`1<string> documents, string projectName, string deploymentName, string language, class Azure.AI.TextAnalytics.MultiLabelClassifyOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.StartMultiLabelClassify(System.Collections.Generic.IEnumerable{System.String},System.String,System.String,System.String,Azure.AI.TextAnalytics.MultiLabelClassifyOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function StartMultiLabelClassify (documents As IEnumerable(Of String), projectName As String, deploymentName As String, Optional language As String = Nothing, Optional options As MultiLabelClassifyOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ClassifyDocumentOperation" /> <MemberSignature Language="F#" Value="abstract member StartMultiLabelClassify : seq<string> * string * string * string * Azure.AI.TextAnalytics.MultiLabelClassifyOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.ClassifyDocumentOperation
override this.StartMultiLabelClassify : seq<string> * string * string * string * Azure.AI.TextAnalytics.MultiLabelClassifyOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.ClassifyDocumentOperation" Usage="textAnalyticsClient.StartMultiLabelClassify (documents, projectName, deploymentName, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>Azure.AI.TextAnalytics.ClassifyDocumentOperation</ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.MultiLabelClassifyOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="projectName">The name of the project which owns the models being consumed.</param> <param name="deploymentName">The name of the deployment being consumed.</param> <param name="language">The language that all the documents are written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a classify each document with multiple labels in the passed-in documents. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/custom-text-classification/overview" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" /> and newer. </remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2022-05-01 and newer.</exception> </Docs> </Member> <Member MemberName="StartMultiLabelClassifyAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation> StartMultiLabelClassifyAsync (System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, string projectName, string deploymentName, Azure.AI.TextAnalytics.MultiLabelClassifyOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.AI.TextAnalytics.ClassifyDocumentOperation> StartMultiLabelClassifyAsync(class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, string projectName, string deploymentName, class Azure.AI.TextAnalytics.MultiLabelClassifyOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.StartMultiLabelClassifyAsync(System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},System.String,System.String,Azure.AI.TextAnalytics.MultiLabelClassifyOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function StartMultiLabelClassifyAsync (documents As IEnumerable(Of TextDocumentInput), projectName As String, deploymentName As String, Optional options As MultiLabelClassifyOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClassifyDocumentOperation)" /> <MemberSignature Language="F#" Value="abstract member StartMultiLabelClassifyAsync : seq<Azure.AI.TextAnalytics.TextDocumentInput> * string * string * Azure.AI.TextAnalytics.MultiLabelClassifyOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation>
override this.StartMultiLabelClassifyAsync : seq<Azure.AI.TextAnalytics.TextDocumentInput> * string * string * Azure.AI.TextAnalytics.MultiLabelClassifyOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation>" Usage="textAnalyticsClient.StartMultiLabelClassifyAsync (documents, projectName, deploymentName, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.MultiLabelClassifyOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="projectName">The name of the project which owns the models being consumed.</param> <param name="deploymentName">The name of the deployment being consumed.</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a classify each document with multiple labels in the passed-in documents. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/custom-text-classification/overview" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" /> and newer. </remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2022-05-01 and newer.</exception> </Docs> </Member> <Member MemberName="StartMultiLabelClassifyAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation> StartMultiLabelClassifyAsync (System.Collections.Generic.IEnumerable<string> documents, string projectName, string deploymentName, string language = default, Azure.AI.TextAnalytics.MultiLabelClassifyOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.AI.TextAnalytics.ClassifyDocumentOperation> StartMultiLabelClassifyAsync(class System.Collections.Generic.IEnumerable`1<string> documents, string projectName, string deploymentName, string language, class Azure.AI.TextAnalytics.MultiLabelClassifyOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.StartMultiLabelClassifyAsync(System.Collections.Generic.IEnumerable{System.String},System.String,System.String,System.String,Azure.AI.TextAnalytics.MultiLabelClassifyOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function StartMultiLabelClassifyAsync (documents As IEnumerable(Of String), projectName As String, deploymentName As String, Optional language As String = Nothing, Optional options As MultiLabelClassifyOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClassifyDocumentOperation)" /> <MemberSignature Language="F#" Value="abstract member StartMultiLabelClassifyAsync : seq<string> * string * string * string * Azure.AI.TextAnalytics.MultiLabelClassifyOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation>
override this.StartMultiLabelClassifyAsync : seq<string> * string * string * string * Azure.AI.TextAnalytics.MultiLabelClassifyOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation>" Usage="textAnalyticsClient.StartMultiLabelClassifyAsync (documents, projectName, deploymentName, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.MultiLabelClassifyOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="projectName">The name of the project which owns the models being consumed.</param> <param name="deploymentName">The name of the deployment being consumed.</param> <param name="language">The language that all the documents are written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a classify each document with multiple labels in the passed-in documents. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/custom-text-classification/overview" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" /> and newer. </remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2022-05-01 and newer.</exception> </Docs> </Member> <Member MemberName="StartRecognizeCustomEntities"> <MemberSignature Language="C#" Value="public virtual Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation StartRecognizeCustomEntities (System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, string projectName, string deploymentName, Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation StartRecognizeCustomEntities(class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, string projectName, string deploymentName, class Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.StartRecognizeCustomEntities(System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},System.String,System.String,Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function StartRecognizeCustomEntities (documents As IEnumerable(Of TextDocumentInput), projectName As String, deploymentName As String, Optional options As RecognizeCustomEntitiesOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As RecognizeCustomEntitiesOperation" /> <MemberSignature Language="F#" Value="abstract member StartRecognizeCustomEntities : seq<Azure.AI.TextAnalytics.TextDocumentInput> * string * string * Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation
override this.StartRecognizeCustomEntities : seq<Azure.AI.TextAnalytics.TextDocumentInput> * string * string * Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation" Usage="textAnalyticsClient.StartRecognizeCustomEntities (documents, projectName, deploymentName, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation</ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="projectName">The name of the project which owns the models being consumed.</param> <param name="deploymentName">The name of the deployment being consumed.</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a collection of custom named entities in the passed-in documents, and categorize those entities into custom types such as contracts or financial documents. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/custom-named-entity-recognition/overview" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2022-05-01 and newer.</exception> </Docs> </Member> <Member MemberName="StartRecognizeCustomEntities"> <MemberSignature Language="C#" Value="public virtual Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation StartRecognizeCustomEntities (System.Collections.Generic.IEnumerable<string> documents, string projectName, string deploymentName, string language = default, Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation StartRecognizeCustomEntities(class System.Collections.Generic.IEnumerable`1<string> documents, string projectName, string deploymentName, string language, class Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.StartRecognizeCustomEntities(System.Collections.Generic.IEnumerable{System.String},System.String,System.String,System.String,Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function StartRecognizeCustomEntities (documents As IEnumerable(Of String), projectName As String, deploymentName As String, Optional language As String = Nothing, Optional options As RecognizeCustomEntitiesOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As RecognizeCustomEntitiesOperation" /> <MemberSignature Language="F#" Value="abstract member StartRecognizeCustomEntities : seq<string> * string * string * string * Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation
override this.StartRecognizeCustomEntities : seq<string> * string * string * string * Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation" Usage="textAnalyticsClient.StartRecognizeCustomEntities (documents, projectName, deploymentName, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation</ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="projectName">The name of the project which owns the models being consumed.</param> <param name="deploymentName">The name of the deployment being consumed.</param> <param name="language">The language that all the documents are written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a collection of custom named entities in the passed-in documents, and categorize those entities into custom types such as contracts or financial documents. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/custom-named-entity-recognition/overview" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2022-05-01 and newer.</exception> </Docs> </Member> <Member MemberName="StartRecognizeCustomEntitiesAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation> StartRecognizeCustomEntitiesAsync (System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, string projectName, string deploymentName, Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation> StartRecognizeCustomEntitiesAsync(class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, string projectName, string deploymentName, class Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.StartRecognizeCustomEntitiesAsync(System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},System.String,System.String,Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function StartRecognizeCustomEntitiesAsync (documents As IEnumerable(Of TextDocumentInput), projectName As String, deploymentName As String, Optional options As RecognizeCustomEntitiesOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of RecognizeCustomEntitiesOperation)" /> <MemberSignature Language="F#" Value="abstract member StartRecognizeCustomEntitiesAsync : seq<Azure.AI.TextAnalytics.TextDocumentInput> * string * string * Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation>
override this.StartRecognizeCustomEntitiesAsync : seq<Azure.AI.TextAnalytics.TextDocumentInput> * string * string * Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation>" Usage="textAnalyticsClient.StartRecognizeCustomEntitiesAsync (documents, projectName, deploymentName, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="projectName">The name of the project which owns the models being consumed.</param> <param name="deploymentName">The name of the deployment being consumed.</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a collection of custom named entities in the passed-in documents, and categorize those entities into custom types such as contracts or financial documents. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/custom-named-entity-recognition/overview" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2022-05-01 and newer.</exception> </Docs> </Member> <Member MemberName="StartRecognizeCustomEntitiesAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation> StartRecognizeCustomEntitiesAsync (System.Collections.Generic.IEnumerable<string> documents, string projectName, string deploymentName, string language = default, Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation> StartRecognizeCustomEntitiesAsync(class System.Collections.Generic.IEnumerable`1<string> documents, string projectName, string deploymentName, string language, class Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.StartRecognizeCustomEntitiesAsync(System.Collections.Generic.IEnumerable{System.String},System.String,System.String,System.String,Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function StartRecognizeCustomEntitiesAsync (documents As IEnumerable(Of String), projectName As String, deploymentName As String, Optional language As String = Nothing, Optional options As RecognizeCustomEntitiesOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of RecognizeCustomEntitiesOperation)" /> <MemberSignature Language="F#" Value="abstract member StartRecognizeCustomEntitiesAsync : seq<string> * string * string * string * Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation>
override this.StartRecognizeCustomEntitiesAsync : seq<string> * string * string * string * Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation>" Usage="textAnalyticsClient.StartRecognizeCustomEntitiesAsync (documents, projectName, deploymentName, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.AI.TextAnalytics.RecognizeCustomEntitiesOperation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.RecognizeCustomEntitiesOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="projectName">The name of the project which owns the models being consumed.</param> <param name="deploymentName">The name of the deployment being consumed.</param> <param name="language">The language that all the documents are written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a collection of custom named entities in the passed-in documents, and categorize those entities into custom types such as contracts or financial documents. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/custom-named-entity-recognition/overview" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks>To be added.</remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2022-05-01 and newer.</exception> </Docs> </Member> <Member MemberName="StartSingleLabelClassify"> <MemberSignature Language="C#" Value="public virtual Azure.AI.TextAnalytics.ClassifyDocumentOperation StartSingleLabelClassify (System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, string projectName, string deploymentName, Azure.AI.TextAnalytics.SingleLabelClassifyOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.TextAnalytics.ClassifyDocumentOperation StartSingleLabelClassify(class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, string projectName, string deploymentName, class Azure.AI.TextAnalytics.SingleLabelClassifyOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.StartSingleLabelClassify(System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},System.String,System.String,Azure.AI.TextAnalytics.SingleLabelClassifyOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function StartSingleLabelClassify (documents As IEnumerable(Of TextDocumentInput), projectName As String, deploymentName As String, Optional options As SingleLabelClassifyOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ClassifyDocumentOperation" /> <MemberSignature Language="F#" Value="abstract member StartSingleLabelClassify : seq<Azure.AI.TextAnalytics.TextDocumentInput> * string * string * Azure.AI.TextAnalytics.SingleLabelClassifyOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.ClassifyDocumentOperation
override this.StartSingleLabelClassify : seq<Azure.AI.TextAnalytics.TextDocumentInput> * string * string * Azure.AI.TextAnalytics.SingleLabelClassifyOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.ClassifyDocumentOperation" Usage="textAnalyticsClient.StartSingleLabelClassify (documents, projectName, deploymentName, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>Azure.AI.TextAnalytics.ClassifyDocumentOperation</ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.SingleLabelClassifyOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="projectName">The name of the project which owns the models being consumed.</param> <param name="deploymentName">The name of the deployment being consumed.</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a classify each document with a single label in the passed-in documents. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/custom-text-classification/overview" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" /> and newer. </remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2022-05-01 and newer.</exception> </Docs> </Member> <Member MemberName="StartSingleLabelClassify"> <MemberSignature Language="C#" Value="public virtual Azure.AI.TextAnalytics.ClassifyDocumentOperation StartSingleLabelClassify (System.Collections.Generic.IEnumerable<string> documents, string projectName, string deploymentName, string language = default, Azure.AI.TextAnalytics.SingleLabelClassifyOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.TextAnalytics.ClassifyDocumentOperation StartSingleLabelClassify(class System.Collections.Generic.IEnumerable`1<string> documents, string projectName, string deploymentName, string language, class Azure.AI.TextAnalytics.SingleLabelClassifyOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.StartSingleLabelClassify(System.Collections.Generic.IEnumerable{System.String},System.String,System.String,System.String,Azure.AI.TextAnalytics.SingleLabelClassifyOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function StartSingleLabelClassify (documents As IEnumerable(Of String), projectName As String, deploymentName As String, Optional language As String = Nothing, Optional options As SingleLabelClassifyOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ClassifyDocumentOperation" /> <MemberSignature Language="F#" Value="abstract member StartSingleLabelClassify : seq<string> * string * string * string * Azure.AI.TextAnalytics.SingleLabelClassifyOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.ClassifyDocumentOperation
override this.StartSingleLabelClassify : seq<string> * string * string * string * Azure.AI.TextAnalytics.SingleLabelClassifyOptions * System.Threading.CancellationToken -> Azure.AI.TextAnalytics.ClassifyDocumentOperation" Usage="textAnalyticsClient.StartSingleLabelClassify (documents, projectName, deploymentName, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>Azure.AI.TextAnalytics.ClassifyDocumentOperation</ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.SingleLabelClassifyOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="projectName">The name of the project which owns the models being consumed.</param> <param name="deploymentName">The name of the deployment being consumed.</param> <param name="language">The language that all the documents are written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a classify each document with a single label in the passed-in documents. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/custom-text-classification/overview" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" /> and newer. </remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2022-05-01 and newer.</exception> </Docs> </Member> <Member MemberName="StartSingleLabelClassifyAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation> StartSingleLabelClassifyAsync (System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput> documents, string projectName, string deploymentName, Azure.AI.TextAnalytics.SingleLabelClassifyOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.AI.TextAnalytics.ClassifyDocumentOperation> StartSingleLabelClassifyAsync(class System.Collections.Generic.IEnumerable`1<class Azure.AI.TextAnalytics.TextDocumentInput> documents, string projectName, string deploymentName, class Azure.AI.TextAnalytics.SingleLabelClassifyOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.StartSingleLabelClassifyAsync(System.Collections.Generic.IEnumerable{Azure.AI.TextAnalytics.TextDocumentInput},System.String,System.String,Azure.AI.TextAnalytics.SingleLabelClassifyOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function StartSingleLabelClassifyAsync (documents As IEnumerable(Of TextDocumentInput), projectName As String, deploymentName As String, Optional options As SingleLabelClassifyOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClassifyDocumentOperation)" /> <MemberSignature Language="F#" Value="abstract member StartSingleLabelClassifyAsync : seq<Azure.AI.TextAnalytics.TextDocumentInput> * string * string * Azure.AI.TextAnalytics.SingleLabelClassifyOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation>
override this.StartSingleLabelClassifyAsync : seq<Azure.AI.TextAnalytics.TextDocumentInput> * string * string * Azure.AI.TextAnalytics.SingleLabelClassifyOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation>" Usage="textAnalyticsClient.StartSingleLabelClassifyAsync (documents, projectName, deploymentName, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<Azure.AI.TextAnalytics.TextDocumentInput>" /> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.SingleLabelClassifyOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="projectName">The name of the project which owns the models being consumed.</param> <param name="deploymentName">The name of the deployment being consumed.</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a classify each document with a single label in the passed-in documents. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/custom-text-classification/overview" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" /> and newer. </remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2022-05-01 and newer.</exception> </Docs> </Member> <Member MemberName="StartSingleLabelClassifyAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation> StartSingleLabelClassifyAsync (System.Collections.Generic.IEnumerable<string> documents, string projectName, string deploymentName, string language = default, Azure.AI.TextAnalytics.SingleLabelClassifyOptions options = default, System.Threading.CancellationToken cancellationToken = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.AI.TextAnalytics.ClassifyDocumentOperation> StartSingleLabelClassifyAsync(class System.Collections.Generic.IEnumerable`1<string> documents, string projectName, string deploymentName, string language, class Azure.AI.TextAnalytics.SingleLabelClassifyOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.StartSingleLabelClassifyAsync(System.Collections.Generic.IEnumerable{System.String},System.String,System.String,System.String,Azure.AI.TextAnalytics.SingleLabelClassifyOptions,System.Threading.CancellationToken)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function StartSingleLabelClassifyAsync (documents As IEnumerable(Of String), projectName As String, deploymentName As String, Optional language As String = Nothing, Optional options As SingleLabelClassifyOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClassifyDocumentOperation)" /> <MemberSignature Language="F#" Value="abstract member StartSingleLabelClassifyAsync : seq<string> * string * string * string * Azure.AI.TextAnalytics.SingleLabelClassifyOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation>
override this.StartSingleLabelClassifyAsync : seq<string> * string * string * string * Azure.AI.TextAnalytics.SingleLabelClassifyOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation>" Usage="textAnalyticsClient.StartSingleLabelClassifyAsync (documents, projectName, deploymentName, language, options, cancellationToken)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.AI.TextAnalytics.ClassifyDocumentOperation></ReturnType> </ReturnValue> <Parameters> <Parameter Name="documents" Type="System.Collections.Generic.IEnumerable<System.String>" /> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <Parameter Name="language" Type="System.String" /> <Parameter Name="options" Type="Azure.AI.TextAnalytics.SingleLabelClassifyOptions" /> <Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" /> </Parameters> <Docs> <param name="documents">The documents to analyze.</param> <param name="projectName">The name of the project which owns the models being consumed.</param> <param name="deploymentName">The name of the deployment being consumed.</param> <param name="language">The language that all the documents are written in. If unspecified, this value will be set to the default language in <see cref="P:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.DefaultLanguage" /> 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".</param> <param name="options"> <see cref="T:Azure.AI.TextAnalytics.TextAnalyticsRequestOptions" /> used to select the version of the predictive model to run, and whether statistics are returned in the response.</param> <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param> <summary> Runs a predictive model to identify a classify each document with a single label in the passed-in documents. <para>For more information on available categories, see <see href="https://docs.microsoft.com/azure/cognitive-services/language-service/custom-text-classification/overview" />.</para><para>For a list of languages supported by this operation, see <see href="https://aka.ms/talangs" />.</para><para>For document length limits, maximum batch size, and supported text encoding, see <see href="https://aka.ms/azsdk/textanalytics/data-limits" />.</para></summary> <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.</returns> <remarks> This method is only available for <see cref="F:Azure.AI.TextAnalytics.TextAnalyticsClientOptions.ServiceVersion.V2022_05_01" /> and newer. </remarks> <exception cref="T:Azure.RequestFailedException">Service returned a non-success status code.</exception> <exception cref="T:System.NotSupportedException">This method is only supported in service API version 2022-05-01 and newer.</exception> </Docs> </Member> <Member MemberName="ToString"> <MemberSignature Language="C#" Value="public override string ToString ();" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.TextAnalytics.TextAnalyticsClient.ToString" /> <MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" /> <MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="textAnalyticsClient.ToString " /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.TextAnalytics</AssemblyName> <AssemblyVersion>5.3.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary> TextAnalyticsClient ToString. </summary> <returns>To be added.</returns> <remarks>To be added.</remarks> </Docs> </Member> </Members> </Type>

xml/Azure.AI.TextAnalytics/TextAnalyticsClient.xml (4,863 lines of code) (raw):