xml/Azure.AI.Language.Conversations/ConversationAnalysisClient.xml (4,346 lines of code) (raw):
<Type Name="ConversationAnalysisClient" FullName="Azure.AI.Language.Conversations.ConversationAnalysisClient">
<TypeSignature Language="C#" Value="public class ConversationAnalysisClient" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ConversationAnalysisClient extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.AI.Language.Conversations.ConversationAnalysisClient" />
<TypeSignature Language="VB.NET" Value="Public Class ConversationAnalysisClient" />
<TypeSignature Language="F#" Value="type ConversationAnalysisClient = class" />
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.Conversations</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary> The language service conversations API is a suite of natural language processing (NLP) skills that can be used to analyze structured conversations (textual or spoken). The synchronous API in this suite accepts a request and mediates among multiple language projects, such as LUIS Generally Available, Question Answering, Conversational Language Understanding, and then calls the best candidate service to handle the request. At last, it returns a response with the candidate service's response as a payload.\n\n In some cases, this API needs to forward requests and responses between the caller and an upstream service. The asynchronous APIs in this suite enable tasks like Conversation Summarization and Conversational PII detection. </summary>
<remarks>
See <see href="https://learn.microsoft.com/rest/api/language/2023-04-01/conversation-analysis-runtime" /> for more information about models you can pass to this client.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ConversationAnalysisClient ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.ConversationAnalysisClient.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.Conversations</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary> Initializes a new instance of ConversationAnalysisClient for mocking. </summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ConversationAnalysisClient (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.Language.Conversations.ConversationAnalysisClient.#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.Language.Conversations.ConversationAnalysisClient : Uri * Azure.AzureKeyCredential -> Azure.AI.Language.Conversations.ConversationAnalysisClient" Usage="new Azure.AI.Language.Conversations.ConversationAnalysisClient (endpoint, credential)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.Conversations</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="credential" Type="Azure.AzureKeyCredential" />
</Parameters>
<Docs>
<param name="endpoint"> Supported Cognitive Services endpoint (e.g., https://<resource-name>.api.cognitiveservices.azure.com). </param>
<param name="credential"> A credential used to authenticate to an Azure Service. </param>
<summary> Initializes a new instance of ConversationAnalysisClient. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="endpoint" /> or <paramref name="credential" /> is null. </exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ConversationAnalysisClient (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.Language.Conversations.ConversationAnalysisClient.#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.Language.Conversations.ConversationAnalysisClient : Uri * Azure.Core.TokenCredential -> Azure.AI.Language.Conversations.ConversationAnalysisClient" Usage="new Azure.AI.Language.Conversations.ConversationAnalysisClient (endpoint, credential)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.Conversations</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="credential" Type="Azure.Core.TokenCredential" />
</Parameters>
<Docs>
<param name="endpoint"> Supported Cognitive Services endpoint (e.g., https://<resource-name>.api.cognitiveservices.azure.com). </param>
<param name="credential"> A credential used to authenticate to an Azure Service. </param>
<summary> Initializes a new instance of ConversationAnalysisClient. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="endpoint" /> or <paramref name="credential" /> is null. </exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ConversationAnalysisClient (Uri endpoint, Azure.AzureKeyCredential credential, Azure.AI.Language.Conversations.ConversationsClientOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.AzureKeyCredential credential, class Azure.AI.Language.Conversations.ConversationsClientOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.ConversationAnalysisClient.#ctor(System.Uri,Azure.AzureKeyCredential,Azure.AI.Language.Conversations.ConversationsClientOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As AzureKeyCredential, options As ConversationsClientOptions)" />
<MemberSignature Language="F#" Value="new Azure.AI.Language.Conversations.ConversationAnalysisClient : Uri * Azure.AzureKeyCredential * Azure.AI.Language.Conversations.ConversationsClientOptions -> Azure.AI.Language.Conversations.ConversationAnalysisClient" Usage="new Azure.AI.Language.Conversations.ConversationAnalysisClient (endpoint, credential, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.Conversations</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="credential" Type="Azure.AzureKeyCredential" />
<Parameter Name="options" Type="Azure.AI.Language.Conversations.ConversationsClientOptions" />
</Parameters>
<Docs>
<param name="endpoint"> Supported Cognitive Services endpoint (e.g., https://<resource-name>.api.cognitiveservices.azure.com). </param>
<param name="credential"> A credential used to authenticate to an Azure Service. </param>
<param name="options"> The options for configuring the client. </param>
<summary> Initializes a new instance of ConversationAnalysisClient. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="endpoint" /> or <paramref name="credential" /> is null. </exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ConversationAnalysisClient (Uri endpoint, Azure.Core.TokenCredential credential, Azure.AI.Language.Conversations.ConversationsClientOptions 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.Language.Conversations.ConversationsClientOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.ConversationAnalysisClient.#ctor(System.Uri,Azure.Core.TokenCredential,Azure.AI.Language.Conversations.ConversationsClientOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As TokenCredential, options As ConversationsClientOptions)" />
<MemberSignature Language="F#" Value="new Azure.AI.Language.Conversations.ConversationAnalysisClient : Uri * Azure.Core.TokenCredential * Azure.AI.Language.Conversations.ConversationsClientOptions -> Azure.AI.Language.Conversations.ConversationAnalysisClient" Usage="new Azure.AI.Language.Conversations.ConversationAnalysisClient (endpoint, credential, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.Conversations</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="credential" Type="Azure.Core.TokenCredential" />
<Parameter Name="options" Type="Azure.AI.Language.Conversations.ConversationsClientOptions" />
</Parameters>
<Docs>
<param name="endpoint"> Supported Cognitive Services endpoint (e.g., https://<resource-name>.cognitiveservices.azure.com). </param>
<param name="credential"> A credential used to authenticate to an Azure Service. </param>
<param name="options"> The options for configuring the client. </param>
<summary> Initializes a new instance of ConversationAnalysisClient. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="endpoint" /> or <paramref name="credential" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="AnalyzeConversation">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.Language.Conversations.Models.AnalyzeConversationActionResult> AnalyzeConversation (Azure.AI.Language.Conversations.Models.AnalyzeConversationInput analyzeConversationInput, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.Language.Conversations.Models.AnalyzeConversationActionResult> AnalyzeConversation(class Azure.AI.Language.Conversations.Models.AnalyzeConversationInput analyzeConversationInput, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.ConversationAnalysisClient.AnalyzeConversation(Azure.AI.Language.Conversations.Models.AnalyzeConversationInput,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeConversation (analyzeConversationInput As AnalyzeConversationInput, Optional cancellationToken As CancellationToken = Nothing) As Response(Of AnalyzeConversationActionResult)" />
<MemberSignature Language="F#" Value="abstract member AnalyzeConversation : Azure.AI.Language.Conversations.Models.AnalyzeConversationInput * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Language.Conversations.Models.AnalyzeConversationActionResult>
override this.AnalyzeConversation : Azure.AI.Language.Conversations.Models.AnalyzeConversationInput * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Language.Conversations.Models.AnalyzeConversationActionResult>" Usage="conversationAnalysisClient.AnalyzeConversation (analyzeConversationInput, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.Conversations</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.AI.Language.Conversations.Models.AnalyzeConversationActionResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="analyzeConversationInput" Type="Azure.AI.Language.Conversations.Models.AnalyzeConversationInput" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="analyzeConversationInput"> The input for the analyze conversations operation. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Analyzes the input conversation utterance. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="analyzeConversationInput" /> is null. </exception>
<example>
This sample shows how to call AnalyzeConversation.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
AnalyzeConversationInput analyzeConversationInput = new ConversationLanguageUnderstandingInput(new ConversationAnalysisInput(new TextConversationItem("1", "1", "Book a flight to Seattle on Oct 10th")), new ConversationLanguageUnderstandingActionContent("{project-name}", "{deployment-name}"));
Response<AnalyzeConversationActionResult> response = client.AnalyzeConversation(analyzeConversationInput);
]]></code>
This sample shows how to call AnalyzeConversation.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
AnalyzeConversationInput analyzeConversationInput = new ConversationLanguageUnderstandingInput(new ConversationAnalysisInput(new TextConversationItem("1", "1", "How do I integrate QnA Maker and LUIS?")
{
Language = "en-GB",
Modality = InputModality.Text,
}), new ConversationLanguageUnderstandingActionContent("{project-name}", "{deployment-name}")
{
Verbose = true,
IsLoggingEnabled = false,
});
Response<AnalyzeConversationActionResult> response = client.AnalyzeConversation(analyzeConversationInput);
]]></code>
This sample shows how to call AnalyzeConversation.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
AnalyzeConversationInput analyzeConversationInput = new ConversationLanguageUnderstandingInput(new ConversationAnalysisInput(new TextConversationItem("1", "1", "Ports and connectors")), new ConversationLanguageUnderstandingActionContent("prj1", "dep1")
{
DirectTarget = "qnaProject",
TargetProjectParameters =
{
["qnaProject"] = new QuestionAnsweringConfig
{
CallingOptions = new QuestionAnswersConfig
{
Question = "App Service overview",
Top = 1,
AnswerContext = new KnowledgeBaseAnswerContext(4)
{
PreviousQuestion = "Meet Surface Pro 4",
},
},
}
},
});
Response<AnalyzeConversationActionResult> response = client.AnalyzeConversation(analyzeConversationInput);
]]></code></example>
</Docs>
</Member>
<Member MemberName="AnalyzeConversation">
<MemberSignature Language="C#" Value="public virtual Azure.Response AnalyzeConversation (Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response AnalyzeConversation(class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.ConversationAnalysisClient.AnalyzeConversation(Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeConversation (content As RequestContent, Optional context As RequestContext = Nothing) As Response" />
<MemberSignature Language="F#" Value="abstract member AnalyzeConversation : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.AnalyzeConversation : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="conversationAnalysisClient.AnalyzeConversation (content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.Conversations</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="content"> The content to send as the body of the request. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Analyzes the input conversation utterance.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.AI.Language.Conversations.ConversationAnalysisClient.AnalyzeConversation(Azure.AI.Language.Conversations.Models.AnalyzeConversationInput,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>
Additional information can be found in the service REST API documentation:
https://learn.microsoft.com/rest/api/language/2023-04-01/conversation-analysis-runtime/analyze-conversation
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="content" /> is null. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call AnalyzeConversation and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
kind = "Conversation",
analysisInput = new
{
conversationItem = new
{
id = "1",
participantId = "1",
text = "Book a flight to Seattle on Oct 10th",
},
},
parameters = new
{
projectName = "{project-name}",
deploymentName = "{deployment-name}",
},
});
Response response = client.AnalyzeConversation(content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("kind").ToString());
]]></code>
This sample shows how to call AnalyzeConversation and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
kind = "Conversation",
analysisInput = new
{
conversationItem = new
{
participantId = "1",
id = "1",
modality = "text",
language = "en-GB",
text = "How do I integrate QnA Maker and LUIS?",
},
},
parameters = new
{
projectName = "{project-name}",
deploymentName = "{deployment-name}",
verbose = true,
isLoggingEnabled = false,
},
});
Response response = client.AnalyzeConversation(content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("kind").ToString());
]]></code>
This sample shows how to call AnalyzeConversation and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
kind = "Conversation",
analysisInput = new
{
conversationItem = new
{
text = "Ports and connectors",
participantId = "1",
id = "1",
},
},
parameters = new
{
projectName = "prj1",
deploymentName = "dep1",
directTarget = "qnaProject",
targetProjectParameters = new
{
qnaProject = new
{
targetProjectKind = "QuestionAnswering",
callingOptions = new
{
context = new
{
previousUserQuery = "Meet Surface Pro 4",
previousQnaId = 4,
},
top = 1,
question = "App Service overview",
},
},
},
},
});
Response response = client.AnalyzeConversation(content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("kind").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="AnalyzeConversationAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Language.Conversations.Models.AnalyzeConversationActionResult>> AnalyzeConversationAsync (Azure.AI.Language.Conversations.Models.AnalyzeConversationInput analyzeConversationInput, 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.Language.Conversations.Models.AnalyzeConversationActionResult>> AnalyzeConversationAsync(class Azure.AI.Language.Conversations.Models.AnalyzeConversationInput analyzeConversationInput, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.ConversationAnalysisClient.AnalyzeConversationAsync(Azure.AI.Language.Conversations.Models.AnalyzeConversationInput,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeConversationAsync (analyzeConversationInput As AnalyzeConversationInput, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AnalyzeConversationActionResult))" />
<MemberSignature Language="F#" Value="abstract member AnalyzeConversationAsync : Azure.AI.Language.Conversations.Models.AnalyzeConversationInput * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Language.Conversations.Models.AnalyzeConversationActionResult>>
override this.AnalyzeConversationAsync : Azure.AI.Language.Conversations.Models.AnalyzeConversationInput * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Language.Conversations.Models.AnalyzeConversationActionResult>>" Usage="conversationAnalysisClient.AnalyzeConversationAsync (analyzeConversationInput, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.Conversations</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.Language.Conversations.Models.AnalyzeConversationActionResult>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="analyzeConversationInput" Type="Azure.AI.Language.Conversations.Models.AnalyzeConversationInput" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="analyzeConversationInput"> The input for the analyze conversations operation. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Analyzes the input conversation utterance. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="analyzeConversationInput" /> is null. </exception>
<example>
This sample shows how to call AnalyzeConversationAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
AnalyzeConversationInput analyzeConversationInput = new ConversationLanguageUnderstandingInput(new ConversationAnalysisInput(new TextConversationItem("1", "1", "Book a flight to Seattle on Oct 10th")), new ConversationLanguageUnderstandingActionContent("{project-name}", "{deployment-name}"));
Response<AnalyzeConversationActionResult> response = await client.AnalyzeConversationAsync(analyzeConversationInput);
]]></code>
This sample shows how to call AnalyzeConversationAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
AnalyzeConversationInput analyzeConversationInput = new ConversationLanguageUnderstandingInput(new ConversationAnalysisInput(new TextConversationItem("1", "1", "How do I integrate QnA Maker and LUIS?")
{
Language = "en-GB",
Modality = InputModality.Text,
}), new ConversationLanguageUnderstandingActionContent("{project-name}", "{deployment-name}")
{
Verbose = true,
IsLoggingEnabled = false,
});
Response<AnalyzeConversationActionResult> response = await client.AnalyzeConversationAsync(analyzeConversationInput);
]]></code>
This sample shows how to call AnalyzeConversationAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
AnalyzeConversationInput analyzeConversationInput = new ConversationLanguageUnderstandingInput(new ConversationAnalysisInput(new TextConversationItem("1", "1", "Ports and connectors")), new ConversationLanguageUnderstandingActionContent("prj1", "dep1")
{
DirectTarget = "qnaProject",
TargetProjectParameters =
{
["qnaProject"] = new QuestionAnsweringConfig
{
CallingOptions = new QuestionAnswersConfig
{
Question = "App Service overview",
Top = 1,
AnswerContext = new KnowledgeBaseAnswerContext(4)
{
PreviousQuestion = "Meet Surface Pro 4",
},
},
}
},
});
Response<AnalyzeConversationActionResult> response = await client.AnalyzeConversationAsync(analyzeConversationInput);
]]></code></example>
</Docs>
</Member>
<Member MemberName="AnalyzeConversationAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> AnalyzeConversationAsync (Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> AnalyzeConversationAsync(class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.ConversationAnalysisClient.AnalyzeConversationAsync(Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeConversationAsync (content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member AnalyzeConversationAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.AnalyzeConversationAsync : Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="conversationAnalysisClient.AnalyzeConversationAsync (content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.Conversations</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="content"> The content to send as the body of the request. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Analyzes the input conversation utterance.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.AI.Language.Conversations.ConversationAnalysisClient.AnalyzeConversationAsync(Azure.AI.Language.Conversations.Models.AnalyzeConversationInput,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>
Additional information can be found in the service REST API documentation:
https://learn.microsoft.com/rest/api/language/2023-04-01/conversation-analysis-runtime/analyze-conversation
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="content" /> is null. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call AnalyzeConversationAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
kind = "Conversation",
analysisInput = new
{
conversationItem = new
{
id = "1",
participantId = "1",
text = "Book a flight to Seattle on Oct 10th",
},
},
parameters = new
{
projectName = "{project-name}",
deploymentName = "{deployment-name}",
},
});
Response response = await client.AnalyzeConversationAsync(content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("kind").ToString());
]]></code>
This sample shows how to call AnalyzeConversationAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
kind = "Conversation",
analysisInput = new
{
conversationItem = new
{
participantId = "1",
id = "1",
modality = "text",
language = "en-GB",
text = "How do I integrate QnA Maker and LUIS?",
},
},
parameters = new
{
projectName = "{project-name}",
deploymentName = "{deployment-name}",
verbose = true,
isLoggingEnabled = false,
},
});
Response response = await client.AnalyzeConversationAsync(content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("kind").ToString());
]]></code>
This sample shows how to call AnalyzeConversationAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
kind = "Conversation",
analysisInput = new
{
conversationItem = new
{
text = "Ports and connectors",
participantId = "1",
id = "1",
},
},
parameters = new
{
projectName = "prj1",
deploymentName = "dep1",
directTarget = "qnaProject",
targetProjectParameters = new
{
qnaProject = new
{
targetProjectKind = "QuestionAnswering",
callingOptions = new
{
context = new
{
previousUserQuery = "Meet Surface Pro 4",
previousQnaId = 4,
},
top = 1,
question = "App Service overview",
},
},
},
},
});
Response response = await client.AnalyzeConversationAsync(content);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("kind").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="AnalyzeConversations">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationState> AnalyzeConversations (Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationInput analyzeConversationOperationInput, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationState> AnalyzeConversations(class Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationInput analyzeConversationOperationInput, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.ConversationAnalysisClient.AnalyzeConversations(Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationInput,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeConversations (analyzeConversationOperationInput As AnalyzeConversationOperationInput, Optional cancellationToken As CancellationToken = Nothing) As Response(Of AnalyzeConversationOperationState)" />
<MemberSignature Language="F#" Value="abstract member AnalyzeConversations : Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationInput * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationState>
override this.AnalyzeConversations : Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationInput * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationState>" Usage="conversationAnalysisClient.AnalyzeConversations (analyzeConversationOperationInput, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.Conversations</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationState></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="analyzeConversationOperationInput" Type="Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationInput" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="analyzeConversationOperationInput">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>
Convenience method to submit an analysis long running operation for conversations and return the response once processed.
<param name="analyzeConversationOperationInput"> The input for the analyze conversations operation. </param><param name="cancellationToken"> The cancellation token to use. </param><exception cref="T:System.ArgumentNullException"><paramref name="analyzeConversationOperationInput" /> is null. </exception><exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception><returns> The <see cref="T:Azure.Response" /> representing the result of the long running operation on the service. </returns></summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AnalyzeConversations">
<MemberSignature Language="C#" Value="public virtual Azure.Operation<BinaryData> AnalyzeConversations (Azure.WaitUntil waitUntil, Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation`1<class System.BinaryData> AnalyzeConversations(valuetype Azure.WaitUntil waitUntil, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.ConversationAnalysisClient.AnalyzeConversations(Azure.WaitUntil,Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeConversations (waitUntil As WaitUntil, content As RequestContent, Optional context As RequestContext = Nothing) As Operation(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member AnalyzeConversations : Azure.WaitUntil * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Operation<BinaryData>
override this.AnalyzeConversations : Azure.WaitUntil * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Operation<BinaryData>" Usage="conversationAnalysisClient.AnalyzeConversations (waitUntil, content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.Conversations</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Operation<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" />
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<Parameter Name="context" Type="Azure.RequestContext" />
</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. For more information on long-running operations, please see <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/LongRunningOperations.md"> Azure.Core Long-Running Operation samples</see>. </param>
<param name="content"> The content to send as the body of the request. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Submits an analysis long running operation for conversations and return the response once processed.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.AI.Language.Conversations.ConversationAnalysisClient.AnalyzeConversations(Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationInput,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Operation" /> representing an asynchronous operation on the service. </returns>
<remarks>
Additional information can be found in the service REST API documentation:
https://learn.microsoft.com/rest/api/language/2023-04-01/analyze-conversation/submit-job
</remarks>
<example>
This sample shows how to call AnalyzeConversations with required parameters and request content, and how to parse the result.
<code><![CDATA[
var credential = new AzureKeyCredential("<key>");
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new ConversationAnalysisClient(endpoint, credential);
var data = new {
analysisInput = new {
conversations = new[] {
new {
conversationItems = new[] {
new {
text = "<text>",
id = "<id>",
participantId = "<participantId>",
}
},
id = "<id>",
language = "<language>",
modality = "text",
}
},
},
tasks = new[] {
new {
kind = "ConversationalSummarizationTask",
}
},
};
var operation = client.AnalyzeConversations(WaitUntil.Completed, RequestContent.Create(data));
BinaryData responseData = operation.Value;
JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("jobId").ToString());
Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
]]></code>
This sample shows how to call AnalyzeConversations with all parameters and request content, and how to parse the result.
<code><![CDATA[
var credential = new AzureKeyCredential("<key>");
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new ConversationAnalysisClient(endpoint, credential);
var data = new {
displayName = "<displayName>",
analysisInput = new {
conversations = new[] {
new {
conversationItems = new[] {
new {
text = "<text>",
id = "<id>",
participantId = "<participantId>",
language = "<language>",
modality = "transcript",
role = "agent",
}
},
id = "<id>",
language = "<language>",
modality = "text",
domain = "finance",
}
},
},
tasks = new[] {
new {
parameters = new {
summaryAspects = new[] {
"issue"
},
modelVersion = "<modelVersion>",
loggingOptOut = true,
},
kind = "ConversationalSummarizationTask",
taskName = "<taskName>",
}
},
};
var operation = client.AnalyzeConversations(WaitUntil.Completed, RequestContent.Create(data));
BinaryData responseData = operation.Value;
JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("displayName").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("expirationDateTime").ToString());
Console.WriteLine(result.GetProperty("jobId").ToString());
Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("errors")[0].GetProperty("code").ToString());
Console.WriteLine(result.GetProperty("errors")[0].GetProperty("message").ToString());
Console.WriteLine(result.GetProperty("errors")[0].GetProperty("target").ToString());
Console.WriteLine(result.GetProperty("errors")[0].GetProperty("details")[0].GetProperty("code").ToString());
Console.WriteLine(result.GetProperty("errors")[0].GetProperty("details")[0].GetProperty("message").ToString());
Console.WriteLine(result.GetProperty("errors")[0].GetProperty("details")[0].GetProperty("target").ToString());
Console.WriteLine(result.GetProperty("errors")[0].GetProperty("details")[0].GetProperty("innererror").GetProperty("code").ToString());
Console.WriteLine(result.GetProperty("errors")[0].GetProperty("details")[0].GetProperty("innererror").GetProperty("message").ToString());
Console.WriteLine(result.GetProperty("errors")[0].GetProperty("details")[0].GetProperty("innererror").GetProperty("details").GetProperty("<test>").ToString());
Console.WriteLine(result.GetProperty("errors")[0].GetProperty("details")[0].GetProperty("innererror").GetProperty("target").ToString());
Console.WriteLine(result.GetProperty("errors")[0].GetProperty("innererror").GetProperty("code").ToString());
Console.WriteLine(result.GetProperty("errors")[0].GetProperty("innererror").GetProperty("message").ToString());
Console.WriteLine(result.GetProperty("errors")[0].GetProperty("innererror").GetProperty("details").GetProperty("<test>").ToString());
Console.WriteLine(result.GetProperty("errors")[0].GetProperty("innererror").GetProperty("target").ToString());
Console.WriteLine(result.GetProperty("nextLink").ToString());
]]></code></example>
<exception cref="T:System.ArgumentNullException">
<paramref name="content" /> is null. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
</Docs>
</Member>
<Member MemberName="AnalyzeConversationsAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationState>> AnalyzeConversationsAsync (Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationInput analyzeConversationOperationInput, 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.Language.Conversations.Models.AnalyzeConversationOperationState>> AnalyzeConversationsAsync(class Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationInput analyzeConversationOperationInput, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.ConversationAnalysisClient.AnalyzeConversationsAsync(Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationInput,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeConversationsAsync (analyzeConversationOperationInput As AnalyzeConversationOperationInput, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AnalyzeConversationOperationState))" />
<MemberSignature Language="F#" Value="abstract member AnalyzeConversationsAsync : Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationInput * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationState>>
override this.AnalyzeConversationsAsync : Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationInput * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationState>>" Usage="conversationAnalysisClient.AnalyzeConversationsAsync (analyzeConversationOperationInput, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.Conversations</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationState>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="analyzeConversationOperationInput" Type="Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationInput" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="analyzeConversationOperationInput">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>
Convenience method to submit an analysis long running operation for conversations and return the response once processed.
<param name="analyzeConversationOperationInput"> The input for the analyze conversations operation. </param><param name="cancellationToken"> The cancellation token to use. </param><exception cref="T:System.ArgumentNullException"><paramref name="analyzeConversationOperationInput" /> is null. </exception><exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception><returns> The <see cref="T:Azure.Response" /> representing the result of the long running operation on the service. </returns></summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AnalyzeConversationsAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation<BinaryData>> AnalyzeConversationsAsync (Azure.WaitUntil waitUntil, Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Operation`1<class System.BinaryData>> AnalyzeConversationsAsync(valuetype Azure.WaitUntil waitUntil, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.ConversationAnalysisClient.AnalyzeConversationsAsync(Azure.WaitUntil,Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeConversationsAsync (waitUntil As WaitUntil, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Operation(Of BinaryData))" />
<MemberSignature Language="F#" Value="abstract member AnalyzeConversationsAsync : Azure.WaitUntil * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>
override this.AnalyzeConversationsAsync : Azure.WaitUntil * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>" Usage="conversationAnalysisClient.AnalyzeConversationsAsync (waitUntil, content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.Conversations</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Operation<System.BinaryData>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" />
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<Parameter Name="context" Type="Azure.RequestContext" />
</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. For more information on long-running operations, please see <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/LongRunningOperations.md"> Azure.Core Long-Running Operation samples</see>. </param>
<param name="content"> The content to send as the body of the request. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Submits an analysis long running operation for conversations and return the response once processed.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.AI.Language.Conversations.ConversationAnalysisClient.AnalyzeConversationsAsync(Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationInput,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Operation" /> representing an asynchronous operation on the service. </returns>
<remarks>
Additional information can be found in the service REST API documentation:
https://learn.microsoft.com/rest/api/language/2023-04-01/analyze-conversation/submit-job
</remarks>
<example>
This sample shows how to call AnalyzeConversationsAsync with required parameters and request content, and how to parse the result.
<code><![CDATA[
var credential = new AzureKeyCredential("<key>");
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new ConversationAnalysisClient(endpoint, credential);
var data = new {
analysisInput = new {
conversations = new[] {
new {
conversationItems = new[] {
new {
text = "<text>",
id = "<id>",
participantId = "<participantId>",
}
},
id = "<id>",
language = "<language>",
modality = "text",
}
},
},
tasks = new[] {
new {
kind = "ConversationalSummarizationTask",
}
},
};
var operation = await client.AnalyzeConversationsAsync(WaitUntil.Completed, RequestContent.Create(data));
BinaryData responseData = operation.Value;
JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("jobId").ToString());
Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
]]></code>
This sample shows how to call AnalyzeConversationsAsync with all parameters and request content, and how to parse the result.
<code><![CDATA[
var credential = new AzureKeyCredential("<key>");
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new ConversationAnalysisClient(endpoint, credential);
var data = new {
displayName = "<displayName>",
analysisInput = new {
conversations = new[] {
new {
conversationItems = new[] {
new {
text = "<text>",
id = "<id>",
participantId = "<participantId>",
language = "<language>",
modality = "transcript",
role = "agent",
}
},
id = "<id>",
language = "<language>",
modality = "text",
domain = "finance",
}
},
},
tasks = new[] {
new {
parameters = new {
summaryAspects = new[] {
"issue"
},
modelVersion = "<modelVersion>",
loggingOptOut = true,
},
kind = "ConversationalSummarizationTask",
taskName = "<taskName>",
}
},
};
var operation = await client.AnalyzeConversationsAsync(WaitUntil.Completed, RequestContent.Create(data));
BinaryData responseData = operation.Value;
JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("displayName").ToString());
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("expirationDateTime").ToString());
Console.WriteLine(result.GetProperty("jobId").ToString());
Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("errors")[0].GetProperty("code").ToString());
Console.WriteLine(result.GetProperty("errors")[0].GetProperty("message").ToString());
Console.WriteLine(result.GetProperty("errors")[0].GetProperty("target").ToString());
Console.WriteLine(result.GetProperty("errors")[0].GetProperty("details")[0].GetProperty("code").ToString());
Console.WriteLine(result.GetProperty("errors")[0].GetProperty("details")[0].GetProperty("message").ToString());
Console.WriteLine(result.GetProperty("errors")[0].GetProperty("details")[0].GetProperty("target").ToString());
Console.WriteLine(result.GetProperty("errors")[0].GetProperty("details")[0].GetProperty("innererror").GetProperty("code").ToString());
Console.WriteLine(result.GetProperty("errors")[0].GetProperty("details")[0].GetProperty("innererror").GetProperty("message").ToString());
Console.WriteLine(result.GetProperty("errors")[0].GetProperty("details")[0].GetProperty("innererror").GetProperty("details").GetProperty("<test>").ToString());
Console.WriteLine(result.GetProperty("errors")[0].GetProperty("details")[0].GetProperty("innererror").GetProperty("target").ToString());
Console.WriteLine(result.GetProperty("errors")[0].GetProperty("innererror").GetProperty("code").ToString());
Console.WriteLine(result.GetProperty("errors")[0].GetProperty("innererror").GetProperty("message").ToString());
Console.WriteLine(result.GetProperty("errors")[0].GetProperty("innererror").GetProperty("details").GetProperty("<test>").ToString());
Console.WriteLine(result.GetProperty("errors")[0].GetProperty("innererror").GetProperty("target").ToString());
Console.WriteLine(result.GetProperty("nextLink").ToString());
]]></code></example>
<exception cref="T:System.ArgumentNullException">
<paramref name="content" /> is null. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
</Docs>
</Member>
<Member MemberName="AnalyzeConversationSubmitOperation">
<MemberSignature Language="C#" Value="public virtual Azure.Operation AnalyzeConversationSubmitOperation (Azure.WaitUntil waitUntil, Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationInput analyzeConversationOperationInput, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation AnalyzeConversationSubmitOperation(valuetype Azure.WaitUntil waitUntil, class Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationInput analyzeConversationOperationInput, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.ConversationAnalysisClient.AnalyzeConversationSubmitOperation(Azure.WaitUntil,Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationInput,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeConversationSubmitOperation (waitUntil As WaitUntil, analyzeConversationOperationInput As AnalyzeConversationOperationInput, Optional cancellationToken As CancellationToken = Nothing) As Operation" />
<MemberSignature Language="F#" Value="abstract member AnalyzeConversationSubmitOperation : Azure.WaitUntil * Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationInput * System.Threading.CancellationToken -> Azure.Operation
override this.AnalyzeConversationSubmitOperation : Azure.WaitUntil * Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationInput * System.Threading.CancellationToken -> Azure.Operation" Usage="conversationAnalysisClient.AnalyzeConversationSubmitOperation (waitUntil, analyzeConversationOperationInput, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.Conversations</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Operation</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="analyzeConversationOperationInput" Type="Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationInput" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="azure-dotnet-preview" />
</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. For more information on long-running operations, please see <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/LongRunningOperations.md"> Azure.Core Long-Running Operation samples</see>. </param>
<param name="analyzeConversationOperationInput"> The input for the analyze conversations operation. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Analyzes the input conversation utterance. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="analyzeConversationOperationInput" /> is null. </exception>
<example>
This sample shows how to call AnalyzeConversationSubmitOperation.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
AnalyzeConversationOperationInput analyzeConversationOperationInput = new AnalyzeConversationOperationInput(new MultiLanguageConversationInput(new ConversationInput[]
{
new TranscriptConversation("1", "en", new TranscriptConversationItem[]
{
new TranscriptConversationItem(
"1",
"1",
"good morning john doe",
"good morning john doe",
"Good morning John Doe.",
"good morning john doe")
{
WordLevelTimings = {new WordLevelTiming
{
Offset = 390000L,
Duration = 2700000L,
Word = "good",
}, new WordLevelTiming
{
Offset = 4500000L,
Duration = 920000L,
Word = "morning",
}, new WordLevelTiming
{
Offset = 590000L,
Duration = 2700000L,
Word = "john",
}, new WordLevelTiming
{
Offset = 6300000L,
Duration = 920000L,
Word = "doe",
}},
}
})
{
Domain = ConversationDomain.Generic,
}
}), new AnalyzeConversationOperationAction[]
{
new PiiOperationAction
{
ActionContent = new ConversationPiiActionContent
{
ModelVersion = "latest",
PiiCategories = {ConversationPiiCategories.All},
RedactAudioTiming = true,
RedactionSource = TranscriptContentType.Lexical,
RedactionPolicy = new CharacterMaskPolicyType
{
RedactionCharacter = RedactionCharacter.Minus,
},
},
Name = "Conversation PII",
}
})
{
DisplayName = "Redacting PII data from transcribed audio",
};
Operation operation = client.AnalyzeConversationSubmitOperation(WaitUntil.Completed, analyzeConversationOperationInput);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperation.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
AnalyzeConversationOperationInput analyzeConversationOperationInput = new AnalyzeConversationOperationInput(new MultiLanguageConversationInput(new ConversationInput[]
{
new TranscriptConversation("1", "en", new TranscriptConversationItem[]
{
new TranscriptConversationItem(
"1",
"1",
"good morning john doe",
"good morning john doe",
"Good morning John Doe.",
"good morning john doe")
{
WordLevelTimings = {new WordLevelTiming
{
Offset = 390000L,
Duration = 2700000L,
Word = "good",
}, new WordLevelTiming
{
Offset = 4500000L,
Duration = 920000L,
Word = "morning",
}, new WordLevelTiming
{
Offset = 590000L,
Duration = 2700000L,
Word = "john",
}, new WordLevelTiming
{
Offset = 6300000L,
Duration = 920000L,
Word = "doe",
}},
}
})
{
Domain = ConversationDomain.Generic,
}
}), new AnalyzeConversationOperationAction[]
{
new PiiOperationAction
{
ActionContent = new ConversationPiiActionContent
{
ModelVersion = "latest",
PiiCategories = {ConversationPiiCategories.All},
RedactAudioTiming = true,
RedactionSource = TranscriptContentType.Lexical,
RedactionPolicy = new EntityMaskTypePolicyType(),
},
Name = "Conversation PII",
}
})
{
DisplayName = "Redacting PII data from transcribed audio",
};
Operation operation = client.AnalyzeConversationSubmitOperation(WaitUntil.Completed, analyzeConversationOperationInput);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperation.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
AnalyzeConversationOperationInput analyzeConversationOperationInput = new AnalyzeConversationOperationInput(new MultiLanguageConversationInput(new ConversationInput[]
{
new TranscriptConversation("1", "en", new TranscriptConversationItem[]
{
new TranscriptConversationItem(
"1",
"1",
"good morning john doe",
"good morning john doe",
"Good morning John Doe.",
"good morning john doe")
{
WordLevelTimings = {new WordLevelTiming
{
Offset = 390000L,
Duration = 2700000L,
Word = "good",
}, new WordLevelTiming
{
Offset = 4500000L,
Duration = 920000L,
Word = "morning",
}, new WordLevelTiming
{
Offset = 590000L,
Duration = 2700000L,
Word = "john",
}, new WordLevelTiming
{
Offset = 6300000L,
Duration = 920000L,
Word = "doe",
}},
}
})
{
Domain = ConversationDomain.Generic,
}
}), new AnalyzeConversationOperationAction[]
{
new PiiOperationAction
{
ActionContent = new ConversationPiiActionContent
{
ModelVersion = "latest",
RedactAudioTiming = true,
RedactionSource = TranscriptContentType.Lexical,
ExcludePiiCategories = {ConversationPiiCategoryExclusions.Person},
},
Name = "Conversation PII",
}
})
{
DisplayName = "Redacting PII data from transcribed audio",
};
Operation operation = client.AnalyzeConversationSubmitOperation(WaitUntil.Completed, analyzeConversationOperationInput);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperation.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
AnalyzeConversationOperationInput analyzeConversationOperationInput = new AnalyzeConversationOperationInput(new MultiLanguageConversationInput(new ConversationInput[]
{
new TranscriptConversation("1", "en", new TranscriptConversationItem[]
{
new TranscriptConversationItem(
"1",
"1",
"good morning john doe",
"good morning john doe",
"Good morning John Doe.",
"good morning john doe")
{
WordLevelTimings = {new WordLevelTiming
{
Offset = 390000L,
Duration = 2700000L,
Word = "good",
}, new WordLevelTiming
{
Offset = 4500000L,
Duration = 920000L,
Word = "morning",
}, new WordLevelTiming
{
Offset = 590000L,
Duration = 2700000L,
Word = "john",
}, new WordLevelTiming
{
Offset = 6300000L,
Duration = 920000L,
Word = "doe",
}},
}
})
{
Domain = ConversationDomain.Generic,
}
}), new AnalyzeConversationOperationAction[]
{
new PiiOperationAction
{
ActionContent = new ConversationPiiActionContent
{
ModelVersion = "latest",
PiiCategories = {ConversationPiiCategories.All},
RedactAudioTiming = true,
RedactionSource = TranscriptContentType.Lexical,
RedactionPolicy = new NoMaskPolicyType(),
},
Name = "Conversation PII",
}
})
{
DisplayName = "Redacting PII data from transcribed audio",
};
Operation operation = client.AnalyzeConversationSubmitOperation(WaitUntil.Completed, analyzeConversationOperationInput);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperation.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
AnalyzeConversationOperationInput analyzeConversationOperationInput = new AnalyzeConversationOperationInput(new MultiLanguageConversationInput(new ConversationInput[]
{
new TranscriptConversation("1", "en", new TranscriptConversationItem[]
{
new TranscriptConversationItem(
"1",
"1",
"good morning john doe",
"good morning john doe",
"Good morning John Doe.",
"good morning john doe")
{
WordLevelTimings = {new WordLevelTiming
{
Offset = 390000L,
Duration = 2700000L,
Word = "good",
}, new WordLevelTiming
{
Offset = 4500000L,
Duration = 920000L,
Word = "morning",
}, new WordLevelTiming
{
Offset = 590000L,
Duration = 2700000L,
Word = "john",
}, new WordLevelTiming
{
Offset = 6300000L,
Duration = 920000L,
Word = "doe",
}},
}
})
{
Domain = ConversationDomain.Generic,
}
}), new AnalyzeConversationOperationAction[]
{
new PiiOperationAction
{
ActionContent = new ConversationPiiActionContent
{
ModelVersion = "latest",
PiiCategories = {ConversationPiiCategories.All},
RedactAudioTiming = true,
RedactionSource = TranscriptContentType.Lexical,
RedactionCharacter = RedactionCharacter.Minus,
},
Name = "Conversation PII",
}
})
{
DisplayName = "Redacting PII data from transcribed audio",
};
Operation operation = client.AnalyzeConversationSubmitOperation(WaitUntil.Completed, analyzeConversationOperationInput);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperation.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
AnalyzeConversationOperationInput analyzeConversationOperationInput = new AnalyzeConversationOperationInput(new MultiLanguageConversationInput(new ConversationInput[]
{
new TranscriptConversation("1", "en", new TranscriptConversationItem[]
{
new TranscriptConversationItem(
"1",
"1",
"good morning john doe",
"good morning john doe",
"Good morning John Doe.",
"good morning john doe")
{
WordLevelTimings = {new WordLevelTiming
{
Offset = 390000L,
Duration = 2700000L,
Word = "good",
}, new WordLevelTiming
{
Offset = 4500000L,
Duration = 920000L,
Word = "morning",
}, new WordLevelTiming
{
Offset = 590000L,
Duration = 2700000L,
Word = "john",
}, new WordLevelTiming
{
Offset = 6300000L,
Duration = 920000L,
Word = "doe",
}},
}
})
{
Domain = ConversationDomain.Generic,
}
}), new AnalyzeConversationOperationAction[]
{
new PiiOperationAction
{
ActionContent = new ConversationPiiActionContent
{
ModelVersion = "latest",
PiiCategories = {ConversationPiiCategories.All},
RedactAudioTiming = true,
RedactionSource = TranscriptContentType.Lexical,
},
Name = "Conversation PII",
}
})
{
DisplayName = "Redacting PII data from transcribed audio",
};
Operation operation = client.AnalyzeConversationSubmitOperation(WaitUntil.Completed, analyzeConversationOperationInput);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperation.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
AnalyzeConversationOperationInput analyzeConversationOperationInput = new AnalyzeConversationOperationInput(new MultiLanguageConversationInput(new ConversationInput[]
{
new TranscriptConversation("1", "en", new TranscriptConversationItem[]
{
new TranscriptConversationItem(
"1",
"speaker 1",
"",
"",
"Let's get started.",
"")
{
ConversationItemLevelTiming = new ConversationItemLevelTiming
{
Offset = 0L,
Duration = 20000000L,
},
},
new TranscriptConversationItem(
"2",
"speaker 2",
"",
"",
"OK. How many remaining bugs do we have now?",
"")
{
ConversationItemLevelTiming = new ConversationItemLevelTiming
{
Offset = 20000000L,
Duration = 50000000L,
},
},
new TranscriptConversationItem(
"3",
"speaker 3",
"",
"",
"Only 3.",
"")
{
ConversationItemLevelTiming = new ConversationItemLevelTiming
{
Offset = 50000000L,
Duration = 60000000L,
},
}
})
}), new AnalyzeConversationOperationAction[]
{
new SummarizationOperationAction
{
ActionContent = new ConversationSummarizationActionContent(new SummaryAspect[]{SummaryAspect.ChapterTitle, SummaryAspect.Narrative}),
Name = "Conversation Summarization Task 1",
}
})
{
DisplayName = "Conversation Summarization Example",
};
Operation operation = client.AnalyzeConversationSubmitOperation(WaitUntil.Completed, analyzeConversationOperationInput);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperation.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
AnalyzeConversationOperationInput analyzeConversationOperationInput = new AnalyzeConversationOperationInput(new MultiLanguageConversationInput(new ConversationInput[]
{
new TextConversation("20220101meeting", "en", new TextConversationItem[]
{
new TextConversationItem("1", "user", "Hi!")
{
Role = ParticipantRole.Customer,
},
new TextConversationItem("2", "agent", "Hello, how can I help you?")
{
Role = ParticipantRole.Agent,
},
new TextConversationItem("3", "user", "I am having trouble issuing a return of a game on my xbox: call of duty")
{
Role = ParticipantRole.Customer,
}
})
{
Domain = ConversationDomain.Generic,
}
}), new AnalyzeConversationOperationAction[]
{
new SummarizationOperationAction
{
ActionContent = new ConversationSummarizationActionContent(new SummaryAspect[]{SummaryAspect.Issue, SummaryAspect.Resolution})
{
ModelVersion = "latest",
},
Name = "analyze 1",
}
})
{
DisplayName = "Analyze conversations from Contoso meeting",
};
Operation operation = client.AnalyzeConversationSubmitOperation(WaitUntil.Completed, analyzeConversationOperationInput);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperation.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
AnalyzeConversationOperationInput analyzeConversationOperationInput = new AnalyzeConversationOperationInput(new MultiLanguageConversationInput(new ConversationInput[]
{
new TranscriptConversation("1", "en", new TranscriptConversationItem[]
{
new TranscriptConversationItem(
"1",
"speaker 1",
"",
"",
"Let's get started.",
"")
{
ConversationItemLevelTiming = new ConversationItemLevelTiming
{
Offset = 0L,
Duration = 20000000L,
},
},
new TranscriptConversationItem(
"2",
"speaker 2",
"",
"",
"OK. How many remaining bugs do we have now?",
"")
{
ConversationItemLevelTiming = new ConversationItemLevelTiming
{
Offset = 20000000L,
Duration = 50000000L,
},
},
new TranscriptConversationItem(
"3",
"speaker 3",
"",
"",
"Only 3.",
"")
{
ConversationItemLevelTiming = new ConversationItemLevelTiming
{
Offset = 50000000L,
Duration = 60000000L,
},
}
})
}), new AnalyzeConversationOperationAction[]
{
new CustomSummarizationOperationAction
{
ActionContent = new CustomConversationSummarizationActionContent("my_project", "my_deployment", new SummaryAspect[]{SummaryAspect.Narrative}),
Name = "Custom Conversation Summarization Task 1",
}
})
{
DisplayName = "Custom Conversation Summarization Example",
};
Operation operation = client.AnalyzeConversationSubmitOperation(WaitUntil.Completed, analyzeConversationOperationInput);
]]></code></example>
</Docs>
</Member>
<Member MemberName="AnalyzeConversationSubmitOperation">
<MemberSignature Language="C#" Value="public virtual Azure.Operation AnalyzeConversationSubmitOperation (Azure.WaitUntil waitUntil, Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation AnalyzeConversationSubmitOperation(valuetype Azure.WaitUntil waitUntil, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.ConversationAnalysisClient.AnalyzeConversationSubmitOperation(Azure.WaitUntil,Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeConversationSubmitOperation (waitUntil As WaitUntil, content As RequestContent, Optional context As RequestContext = Nothing) As Operation" />
<MemberSignature Language="F#" Value="abstract member AnalyzeConversationSubmitOperation : Azure.WaitUntil * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Operation
override this.AnalyzeConversationSubmitOperation : Azure.WaitUntil * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Operation" Usage="conversationAnalysisClient.AnalyzeConversationSubmitOperation (waitUntil, content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.Conversations</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Operation</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="content" Type="Azure.Core.RequestContent" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="context" Type="Azure.RequestContext" Index="2" FrameworkAlternate="azure-dotnet-preview" />
</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. For more information on long-running operations, please see <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/LongRunningOperations.md"> Azure.Core Long-Running Operation samples</see>. </param>
<param name="content"> The content to send as the body of the request. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Analyzes the input conversation utterance.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.AI.Language.Conversations.ConversationAnalysisClient.AnalyzeConversationSubmitOperation(Azure.WaitUntil,Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationInput,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Operation" /> representing an asynchronous operation on the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="content" /> is null. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call AnalyzeConversationSubmitOperation.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
displayName = "Redacting PII data from transcribed audio",
analysisInput = new
{
conversations = new object[]
{
new
{
id = "1",
language = "en",
modality = "transcript",
domain = "generic",
conversationItems = new object[]
{
new
{
participantId = "1",
id = "1",
text = "Good morning John Doe.",
itn = "good morning john doe",
maskedItn = "good morning john doe",
lexical = "good morning john doe",
wordLevelTimings = new object[]
{
new
{
word = "good",
offset = 390000L,
duration = 2700000L,
},
new
{
word = "morning",
offset = 4500000L,
duration = 920000L,
},
new
{
word = "john",
offset = 590000L,
duration = 2700000L,
},
new
{
word = "doe",
offset = 6300000L,
duration = 920000L,
}
},
}
},
}
},
},
tasks = new object[]
{
new
{
taskName = "Conversation PII",
kind = "ConversationalPIITask",
parameters = new
{
modelVersion = "latest",
piiCategories = new object[]
{
"All"
},
redactionPolicy = new
{
policyKind = "characterMask",
redactionCharacter = "-",
},
redactionSource = "lexical",
redactAudioTiming = true,
},
}
},
});
Operation operation = client.AnalyzeConversationSubmitOperation(WaitUntil.Completed, content);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperation.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
displayName = "Redacting PII data from transcribed audio",
analysisInput = new
{
conversations = new object[]
{
new
{
id = "1",
language = "en",
modality = "transcript",
domain = "generic",
conversationItems = new object[]
{
new
{
participantId = "1",
id = "1",
text = "Good morning John Doe.",
itn = "good morning john doe",
maskedItn = "good morning john doe",
lexical = "good morning john doe",
wordLevelTimings = new object[]
{
new
{
word = "good",
offset = 390000L,
duration = 2700000L,
},
new
{
word = "morning",
offset = 4500000L,
duration = 920000L,
},
new
{
word = "john",
offset = 590000L,
duration = 2700000L,
},
new
{
word = "doe",
offset = 6300000L,
duration = 920000L,
}
},
}
},
}
},
},
tasks = new object[]
{
new
{
taskName = "Conversation PII",
kind = "ConversationalPIITask",
parameters = new
{
modelVersion = "latest",
piiCategories = new object[]
{
"All"
},
redactionPolicy = new
{
policyKind = "entityMask",
},
redactionSource = "lexical",
redactAudioTiming = true,
},
}
},
});
Operation operation = client.AnalyzeConversationSubmitOperation(WaitUntil.Completed, content);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperation.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
displayName = "Redacting PII data from transcribed audio",
analysisInput = new
{
conversations = new object[]
{
new
{
id = "1",
language = "en",
modality = "transcript",
domain = "generic",
conversationItems = new object[]
{
new
{
participantId = "1",
id = "1",
text = "Good morning John Doe.",
itn = "good morning john doe",
maskedItn = "good morning john doe",
lexical = "good morning john doe",
wordLevelTimings = new object[]
{
new
{
word = "good",
offset = 390000L,
duration = 2700000L,
},
new
{
word = "morning",
offset = 4500000L,
duration = 920000L,
},
new
{
word = "john",
offset = 590000L,
duration = 2700000L,
},
new
{
word = "doe",
offset = 6300000L,
duration = 920000L,
}
},
}
},
}
},
},
tasks = new object[]
{
new
{
taskName = "Conversation PII",
kind = "ConversationalPIITask",
parameters = new
{
modelVersion = "latest",
excludePiiCategories = new object[]
{
"Person"
},
redactionSource = "lexical",
redactAudioTiming = true,
},
}
},
});
Operation operation = client.AnalyzeConversationSubmitOperation(WaitUntil.Completed, content);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperation.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
displayName = "Redacting PII data from transcribed audio",
analysisInput = new
{
conversations = new object[]
{
new
{
id = "1",
language = "en",
modality = "transcript",
domain = "generic",
conversationItems = new object[]
{
new
{
participantId = "1",
id = "1",
text = "Good morning John Doe.",
itn = "good morning john doe",
maskedItn = "good morning john doe",
lexical = "good morning john doe",
wordLevelTimings = new object[]
{
new
{
word = "good",
offset = 390000L,
duration = 2700000L,
},
new
{
word = "morning",
offset = 4500000L,
duration = 920000L,
},
new
{
word = "john",
offset = 590000L,
duration = 2700000L,
},
new
{
word = "doe",
offset = 6300000L,
duration = 920000L,
}
},
}
},
}
},
},
tasks = new object[]
{
new
{
taskName = "Conversation PII",
kind = "ConversationalPIITask",
parameters = new
{
modelVersion = "latest",
piiCategories = new object[]
{
"All"
},
redactionPolicy = new
{
policyKind = "noMask",
},
redactionSource = "lexical",
redactAudioTiming = true,
},
}
},
});
Operation operation = client.AnalyzeConversationSubmitOperation(WaitUntil.Completed, content);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperation.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
displayName = "Redacting PII data from transcribed audio",
analysisInput = new
{
conversations = new object[]
{
new
{
id = "1",
language = "en",
modality = "transcript",
domain = "generic",
conversationItems = new object[]
{
new
{
participantId = "1",
id = "1",
text = "Good morning John Doe.",
itn = "good morning john doe",
maskedItn = "good morning john doe",
lexical = "good morning john doe",
wordLevelTimings = new object[]
{
new
{
word = "good",
offset = 390000L,
duration = 2700000L,
},
new
{
word = "morning",
offset = 4500000L,
duration = 920000L,
},
new
{
word = "john",
offset = 590000L,
duration = 2700000L,
},
new
{
word = "doe",
offset = 6300000L,
duration = 920000L,
}
},
}
},
}
},
},
tasks = new object[]
{
new
{
taskName = "Conversation PII",
kind = "ConversationalPIITask",
parameters = new
{
modelVersion = "latest",
piiCategories = new object[]
{
"All"
},
redactionCharacter = "-",
redactionSource = "lexical",
redactAudioTiming = true,
},
}
},
});
Operation operation = client.AnalyzeConversationSubmitOperation(WaitUntil.Completed, content);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperation.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
displayName = "Redacting PII data from transcribed audio",
analysisInput = new
{
conversations = new object[]
{
new
{
id = "1",
language = "en",
modality = "transcript",
domain = "generic",
conversationItems = new object[]
{
new
{
participantId = "1",
id = "1",
text = "Good morning John Doe.",
itn = "good morning john doe",
maskedItn = "good morning john doe",
lexical = "good morning john doe",
wordLevelTimings = new object[]
{
new
{
word = "good",
offset = 390000L,
duration = 2700000L,
},
new
{
word = "morning",
offset = 4500000L,
duration = 920000L,
},
new
{
word = "john",
offset = 590000L,
duration = 2700000L,
},
new
{
word = "doe",
offset = 6300000L,
duration = 920000L,
}
},
}
},
}
},
},
tasks = new object[]
{
new
{
taskName = "Conversation PII",
kind = "ConversationalPIITask",
parameters = new
{
modelVersion = "latest",
piiCategories = new object[]
{
"All"
},
redactionSource = "lexical",
redactAudioTiming = true,
},
}
},
});
Operation operation = client.AnalyzeConversationSubmitOperation(WaitUntil.Completed, content);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperation.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
displayName = "Conversation Summarization Example",
analysisInput = new
{
conversations = new object[]
{
new
{
id = "1",
language = "en",
modality = "transcript",
conversationItems = new object[]
{
new
{
participantId = "speaker 1",
id = "1",
text = "Let's get started.",
lexical = "",
itn = "",
maskedItn = "",
conversationItemLevelTiming = new
{
offset = 0L,
duration = 20000000L,
},
},
new
{
participantId = "speaker 2",
id = "2",
text = "OK. How many remaining bugs do we have now?",
lexical = "",
itn = "",
maskedItn = "",
conversationItemLevelTiming = new
{
offset = 20000000L,
duration = 50000000L,
},
},
new
{
participantId = "speaker 3",
id = "3",
text = "Only 3.",
lexical = "",
itn = "",
maskedItn = "",
conversationItemLevelTiming = new
{
offset = 50000000L,
duration = 60000000L,
},
}
},
}
},
},
tasks = new object[]
{
new
{
taskName = "Conversation Summarization Task 1",
kind = "ConversationalSummarizationTask",
parameters = new
{
summaryAspects = new object[]
{
"chapterTitle",
"narrative"
},
},
}
},
});
Operation operation = client.AnalyzeConversationSubmitOperation(WaitUntil.Completed, content);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperation.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
displayName = "Analyze conversations from Contoso meeting",
analysisInput = new
{
conversations = new object[]
{
new
{
id = "20220101meeting",
language = "en",
modality = "text",
domain = "generic",
conversationItems = new object[]
{
new
{
participantId = "user",
role = "customer",
id = "1",
text = "Hi!",
},
new
{
participantId = "agent",
role = "agent",
id = "2",
text = "Hello, how can I help you?",
},
new
{
participantId = "user",
role = "customer",
id = "3",
text = "I am having trouble issuing a return of a game on my xbox: call of duty",
}
},
}
},
},
tasks = new object[]
{
new
{
taskName = "analyze 1",
kind = "ConversationalSummarizationTask",
parameters = new
{
modelVersion = "latest",
summaryAspects = new object[]
{
"issue",
"resolution"
},
},
}
},
});
Operation operation = client.AnalyzeConversationSubmitOperation(WaitUntil.Completed, content);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperation.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
displayName = "Custom Conversation Summarization Example",
analysisInput = new
{
conversations = new object[]
{
new
{
id = "1",
language = "en",
modality = "transcript",
conversationItems = new object[]
{
new
{
participantId = "speaker 1",
id = "1",
text = "Let's get started.",
lexical = "",
itn = "",
maskedItn = "",
conversationItemLevelTiming = new
{
offset = 0L,
duration = 20000000L,
},
},
new
{
participantId = "speaker 2",
id = "2",
text = "OK. How many remaining bugs do we have now?",
lexical = "",
itn = "",
maskedItn = "",
conversationItemLevelTiming = new
{
offset = 20000000L,
duration = 50000000L,
},
},
new
{
participantId = "speaker 3",
id = "3",
text = "Only 3.",
lexical = "",
itn = "",
maskedItn = "",
conversationItemLevelTiming = new
{
offset = 50000000L,
duration = 60000000L,
},
}
},
}
},
},
tasks = new object[]
{
new
{
taskName = "Custom Conversation Summarization Task 1",
kind = "CustomConversationalSummarizationTask",
parameters = new
{
summaryAspects = new object[]
{
"narrative"
},
projectName = "my_project",
deploymentName = "my_deployment",
},
}
},
});
Operation operation = client.AnalyzeConversationSubmitOperation(WaitUntil.Completed, content);
]]></code></example>
</Docs>
</Member>
<Member MemberName="AnalyzeConversationSubmitOperationAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation> AnalyzeConversationSubmitOperationAsync (Azure.WaitUntil waitUntil, Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationInput analyzeConversationOperationInput, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Operation> AnalyzeConversationSubmitOperationAsync(valuetype Azure.WaitUntil waitUntil, class Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationInput analyzeConversationOperationInput, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.ConversationAnalysisClient.AnalyzeConversationSubmitOperationAsync(Azure.WaitUntil,Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationInput,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeConversationSubmitOperationAsync (waitUntil As WaitUntil, analyzeConversationOperationInput As AnalyzeConversationOperationInput, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Operation)" />
<MemberSignature Language="F#" Value="abstract member AnalyzeConversationSubmitOperationAsync : Azure.WaitUntil * Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationInput * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation>
override this.AnalyzeConversationSubmitOperationAsync : Azure.WaitUntil * Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationInput * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation>" Usage="conversationAnalysisClient.AnalyzeConversationSubmitOperationAsync (waitUntil, analyzeConversationOperationInput, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.Conversations</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Operation></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="analyzeConversationOperationInput" Type="Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationInput" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="azure-dotnet-preview" />
</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. For more information on long-running operations, please see <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/LongRunningOperations.md"> Azure.Core Long-Running Operation samples</see>. </param>
<param name="analyzeConversationOperationInput"> The input for the analyze conversations operation. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Analyzes the input conversation utterance. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="analyzeConversationOperationInput" /> is null. </exception>
<example>
This sample shows how to call AnalyzeConversationSubmitOperationAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
AnalyzeConversationOperationInput analyzeConversationOperationInput = new AnalyzeConversationOperationInput(new MultiLanguageConversationInput(new ConversationInput[]
{
new TranscriptConversation("1", "en", new TranscriptConversationItem[]
{
new TranscriptConversationItem(
"1",
"1",
"good morning john doe",
"good morning john doe",
"Good morning John Doe.",
"good morning john doe")
{
WordLevelTimings = {new WordLevelTiming
{
Offset = 390000L,
Duration = 2700000L,
Word = "good",
}, new WordLevelTiming
{
Offset = 4500000L,
Duration = 920000L,
Word = "morning",
}, new WordLevelTiming
{
Offset = 590000L,
Duration = 2700000L,
Word = "john",
}, new WordLevelTiming
{
Offset = 6300000L,
Duration = 920000L,
Word = "doe",
}},
}
})
{
Domain = ConversationDomain.Generic,
}
}), new AnalyzeConversationOperationAction[]
{
new PiiOperationAction
{
ActionContent = new ConversationPiiActionContent
{
ModelVersion = "latest",
PiiCategories = {ConversationPiiCategories.All},
RedactAudioTiming = true,
RedactionSource = TranscriptContentType.Lexical,
RedactionPolicy = new CharacterMaskPolicyType
{
RedactionCharacter = RedactionCharacter.Minus,
},
},
Name = "Conversation PII",
}
})
{
DisplayName = "Redacting PII data from transcribed audio",
};
Operation operation = await client.AnalyzeConversationSubmitOperationAsync(WaitUntil.Completed, analyzeConversationOperationInput);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperationAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
AnalyzeConversationOperationInput analyzeConversationOperationInput = new AnalyzeConversationOperationInput(new MultiLanguageConversationInput(new ConversationInput[]
{
new TranscriptConversation("1", "en", new TranscriptConversationItem[]
{
new TranscriptConversationItem(
"1",
"1",
"good morning john doe",
"good morning john doe",
"Good morning John Doe.",
"good morning john doe")
{
WordLevelTimings = {new WordLevelTiming
{
Offset = 390000L,
Duration = 2700000L,
Word = "good",
}, new WordLevelTiming
{
Offset = 4500000L,
Duration = 920000L,
Word = "morning",
}, new WordLevelTiming
{
Offset = 590000L,
Duration = 2700000L,
Word = "john",
}, new WordLevelTiming
{
Offset = 6300000L,
Duration = 920000L,
Word = "doe",
}},
}
})
{
Domain = ConversationDomain.Generic,
}
}), new AnalyzeConversationOperationAction[]
{
new PiiOperationAction
{
ActionContent = new ConversationPiiActionContent
{
ModelVersion = "latest",
PiiCategories = {ConversationPiiCategories.All},
RedactAudioTiming = true,
RedactionSource = TranscriptContentType.Lexical,
RedactionPolicy = new EntityMaskTypePolicyType(),
},
Name = "Conversation PII",
}
})
{
DisplayName = "Redacting PII data from transcribed audio",
};
Operation operation = await client.AnalyzeConversationSubmitOperationAsync(WaitUntil.Completed, analyzeConversationOperationInput);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperationAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
AnalyzeConversationOperationInput analyzeConversationOperationInput = new AnalyzeConversationOperationInput(new MultiLanguageConversationInput(new ConversationInput[]
{
new TranscriptConversation("1", "en", new TranscriptConversationItem[]
{
new TranscriptConversationItem(
"1",
"1",
"good morning john doe",
"good morning john doe",
"Good morning John Doe.",
"good morning john doe")
{
WordLevelTimings = {new WordLevelTiming
{
Offset = 390000L,
Duration = 2700000L,
Word = "good",
}, new WordLevelTiming
{
Offset = 4500000L,
Duration = 920000L,
Word = "morning",
}, new WordLevelTiming
{
Offset = 590000L,
Duration = 2700000L,
Word = "john",
}, new WordLevelTiming
{
Offset = 6300000L,
Duration = 920000L,
Word = "doe",
}},
}
})
{
Domain = ConversationDomain.Generic,
}
}), new AnalyzeConversationOperationAction[]
{
new PiiOperationAction
{
ActionContent = new ConversationPiiActionContent
{
ModelVersion = "latest",
RedactAudioTiming = true,
RedactionSource = TranscriptContentType.Lexical,
ExcludePiiCategories = {ConversationPiiCategoryExclusions.Person},
},
Name = "Conversation PII",
}
})
{
DisplayName = "Redacting PII data from transcribed audio",
};
Operation operation = await client.AnalyzeConversationSubmitOperationAsync(WaitUntil.Completed, analyzeConversationOperationInput);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperationAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
AnalyzeConversationOperationInput analyzeConversationOperationInput = new AnalyzeConversationOperationInput(new MultiLanguageConversationInput(new ConversationInput[]
{
new TranscriptConversation("1", "en", new TranscriptConversationItem[]
{
new TranscriptConversationItem(
"1",
"1",
"good morning john doe",
"good morning john doe",
"Good morning John Doe.",
"good morning john doe")
{
WordLevelTimings = {new WordLevelTiming
{
Offset = 390000L,
Duration = 2700000L,
Word = "good",
}, new WordLevelTiming
{
Offset = 4500000L,
Duration = 920000L,
Word = "morning",
}, new WordLevelTiming
{
Offset = 590000L,
Duration = 2700000L,
Word = "john",
}, new WordLevelTiming
{
Offset = 6300000L,
Duration = 920000L,
Word = "doe",
}},
}
})
{
Domain = ConversationDomain.Generic,
}
}), new AnalyzeConversationOperationAction[]
{
new PiiOperationAction
{
ActionContent = new ConversationPiiActionContent
{
ModelVersion = "latest",
PiiCategories = {ConversationPiiCategories.All},
RedactAudioTiming = true,
RedactionSource = TranscriptContentType.Lexical,
RedactionPolicy = new NoMaskPolicyType(),
},
Name = "Conversation PII",
}
})
{
DisplayName = "Redacting PII data from transcribed audio",
};
Operation operation = await client.AnalyzeConversationSubmitOperationAsync(WaitUntil.Completed, analyzeConversationOperationInput);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperationAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
AnalyzeConversationOperationInput analyzeConversationOperationInput = new AnalyzeConversationOperationInput(new MultiLanguageConversationInput(new ConversationInput[]
{
new TranscriptConversation("1", "en", new TranscriptConversationItem[]
{
new TranscriptConversationItem(
"1",
"1",
"good morning john doe",
"good morning john doe",
"Good morning John Doe.",
"good morning john doe")
{
WordLevelTimings = {new WordLevelTiming
{
Offset = 390000L,
Duration = 2700000L,
Word = "good",
}, new WordLevelTiming
{
Offset = 4500000L,
Duration = 920000L,
Word = "morning",
}, new WordLevelTiming
{
Offset = 590000L,
Duration = 2700000L,
Word = "john",
}, new WordLevelTiming
{
Offset = 6300000L,
Duration = 920000L,
Word = "doe",
}},
}
})
{
Domain = ConversationDomain.Generic,
}
}), new AnalyzeConversationOperationAction[]
{
new PiiOperationAction
{
ActionContent = new ConversationPiiActionContent
{
ModelVersion = "latest",
PiiCategories = {ConversationPiiCategories.All},
RedactAudioTiming = true,
RedactionSource = TranscriptContentType.Lexical,
RedactionCharacter = RedactionCharacter.Minus,
},
Name = "Conversation PII",
}
})
{
DisplayName = "Redacting PII data from transcribed audio",
};
Operation operation = await client.AnalyzeConversationSubmitOperationAsync(WaitUntil.Completed, analyzeConversationOperationInput);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperationAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
AnalyzeConversationOperationInput analyzeConversationOperationInput = new AnalyzeConversationOperationInput(new MultiLanguageConversationInput(new ConversationInput[]
{
new TranscriptConversation("1", "en", new TranscriptConversationItem[]
{
new TranscriptConversationItem(
"1",
"1",
"good morning john doe",
"good morning john doe",
"Good morning John Doe.",
"good morning john doe")
{
WordLevelTimings = {new WordLevelTiming
{
Offset = 390000L,
Duration = 2700000L,
Word = "good",
}, new WordLevelTiming
{
Offset = 4500000L,
Duration = 920000L,
Word = "morning",
}, new WordLevelTiming
{
Offset = 590000L,
Duration = 2700000L,
Word = "john",
}, new WordLevelTiming
{
Offset = 6300000L,
Duration = 920000L,
Word = "doe",
}},
}
})
{
Domain = ConversationDomain.Generic,
}
}), new AnalyzeConversationOperationAction[]
{
new PiiOperationAction
{
ActionContent = new ConversationPiiActionContent
{
ModelVersion = "latest",
PiiCategories = {ConversationPiiCategories.All},
RedactAudioTiming = true,
RedactionSource = TranscriptContentType.Lexical,
},
Name = "Conversation PII",
}
})
{
DisplayName = "Redacting PII data from transcribed audio",
};
Operation operation = await client.AnalyzeConversationSubmitOperationAsync(WaitUntil.Completed, analyzeConversationOperationInput);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperationAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
AnalyzeConversationOperationInput analyzeConversationOperationInput = new AnalyzeConversationOperationInput(new MultiLanguageConversationInput(new ConversationInput[]
{
new TranscriptConversation("1", "en", new TranscriptConversationItem[]
{
new TranscriptConversationItem(
"1",
"speaker 1",
"",
"",
"Let's get started.",
"")
{
ConversationItemLevelTiming = new ConversationItemLevelTiming
{
Offset = 0L,
Duration = 20000000L,
},
},
new TranscriptConversationItem(
"2",
"speaker 2",
"",
"",
"OK. How many remaining bugs do we have now?",
"")
{
ConversationItemLevelTiming = new ConversationItemLevelTiming
{
Offset = 20000000L,
Duration = 50000000L,
},
},
new TranscriptConversationItem(
"3",
"speaker 3",
"",
"",
"Only 3.",
"")
{
ConversationItemLevelTiming = new ConversationItemLevelTiming
{
Offset = 50000000L,
Duration = 60000000L,
},
}
})
}), new AnalyzeConversationOperationAction[]
{
new SummarizationOperationAction
{
ActionContent = new ConversationSummarizationActionContent(new SummaryAspect[]{SummaryAspect.ChapterTitle, SummaryAspect.Narrative}),
Name = "Conversation Summarization Task 1",
}
})
{
DisplayName = "Conversation Summarization Example",
};
Operation operation = await client.AnalyzeConversationSubmitOperationAsync(WaitUntil.Completed, analyzeConversationOperationInput);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperationAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
AnalyzeConversationOperationInput analyzeConversationOperationInput = new AnalyzeConversationOperationInput(new MultiLanguageConversationInput(new ConversationInput[]
{
new TextConversation("20220101meeting", "en", new TextConversationItem[]
{
new TextConversationItem("1", "user", "Hi!")
{
Role = ParticipantRole.Customer,
},
new TextConversationItem("2", "agent", "Hello, how can I help you?")
{
Role = ParticipantRole.Agent,
},
new TextConversationItem("3", "user", "I am having trouble issuing a return of a game on my xbox: call of duty")
{
Role = ParticipantRole.Customer,
}
})
{
Domain = ConversationDomain.Generic,
}
}), new AnalyzeConversationOperationAction[]
{
new SummarizationOperationAction
{
ActionContent = new ConversationSummarizationActionContent(new SummaryAspect[]{SummaryAspect.Issue, SummaryAspect.Resolution})
{
ModelVersion = "latest",
},
Name = "analyze 1",
}
})
{
DisplayName = "Analyze conversations from Contoso meeting",
};
Operation operation = await client.AnalyzeConversationSubmitOperationAsync(WaitUntil.Completed, analyzeConversationOperationInput);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperationAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
AnalyzeConversationOperationInput analyzeConversationOperationInput = new AnalyzeConversationOperationInput(new MultiLanguageConversationInput(new ConversationInput[]
{
new TranscriptConversation("1", "en", new TranscriptConversationItem[]
{
new TranscriptConversationItem(
"1",
"speaker 1",
"",
"",
"Let's get started.",
"")
{
ConversationItemLevelTiming = new ConversationItemLevelTiming
{
Offset = 0L,
Duration = 20000000L,
},
},
new TranscriptConversationItem(
"2",
"speaker 2",
"",
"",
"OK. How many remaining bugs do we have now?",
"")
{
ConversationItemLevelTiming = new ConversationItemLevelTiming
{
Offset = 20000000L,
Duration = 50000000L,
},
},
new TranscriptConversationItem(
"3",
"speaker 3",
"",
"",
"Only 3.",
"")
{
ConversationItemLevelTiming = new ConversationItemLevelTiming
{
Offset = 50000000L,
Duration = 60000000L,
},
}
})
}), new AnalyzeConversationOperationAction[]
{
new CustomSummarizationOperationAction
{
ActionContent = new CustomConversationSummarizationActionContent("my_project", "my_deployment", new SummaryAspect[]{SummaryAspect.Narrative}),
Name = "Custom Conversation Summarization Task 1",
}
})
{
DisplayName = "Custom Conversation Summarization Example",
};
Operation operation = await client.AnalyzeConversationSubmitOperationAsync(WaitUntil.Completed, analyzeConversationOperationInput);
]]></code></example>
</Docs>
</Member>
<Member MemberName="AnalyzeConversationSubmitOperationAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation> AnalyzeConversationSubmitOperationAsync (Azure.WaitUntil waitUntil, Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Operation> AnalyzeConversationSubmitOperationAsync(valuetype Azure.WaitUntil waitUntil, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.ConversationAnalysisClient.AnalyzeConversationSubmitOperationAsync(Azure.WaitUntil,Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeConversationSubmitOperationAsync (waitUntil As WaitUntil, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Operation)" />
<MemberSignature Language="F#" Value="abstract member AnalyzeConversationSubmitOperationAsync : Azure.WaitUntil * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation>
override this.AnalyzeConversationSubmitOperationAsync : Azure.WaitUntil * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation>" Usage="conversationAnalysisClient.AnalyzeConversationSubmitOperationAsync (waitUntil, content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.Conversations</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Operation></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="content" Type="Azure.Core.RequestContent" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="context" Type="Azure.RequestContext" Index="2" FrameworkAlternate="azure-dotnet-preview" />
</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. For more information on long-running operations, please see <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/LongRunningOperations.md"> Azure.Core Long-Running Operation samples</see>. </param>
<param name="content"> The content to send as the body of the request. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Analyzes the input conversation utterance.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.AI.Language.Conversations.ConversationAnalysisClient.AnalyzeConversationSubmitOperationAsync(Azure.WaitUntil,Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationInput,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Operation" /> representing an asynchronous operation on the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="content" /> is null. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call AnalyzeConversationSubmitOperationAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
displayName = "Redacting PII data from transcribed audio",
analysisInput = new
{
conversations = new object[]
{
new
{
id = "1",
language = "en",
modality = "transcript",
domain = "generic",
conversationItems = new object[]
{
new
{
participantId = "1",
id = "1",
text = "Good morning John Doe.",
itn = "good morning john doe",
maskedItn = "good morning john doe",
lexical = "good morning john doe",
wordLevelTimings = new object[]
{
new
{
word = "good",
offset = 390000L,
duration = 2700000L,
},
new
{
word = "morning",
offset = 4500000L,
duration = 920000L,
},
new
{
word = "john",
offset = 590000L,
duration = 2700000L,
},
new
{
word = "doe",
offset = 6300000L,
duration = 920000L,
}
},
}
},
}
},
},
tasks = new object[]
{
new
{
taskName = "Conversation PII",
kind = "ConversationalPIITask",
parameters = new
{
modelVersion = "latest",
piiCategories = new object[]
{
"All"
},
redactionPolicy = new
{
policyKind = "characterMask",
redactionCharacter = "-",
},
redactionSource = "lexical",
redactAudioTiming = true,
},
}
},
});
Operation operation = await client.AnalyzeConversationSubmitOperationAsync(WaitUntil.Completed, content);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperationAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
displayName = "Redacting PII data from transcribed audio",
analysisInput = new
{
conversations = new object[]
{
new
{
id = "1",
language = "en",
modality = "transcript",
domain = "generic",
conversationItems = new object[]
{
new
{
participantId = "1",
id = "1",
text = "Good morning John Doe.",
itn = "good morning john doe",
maskedItn = "good morning john doe",
lexical = "good morning john doe",
wordLevelTimings = new object[]
{
new
{
word = "good",
offset = 390000L,
duration = 2700000L,
},
new
{
word = "morning",
offset = 4500000L,
duration = 920000L,
},
new
{
word = "john",
offset = 590000L,
duration = 2700000L,
},
new
{
word = "doe",
offset = 6300000L,
duration = 920000L,
}
},
}
},
}
},
},
tasks = new object[]
{
new
{
taskName = "Conversation PII",
kind = "ConversationalPIITask",
parameters = new
{
modelVersion = "latest",
piiCategories = new object[]
{
"All"
},
redactionPolicy = new
{
policyKind = "entityMask",
},
redactionSource = "lexical",
redactAudioTiming = true,
},
}
},
});
Operation operation = await client.AnalyzeConversationSubmitOperationAsync(WaitUntil.Completed, content);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperationAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
displayName = "Redacting PII data from transcribed audio",
analysisInput = new
{
conversations = new object[]
{
new
{
id = "1",
language = "en",
modality = "transcript",
domain = "generic",
conversationItems = new object[]
{
new
{
participantId = "1",
id = "1",
text = "Good morning John Doe.",
itn = "good morning john doe",
maskedItn = "good morning john doe",
lexical = "good morning john doe",
wordLevelTimings = new object[]
{
new
{
word = "good",
offset = 390000L,
duration = 2700000L,
},
new
{
word = "morning",
offset = 4500000L,
duration = 920000L,
},
new
{
word = "john",
offset = 590000L,
duration = 2700000L,
},
new
{
word = "doe",
offset = 6300000L,
duration = 920000L,
}
},
}
},
}
},
},
tasks = new object[]
{
new
{
taskName = "Conversation PII",
kind = "ConversationalPIITask",
parameters = new
{
modelVersion = "latest",
excludePiiCategories = new object[]
{
"Person"
},
redactionSource = "lexical",
redactAudioTiming = true,
},
}
},
});
Operation operation = await client.AnalyzeConversationSubmitOperationAsync(WaitUntil.Completed, content);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperationAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
displayName = "Redacting PII data from transcribed audio",
analysisInput = new
{
conversations = new object[]
{
new
{
id = "1",
language = "en",
modality = "transcript",
domain = "generic",
conversationItems = new object[]
{
new
{
participantId = "1",
id = "1",
text = "Good morning John Doe.",
itn = "good morning john doe",
maskedItn = "good morning john doe",
lexical = "good morning john doe",
wordLevelTimings = new object[]
{
new
{
word = "good",
offset = 390000L,
duration = 2700000L,
},
new
{
word = "morning",
offset = 4500000L,
duration = 920000L,
},
new
{
word = "john",
offset = 590000L,
duration = 2700000L,
},
new
{
word = "doe",
offset = 6300000L,
duration = 920000L,
}
},
}
},
}
},
},
tasks = new object[]
{
new
{
taskName = "Conversation PII",
kind = "ConversationalPIITask",
parameters = new
{
modelVersion = "latest",
piiCategories = new object[]
{
"All"
},
redactionPolicy = new
{
policyKind = "noMask",
},
redactionSource = "lexical",
redactAudioTiming = true,
},
}
},
});
Operation operation = await client.AnalyzeConversationSubmitOperationAsync(WaitUntil.Completed, content);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperationAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
displayName = "Redacting PII data from transcribed audio",
analysisInput = new
{
conversations = new object[]
{
new
{
id = "1",
language = "en",
modality = "transcript",
domain = "generic",
conversationItems = new object[]
{
new
{
participantId = "1",
id = "1",
text = "Good morning John Doe.",
itn = "good morning john doe",
maskedItn = "good morning john doe",
lexical = "good morning john doe",
wordLevelTimings = new object[]
{
new
{
word = "good",
offset = 390000L,
duration = 2700000L,
},
new
{
word = "morning",
offset = 4500000L,
duration = 920000L,
},
new
{
word = "john",
offset = 590000L,
duration = 2700000L,
},
new
{
word = "doe",
offset = 6300000L,
duration = 920000L,
}
},
}
},
}
},
},
tasks = new object[]
{
new
{
taskName = "Conversation PII",
kind = "ConversationalPIITask",
parameters = new
{
modelVersion = "latest",
piiCategories = new object[]
{
"All"
},
redactionCharacter = "-",
redactionSource = "lexical",
redactAudioTiming = true,
},
}
},
});
Operation operation = await client.AnalyzeConversationSubmitOperationAsync(WaitUntil.Completed, content);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperationAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
displayName = "Redacting PII data from transcribed audio",
analysisInput = new
{
conversations = new object[]
{
new
{
id = "1",
language = "en",
modality = "transcript",
domain = "generic",
conversationItems = new object[]
{
new
{
participantId = "1",
id = "1",
text = "Good morning John Doe.",
itn = "good morning john doe",
maskedItn = "good morning john doe",
lexical = "good morning john doe",
wordLevelTimings = new object[]
{
new
{
word = "good",
offset = 390000L,
duration = 2700000L,
},
new
{
word = "morning",
offset = 4500000L,
duration = 920000L,
},
new
{
word = "john",
offset = 590000L,
duration = 2700000L,
},
new
{
word = "doe",
offset = 6300000L,
duration = 920000L,
}
},
}
},
}
},
},
tasks = new object[]
{
new
{
taskName = "Conversation PII",
kind = "ConversationalPIITask",
parameters = new
{
modelVersion = "latest",
piiCategories = new object[]
{
"All"
},
redactionSource = "lexical",
redactAudioTiming = true,
},
}
},
});
Operation operation = await client.AnalyzeConversationSubmitOperationAsync(WaitUntil.Completed, content);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperationAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
displayName = "Conversation Summarization Example",
analysisInput = new
{
conversations = new object[]
{
new
{
id = "1",
language = "en",
modality = "transcript",
conversationItems = new object[]
{
new
{
participantId = "speaker 1",
id = "1",
text = "Let's get started.",
lexical = "",
itn = "",
maskedItn = "",
conversationItemLevelTiming = new
{
offset = 0L,
duration = 20000000L,
},
},
new
{
participantId = "speaker 2",
id = "2",
text = "OK. How many remaining bugs do we have now?",
lexical = "",
itn = "",
maskedItn = "",
conversationItemLevelTiming = new
{
offset = 20000000L,
duration = 50000000L,
},
},
new
{
participantId = "speaker 3",
id = "3",
text = "Only 3.",
lexical = "",
itn = "",
maskedItn = "",
conversationItemLevelTiming = new
{
offset = 50000000L,
duration = 60000000L,
},
}
},
}
},
},
tasks = new object[]
{
new
{
taskName = "Conversation Summarization Task 1",
kind = "ConversationalSummarizationTask",
parameters = new
{
summaryAspects = new object[]
{
"chapterTitle",
"narrative"
},
},
}
},
});
Operation operation = await client.AnalyzeConversationSubmitOperationAsync(WaitUntil.Completed, content);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperationAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
displayName = "Analyze conversations from Contoso meeting",
analysisInput = new
{
conversations = new object[]
{
new
{
id = "20220101meeting",
language = "en",
modality = "text",
domain = "generic",
conversationItems = new object[]
{
new
{
participantId = "user",
role = "customer",
id = "1",
text = "Hi!",
},
new
{
participantId = "agent",
role = "agent",
id = "2",
text = "Hello, how can I help you?",
},
new
{
participantId = "user",
role = "customer",
id = "3",
text = "I am having trouble issuing a return of a game on my xbox: call of duty",
}
},
}
},
},
tasks = new object[]
{
new
{
taskName = "analyze 1",
kind = "ConversationalSummarizationTask",
parameters = new
{
modelVersion = "latest",
summaryAspects = new object[]
{
"issue",
"resolution"
},
},
}
},
});
Operation operation = await client.AnalyzeConversationSubmitOperationAsync(WaitUntil.Completed, content);
]]></code>
This sample shows how to call AnalyzeConversationSubmitOperationAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
displayName = "Custom Conversation Summarization Example",
analysisInput = new
{
conversations = new object[]
{
new
{
id = "1",
language = "en",
modality = "transcript",
conversationItems = new object[]
{
new
{
participantId = "speaker 1",
id = "1",
text = "Let's get started.",
lexical = "",
itn = "",
maskedItn = "",
conversationItemLevelTiming = new
{
offset = 0L,
duration = 20000000L,
},
},
new
{
participantId = "speaker 2",
id = "2",
text = "OK. How many remaining bugs do we have now?",
lexical = "",
itn = "",
maskedItn = "",
conversationItemLevelTiming = new
{
offset = 20000000L,
duration = 50000000L,
},
},
new
{
participantId = "speaker 3",
id = "3",
text = "Only 3.",
lexical = "",
itn = "",
maskedItn = "",
conversationItemLevelTiming = new
{
offset = 50000000L,
duration = 60000000L,
},
}
},
}
},
},
tasks = new object[]
{
new
{
taskName = "Custom Conversation Summarization Task 1",
kind = "CustomConversationalSummarizationTask",
parameters = new
{
summaryAspects = new object[]
{
"narrative"
},
projectName = "my_project",
deploymentName = "my_deployment",
},
}
},
});
Operation operation = await client.AnalyzeConversationSubmitOperationAsync(WaitUntil.Completed, content);
]]></code></example>
</Docs>
</Member>
<Member MemberName="CancelAnalyzeConversations">
<MemberSignature Language="C#" Value="public virtual Azure.Operation CancelAnalyzeConversations (Azure.WaitUntil waitUntil, Guid jobId, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation CancelAnalyzeConversations(valuetype Azure.WaitUntil waitUntil, valuetype System.Guid jobId, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.ConversationAnalysisClient.CancelAnalyzeConversations(Azure.WaitUntil,System.Guid,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CancelAnalyzeConversations (waitUntil As WaitUntil, jobId As Guid, Optional context As RequestContext = Nothing) As Operation" />
<MemberSignature Language="F#" Value="abstract member CancelAnalyzeConversations : Azure.WaitUntil * Guid * Azure.RequestContext -> Azure.Operation
override this.CancelAnalyzeConversations : Azure.WaitUntil * Guid * Azure.RequestContext -> Azure.Operation" Usage="conversationAnalysisClient.CancelAnalyzeConversations (waitUntil, jobId, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.Conversations</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Operation</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" />
<Parameter Name="jobId" Type="System.Guid" />
<Parameter Name="context" Type="Azure.RequestContext" />
</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. For more information on long-running operations, please see <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/LongRunningOperations.md"> Azure.Core Long-Running Operation samples</see>. </param>
<param name="jobId"> The job ID to cancel. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Cancel a long-running Text Analysis conversations job.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Operation" /> representing an asynchronous operation on the service. </returns>
<remarks>
Additional information can be found in the service REST API documentation:
https://learn.microsoft.com/rest/api/language/2023-04-01/analyze-conversation/cancel-job
</remarks>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call CancelAnalyzeConversations.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Operation operation = client.CancelAnalyzeConversations(WaitUntil.Completed, Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"));
]]></code></example>
</Docs>
</Member>
<Member MemberName="CancelAnalyzeConversationsAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation> CancelAnalyzeConversationsAsync (Azure.WaitUntil waitUntil, Guid jobId, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Operation> CancelAnalyzeConversationsAsync(valuetype Azure.WaitUntil waitUntil, valuetype System.Guid jobId, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.ConversationAnalysisClient.CancelAnalyzeConversationsAsync(Azure.WaitUntil,System.Guid,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CancelAnalyzeConversationsAsync (waitUntil As WaitUntil, jobId As Guid, Optional context As RequestContext = Nothing) As Task(Of Operation)" />
<MemberSignature Language="F#" Value="abstract member CancelAnalyzeConversationsAsync : Azure.WaitUntil * Guid * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation>
override this.CancelAnalyzeConversationsAsync : Azure.WaitUntil * Guid * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation>" Usage="conversationAnalysisClient.CancelAnalyzeConversationsAsync (waitUntil, jobId, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.Conversations</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Operation></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" />
<Parameter Name="jobId" Type="System.Guid" />
<Parameter Name="context" Type="Azure.RequestContext" />
</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. For more information on long-running operations, please see <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/LongRunningOperations.md"> Azure.Core Long-Running Operation samples</see>. </param>
<param name="jobId"> The job ID to cancel. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Cancel a long-running Text Analysis conversations job.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Operation" /> representing an asynchronous operation on the service. </returns>
<remarks>
Additional information can be found in the service REST API documentation:
https://learn.microsoft.com/rest/api/language/2023-04-01/analyze-conversation/cancel-job
</remarks>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call CancelAnalyzeConversationsAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Operation operation = await client.CancelAnalyzeConversationsAsync(WaitUntil.Completed, Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"));
]]></code></example>
</Docs>
</Member>
<Member MemberName="Endpoint">
<MemberSignature Language="C#" Value="public virtual Uri Endpoint { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Uri Endpoint" />
<MemberSignature Language="DocId" Value="P:Azure.AI.Language.Conversations.ConversationAnalysisClient.Endpoint" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property Endpoint As Uri" />
<MemberSignature Language="F#" Value="member this.Endpoint : Uri" Usage="Azure.AI.Language.Conversations.ConversationAnalysisClient.Endpoint" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.Conversations</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Uri</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the service endpoint for this client.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetAnalyzeConversationJobStatus">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationState> GetAnalyzeConversationJobStatus (Guid jobId, bool? showStatistics = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationState> GetAnalyzeConversationJobStatus(valuetype System.Guid jobId, valuetype System.Nullable`1<bool> showStatistics, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.ConversationAnalysisClient.GetAnalyzeConversationJobStatus(System.Guid,System.Nullable{System.Boolean},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetAnalyzeConversationJobStatus (jobId As Guid, Optional showStatistics As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of AnalyzeConversationOperationState)" />
<MemberSignature Language="F#" Value="abstract member GetAnalyzeConversationJobStatus : Guid * Nullable<bool> * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationState>
override this.GetAnalyzeConversationJobStatus : Guid * Nullable<bool> * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationState>" Usage="conversationAnalysisClient.GetAnalyzeConversationJobStatus (jobId, showStatistics, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.Conversations</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationState></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="jobId" Type="System.Guid" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="showStatistics" Type="System.Nullable<System.Boolean>" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="jobId"> job ID. </param>
<param name="showStatistics"> (Optional) if set to true, response will contain request and document level statistics. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Get analysis status and results. </summary>
<returns>To be added.</returns>
<remarks> Get the status of an analysis job. A job can consist of one or more tasks. After all tasks succeed, the job transitions to the succeeded state and results are available for each task. </remarks>
<example>
This sample shows how to call GetAnalyzeConversationJobStatus.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response<AnalyzeConversationOperationState> response = client.GetAnalyzeConversationJobStatus(Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"));
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatus.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response<AnalyzeConversationOperationState> response = client.GetAnalyzeConversationJobStatus(Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"));
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatus.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response<AnalyzeConversationOperationState> response = client.GetAnalyzeConversationJobStatus(Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"));
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatus.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response<AnalyzeConversationOperationState> response = client.GetAnalyzeConversationJobStatus(Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"));
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatus.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response<AnalyzeConversationOperationState> response = client.GetAnalyzeConversationJobStatus(Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"));
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatus.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response<AnalyzeConversationOperationState> response = client.GetAnalyzeConversationJobStatus(Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"));
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatus.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response<AnalyzeConversationOperationState> response = client.GetAnalyzeConversationJobStatus(Guid.Parse("3e9e8518-492f-47f9-abd1-9a7468231086"));
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatus.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response<AnalyzeConversationOperationState> response = client.GetAnalyzeConversationJobStatus(Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"));
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatus.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response<AnalyzeConversationOperationState> response = client.GetAnalyzeConversationJobStatus(Guid.Parse("3e9e8518-492f-47f9-abd1-9a7468231086"));
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetAnalyzeConversationJobStatus">
<MemberSignature Language="C#" Value="public virtual Azure.Response GetAnalyzeConversationJobStatus (Guid jobId, bool? showStats = default, Azure.RequestContext context = default);" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetAnalyzeConversationJobStatus(valuetype System.Guid jobId, valuetype System.Nullable`1<bool> showStats, class Azure.RequestContext context) cil managed" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.ConversationAnalysisClient.GetAnalyzeConversationJobStatus(System.Guid,System.Nullable{System.Boolean},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetAnalyzeConversationJobStatus (jobId As Guid, Optional showStats As Nullable(Of Boolean) = Nothing, Optional context As RequestContext = Nothing) As Response" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="F#" Value="abstract member GetAnalyzeConversationJobStatus : Guid * Nullable<bool> * Azure.RequestContext -> Azure.Response
override this.GetAnalyzeConversationJobStatus : Guid * Nullable<bool> * Azure.RequestContext -> Azure.Response" Usage="conversationAnalysisClient.GetAnalyzeConversationJobStatus (jobId, showStats, context)" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="C#" Value="public virtual Azure.Response GetAnalyzeConversationJobStatus (Guid jobId, bool? showStatistics, Azure.RequestContext context);" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetAnalyzeConversationJobStatus(valuetype System.Guid jobId, valuetype System.Nullable`1<bool> showStatistics, class Azure.RequestContext context) cil managed" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetAnalyzeConversationJobStatus (jobId As Guid, showStatistics As Nullable(Of Boolean), context As RequestContext) As Response" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="F#" Value="abstract member GetAnalyzeConversationJobStatus : Guid * Nullable<bool> * Azure.RequestContext -> Azure.Response
override this.GetAnalyzeConversationJobStatus : Guid * Nullable<bool> * Azure.RequestContext -> Azure.Response" Usage="conversationAnalysisClient.GetAnalyzeConversationJobStatus (jobId, showStatistics, context)" FrameworkAlternate="azure-dotnet-preview" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.Conversations</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="jobId" Type="System.Guid" Index="0" />
<Parameter Name="showStats" Type="System.Nullable<System.Boolean>" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="showStatistics" Type="System.Nullable<System.Boolean>" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="context" Type="Azure.RequestContext" Index="2" />
</Parameters>
<Docs>
<param name="showStats"> (Optional) if set to true, response will contain request and document level statistics. </param>
<param name="jobId"> job ID. </param>
<param name="showStatistics"> (Optional) if set to true, response will contain request and document level statistics. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Get analysis status and results
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.AI.Language.Conversations.ConversationAnalysisClient.GetAnalyzeConversationJobStatus(System.Guid,System.Nullable{System.Boolean},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>
Additional information can be found in the service REST API documentation:
https://learn.microsoft.com/rest/api/language/2023-04-01/analyze-conversation/job-status
</remarks>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetAnalyzeConversationJobStatus and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response response = client.GetAnalyzeConversationJobStatus(Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"), null, null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("jobId").ToString());
Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("completed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("failed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("inProgress").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("total").ToString());
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatus and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response response = client.GetAnalyzeConversationJobStatus(Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"), null, null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("jobId").ToString());
Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("completed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("failed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("inProgress").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("total").ToString());
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatus and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response response = client.GetAnalyzeConversationJobStatus(Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"), null, null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("jobId").ToString());
Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("completed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("failed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("inProgress").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("total").ToString());
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatus and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response response = client.GetAnalyzeConversationJobStatus(Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"), null, null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("jobId").ToString());
Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("completed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("failed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("inProgress").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("total").ToString());
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatus and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response response = client.GetAnalyzeConversationJobStatus(Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"), null, null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("jobId").ToString());
Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("completed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("failed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("inProgress").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("total").ToString());
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatus and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response response = client.GetAnalyzeConversationJobStatus(Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"), null, null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("jobId").ToString());
Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("completed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("failed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("inProgress").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("total").ToString());
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatus and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response response = client.GetAnalyzeConversationJobStatus(Guid.Parse("3e9e8518-492f-47f9-abd1-9a7468231086"), null, null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("jobId").ToString());
Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("completed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("failed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("inProgress").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("total").ToString());
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatus and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response response = client.GetAnalyzeConversationJobStatus(Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"), null, null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("jobId").ToString());
Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("completed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("failed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("inProgress").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("total").ToString());
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatus and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response response = client.GetAnalyzeConversationJobStatus(Guid.Parse("3e9e8518-492f-47f9-abd1-9a7468231086"), null, null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("jobId").ToString());
Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("completed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("failed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("inProgress").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("total").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetAnalyzeConversationJobStatusAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationState>> GetAnalyzeConversationJobStatusAsync (Guid jobId, bool? showStatistics = 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.Language.Conversations.Models.AnalyzeConversationOperationState>> GetAnalyzeConversationJobStatusAsync(valuetype System.Guid jobId, valuetype System.Nullable`1<bool> showStatistics, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.ConversationAnalysisClient.GetAnalyzeConversationJobStatusAsync(System.Guid,System.Nullable{System.Boolean},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetAnalyzeConversationJobStatusAsync (jobId As Guid, Optional showStatistics As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of AnalyzeConversationOperationState))" />
<MemberSignature Language="F#" Value="abstract member GetAnalyzeConversationJobStatusAsync : Guid * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationState>>
override this.GetAnalyzeConversationJobStatusAsync : Guid * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationState>>" Usage="conversationAnalysisClient.GetAnalyzeConversationJobStatusAsync (jobId, showStatistics, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.Conversations</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.AI.Language.Conversations.Models.AnalyzeConversationOperationState>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="jobId" Type="System.Guid" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="showStatistics" Type="System.Nullable<System.Boolean>" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="jobId"> job ID. </param>
<param name="showStatistics"> (Optional) if set to true, response will contain request and document level statistics. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Get analysis status and results. </summary>
<returns>To be added.</returns>
<remarks> Get the status of an analysis job. A job can consist of one or more tasks. After all tasks succeed, the job transitions to the succeeded state and results are available for each task. </remarks>
<example>
This sample shows how to call GetAnalyzeConversationJobStatusAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response<AnalyzeConversationOperationState> response = await client.GetAnalyzeConversationJobStatusAsync(Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"));
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatusAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response<AnalyzeConversationOperationState> response = await client.GetAnalyzeConversationJobStatusAsync(Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"));
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatusAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response<AnalyzeConversationOperationState> response = await client.GetAnalyzeConversationJobStatusAsync(Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"));
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatusAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response<AnalyzeConversationOperationState> response = await client.GetAnalyzeConversationJobStatusAsync(Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"));
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatusAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response<AnalyzeConversationOperationState> response = await client.GetAnalyzeConversationJobStatusAsync(Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"));
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatusAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response<AnalyzeConversationOperationState> response = await client.GetAnalyzeConversationJobStatusAsync(Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"));
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatusAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response<AnalyzeConversationOperationState> response = await client.GetAnalyzeConversationJobStatusAsync(Guid.Parse("3e9e8518-492f-47f9-abd1-9a7468231086"));
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatusAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response<AnalyzeConversationOperationState> response = await client.GetAnalyzeConversationJobStatusAsync(Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"));
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatusAsync.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response<AnalyzeConversationOperationState> response = await client.GetAnalyzeConversationJobStatusAsync(Guid.Parse("3e9e8518-492f-47f9-abd1-9a7468231086"));
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetAnalyzeConversationJobStatusAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetAnalyzeConversationJobStatusAsync (Guid jobId, bool? showStats = default, Azure.RequestContext context = default);" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetAnalyzeConversationJobStatusAsync(valuetype System.Guid jobId, valuetype System.Nullable`1<bool> showStats, class Azure.RequestContext context) cil managed" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.ConversationAnalysisClient.GetAnalyzeConversationJobStatusAsync(System.Guid,System.Nullable{System.Boolean},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetAnalyzeConversationJobStatusAsync (jobId As Guid, Optional showStats As Nullable(Of Boolean) = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="F#" Value="abstract member GetAnalyzeConversationJobStatusAsync : Guid * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetAnalyzeConversationJobStatusAsync : Guid * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="conversationAnalysisClient.GetAnalyzeConversationJobStatusAsync (jobId, showStats, context)" FrameworkAlternate="azure-dotnet" />
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetAnalyzeConversationJobStatusAsync (Guid jobId, bool? showStatistics, Azure.RequestContext context);" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetAnalyzeConversationJobStatusAsync(valuetype System.Guid jobId, valuetype System.Nullable`1<bool> showStatistics, class Azure.RequestContext context) cil managed" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetAnalyzeConversationJobStatusAsync (jobId As Guid, showStatistics As Nullable(Of Boolean), context As RequestContext) As Task(Of Response)" FrameworkAlternate="azure-dotnet-preview" />
<MemberSignature Language="F#" Value="abstract member GetAnalyzeConversationJobStatusAsync : Guid * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetAnalyzeConversationJobStatusAsync : Guid * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="conversationAnalysisClient.GetAnalyzeConversationJobStatusAsync (jobId, showStatistics, context)" FrameworkAlternate="azure-dotnet-preview" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.Conversations</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="jobId" Type="System.Guid" Index="0" />
<Parameter Name="showStats" Type="System.Nullable<System.Boolean>" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="showStatistics" Type="System.Nullable<System.Boolean>" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="context" Type="Azure.RequestContext" Index="2" />
</Parameters>
<Docs>
<param name="showStats"> (Optional) if set to true, response will contain request and document level statistics. </param>
<param name="jobId"> job ID. </param>
<param name="showStatistics"> (Optional) if set to true, response will contain request and document level statistics. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Get analysis status and results
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.AI.Language.Conversations.ConversationAnalysisClient.GetAnalyzeConversationJobStatusAsync(System.Guid,System.Nullable{System.Boolean},System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>
Additional information can be found in the service REST API documentation:
https://learn.microsoft.com/rest/api/language/2023-04-01/analyze-conversation/job-status
</remarks>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetAnalyzeConversationJobStatusAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response response = await client.GetAnalyzeConversationJobStatusAsync(Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"), null, null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("jobId").ToString());
Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("completed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("failed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("inProgress").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("total").ToString());
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatusAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response response = await client.GetAnalyzeConversationJobStatusAsync(Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"), null, null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("jobId").ToString());
Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("completed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("failed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("inProgress").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("total").ToString());
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatusAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response response = await client.GetAnalyzeConversationJobStatusAsync(Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"), null, null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("jobId").ToString());
Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("completed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("failed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("inProgress").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("total").ToString());
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatusAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response response = await client.GetAnalyzeConversationJobStatusAsync(Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"), null, null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("jobId").ToString());
Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("completed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("failed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("inProgress").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("total").ToString());
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatusAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response response = await client.GetAnalyzeConversationJobStatusAsync(Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"), null, null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("jobId").ToString());
Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("completed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("failed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("inProgress").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("total").ToString());
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatusAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response response = await client.GetAnalyzeConversationJobStatusAsync(Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"), null, null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("jobId").ToString());
Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("completed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("failed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("inProgress").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("total").ToString());
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatusAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response response = await client.GetAnalyzeConversationJobStatusAsync(Guid.Parse("3e9e8518-492f-47f9-abd1-9a7468231086"), null, null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("jobId").ToString());
Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("completed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("failed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("inProgress").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("total").ToString());
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatusAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response response = await client.GetAnalyzeConversationJobStatusAsync(Guid.Parse("c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18"), null, null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("jobId").ToString());
Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("completed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("failed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("inProgress").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("total").ToString());
]]></code>
This sample shows how to call GetAnalyzeConversationJobStatusAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<key>");
ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential);
Response response = await client.GetAnalyzeConversationJobStatusAsync(Guid.Parse("3e9e8518-492f-47f9-abd1-9a7468231086"), null, null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("createdDateTime").ToString());
Console.WriteLine(result.GetProperty("jobId").ToString());
Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("completed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("failed").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("inProgress").ToString());
Console.WriteLine(result.GetProperty("tasks").GetProperty("total").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="Pipeline">
<MemberSignature Language="C#" Value="public virtual Azure.Core.Pipeline.HttpPipeline Pipeline { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.Core.Pipeline.HttpPipeline Pipeline" />
<MemberSignature Language="DocId" Value="P:Azure.AI.Language.Conversations.ConversationAnalysisClient.Pipeline" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property Pipeline As HttpPipeline" />
<MemberSignature Language="F#" Value="member this.Pipeline : Azure.Core.Pipeline.HttpPipeline" Usage="Azure.AI.Language.Conversations.ConversationAnalysisClient.Pipeline" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.Language.Conversations</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Core.Pipeline.HttpPipeline</ReturnType>
</ReturnValue>
<Docs>
<summary> The HTTP pipeline for sending and receiving REST requests and responses. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>