xml/Azure.AI.Language.Conversations.Authoring/ConversationAuthoringClient.xml

<Type Name="ConversationAuthoringClient" FullName="Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient"> <TypeSignature Language="C#" Value="public class ConversationAuthoringClient" /> <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ConversationAuthoringClient extends System.Object" /> <TypeSignature Language="DocId" Value="T:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient" /> <TypeSignature Language="VB.NET" Value="Public Class ConversationAuthoringClient" /> <TypeSignature Language="F#" Value="type ConversationAuthoringClient = 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 /> <Attributes> <Attribute FrameworkAlternate="azure-dotnet-preview"> <AttributeName Language="C#">[System.Obsolete("This class is obsolete and and will be removed in a future release. Find more details here: https://aka.ms/language-conversations-sdk", true)]</AttributeName> <AttributeName Language="F#">[<System.Obsolete("This class is obsolete and and will be removed in a future release. Find more details here: https://aka.ms/language-conversations-sdk", true)>]</AttributeName> </Attribute> </Attributes> <Docs> <summary> The ConversationAuthoring service client. </summary> <remarks> See <see href="https://learn.microsoft.com/rest/api/language/2023-04-01/conversational-analysis-authoring" /> for more information about models you can pass to this client. </remarks> </Docs> <Members> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="protected ConversationAuthoringClient ();" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.#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 ConversationAuthoringClient for mocking. </summary> <remarks>To be added.</remarks> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public ConversationAuthoringClient (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.Authoring.ConversationAuthoringClient.#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.Authoring.ConversationAuthoringClient : Uri * Azure.AzureKeyCredential -> Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient" Usage="new Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient (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>.cognitiveservices.azure.com). </param> <param name="credential"> A credential used to authenticate to an Azure Service. </param> <summary> Initializes a new instance of ConversationAuthoringClient. </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 ConversationAuthoringClient (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.Authoring.ConversationAuthoringClient.#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.Authoring.ConversationAuthoringClient : Uri * Azure.Core.TokenCredential -> Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient" Usage="new Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient (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>.cognitiveservices.azure.com). </param> <param name="credential"> A credential used to authenticate to an Azure Service. </param> <summary> Initializes a new instance of ConversationAuthoringClient. </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 ConversationAuthoringClient (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.Authoring.ConversationAuthoringClient.#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.Authoring.ConversationAuthoringClient : Uri * Azure.AzureKeyCredential * Azure.AI.Language.Conversations.ConversationsClientOptions -> Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient" Usage="new Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient (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>.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 ConversationAuthoringClient. </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 ConversationAuthoringClient (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.Authoring.ConversationAuthoringClient.#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.Authoring.ConversationAuthoringClient : Uri * Azure.Core.TokenCredential * Azure.AI.Language.Conversations.ConversationsClientOptions -> Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient" Usage="new Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient (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 ConversationAuthoringClient </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="CancelTrainingJob"> <MemberSignature Language="C#" Value="public virtual Azure.Operation<BinaryData> CancelTrainingJob (Azure.WaitUntil waitUntil, string projectName, string jobId, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation`1<class System.BinaryData> CancelTrainingJob(valuetype Azure.WaitUntil waitUntil, string projectName, string jobId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.CancelTrainingJob(Azure.WaitUntil,System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function CancelTrainingJob (waitUntil As WaitUntil, projectName As String, jobId As String, Optional context As RequestContext = Nothing) As Operation(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member CancelTrainingJob : Azure.WaitUntil * string * string * Azure.RequestContext -> Azure.Operation<BinaryData>
override this.CancelTrainingJob : Azure.WaitUntil * string * string * Azure.RequestContext -> Azure.Operation<BinaryData>" Usage="conversationAuthoringClient.CancelTrainingJob (waitUntil, projectName, 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<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="jobId" Type="System.String" /> <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="projectName"> The name of the project to use. </param> <param name="jobId"> The job ID. </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] Triggers a cancellation for a running training 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/conversational-analysis-authoring/cancel-training-job </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="jobId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> or <paramref name="jobId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call CancelTrainingJob with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); var operation = client.CancelTrainingJob(WaitUntil.Completed, "<projectName>", "<jobId>"); BinaryData responseData = operation.Value; JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement; Console.WriteLine(result.GetProperty("result").GetProperty("modelLabel").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingConfigVersion").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingMode").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("percentComplete").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("startDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("endDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("percentComplete").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("startDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("endDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("estimatedEndDateTime").ToString()); Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> <Member MemberName="CancelTrainingJobAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation<BinaryData>> CancelTrainingJobAsync (Azure.WaitUntil waitUntil, string projectName, string jobId, 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>> CancelTrainingJobAsync(valuetype Azure.WaitUntil waitUntil, string projectName, string jobId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.CancelTrainingJobAsync(Azure.WaitUntil,System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function CancelTrainingJobAsync (waitUntil As WaitUntil, projectName As String, jobId As String, Optional context As RequestContext = Nothing) As Task(Of Operation(Of BinaryData))" /> <MemberSignature Language="F#" Value="abstract member CancelTrainingJobAsync : Azure.WaitUntil * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>
override this.CancelTrainingJobAsync : Azure.WaitUntil * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>" Usage="conversationAuthoringClient.CancelTrainingJobAsync (waitUntil, projectName, 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<System.BinaryData>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="jobId" Type="System.String" /> <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="projectName"> The name of the project to use. </param> <param name="jobId"> The job ID. </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] Triggers a cancellation for a running training 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/conversational-analysis-authoring/cancel-training-job </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="jobId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> or <paramref name="jobId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call CancelTrainingJobAsync with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); var operation = await client.CancelTrainingJobAsync(WaitUntil.Completed, "<projectName>", "<jobId>"); BinaryData responseData = operation.Value; JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement; Console.WriteLine(result.GetProperty("result").GetProperty("modelLabel").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingConfigVersion").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingMode").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("percentComplete").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("startDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("endDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("percentComplete").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("startDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("endDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("estimatedEndDateTime").ToString()); Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> <Member MemberName="CreateProject"> <MemberSignature Language="C#" Value="public virtual Azure.Response CreateProject (string projectName, Azure.Core.RequestContent content, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response CreateProject(string projectName, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.CreateProject(System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function CreateProject (projectName As String, content As RequestContent, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member CreateProject : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.CreateProject : string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response" Usage="conversationAuthoringClient.CreateProject (projectName, 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="projectName" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </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] Creates a new project or updates an existing one. </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/conversational-analysis-authoring/create-project </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call CreateProject 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 ConversationAuthoringClient(endpoint, credential); var data = new { projectKind = "Conversation", projectName = "<projectName>", language = "<language>", }; Response response = client.CreateProject("<projectName>", RequestContent.Create(data)); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastModifiedDateTime").ToString()); Console.WriteLine(result.GetProperty("projectKind").ToString()); Console.WriteLine(result.GetProperty("projectName").ToString()); Console.WriteLine(result.GetProperty("language").ToString()); ]]></code> This sample shows how to call CreateProject 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 ConversationAuthoringClient(endpoint, credential); var data = new { projectKind = "Conversation", settings = new { confidenceThreshold = 123.45f, }, projectName = "<projectName>", multilingual = true, description = "<description>", language = "<language>", }; Response response = client.CreateProject("<projectName>", RequestContent.Create(data)); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastModifiedDateTime").ToString()); Console.WriteLine(result.GetProperty("lastTrainedDateTime").ToString()); Console.WriteLine(result.GetProperty("lastDeployedDateTime").ToString()); Console.WriteLine(result.GetProperty("projectKind").ToString()); Console.WriteLine(result.GetProperty("settings").GetProperty("confidenceThreshold").ToString()); Console.WriteLine(result.GetProperty("projectName").ToString()); Console.WriteLine(result.GetProperty("multilingual").ToString()); Console.WriteLine(result.GetProperty("description").ToString()); Console.WriteLine(result.GetProperty("language").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="CreateProjectAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> CreateProjectAsync (string projectName, 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> CreateProjectAsync(string projectName, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.CreateProjectAsync(System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function CreateProjectAsync (projectName As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member CreateProjectAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.CreateProjectAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="conversationAuthoringClient.CreateProjectAsync (projectName, 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="projectName" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </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] Creates a new project or updates an existing one. </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/conversational-analysis-authoring/create-project </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call CreateProjectAsync 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 ConversationAuthoringClient(endpoint, credential); var data = new { projectKind = "Conversation", projectName = "<projectName>", language = "<language>", }; Response response = await client.CreateProjectAsync("<projectName>", RequestContent.Create(data)); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastModifiedDateTime").ToString()); Console.WriteLine(result.GetProperty("projectKind").ToString()); Console.WriteLine(result.GetProperty("projectName").ToString()); Console.WriteLine(result.GetProperty("language").ToString()); ]]></code> This sample shows how to call CreateProjectAsync 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 ConversationAuthoringClient(endpoint, credential); var data = new { projectKind = "Conversation", settings = new { confidenceThreshold = 123.45f, }, projectName = "<projectName>", multilingual = true, description = "<description>", language = "<language>", }; Response response = await client.CreateProjectAsync("<projectName>", RequestContent.Create(data)); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastModifiedDateTime").ToString()); Console.WriteLine(result.GetProperty("lastTrainedDateTime").ToString()); Console.WriteLine(result.GetProperty("lastDeployedDateTime").ToString()); Console.WriteLine(result.GetProperty("projectKind").ToString()); Console.WriteLine(result.GetProperty("settings").GetProperty("confidenceThreshold").ToString()); Console.WriteLine(result.GetProperty("projectName").ToString()); Console.WriteLine(result.GetProperty("multilingual").ToString()); Console.WriteLine(result.GetProperty("description").ToString()); Console.WriteLine(result.GetProperty("language").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="DeleteDeployment"> <MemberSignature Language="C#" Value="public virtual Azure.Operation<BinaryData> DeleteDeployment (Azure.WaitUntil waitUntil, string projectName, string deploymentName, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation`1<class System.BinaryData> DeleteDeployment(valuetype Azure.WaitUntil waitUntil, string projectName, string deploymentName, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.DeleteDeployment(Azure.WaitUntil,System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteDeployment (waitUntil As WaitUntil, projectName As String, deploymentName As String, Optional context As RequestContext = Nothing) As Operation(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member DeleteDeployment : Azure.WaitUntil * string * string * Azure.RequestContext -> Azure.Operation<BinaryData>
override this.DeleteDeployment : Azure.WaitUntil * string * string * Azure.RequestContext -> Azure.Operation<BinaryData>" Usage="conversationAuthoringClient.DeleteDeployment (waitUntil, projectName, deploymentName, 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="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <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="projectName"> The name of the project to use. </param> <param name="deploymentName"> The name of the specific deployment of the project to use. </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] Deletes a project deployment. <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/conversational-analysis-authoring/delete-deployment </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="deploymentName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> or <paramref name="deploymentName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call DeleteDeployment with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); var operation = client.DeleteDeployment(WaitUntil.Completed, "<projectName>", "<deploymentName>"); BinaryData responseData = operation.Value; JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement; Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> <Member MemberName="DeleteDeploymentAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation<BinaryData>> DeleteDeploymentAsync (Azure.WaitUntil waitUntil, string projectName, string deploymentName, 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>> DeleteDeploymentAsync(valuetype Azure.WaitUntil waitUntil, string projectName, string deploymentName, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.DeleteDeploymentAsync(Azure.WaitUntil,System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteDeploymentAsync (waitUntil As WaitUntil, projectName As String, deploymentName As String, Optional context As RequestContext = Nothing) As Task(Of Operation(Of BinaryData))" /> <MemberSignature Language="F#" Value="abstract member DeleteDeploymentAsync : Azure.WaitUntil * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>
override this.DeleteDeploymentAsync : Azure.WaitUntil * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>" Usage="conversationAuthoringClient.DeleteDeploymentAsync (waitUntil, projectName, deploymentName, 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="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <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="projectName"> The name of the project to use. </param> <param name="deploymentName"> The name of the specific deployment of the project to use. </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] Deletes a project deployment. <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/conversational-analysis-authoring/delete-deployment </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="deploymentName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> or <paramref name="deploymentName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call DeleteDeploymentAsync with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); var operation = await client.DeleteDeploymentAsync(WaitUntil.Completed, "<projectName>", "<deploymentName>"); BinaryData responseData = operation.Value; JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement; Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> <Member MemberName="DeleteProject"> <MemberSignature Language="C#" Value="public virtual Azure.Operation<BinaryData> DeleteProject (Azure.WaitUntil waitUntil, string projectName, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation`1<class System.BinaryData> DeleteProject(valuetype Azure.WaitUntil waitUntil, string projectName, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.DeleteProject(Azure.WaitUntil,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteProject (waitUntil As WaitUntil, projectName As String, Optional context As RequestContext = Nothing) As Operation(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member DeleteProject : Azure.WaitUntil * string * Azure.RequestContext -> Azure.Operation<BinaryData>
override this.DeleteProject : Azure.WaitUntil * string * Azure.RequestContext -> Azure.Operation<BinaryData>" Usage="conversationAuthoringClient.DeleteProject (waitUntil, projectName, 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="projectName" Type="System.String" /> <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="projectName"> The name of the project to use. </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] Deletes a project. <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/conversational-analysis-authoring/delete-project </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call DeleteProject with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); var operation = client.DeleteProject(WaitUntil.Completed, "<projectName>"); BinaryData responseData = operation.Value; JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement; Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> <Member MemberName="DeleteProjectAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation<BinaryData>> DeleteProjectAsync (Azure.WaitUntil waitUntil, string projectName, 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>> DeleteProjectAsync(valuetype Azure.WaitUntil waitUntil, string projectName, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.DeleteProjectAsync(Azure.WaitUntil,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteProjectAsync (waitUntil As WaitUntil, projectName As String, Optional context As RequestContext = Nothing) As Task(Of Operation(Of BinaryData))" /> <MemberSignature Language="F#" Value="abstract member DeleteProjectAsync : Azure.WaitUntil * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>
override this.DeleteProjectAsync : Azure.WaitUntil * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>" Usage="conversationAuthoringClient.DeleteProjectAsync (waitUntil, projectName, 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="projectName" Type="System.String" /> <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="projectName"> The name of the project to use. </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] Deletes a project. <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/conversational-analysis-authoring/delete-project </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call DeleteProjectAsync with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); var operation = await client.DeleteProjectAsync(WaitUntil.Completed, "<projectName>"); BinaryData responseData = operation.Value; JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement; Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> <Member MemberName="DeleteTrainedModel"> <MemberSignature Language="C#" Value="public virtual Azure.Response DeleteTrainedModel (string projectName, string trainedModelLabel, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response DeleteTrainedModel(string projectName, string trainedModelLabel, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.DeleteTrainedModel(System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteTrainedModel (projectName As String, trainedModelLabel As String, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member DeleteTrainedModel : string * string * Azure.RequestContext -> Azure.Response
override this.DeleteTrainedModel : string * string * Azure.RequestContext -> Azure.Response" Usage="conversationAuthoringClient.DeleteTrainedModel (projectName, trainedModelLabel, 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="projectName" Type="System.String" /> <Parameter Name="trainedModelLabel" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </param> <param name="trainedModelLabel"> The trained model label. </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] Deletes an existing trained model. <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 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/conversational-analysis-authoring/delete-trained-model </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="trainedModelLabel" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> or <paramref name="trainedModelLabel" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call DeleteTrainedModel with required parameters. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); Response response = client.DeleteTrainedModel("<projectName>", "<trainedModelLabel>"); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="DeleteTrainedModelAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> DeleteTrainedModelAsync (string projectName, string trainedModelLabel, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> DeleteTrainedModelAsync(string projectName, string trainedModelLabel, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.DeleteTrainedModelAsync(System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteTrainedModelAsync (projectName As String, trainedModelLabel As String, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member DeleteTrainedModelAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteTrainedModelAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="conversationAuthoringClient.DeleteTrainedModelAsync (projectName, trainedModelLabel, 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="projectName" Type="System.String" /> <Parameter Name="trainedModelLabel" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </param> <param name="trainedModelLabel"> The trained model label. </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] Deletes an existing trained model. <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 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/conversational-analysis-authoring/delete-trained-model </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="trainedModelLabel" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> or <paramref name="trainedModelLabel" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call DeleteTrainedModelAsync with required parameters. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); Response response = await client.DeleteTrainedModelAsync("<projectName>", "<trainedModelLabel>"); Console.WriteLine(response.Status); ]]></code></example> </Docs> </Member> <Member MemberName="DeployProject"> <MemberSignature Language="C#" Value="public virtual Azure.Operation<BinaryData> DeployProject (Azure.WaitUntil waitUntil, string projectName, string deploymentName, 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> DeployProject(valuetype Azure.WaitUntil waitUntil, string projectName, string deploymentName, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.DeployProject(Azure.WaitUntil,System.String,System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DeployProject (waitUntil As WaitUntil, projectName As String, deploymentName As String, content As RequestContent, Optional context As RequestContext = Nothing) As Operation(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member DeployProject : Azure.WaitUntil * string * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Operation<BinaryData>
override this.DeployProject : Azure.WaitUntil * string * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Operation<BinaryData>" Usage="conversationAuthoringClient.DeployProject (waitUntil, projectName, deploymentName, 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="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <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="projectName"> The name of the project to use. </param> <param name="deploymentName"> The name of the specific deployment of the project to use. </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] Creates a new deployment or replaces an existing one. <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/conversational-analysis-authoring/deploy-project </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" />, <paramref name="deploymentName" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> or <paramref name="deploymentName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call DeployProject with required parameters and request content and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); var data = new { trainedModelLabel = "<trainedModelLabel>", }; var operation = client.DeployProject(WaitUntil.Completed, "<projectName>", "<deploymentName>", RequestContent.Create(data)); BinaryData responseData = operation.Value; JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement; Console.WriteLine(result.GetProperty("deploymentName").ToString()); Console.WriteLine(result.GetProperty("modelId").ToString()); Console.WriteLine(result.GetProperty("lastTrainedDateTime").ToString()); Console.WriteLine(result.GetProperty("lastDeployedDateTime").ToString()); Console.WriteLine(result.GetProperty("deploymentExpirationDate").ToString()); Console.WriteLine(result.GetProperty("modelTrainingConfigVersion").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="DeployProjectAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation<BinaryData>> DeployProjectAsync (Azure.WaitUntil waitUntil, string projectName, string deploymentName, 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>> DeployProjectAsync(valuetype Azure.WaitUntil waitUntil, string projectName, string deploymentName, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.DeployProjectAsync(Azure.WaitUntil,System.String,System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function DeployProjectAsync (waitUntil As WaitUntil, projectName As String, deploymentName As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Operation(Of BinaryData))" /> <MemberSignature Language="F#" Value="abstract member DeployProjectAsync : Azure.WaitUntil * string * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>
override this.DeployProjectAsync : Azure.WaitUntil * string * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>" Usage="conversationAuthoringClient.DeployProjectAsync (waitUntil, projectName, deploymentName, 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="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <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="projectName"> The name of the project to use. </param> <param name="deploymentName"> The name of the specific deployment of the project to use. </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] Creates a new deployment or replaces an existing one. <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/conversational-analysis-authoring/deploy-project </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" />, <paramref name="deploymentName" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> or <paramref name="deploymentName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call DeployProjectAsync with required parameters and request content and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); var data = new { trainedModelLabel = "<trainedModelLabel>", }; var operation = await client.DeployProjectAsync(WaitUntil.Completed, "<projectName>", "<deploymentName>", RequestContent.Create(data)); BinaryData responseData = operation.Value; JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement; Console.WriteLine(result.GetProperty("deploymentName").ToString()); Console.WriteLine(result.GetProperty("modelId").ToString()); Console.WriteLine(result.GetProperty("lastTrainedDateTime").ToString()); Console.WriteLine(result.GetProperty("lastDeployedDateTime").ToString()); Console.WriteLine(result.GetProperty("deploymentExpirationDate").ToString()); Console.WriteLine(result.GetProperty("modelTrainingConfigVersion").ToString()); ]]></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.Authoring.ConversationAuthoringClient.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.Authoring.ConversationAuthoringClient.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="ExportProject"> <MemberSignature Language="C#" Value="public virtual Azure.Operation<BinaryData> ExportProject (Azure.WaitUntil waitUntil, string projectName, string exportedProjectFormat, string assetKind, string stringIndexType, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation`1<class System.BinaryData> ExportProject(valuetype Azure.WaitUntil waitUntil, string projectName, string exportedProjectFormat, string assetKind, string stringIndexType, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.ExportProject(Azure.WaitUntil,System.String,System.String,System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function ExportProject (waitUntil As WaitUntil, projectName As String, exportedProjectFormat As String, assetKind As String, stringIndexType As String, context As RequestContext) As Operation(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member ExportProject : Azure.WaitUntil * string * string * string * string * Azure.RequestContext -> Azure.Operation<BinaryData>
override this.ExportProject : Azure.WaitUntil * string * string * string * string * Azure.RequestContext -> Azure.Operation<BinaryData>" Usage="conversationAuthoringClient.ExportProject (waitUntil, projectName, exportedProjectFormat, assetKind, stringIndexType, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Language.Conversations</AssemblyName> <AssemblyVersion>1.1.0.0</AssemblyVersion> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>Azure.Operation<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="exportedProjectFormat" Type="System.String" /> <Parameter Name="assetKind" Type="System.String" /> <Parameter Name="stringIndexType" Type="System.String" /> <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="projectName"> The name of the project to use. </param> <param name="exportedProjectFormat"> The format of the exported project file to use. Allowed values: "Conversation" | "Luis". </param> <param name="assetKind"> Kind of asset to export. </param> <param name="stringIndexType"> Specifies the method used to interpret string offsets. Set this to "Utf16CodeUnit" for .NET strings, which are encoded as UTF-16. Allowed values: "Utf16CodeUnit". </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> Triggers a job to export a project's data. </summary> <returns> The <see cref="T:Azure.Operation`1" /> from the service that will contain a <see cref="T:System.BinaryData" /> object once the asynchronous operation on the service has completed. Details of the body schema for the operation's final value are in the Remarks section below. </returns> <remarks> Below is the JSON schema for the response payload. Additional information can be found in the service REST API documentation: https://learn.microsoft.com/rest/api/language/2023-04-01/conversational-analysis-authoring/export Response Body: Schema for <c>ExportProjectJobState</c>: <code>{ resultUrl: string, # Optional. The URL to use in order to download the exported project. jobId: string, # Required. The job ID. createdDateTime: string (ISO 8601 Format), # Required. The creation date time of the job. lastUpdatedDateTime: string (ISO 8601 Format), # Required. The last date time the job was updated. expirationDateTime: string (ISO 8601 Format), # Optional. The expiration date time of the job. status: "notStarted" | "running" | "succeeded" | "failed" | "cancelled" | "cancelling" | "partiallyCompleted", # Required. The job status. warnings: [ { code: string, # Required. The warning code. message: string, # Required. The warning message. } ], # Optional. The warnings that were encountered while executing the job. errors: [ { code: "InvalidRequest" | "InvalidArgument" | "Unauthorized" | "Forbidden" | "NotFound" | "ProjectNotFound" | "OperationNotFound" | "AzureCognitiveSearchNotFound" | "AzureCognitiveSearchIndexNotFound" | "TooManyRequests" | "AzureCognitiveSearchThrottling" | "AzureCognitiveSearchIndexLimitReached" | "InternalServerError" | "ServiceUnavailable" | "Timeout" | "QuotaExceeded" | "Conflict" | "Warning", # Required. One of a server-defined set of error codes. message: string, # Required. A human-readable representation of the error. target: string, # Optional. The target of the error. details: [Error], # Optional. An array of details about specific errors that led to this reported error. innererror: { code: "InvalidRequest" | "InvalidParameterValue" | "KnowledgeBaseNotFound" | "AzureCognitiveSearchNotFound" | "AzureCognitiveSearchThrottling" | "ExtractionFailure" | "InvalidRequestBodyFormat" | "EmptyRequest" | "MissingInputDocuments" | "InvalidDocument" | "ModelVersionIncorrect" | "InvalidDocumentBatch" | "UnsupportedLanguageCode" | "InvalidCountryHint", # Required. One of a server-defined set of error codes. message: string, # Required. Error message. details: Dictionary<string, string>, # Optional. Error details. target: string, # Optional. Error target. innererror: InnerErrorModel, # Optional. An object containing more specific information than the current object about the error. }, # Optional. An object containing more specific information than the current object about the error. } ], # Optional. The errors encountered while executing the job. } </code></remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="stringIndexType" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call ExportProject with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); var operation = client.ExportProject(WaitUntil.Completed, "<projectName>"); BinaryData data = operation.WaitForCompletion(); JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; Console.WriteLine(result.ToString()); ]]></code> This sample shows how to call ExportProject with all parameters, 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 ConversationAuthoringClient(endpoint, credential); var operation = client.ExportProject(WaitUntil.Completed, "<projectName>", "<exportedProjectFormat>", "<assetKind>", <Utf16CodeUnit>); BinaryData data = operation.WaitForCompletion(); JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; Console.WriteLine(result.GetProperty("resultUrl").ToString()); Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> <Member MemberName="ExportProject"> <MemberSignature Language="C#" Value="public virtual Azure.Operation<BinaryData> ExportProject (Azure.WaitUntil waitUntil, string projectName, string exportedProjectFormat = default, string assetKind = default, string stringIndexType = "Utf16CodeUnit", string trainedModelLabel = default, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation`1<class System.BinaryData> ExportProject(valuetype Azure.WaitUntil waitUntil, string projectName, string exportedProjectFormat, string assetKind, string stringIndexType, string trainedModelLabel, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.ExportProject(Azure.WaitUntil,System.String,System.String,System.String,System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function ExportProject (waitUntil As WaitUntil, projectName As String, Optional exportedProjectFormat As String = Nothing, Optional assetKind As String = Nothing, Optional stringIndexType As String = "Utf16CodeUnit", Optional trainedModelLabel As String = Nothing, Optional context As RequestContext = Nothing) As Operation(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member ExportProject : Azure.WaitUntil * string * string * string * string * string * Azure.RequestContext -> Azure.Operation<BinaryData>
override this.ExportProject : Azure.WaitUntil * string * string * string * string * string * Azure.RequestContext -> Azure.Operation<BinaryData>" Usage="conversationAuthoringClient.ExportProject (waitUntil, projectName, exportedProjectFormat, assetKind, stringIndexType, trainedModelLabel, 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="projectName" Type="System.String" /> <Parameter Name="exportedProjectFormat" Type="System.String" /> <Parameter Name="assetKind" Type="System.String" /> <Parameter Name="stringIndexType" Type="System.String" /> <Parameter Name="trainedModelLabel" Type="System.String" /> <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="projectName"> The name of the project to use. </param> <param name="exportedProjectFormat"> The format of the exported project file to use. Allowed values: "Conversation" | "Luis". </param> <param name="assetKind"> Kind of asset to export. </param> <param name="stringIndexType"> Specifies the method used to interpret string offsets. Set this to "Utf16CodeUnit" for .NET strings, which are encoded as UTF-16. Allowed values: "Utf16CodeUnit". </param> <param name="trainedModelLabel"> Trained model label to export. If the trainedModelLabel is null, the default behavior is to export the current working copy. </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] Triggers a job to export a project's data. <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/conversational-analysis-authoring/export </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="stringIndexType" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call ExportProject with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); var operation = client.ExportProject(WaitUntil.Completed, "<projectName>"); BinaryData responseData = operation.Value; JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement; Console.WriteLine(result.ToString()); ]]></code> This sample shows how to call ExportProject with all parameters, 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 ConversationAuthoringClient(endpoint, credential); var operation = client.ExportProject(WaitUntil.Completed, "<projectName>", "<exportedProjectFormat>", "<assetKind>", "Utf16CodeUnit", "<trainedModelLabel>"); BinaryData responseData = operation.Value; JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement; Console.WriteLine(result.GetProperty("resultUrl").ToString()); Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> <Member MemberName="ExportProjectAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation<BinaryData>> ExportProjectAsync (Azure.WaitUntil waitUntil, string projectName, string exportedProjectFormat, string assetKind, string stringIndexType, Azure.RequestContext context);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Operation`1<class System.BinaryData>> ExportProjectAsync(valuetype Azure.WaitUntil waitUntil, string projectName, string exportedProjectFormat, string assetKind, string stringIndexType, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.ExportProjectAsync(Azure.WaitUntil,System.String,System.String,System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function ExportProjectAsync (waitUntil As WaitUntil, projectName As String, exportedProjectFormat As String, assetKind As String, stringIndexType As String, context As RequestContext) As Task(Of Operation(Of BinaryData))" /> <MemberSignature Language="F#" Value="abstract member ExportProjectAsync : Azure.WaitUntil * string * string * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>
override this.ExportProjectAsync : Azure.WaitUntil * string * string * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>" Usage="conversationAuthoringClient.ExportProjectAsync (waitUntil, projectName, exportedProjectFormat, assetKind, stringIndexType, context)" /> <MemberType>Method</MemberType> <AssemblyInfo> <AssemblyName>Azure.AI.Language.Conversations</AssemblyName> <AssemblyVersion>1.1.0.0</AssemblyVersion> <AssemblyVersion>2.0.0.0</AssemblyVersion> </AssemblyInfo> <Attributes> <Attribute> <AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName> <AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Threading.Tasks.Task<Azure.Operation<System.BinaryData>></ReturnType> </ReturnValue> <Parameters> <Parameter Name="waitUntil" Type="Azure.WaitUntil" /> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="exportedProjectFormat" Type="System.String" /> <Parameter Name="assetKind" Type="System.String" /> <Parameter Name="stringIndexType" Type="System.String" /> <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="projectName"> The name of the project to use. </param> <param name="exportedProjectFormat"> The format of the exported project file to use. Allowed values: "Conversation" | "Luis". </param> <param name="assetKind"> Kind of asset to export. </param> <param name="stringIndexType"> Specifies the method used to interpret string offsets. Set this to "Utf16CodeUnit" for .NET strings, which are encoded as UTF-16. Allowed values: "Utf16CodeUnit". </param> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> Triggers a job to export a project's data. </summary> <returns> The <see cref="T:Azure.Operation`1" /> from the service that will contain a <see cref="T:System.BinaryData" /> object once the asynchronous operation on the service has completed. Details of the body schema for the operation's final value are in the Remarks section below. </returns> <remarks> Below is the JSON schema for the response payload. Additional information can be found in the service REST API documentation: https://learn.microsoft.com/rest/api/language/2023-04-01/conversational-analysis-authoring/export Response Body: Schema for <c>ExportProjectJobState</c>: <code>{ resultUrl: string, # Optional. The URL to use in order to download the exported project. jobId: string, # Required. The job ID. createdDateTime: string (ISO 8601 Format), # Required. The creation date time of the job. lastUpdatedDateTime: string (ISO 8601 Format), # Required. The last date time the job was updated. expirationDateTime: string (ISO 8601 Format), # Optional. The expiration date time of the job. status: "notStarted" | "running" | "succeeded" | "failed" | "cancelled" | "cancelling" | "partiallyCompleted", # Required. The job status. warnings: [ { code: string, # Required. The warning code. message: string, # Required. The warning message. } ], # Optional. The warnings that were encountered while executing the job. errors: [ { code: "InvalidRequest" | "InvalidArgument" | "Unauthorized" | "Forbidden" | "NotFound" | "ProjectNotFound" | "OperationNotFound" | "AzureCognitiveSearchNotFound" | "AzureCognitiveSearchIndexNotFound" | "TooManyRequests" | "AzureCognitiveSearchThrottling" | "AzureCognitiveSearchIndexLimitReached" | "InternalServerError" | "ServiceUnavailable" | "Timeout" | "QuotaExceeded" | "Conflict" | "Warning", # Required. One of a server-defined set of error codes. message: string, # Required. A human-readable representation of the error. target: string, # Optional. The target of the error. details: [Error], # Optional. An array of details about specific errors that led to this reported error. innererror: { code: "InvalidRequest" | "InvalidParameterValue" | "KnowledgeBaseNotFound" | "AzureCognitiveSearchNotFound" | "AzureCognitiveSearchThrottling" | "ExtractionFailure" | "InvalidRequestBodyFormat" | "EmptyRequest" | "MissingInputDocuments" | "InvalidDocument" | "ModelVersionIncorrect" | "InvalidDocumentBatch" | "UnsupportedLanguageCode" | "InvalidCountryHint", # Required. One of a server-defined set of error codes. message: string, # Required. Error message. details: Dictionary<string, string>, # Optional. Error details. target: string, # Optional. Error target. innererror: InnerErrorModel, # Optional. An object containing more specific information than the current object about the error. }, # Optional. An object containing more specific information than the current object about the error. } ], # Optional. The errors encountered while executing the job. } </code></remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="stringIndexType" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call ExportProjectAsync with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); var operation = await client.ExportProjectAsync(WaitUntil.Completed, "<projectName>"); BinaryData data = await operation.WaitForCompletionAsync(); JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; Console.WriteLine(result.ToString()); ]]></code> This sample shows how to call ExportProjectAsync with all parameters, 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 ConversationAuthoringClient(endpoint, credential); var operation = await client.ExportProjectAsync(WaitUntil.Completed, "<projectName>", "<exportedProjectFormat>", "<assetKind>", <Utf16CodeUnit>); BinaryData data = await operation.WaitForCompletionAsync(); JsonElement result = JsonDocument.Parse(data.ToStream()).RootElement; Console.WriteLine(result.GetProperty("resultUrl").ToString()); Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> <Member MemberName="ExportProjectAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation<BinaryData>> ExportProjectAsync (Azure.WaitUntil waitUntil, string projectName, string exportedProjectFormat = default, string assetKind = default, string stringIndexType = "Utf16CodeUnit", string trainedModelLabel = default, 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>> ExportProjectAsync(valuetype Azure.WaitUntil waitUntil, string projectName, string exportedProjectFormat, string assetKind, string stringIndexType, string trainedModelLabel, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.ExportProjectAsync(Azure.WaitUntil,System.String,System.String,System.String,System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function ExportProjectAsync (waitUntil As WaitUntil, projectName As String, Optional exportedProjectFormat As String = Nothing, Optional assetKind As String = Nothing, Optional stringIndexType As String = "Utf16CodeUnit", Optional trainedModelLabel As String = Nothing, Optional context As RequestContext = Nothing) As Task(Of Operation(Of BinaryData))" /> <MemberSignature Language="F#" Value="abstract member ExportProjectAsync : Azure.WaitUntil * string * string * string * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>
override this.ExportProjectAsync : Azure.WaitUntil * string * string * string * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>" Usage="conversationAuthoringClient.ExportProjectAsync (waitUntil, projectName, exportedProjectFormat, assetKind, stringIndexType, trainedModelLabel, 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="projectName" Type="System.String" /> <Parameter Name="exportedProjectFormat" Type="System.String" /> <Parameter Name="assetKind" Type="System.String" /> <Parameter Name="stringIndexType" Type="System.String" /> <Parameter Name="trainedModelLabel" Type="System.String" /> <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="projectName"> The name of the project to use. </param> <param name="exportedProjectFormat"> The format of the exported project file to use. Allowed values: "Conversation" | "Luis". </param> <param name="assetKind"> Kind of asset to export. </param> <param name="stringIndexType"> Specifies the method used to interpret string offsets. Set this to "Utf16CodeUnit" for .NET strings, which are encoded as UTF-16. Allowed values: "Utf16CodeUnit". </param> <param name="trainedModelLabel"> Trained model label to export. If the trainedModelLabel is null, the default behavior is to export the current working copy. </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] Triggers a job to export a project's data. <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/conversational-analysis-authoring/export </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="stringIndexType" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call ExportProjectAsync with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); var operation = await client.ExportProjectAsync(WaitUntil.Completed, "<projectName>"); BinaryData responseData = operation.Value; JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement; Console.WriteLine(result.ToString()); ]]></code> This sample shows how to call ExportProjectAsync with all parameters, 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 ConversationAuthoringClient(endpoint, credential); var operation = await client.ExportProjectAsync(WaitUntil.Completed, "<projectName>", "<exportedProjectFormat>", "<assetKind>", "Utf16CodeUnit", "<trainedModelLabel>"); BinaryData responseData = operation.Value; JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement; Console.WriteLine(result.GetProperty("resultUrl").ToString()); Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> <Member MemberName="GetDeployment"> <MemberSignature Language="C#" Value="public virtual Azure.Response GetDeployment (string projectName, string deploymentName, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetDeployment(string projectName, string deploymentName, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetDeployment(System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetDeployment (projectName As String, deploymentName As String, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member GetDeployment : string * string * Azure.RequestContext -> Azure.Response
override this.GetDeployment : string * string * Azure.RequestContext -> Azure.Response" Usage="conversationAuthoringClient.GetDeployment (projectName, deploymentName, 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="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName">The name of the project.</param> <param name="deploymentName">The name of the deployment.</param> <param name="context">The request context.</param> <summary> Gets the deployment details for a specified project and deployment name. </summary> <returns>A <see cref="T:Azure.Response" /> containing the deployment details.</returns> <remarks> Additional information can be found in the service REST API documentation: https://learn.microsoft.com/rest/api/language/2023-04-01/conversational-analysis-authoring/get-deployment </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="deploymentName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> or <paramref name="deploymentName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetDeployment with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); Response response = client.GetDeployment("<projectName>", "<deploymentName>"); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("deploymentName").ToString()); Console.WriteLine(result.GetProperty("modelId").ToString()); Console.WriteLine(result.GetProperty("lastTrainedDateTime").ToString()); Console.WriteLine(result.GetProperty("lastDeployedDateTime").ToString()); Console.WriteLine(result.GetProperty("deploymentExpirationDate").ToString()); Console.WriteLine(result.GetProperty("modelTrainingConfigVersion").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetDeploymentAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetDeploymentAsync (string projectName, string deploymentName, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetDeploymentAsync(string projectName, string deploymentName, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetDeploymentAsync(System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetDeploymentAsync (projectName As String, deploymentName As String, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member GetDeploymentAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetDeploymentAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="conversationAuthoringClient.GetDeploymentAsync (projectName, deploymentName, 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="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName">The name of the project.</param> <param name="deploymentName">The name of the deployment.</param> <param name="context">The request context.</param> <summary> Asynchronously gets the deployment details for a specified project and deployment name. </summary> <returns>A task that represents the asynchronous operation. The task result contains the response.</returns> <remarks> Additional information can be found in the service REST API documentation: https://learn.microsoft.com/rest/api/language/2023-04-01/conversational-analysis-authoring/get-deployment </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="deploymentName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> or <paramref name="deploymentName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetDeploymentAsync with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); Response response = await client.GetDeploymentAsync("<projectName>", "<deploymentName>"); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("deploymentName").ToString()); Console.WriteLine(result.GetProperty("modelId").ToString()); Console.WriteLine(result.GetProperty("lastTrainedDateTime").ToString()); Console.WriteLine(result.GetProperty("lastDeployedDateTime").ToString()); Console.WriteLine(result.GetProperty("deploymentExpirationDate").ToString()); Console.WriteLine(result.GetProperty("modelTrainingConfigVersion").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetDeploymentJobStatus"> <MemberSignature Language="C#" Value="public virtual Azure.Response GetDeploymentJobStatus (string projectName, string deploymentName, string jobId, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetDeploymentJobStatus(string projectName, string deploymentName, string jobId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetDeploymentJobStatus(System.String,System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetDeploymentJobStatus (projectName As String, deploymentName As String, jobId As String, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member GetDeploymentJobStatus : string * string * string * Azure.RequestContext -> Azure.Response
override this.GetDeploymentJobStatus : string * string * string * Azure.RequestContext -> Azure.Response" Usage="conversationAuthoringClient.GetDeploymentJobStatus (projectName, deploymentName, 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.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <Parameter Name="jobId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </param> <param name="deploymentName"> The name of the specific deployment of the project to use. </param> <param name="jobId"> The job ID. </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] Gets the status of an existing deployment 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 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/conversational-analysis-authoring/get-deployment-status </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" />, <paramref name="deploymentName" /> or <paramref name="jobId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" />, <paramref name="deploymentName" /> or <paramref name="jobId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetDeploymentJobStatus with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); Response response = client.GetDeploymentJobStatus("<projectName>", "<deploymentName>", "<jobId>"); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> <Member MemberName="GetDeploymentJobStatusAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetDeploymentJobStatusAsync (string projectName, string deploymentName, string jobId, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetDeploymentJobStatusAsync(string projectName, string deploymentName, string jobId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetDeploymentJobStatusAsync(System.String,System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetDeploymentJobStatusAsync (projectName As String, deploymentName As String, jobId As String, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member GetDeploymentJobStatusAsync : string * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetDeploymentJobStatusAsync : string * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="conversationAuthoringClient.GetDeploymentJobStatusAsync (projectName, deploymentName, 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.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="deploymentName" Type="System.String" /> <Parameter Name="jobId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </param> <param name="deploymentName"> The name of the specific deployment of the project to use. </param> <param name="jobId"> The job ID. </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] Gets the status of an existing deployment 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 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/conversational-analysis-authoring/get-deployment-status </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" />, <paramref name="deploymentName" /> or <paramref name="jobId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" />, <paramref name="deploymentName" /> or <paramref name="jobId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetDeploymentJobStatusAsync with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); Response response = await client.GetDeploymentJobStatusAsync("<projectName>", "<deploymentName>", "<jobId>"); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> <Member MemberName="GetDeployments"> <MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetDeployments (string projectName, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetDeployments(string projectName, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetDeployments(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetDeployments (projectName As String, Optional context As RequestContext = Nothing) As Pageable(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member GetDeployments : string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetDeployments : string * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="conversationAuthoringClient.GetDeployments (projectName, 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.Pageable<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </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] Lists the deployments belonging to a project. <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.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns> <remarks> Additional information can be found in the service REST API documentation: https://learn.microsoft.com/rest/api/language/2023-04-01/conversational-analysis-authoring/list-deployments </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetDeployments with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); foreach (var item in client.GetDeployments("<projectName>")) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("deploymentName").ToString()); Console.WriteLine(result.GetProperty("modelId").ToString()); Console.WriteLine(result.GetProperty("lastTrainedDateTime").ToString()); Console.WriteLine(result.GetProperty("lastDeployedDateTime").ToString()); Console.WriteLine(result.GetProperty("deploymentExpirationDate").ToString()); Console.WriteLine(result.GetProperty("modelTrainingConfigVersion").ToString()); } ]]></code></example> </Docs> </Member> <Member MemberName="GetDeploymentsAsync"> <MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetDeploymentsAsync (string projectName, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetDeploymentsAsync(string projectName, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetDeploymentsAsync(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetDeploymentsAsync (projectName As String, Optional context As RequestContext = Nothing) As AsyncPageable(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member GetDeploymentsAsync : string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetDeploymentsAsync : string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="conversationAuthoringClient.GetDeploymentsAsync (projectName, 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.AsyncPageable<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </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] Lists the deployments belonging to a project. <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.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns> <remarks> Additional information can be found in the service REST API documentation: https://learn.microsoft.com/rest/api/language/2023-04-01/conversational-analysis-authoring/list-deployments </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetDeploymentsAsync with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); await foreach (var item in client.GetDeploymentsAsync("<projectName>")) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("deploymentName").ToString()); Console.WriteLine(result.GetProperty("modelId").ToString()); Console.WriteLine(result.GetProperty("lastTrainedDateTime").ToString()); Console.WriteLine(result.GetProperty("lastDeployedDateTime").ToString()); Console.WriteLine(result.GetProperty("deploymentExpirationDate").ToString()); Console.WriteLine(result.GetProperty("modelTrainingConfigVersion").ToString()); } ]]></code></example> </Docs> </Member> <Member MemberName="GetExportProjectJobStatus"> <MemberSignature Language="C#" Value="public virtual Azure.Response GetExportProjectJobStatus (string projectName, string jobId, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetExportProjectJobStatus(string projectName, string jobId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetExportProjectJobStatus(System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetExportProjectJobStatus (projectName As String, jobId As String, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member GetExportProjectJobStatus : string * string * Azure.RequestContext -> Azure.Response
override this.GetExportProjectJobStatus : string * string * Azure.RequestContext -> Azure.Response" Usage="conversationAuthoringClient.GetExportProjectJobStatus (projectName, 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.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="jobId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </param> <param name="jobId"> The job ID. </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] Gets the status of an export job. Once job completes, returns the project metadata, and assets. <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 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/conversational-analysis-authoring/get-export-status </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="jobId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> or <paramref name="jobId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetExportProjectJobStatus with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); Response response = client.GetExportProjectJobStatus("<projectName>", "<jobId>"); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("resultUrl").ToString()); Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> <Member MemberName="GetExportProjectJobStatusAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetExportProjectJobStatusAsync (string projectName, string jobId, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetExportProjectJobStatusAsync(string projectName, string jobId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetExportProjectJobStatusAsync(System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetExportProjectJobStatusAsync (projectName As String, jobId As String, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member GetExportProjectJobStatusAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetExportProjectJobStatusAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="conversationAuthoringClient.GetExportProjectJobStatusAsync (projectName, 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.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="jobId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </param> <param name="jobId"> The job ID. </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] Gets the status of an export job. Once job completes, returns the project metadata, and assets. <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 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/conversational-analysis-authoring/get-export-status </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="jobId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> or <paramref name="jobId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetExportProjectJobStatusAsync with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); Response response = await client.GetExportProjectJobStatusAsync("<projectName>", "<jobId>"); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("resultUrl").ToString()); Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> <Member MemberName="GetImportProjectJobStatus"> <MemberSignature Language="C#" Value="public virtual Azure.Response GetImportProjectJobStatus (string projectName, string jobId, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetImportProjectJobStatus(string projectName, string jobId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetImportProjectJobStatus(System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetImportProjectJobStatus (projectName As String, jobId As String, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member GetImportProjectJobStatus : string * string * Azure.RequestContext -> Azure.Response
override this.GetImportProjectJobStatus : string * string * Azure.RequestContext -> Azure.Response" Usage="conversationAuthoringClient.GetImportProjectJobStatus (projectName, 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.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="jobId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </param> <param name="jobId"> The job ID. </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] Gets the status for an import. <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 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/conversational-analysis-authoring/get-import-status </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="jobId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> or <paramref name="jobId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetImportProjectJobStatus with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); Response response = client.GetImportProjectJobStatus("<projectName>", "<jobId>"); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> <Member MemberName="GetImportProjectJobStatusAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetImportProjectJobStatusAsync (string projectName, string jobId, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetImportProjectJobStatusAsync(string projectName, string jobId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetImportProjectJobStatusAsync(System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetImportProjectJobStatusAsync (projectName As String, jobId As String, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member GetImportProjectJobStatusAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetImportProjectJobStatusAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="conversationAuthoringClient.GetImportProjectJobStatusAsync (projectName, 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.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="jobId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </param> <param name="jobId"> The job ID. </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] Gets the status for an import. <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 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/conversational-analysis-authoring/get-import-status </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="jobId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> or <paramref name="jobId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetImportProjectJobStatusAsync with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); Response response = await client.GetImportProjectJobStatusAsync("<projectName>", "<jobId>"); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> <Member MemberName="GetLoadSnapshotJobStatus"> <MemberSignature Language="C#" Value="public virtual Azure.Response GetLoadSnapshotJobStatus (string projectName, string trainedModelLabel, string jobId, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetLoadSnapshotJobStatus(string projectName, string trainedModelLabel, string jobId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetLoadSnapshotJobStatus(System.String,System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetLoadSnapshotJobStatus (projectName As String, trainedModelLabel As String, jobId As String, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member GetLoadSnapshotJobStatus : string * string * string * Azure.RequestContext -> Azure.Response
override this.GetLoadSnapshotJobStatus : string * string * string * Azure.RequestContext -> Azure.Response" Usage="conversationAuthoringClient.GetLoadSnapshotJobStatus (projectName, trainedModelLabel, 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.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="trainedModelLabel" Type="System.String" /> <Parameter Name="jobId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </param> <param name="trainedModelLabel"> The trained model label. </param> <param name="jobId"> The job ID. </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] Gets the status for loading a snapshot. <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 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/conversational-analysis-authoring/get-load-snapshot-status </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" />, <paramref name="trainedModelLabel" /> or <paramref name="jobId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" />, <paramref name="trainedModelLabel" /> or <paramref name="jobId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetLoadSnapshotJobStatus with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); Response response = client.GetLoadSnapshotJobStatus("<projectName>", "<trainedModelLabel>", "<jobId>"); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> <Member MemberName="GetLoadSnapshotJobStatusAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetLoadSnapshotJobStatusAsync (string projectName, string trainedModelLabel, string jobId, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetLoadSnapshotJobStatusAsync(string projectName, string trainedModelLabel, string jobId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetLoadSnapshotJobStatusAsync(System.String,System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetLoadSnapshotJobStatusAsync (projectName As String, trainedModelLabel As String, jobId As String, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member GetLoadSnapshotJobStatusAsync : string * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetLoadSnapshotJobStatusAsync : string * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="conversationAuthoringClient.GetLoadSnapshotJobStatusAsync (projectName, trainedModelLabel, 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.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="trainedModelLabel" Type="System.String" /> <Parameter Name="jobId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </param> <param name="trainedModelLabel"> The trained model label. </param> <param name="jobId"> The job ID. </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] Gets the status for loading a snapshot. <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 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/conversational-analysis-authoring/get-load-snapshot-status </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" />, <paramref name="trainedModelLabel" /> or <paramref name="jobId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" />, <paramref name="trainedModelLabel" /> or <paramref name="jobId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetLoadSnapshotJobStatusAsync with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); Response response = await client.GetLoadSnapshotJobStatusAsync("<projectName>", "<trainedModelLabel>", "<jobId>"); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> <Member MemberName="GetModelEvaluationResults"> <MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetModelEvaluationResults (string projectName, string trainedModelLabel, string stringIndexType = "Utf16CodeUnit", Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetModelEvaluationResults(string projectName, string trainedModelLabel, string stringIndexType, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetModelEvaluationResults(System.String,System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetModelEvaluationResults (projectName As String, trainedModelLabel As String, Optional stringIndexType As String = "Utf16CodeUnit", Optional context As RequestContext = Nothing) As Pageable(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member GetModelEvaluationResults : string * string * string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetModelEvaluationResults : string * string * string * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="conversationAuthoringClient.GetModelEvaluationResults (projectName, trainedModelLabel, stringIndexType, 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.Pageable<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="trainedModelLabel" Type="System.String" /> <Parameter Name="stringIndexType" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </param> <param name="trainedModelLabel"> The trained model label. </param> <param name="stringIndexType"> Specifies the method used to interpret string offsets. Set this to "Utf16CodeUnit" for .NET strings, which are encoded as UTF-16. Allowed values: "Utf16CodeUnit". </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] Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process. <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.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns> <remarks> Additional information can be found in the service REST API documentation: https://learn.microsoft.com/rest/api/language/2023-04-01/conversational-analysis-authoring/get-model-evaluation-results </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" />, <paramref name="trainedModelLabel" /> or <paramref name="stringIndexType" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> or <paramref name="trainedModelLabel" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetModelEvaluationResults with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); foreach (var item in client.GetModelEvaluationResults("<projectName>", "<trainedModelLabel>")) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("text").ToString()); Console.WriteLine(result.GetProperty("language").ToString()); Console.WriteLine(result.GetProperty("entitiesResult").GetProperty("expectedEntities")[0].GetProperty("category").ToString()); Console.WriteLine(result.GetProperty("entitiesResult").GetProperty("expectedEntities")[0].GetProperty("offset").ToString()); Console.WriteLine(result.GetProperty("entitiesResult").GetProperty("expectedEntities")[0].GetProperty("length").ToString()); Console.WriteLine(result.GetProperty("entitiesResult").GetProperty("predictedEntities")[0].GetProperty("category").ToString()); Console.WriteLine(result.GetProperty("entitiesResult").GetProperty("predictedEntities")[0].GetProperty("offset").ToString()); Console.WriteLine(result.GetProperty("entitiesResult").GetProperty("predictedEntities")[0].GetProperty("length").ToString()); Console.WriteLine(result.GetProperty("intentsResult").GetProperty("expectedIntent").ToString()); Console.WriteLine(result.GetProperty("intentsResult").GetProperty("predictedIntent").ToString()); } ]]></code> This sample shows how to call GetModelEvaluationResults with all parameters, 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 ConversationAuthoringClient(endpoint, credential); foreach (var item in client.GetModelEvaluationResults("<projectName>", "<trainedModelLabel>", "Utf16CodeUnit")) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("text").ToString()); Console.WriteLine(result.GetProperty("language").ToString()); Console.WriteLine(result.GetProperty("entitiesResult").GetProperty("expectedEntities")[0].GetProperty("category").ToString()); Console.WriteLine(result.GetProperty("entitiesResult").GetProperty("expectedEntities")[0].GetProperty("offset").ToString()); Console.WriteLine(result.GetProperty("entitiesResult").GetProperty("expectedEntities")[0].GetProperty("length").ToString()); Console.WriteLine(result.GetProperty("entitiesResult").GetProperty("predictedEntities")[0].GetProperty("category").ToString()); Console.WriteLine(result.GetProperty("entitiesResult").GetProperty("predictedEntities")[0].GetProperty("offset").ToString()); Console.WriteLine(result.GetProperty("entitiesResult").GetProperty("predictedEntities")[0].GetProperty("length").ToString()); Console.WriteLine(result.GetProperty("intentsResult").GetProperty("expectedIntent").ToString()); Console.WriteLine(result.GetProperty("intentsResult").GetProperty("predictedIntent").ToString()); } ]]></code></example> </Docs> </Member> <Member MemberName="GetModelEvaluationResultsAsync"> <MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetModelEvaluationResultsAsync (string projectName, string trainedModelLabel, string stringIndexType = "Utf16CodeUnit", Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetModelEvaluationResultsAsync(string projectName, string trainedModelLabel, string stringIndexType, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetModelEvaluationResultsAsync(System.String,System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetModelEvaluationResultsAsync (projectName As String, trainedModelLabel As String, Optional stringIndexType As String = "Utf16CodeUnit", Optional context As RequestContext = Nothing) As AsyncPageable(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member GetModelEvaluationResultsAsync : string * string * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetModelEvaluationResultsAsync : string * string * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="conversationAuthoringClient.GetModelEvaluationResultsAsync (projectName, trainedModelLabel, stringIndexType, 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.AsyncPageable<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="trainedModelLabel" Type="System.String" /> <Parameter Name="stringIndexType" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </param> <param name="trainedModelLabel"> The trained model label. </param> <param name="stringIndexType"> Specifies the method used to interpret string offsets. Set this to "Utf16CodeUnit" for .NET strings, which are encoded as UTF-16. Allowed values: "Utf16CodeUnit". </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] Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process. <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.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns> <remarks> Additional information can be found in the service REST API documentation: https://learn.microsoft.com/rest/api/language/2023-04-01/conversational-analysis-authoring/get-model-evaluation-results </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" />, <paramref name="trainedModelLabel" /> or <paramref name="stringIndexType" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> or <paramref name="trainedModelLabel" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetModelEvaluationResultsAsync with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); await foreach (var item in client.GetModelEvaluationResultsAsync("<projectName>", "<trainedModelLabel>")) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("text").ToString()); Console.WriteLine(result.GetProperty("language").ToString()); Console.WriteLine(result.GetProperty("entitiesResult").GetProperty("expectedEntities")[0].GetProperty("category").ToString()); Console.WriteLine(result.GetProperty("entitiesResult").GetProperty("expectedEntities")[0].GetProperty("offset").ToString()); Console.WriteLine(result.GetProperty("entitiesResult").GetProperty("expectedEntities")[0].GetProperty("length").ToString()); Console.WriteLine(result.GetProperty("entitiesResult").GetProperty("predictedEntities")[0].GetProperty("category").ToString()); Console.WriteLine(result.GetProperty("entitiesResult").GetProperty("predictedEntities")[0].GetProperty("offset").ToString()); Console.WriteLine(result.GetProperty("entitiesResult").GetProperty("predictedEntities")[0].GetProperty("length").ToString()); Console.WriteLine(result.GetProperty("intentsResult").GetProperty("expectedIntent").ToString()); Console.WriteLine(result.GetProperty("intentsResult").GetProperty("predictedIntent").ToString()); } ]]></code> This sample shows how to call GetModelEvaluationResultsAsync with all parameters, 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 ConversationAuthoringClient(endpoint, credential); await foreach (var item in client.GetModelEvaluationResultsAsync("<projectName>", "<trainedModelLabel>", "Utf16CodeUnit")) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("text").ToString()); Console.WriteLine(result.GetProperty("language").ToString()); Console.WriteLine(result.GetProperty("entitiesResult").GetProperty("expectedEntities")[0].GetProperty("category").ToString()); Console.WriteLine(result.GetProperty("entitiesResult").GetProperty("expectedEntities")[0].GetProperty("offset").ToString()); Console.WriteLine(result.GetProperty("entitiesResult").GetProperty("expectedEntities")[0].GetProperty("length").ToString()); Console.WriteLine(result.GetProperty("entitiesResult").GetProperty("predictedEntities")[0].GetProperty("category").ToString()); Console.WriteLine(result.GetProperty("entitiesResult").GetProperty("predictedEntities")[0].GetProperty("offset").ToString()); Console.WriteLine(result.GetProperty("entitiesResult").GetProperty("predictedEntities")[0].GetProperty("length").ToString()); Console.WriteLine(result.GetProperty("intentsResult").GetProperty("expectedIntent").ToString()); Console.WriteLine(result.GetProperty("intentsResult").GetProperty("predictedIntent").ToString()); } ]]></code></example> </Docs> </Member> <Member MemberName="GetModelEvaluationSummary"> <MemberSignature Language="C#" Value="public virtual Azure.Response GetModelEvaluationSummary (string projectName, string trainedModelLabel, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetModelEvaluationSummary(string projectName, string trainedModelLabel, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetModelEvaluationSummary(System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetModelEvaluationSummary (projectName As String, trainedModelLabel As String, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member GetModelEvaluationSummary : string * string * Azure.RequestContext -> Azure.Response
override this.GetModelEvaluationSummary : string * string * Azure.RequestContext -> Azure.Response" Usage="conversationAuthoringClient.GetModelEvaluationSummary (projectName, trainedModelLabel, 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="projectName" Type="System.String" /> <Parameter Name="trainedModelLabel" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </param> <param name="trainedModelLabel"> The trained model label. </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] Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc. <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 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/conversational-analysis-authoring/get-model-evaluation-summary </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="trainedModelLabel" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> or <paramref name="trainedModelLabel" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetModelEvaluationSummary with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); Response response = client.GetModelEvaluationSummary("<projectName>", "<trainedModelLabel>"); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("confusionMatrix").GetProperty("<test>").GetProperty("<test>").GetProperty("normalizedValue").ToString()); Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("confusionMatrix").GetProperty("<test>").GetProperty("<test>").GetProperty("rawValue").ToString()); Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("entities").GetProperty("<test>").GetProperty("f1").ToString()); Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("entities").GetProperty("<test>").GetProperty("precision").ToString()); Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("entities").GetProperty("<test>").GetProperty("recall").ToString()); Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("entities").GetProperty("<test>").GetProperty("truePositiveCount").ToString()); Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("entities").GetProperty("<test>").GetProperty("trueNegativeCount").ToString()); Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("entities").GetProperty("<test>").GetProperty("falsePositiveCount").ToString()); Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("entities").GetProperty("<test>").GetProperty("falseNegativeCount").ToString()); Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("microF1").ToString()); Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("microPrecision").ToString()); Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("microRecall").ToString()); Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("macroF1").ToString()); Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("macroPrecision").ToString()); Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("macroRecall").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("confusionMatrix").GetProperty("<test>").GetProperty("<test>").GetProperty("normalizedValue").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("confusionMatrix").GetProperty("<test>").GetProperty("<test>").GetProperty("rawValue").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("intents").GetProperty("<test>").GetProperty("f1").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("intents").GetProperty("<test>").GetProperty("precision").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("intents").GetProperty("<test>").GetProperty("recall").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("intents").GetProperty("<test>").GetProperty("truePositiveCount").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("intents").GetProperty("<test>").GetProperty("trueNegativeCount").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("intents").GetProperty("<test>").GetProperty("falsePositiveCount").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("intents").GetProperty("<test>").GetProperty("falseNegativeCount").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("microF1").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("microPrecision").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("microRecall").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("macroF1").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("macroPrecision").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("macroRecall").ToString()); Console.WriteLine(result.GetProperty("evaluationOptions").GetProperty("kind").ToString()); Console.WriteLine(result.GetProperty("evaluationOptions").GetProperty("trainingSplitPercentage").ToString()); Console.WriteLine(result.GetProperty("evaluationOptions").GetProperty("testingSplitPercentage").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetModelEvaluationSummaryAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetModelEvaluationSummaryAsync (string projectName, string trainedModelLabel, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetModelEvaluationSummaryAsync(string projectName, string trainedModelLabel, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetModelEvaluationSummaryAsync(System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetModelEvaluationSummaryAsync (projectName As String, trainedModelLabel As String, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member GetModelEvaluationSummaryAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetModelEvaluationSummaryAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="conversationAuthoringClient.GetModelEvaluationSummaryAsync (projectName, trainedModelLabel, 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="projectName" Type="System.String" /> <Parameter Name="trainedModelLabel" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </param> <param name="trainedModelLabel"> The trained model label. </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] Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc. <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 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/conversational-analysis-authoring/get-model-evaluation-summary </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="trainedModelLabel" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> or <paramref name="trainedModelLabel" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetModelEvaluationSummaryAsync with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); Response response = await client.GetModelEvaluationSummaryAsync("<projectName>", "<trainedModelLabel>"); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("confusionMatrix").GetProperty("<test>").GetProperty("<test>").GetProperty("normalizedValue").ToString()); Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("confusionMatrix").GetProperty("<test>").GetProperty("<test>").GetProperty("rawValue").ToString()); Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("entities").GetProperty("<test>").GetProperty("f1").ToString()); Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("entities").GetProperty("<test>").GetProperty("precision").ToString()); Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("entities").GetProperty("<test>").GetProperty("recall").ToString()); Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("entities").GetProperty("<test>").GetProperty("truePositiveCount").ToString()); Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("entities").GetProperty("<test>").GetProperty("trueNegativeCount").ToString()); Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("entities").GetProperty("<test>").GetProperty("falsePositiveCount").ToString()); Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("entities").GetProperty("<test>").GetProperty("falseNegativeCount").ToString()); Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("microF1").ToString()); Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("microPrecision").ToString()); Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("microRecall").ToString()); Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("macroF1").ToString()); Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("macroPrecision").ToString()); Console.WriteLine(result.GetProperty("entitiesEvaluation").GetProperty("macroRecall").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("confusionMatrix").GetProperty("<test>").GetProperty("<test>").GetProperty("normalizedValue").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("confusionMatrix").GetProperty("<test>").GetProperty("<test>").GetProperty("rawValue").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("intents").GetProperty("<test>").GetProperty("f1").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("intents").GetProperty("<test>").GetProperty("precision").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("intents").GetProperty("<test>").GetProperty("recall").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("intents").GetProperty("<test>").GetProperty("truePositiveCount").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("intents").GetProperty("<test>").GetProperty("trueNegativeCount").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("intents").GetProperty("<test>").GetProperty("falsePositiveCount").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("intents").GetProperty("<test>").GetProperty("falseNegativeCount").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("microF1").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("microPrecision").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("microRecall").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("macroF1").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("macroPrecision").ToString()); Console.WriteLine(result.GetProperty("intentsEvaluation").GetProperty("macroRecall").ToString()); Console.WriteLine(result.GetProperty("evaluationOptions").GetProperty("kind").ToString()); Console.WriteLine(result.GetProperty("evaluationOptions").GetProperty("trainingSplitPercentage").ToString()); Console.WriteLine(result.GetProperty("evaluationOptions").GetProperty("testingSplitPercentage").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetProject"> <MemberSignature Language="C#" Value="public virtual Azure.Response GetProject (string projectName, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetProject(string projectName, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetProject(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetProject (projectName As String, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member GetProject : string * Azure.RequestContext -> Azure.Response
override this.GetProject : string * Azure.RequestContext -> Azure.Response" Usage="conversationAuthoringClient.GetProject (projectName, 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="projectName" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </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] Gets the details of the projects. </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/conversational-analysis-authoring/get-project </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetProject with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); Response response = client.GetProject("<projectName>"); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastModifiedDateTime").ToString()); Console.WriteLine(result.GetProperty("lastTrainedDateTime").ToString()); Console.WriteLine(result.GetProperty("lastDeployedDateTime").ToString()); Console.WriteLine(result.GetProperty("projectKind").ToString()); Console.WriteLine(result.GetProperty("settings").GetProperty("confidenceThreshold").ToString()); Console.WriteLine(result.GetProperty("projectName").ToString()); Console.WriteLine(result.GetProperty("multilingual").ToString()); Console.WriteLine(result.GetProperty("description").ToString()); Console.WriteLine(result.GetProperty("language").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetProjectAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetProjectAsync (string projectName, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetProjectAsync(string projectName, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetProjectAsync(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetProjectAsync (projectName As String, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member GetProjectAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetProjectAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="conversationAuthoringClient.GetProjectAsync (projectName, 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="projectName" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </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] Gets the details of the projects. </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/conversational-analysis-authoring/get-project </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetProjectAsync with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); Response response = await client.GetProjectAsync("<projectName>"); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastModifiedDateTime").ToString()); Console.WriteLine(result.GetProperty("lastTrainedDateTime").ToString()); Console.WriteLine(result.GetProperty("lastDeployedDateTime").ToString()); Console.WriteLine(result.GetProperty("projectKind").ToString()); Console.WriteLine(result.GetProperty("settings").GetProperty("confidenceThreshold").ToString()); Console.WriteLine(result.GetProperty("projectName").ToString()); Console.WriteLine(result.GetProperty("multilingual").ToString()); Console.WriteLine(result.GetProperty("description").ToString()); Console.WriteLine(result.GetProperty("language").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetProjectDeletionJobStatus"> <MemberSignature Language="C#" Value="public virtual Azure.Response GetProjectDeletionJobStatus (string jobId, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetProjectDeletionJobStatus(string jobId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetProjectDeletionJobStatus(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetProjectDeletionJobStatus (jobId As String, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member GetProjectDeletionJobStatus : string * Azure.RequestContext -> Azure.Response
override this.GetProjectDeletionJobStatus : string * Azure.RequestContext -> Azure.Response" Usage="conversationAuthoringClient.GetProjectDeletionJobStatus (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.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="jobId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="jobId"> The job ID. </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] Gets the status for a project deletion 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 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/conversational-analysis-authoring/get-project-deletion-status </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="jobId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="jobId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetProjectDeletionJobStatus with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); Response response = client.GetProjectDeletionJobStatus("<jobId>"); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> <Member MemberName="GetProjectDeletionJobStatusAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetProjectDeletionJobStatusAsync (string jobId, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetProjectDeletionJobStatusAsync(string jobId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetProjectDeletionJobStatusAsync(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetProjectDeletionJobStatusAsync (jobId As String, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member GetProjectDeletionJobStatusAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetProjectDeletionJobStatusAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="conversationAuthoringClient.GetProjectDeletionJobStatusAsync (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.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="jobId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="jobId"> The job ID. </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] Gets the status for a project deletion 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 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/conversational-analysis-authoring/get-project-deletion-status </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="jobId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="jobId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetProjectDeletionJobStatusAsync with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); Response response = await client.GetProjectDeletionJobStatusAsync("<jobId>"); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> <Member MemberName="GetProjects"> <MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetProjects (Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetProjects(class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetProjects(Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetProjects (Optional context As RequestContext = Nothing) As Pageable(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member GetProjects : Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetProjects : Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="conversationAuthoringClient.GetProjects 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.Pageable<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Lists the existing projects. <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.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns> <remarks> Additional information can be found in the service REST API documentation: https://learn.microsoft.com/rest/api/language/2023-04-01/conversational-analysis-authoring/list-projects </remarks> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetProjects and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); foreach (var item in client.GetProjects()) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastModifiedDateTime").ToString()); Console.WriteLine(result.GetProperty("lastTrainedDateTime").ToString()); Console.WriteLine(result.GetProperty("lastDeployedDateTime").ToString()); Console.WriteLine(result.GetProperty("projectKind").ToString()); Console.WriteLine(result.GetProperty("settings").GetProperty("confidenceThreshold").ToString()); Console.WriteLine(result.GetProperty("projectName").ToString()); Console.WriteLine(result.GetProperty("multilingual").ToString()); Console.WriteLine(result.GetProperty("description").ToString()); Console.WriteLine(result.GetProperty("language").ToString()); } ]]></code></example> </Docs> </Member> <Member MemberName="GetProjectsAsync"> <MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetProjectsAsync (Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetProjectsAsync(class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetProjectsAsync(Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetProjectsAsync (Optional context As RequestContext = Nothing) As AsyncPageable(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member GetProjectsAsync : Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetProjectsAsync : Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="conversationAuthoringClient.GetProjectsAsync 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.AsyncPageable<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param> <summary> [Protocol Method] Lists the existing projects. <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.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns> <remarks> Additional information can be found in the service REST API documentation: https://learn.microsoft.com/rest/api/language/2023-04-01/conversational-analysis-authoring/list-projects </remarks> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetProjectsAsync and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); await foreach (var item in client.GetProjectsAsync()) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastModifiedDateTime").ToString()); Console.WriteLine(result.GetProperty("lastTrainedDateTime").ToString()); Console.WriteLine(result.GetProperty("lastDeployedDateTime").ToString()); Console.WriteLine(result.GetProperty("projectKind").ToString()); Console.WriteLine(result.GetProperty("settings").GetProperty("confidenceThreshold").ToString()); Console.WriteLine(result.GetProperty("projectName").ToString()); Console.WriteLine(result.GetProperty("multilingual").ToString()); Console.WriteLine(result.GetProperty("description").ToString()); Console.WriteLine(result.GetProperty("language").ToString()); } ]]></code></example> </Docs> </Member> <Member MemberName="GetSupportedLanguages"> <MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetSupportedLanguages (string projectKind, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetSupportedLanguages(string projectKind, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetSupportedLanguages(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetSupportedLanguages (projectKind As String, Optional context As RequestContext = Nothing) As Pageable(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member GetSupportedLanguages : string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetSupportedLanguages : string * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="conversationAuthoringClient.GetSupportedLanguages (projectKind, 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.Pageable<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="projectKind" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectKind"> The project kind. Allowed values: "Conversation" | "Orchestration". </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] Lists the supported languages for the given project type. <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.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns> <remarks> Additional information can be found in the service REST API documentation: https://learn.microsoft.com/rest/api/language/2023-04-01/conversational-analysis-authoring/get-supported-languages </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectKind" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetSupportedLanguages with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); foreach (var item in client.GetSupportedLanguages("<projectKind>")) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("languageName").ToString()); Console.WriteLine(result.GetProperty("languageCode").ToString()); } ]]></code></example> </Docs> </Member> <Member MemberName="GetSupportedLanguagesAsync"> <MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetSupportedLanguagesAsync (string projectKind, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetSupportedLanguagesAsync(string projectKind, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetSupportedLanguagesAsync(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetSupportedLanguagesAsync (projectKind As String, Optional context As RequestContext = Nothing) As AsyncPageable(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member GetSupportedLanguagesAsync : string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetSupportedLanguagesAsync : string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="conversationAuthoringClient.GetSupportedLanguagesAsync (projectKind, 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.AsyncPageable<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="projectKind" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectKind"> The project kind. Allowed values: "Conversation" | "Orchestration". </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] Lists the supported languages for the given project type. <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.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns> <remarks> Additional information can be found in the service REST API documentation: https://learn.microsoft.com/rest/api/language/2023-04-01/conversational-analysis-authoring/get-supported-languages </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectKind" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetSupportedLanguagesAsync with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); await foreach (var item in client.GetSupportedLanguagesAsync("<projectKind>")) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("languageName").ToString()); Console.WriteLine(result.GetProperty("languageCode").ToString()); } ]]></code></example> </Docs> </Member> <Member MemberName="GetSupportedPrebuiltEntities"> <MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetSupportedPrebuiltEntities (string language = default, bool? multilingual = default, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetSupportedPrebuiltEntities(string language, valuetype System.Nullable`1<bool> multilingual, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetSupportedPrebuiltEntities(System.String,System.Nullable{System.Boolean},Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetSupportedPrebuiltEntities (Optional language As String = Nothing, Optional multilingual As Nullable(Of Boolean) = Nothing, Optional context As RequestContext = Nothing) As Pageable(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member GetSupportedPrebuiltEntities : string * Nullable<bool> * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetSupportedPrebuiltEntities : string * Nullable<bool> * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="conversationAuthoringClient.GetSupportedPrebuiltEntities (language, multilingual, 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.Pageable<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="language" Type="System.String" /> <Parameter Name="multilingual" Type="System.Nullable<System.Boolean>" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="language"> The language to get supported prebuilt entities for. Required if multilingual is false. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. </param> <param name="multilingual"> Whether to get the support prebuilt entities for multilingual or monolingual projects. If true, the language parameter is ignored. </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] Lists the supported prebuilt entities that can be used while creating composed entities. <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.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns> <remarks> Additional information can be found in the service REST API documentation: https://learn.microsoft.com/rest/api/language/2023-04-01/conversational-analysis-authoring/get-supported-prebuilt-entities </remarks> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetSupportedPrebuiltEntities and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); foreach (var item in client.GetSupportedPrebuiltEntities()) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("category").ToString()); Console.WriteLine(result.GetProperty("description").ToString()); Console.WriteLine(result.GetProperty("examples").ToString()); } ]]></code> This sample shows how to call GetSupportedPrebuiltEntities with all parameters, 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 ConversationAuthoringClient(endpoint, credential); foreach (var item in client.GetSupportedPrebuiltEntities("<language>", true)) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("category").ToString()); Console.WriteLine(result.GetProperty("description").ToString()); Console.WriteLine(result.GetProperty("examples").ToString()); } ]]></code></example> </Docs> </Member> <Member MemberName="GetSupportedPrebuiltEntitiesAsync"> <MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetSupportedPrebuiltEntitiesAsync (string language = default, bool? multilingual = default, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetSupportedPrebuiltEntitiesAsync(string language, valuetype System.Nullable`1<bool> multilingual, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetSupportedPrebuiltEntitiesAsync(System.String,System.Nullable{System.Boolean},Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetSupportedPrebuiltEntitiesAsync (Optional language As String = Nothing, Optional multilingual As Nullable(Of Boolean) = Nothing, Optional context As RequestContext = Nothing) As AsyncPageable(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member GetSupportedPrebuiltEntitiesAsync : string * Nullable<bool> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetSupportedPrebuiltEntitiesAsync : string * Nullable<bool> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="conversationAuthoringClient.GetSupportedPrebuiltEntitiesAsync (language, multilingual, 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.AsyncPageable<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="language" Type="System.String" /> <Parameter Name="multilingual" Type="System.Nullable<System.Boolean>" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="language"> The language to get supported prebuilt entities for. Required if multilingual is false. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. </param> <param name="multilingual"> Whether to get the support prebuilt entities for multilingual or monolingual projects. If true, the language parameter is ignored. </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] Lists the supported prebuilt entities that can be used while creating composed entities. <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.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns> <remarks> Additional information can be found in the service REST API documentation: https://learn.microsoft.com/rest/api/language/2023-04-01/conversational-analysis-authoring/get-supported-prebuilt-entities </remarks> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetSupportedPrebuiltEntitiesAsync and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); await foreach (var item in client.GetSupportedPrebuiltEntitiesAsync()) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("category").ToString()); Console.WriteLine(result.GetProperty("description").ToString()); Console.WriteLine(result.GetProperty("examples").ToString()); } ]]></code> This sample shows how to call GetSupportedPrebuiltEntitiesAsync with all parameters, 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 ConversationAuthoringClient(endpoint, credential); await foreach (var item in client.GetSupportedPrebuiltEntitiesAsync("<language>", true)) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("category").ToString()); Console.WriteLine(result.GetProperty("description").ToString()); Console.WriteLine(result.GetProperty("examples").ToString()); } ]]></code></example> </Docs> </Member> <Member MemberName="GetSwapDeploymentsJobStatus"> <MemberSignature Language="C#" Value="public virtual Azure.Response GetSwapDeploymentsJobStatus (string projectName, string jobId, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetSwapDeploymentsJobStatus(string projectName, string jobId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetSwapDeploymentsJobStatus(System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetSwapDeploymentsJobStatus (projectName As String, jobId As String, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member GetSwapDeploymentsJobStatus : string * string * Azure.RequestContext -> Azure.Response
override this.GetSwapDeploymentsJobStatus : string * string * Azure.RequestContext -> Azure.Response" Usage="conversationAuthoringClient.GetSwapDeploymentsJobStatus (projectName, 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.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="jobId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </param> <param name="jobId"> The job ID. </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] Gets the status of an existing swap deployment 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 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/conversational-analysis-authoring/get-swap-deployments-status </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="jobId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> or <paramref name="jobId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetSwapDeploymentsJobStatus with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); Response response = client.GetSwapDeploymentsJobStatus("<projectName>", "<jobId>"); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> <Member MemberName="GetSwapDeploymentsJobStatusAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetSwapDeploymentsJobStatusAsync (string projectName, string jobId, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetSwapDeploymentsJobStatusAsync(string projectName, string jobId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetSwapDeploymentsJobStatusAsync(System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetSwapDeploymentsJobStatusAsync (projectName As String, jobId As String, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member GetSwapDeploymentsJobStatusAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetSwapDeploymentsJobStatusAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="conversationAuthoringClient.GetSwapDeploymentsJobStatusAsync (projectName, 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.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="jobId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </param> <param name="jobId"> The job ID. </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] Gets the status of an existing swap deployment 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 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/conversational-analysis-authoring/get-swap-deployments-status </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="jobId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> or <paramref name="jobId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetSwapDeploymentsJobStatusAsync with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); Response response = await client.GetSwapDeploymentsJobStatusAsync("<projectName>", "<jobId>"); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> <Member MemberName="GetTrainedModel"> <MemberSignature Language="C#" Value="public virtual Azure.Response GetTrainedModel (string projectName, string trainedModelLabel, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetTrainedModel(string projectName, string trainedModelLabel, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetTrainedModel(System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTrainedModel (projectName As String, trainedModelLabel As String, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member GetTrainedModel : string * string * Azure.RequestContext -> Azure.Response
override this.GetTrainedModel : string * string * Azure.RequestContext -> Azure.Response" Usage="conversationAuthoringClient.GetTrainedModel (projectName, trainedModelLabel, 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="projectName" Type="System.String" /> <Parameter Name="trainedModelLabel" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </param> <param name="trainedModelLabel"> The trained model label. </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] Gets the details of a trained model. <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 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/conversational-analysis-authoring/get-trained-model </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="trainedModelLabel" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> or <paramref name="trainedModelLabel" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetTrainedModel with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); Response response = client.GetTrainedModel("<projectName>", "<trainedModelLabel>"); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("label").ToString()); Console.WriteLine(result.GetProperty("modelId").ToString()); Console.WriteLine(result.GetProperty("lastTrainedDateTime").ToString()); Console.WriteLine(result.GetProperty("lastTrainingDurationInSeconds").ToString()); Console.WriteLine(result.GetProperty("modelExpirationDate").ToString()); Console.WriteLine(result.GetProperty("modelTrainingConfigVersion").ToString()); Console.WriteLine(result.GetProperty("hasSnapshot").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetTrainedModelAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetTrainedModelAsync (string projectName, string trainedModelLabel, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetTrainedModelAsync(string projectName, string trainedModelLabel, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetTrainedModelAsync(System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTrainedModelAsync (projectName As String, trainedModelLabel As String, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member GetTrainedModelAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetTrainedModelAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="conversationAuthoringClient.GetTrainedModelAsync (projectName, trainedModelLabel, 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="projectName" Type="System.String" /> <Parameter Name="trainedModelLabel" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </param> <param name="trainedModelLabel"> The trained model label. </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] Gets the details of a trained model. <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 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/conversational-analysis-authoring/get-trained-model </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="trainedModelLabel" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> or <paramref name="trainedModelLabel" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetTrainedModelAsync with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); Response response = await client.GetTrainedModelAsync("<projectName>", "<trainedModelLabel>"); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("label").ToString()); Console.WriteLine(result.GetProperty("modelId").ToString()); Console.WriteLine(result.GetProperty("lastTrainedDateTime").ToString()); Console.WriteLine(result.GetProperty("lastTrainingDurationInSeconds").ToString()); Console.WriteLine(result.GetProperty("modelExpirationDate").ToString()); Console.WriteLine(result.GetProperty("modelTrainingConfigVersion").ToString()); Console.WriteLine(result.GetProperty("hasSnapshot").ToString()); ]]></code></example> </Docs> </Member> <Member MemberName="GetTrainedModels"> <MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetTrainedModels (string projectName, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetTrainedModels(string projectName, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetTrainedModels(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTrainedModels (projectName As String, Optional context As RequestContext = Nothing) As Pageable(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member GetTrainedModels : string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetTrainedModels : string * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="conversationAuthoringClient.GetTrainedModels (projectName, 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.Pageable<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </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] Lists the trained models belonging to a project. <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.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns> <remarks> Additional information can be found in the service REST API documentation: https://learn.microsoft.com/rest/api/language/2023-04-01/conversational-analysis-authoring/list-trained-models </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetTrainedModels with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); foreach (var item in client.GetTrainedModels("<projectName>")) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("label").ToString()); Console.WriteLine(result.GetProperty("modelId").ToString()); Console.WriteLine(result.GetProperty("lastTrainedDateTime").ToString()); Console.WriteLine(result.GetProperty("lastTrainingDurationInSeconds").ToString()); Console.WriteLine(result.GetProperty("modelExpirationDate").ToString()); Console.WriteLine(result.GetProperty("modelTrainingConfigVersion").ToString()); Console.WriteLine(result.GetProperty("hasSnapshot").ToString()); } ]]></code></example> </Docs> </Member> <Member MemberName="GetTrainedModelsAsync"> <MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetTrainedModelsAsync (string projectName, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetTrainedModelsAsync(string projectName, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetTrainedModelsAsync(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTrainedModelsAsync (projectName As String, Optional context As RequestContext = Nothing) As AsyncPageable(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member GetTrainedModelsAsync : string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetTrainedModelsAsync : string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="conversationAuthoringClient.GetTrainedModelsAsync (projectName, 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.AsyncPageable<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </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] Lists the trained models belonging to a project. <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.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns> <remarks> Additional information can be found in the service REST API documentation: https://learn.microsoft.com/rest/api/language/2023-04-01/conversational-analysis-authoring/list-trained-models </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetTrainedModelsAsync with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); await foreach (var item in client.GetTrainedModelsAsync("<projectName>")) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("label").ToString()); Console.WriteLine(result.GetProperty("modelId").ToString()); Console.WriteLine(result.GetProperty("lastTrainedDateTime").ToString()); Console.WriteLine(result.GetProperty("lastTrainingDurationInSeconds").ToString()); Console.WriteLine(result.GetProperty("modelExpirationDate").ToString()); Console.WriteLine(result.GetProperty("modelTrainingConfigVersion").ToString()); Console.WriteLine(result.GetProperty("hasSnapshot").ToString()); } ]]></code></example> </Docs> </Member> <Member MemberName="GetTrainingConfigVersions"> <MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetTrainingConfigVersions (string projectKind, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetTrainingConfigVersions(string projectKind, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetTrainingConfigVersions(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTrainingConfigVersions (projectKind As String, Optional context As RequestContext = Nothing) As Pageable(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member GetTrainingConfigVersions : string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetTrainingConfigVersions : string * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="conversationAuthoringClient.GetTrainingConfigVersions (projectKind, 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.Pageable<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="projectKind" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectKind"> The project kind. Allowed values: "Conversation" | "Orchestration". </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] Lists the support training config version for a given project type. <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.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns> <remarks> Additional information can be found in the service REST API documentation: https://learn.microsoft.com/rest/api/language/2023-04-01/conversational-analysis-authoring/list-training-config-versions </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectKind" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetTrainingConfigVersions with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); foreach (var item in client.GetTrainingConfigVersions("<projectKind>")) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("trainingConfigVersion").ToString()); Console.WriteLine(result.GetProperty("modelExpirationDate").ToString()); } ]]></code></example> </Docs> </Member> <Member MemberName="GetTrainingConfigVersionsAsync"> <MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetTrainingConfigVersionsAsync (string projectKind, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetTrainingConfigVersionsAsync(string projectKind, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetTrainingConfigVersionsAsync(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTrainingConfigVersionsAsync (projectKind As String, Optional context As RequestContext = Nothing) As AsyncPageable(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member GetTrainingConfigVersionsAsync : string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetTrainingConfigVersionsAsync : string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="conversationAuthoringClient.GetTrainingConfigVersionsAsync (projectKind, 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.AsyncPageable<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="projectKind" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectKind"> The project kind. Allowed values: "Conversation" | "Orchestration". </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] Lists the support training config version for a given project type. <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.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns> <remarks> Additional information can be found in the service REST API documentation: https://learn.microsoft.com/rest/api/language/2023-04-01/conversational-analysis-authoring/list-training-config-versions </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectKind" /> is null. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetTrainingConfigVersionsAsync with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); await foreach (var item in client.GetTrainingConfigVersionsAsync("<projectKind>")) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("trainingConfigVersion").ToString()); Console.WriteLine(result.GetProperty("modelExpirationDate").ToString()); } ]]></code></example> </Docs> </Member> <Member MemberName="GetTrainingJobs"> <MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetTrainingJobs (string projectName, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetTrainingJobs(string projectName, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetTrainingJobs(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTrainingJobs (projectName As String, Optional context As RequestContext = Nothing) As Pageable(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member GetTrainingJobs : string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetTrainingJobs : string * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="conversationAuthoringClient.GetTrainingJobs (projectName, 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.Pageable<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </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] Lists the non-expired training jobs created for a project. <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.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns> <remarks> Additional information can be found in the service REST API documentation: https://learn.microsoft.com/rest/api/language/2023-04-01/conversational-analysis-authoring/list-training-jobs </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetTrainingJobs with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); foreach (var item in client.GetTrainingJobs("<projectName>")) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("result").GetProperty("modelLabel").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingConfigVersion").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingMode").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("percentComplete").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("startDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("endDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("percentComplete").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("startDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("endDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("estimatedEndDateTime").ToString()); Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); } ]]></code></example> </Docs> </Member> <Member MemberName="GetTrainingJobsAsync"> <MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetTrainingJobsAsync (string projectName, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetTrainingJobsAsync(string projectName, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetTrainingJobsAsync(System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTrainingJobsAsync (projectName As String, Optional context As RequestContext = Nothing) As AsyncPageable(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member GetTrainingJobsAsync : string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetTrainingJobsAsync : string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="conversationAuthoringClient.GetTrainingJobsAsync (projectName, 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.AsyncPageable<System.BinaryData></ReturnType> </ReturnValue> <Parameters> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </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] Lists the non-expired training jobs created for a project. <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.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns> <remarks> Additional information can be found in the service REST API documentation: https://learn.microsoft.com/rest/api/language/2023-04-01/conversational-analysis-authoring/list-training-jobs </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetTrainingJobsAsync with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); await foreach (var item in client.GetTrainingJobsAsync("<projectName>")) { JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; Console.WriteLine(result.GetProperty("result").GetProperty("modelLabel").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingConfigVersion").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingMode").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("percentComplete").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("startDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("endDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("percentComplete").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("startDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("endDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("estimatedEndDateTime").ToString()); Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); } ]]></code></example> </Docs> </Member> <Member MemberName="GetTrainingJobStatus"> <MemberSignature Language="C#" Value="public virtual Azure.Response GetTrainingJobStatus (string projectName, string jobId, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetTrainingJobStatus(string projectName, string jobId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetTrainingJobStatus(System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTrainingJobStatus (projectName As String, jobId As String, Optional context As RequestContext = Nothing) As Response" /> <MemberSignature Language="F#" Value="abstract member GetTrainingJobStatus : string * string * Azure.RequestContext -> Azure.Response
override this.GetTrainingJobStatus : string * string * Azure.RequestContext -> Azure.Response" Usage="conversationAuthoringClient.GetTrainingJobStatus (projectName, 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.Response</ReturnType> </ReturnValue> <Parameters> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="jobId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </param> <param name="jobId"> The job ID. </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] Gets the status for a training 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 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/conversational-analysis-authoring/get-training-status </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="jobId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> or <paramref name="jobId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetTrainingJobStatus with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); Response response = client.GetTrainingJobStatus("<projectName>", "<jobId>"); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("result").GetProperty("modelLabel").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingConfigVersion").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingMode").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("percentComplete").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("startDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("endDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("percentComplete").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("startDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("endDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("estimatedEndDateTime").ToString()); Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> <Member MemberName="GetTrainingJobStatusAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetTrainingJobStatusAsync (string projectName, string jobId, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetTrainingJobStatusAsync(string projectName, string jobId, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.GetTrainingJobStatusAsync(System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function GetTrainingJobStatusAsync (projectName As String, jobId As String, Optional context As RequestContext = Nothing) As Task(Of Response)" /> <MemberSignature Language="F#" Value="abstract member GetTrainingJobStatusAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetTrainingJobStatusAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="conversationAuthoringClient.GetTrainingJobStatusAsync (projectName, 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.Response></ReturnType> </ReturnValue> <Parameters> <Parameter Name="projectName" Type="System.String" /> <Parameter Name="jobId" Type="System.String" /> <Parameter Name="context" Type="Azure.RequestContext" /> </Parameters> <Docs> <param name="projectName"> The name of the project to use. </param> <param name="jobId"> The job ID. </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] Gets the status for a training 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 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/conversational-analysis-authoring/get-training-status </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="jobId" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> or <paramref name="jobId" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call GetTrainingJobStatusAsync with required parameters and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); Response response = await client.GetTrainingJobStatusAsync("<projectName>", "<jobId>"); JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; Console.WriteLine(result.GetProperty("result").GetProperty("modelLabel").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingConfigVersion").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingMode").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("percentComplete").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("startDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("endDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("percentComplete").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("startDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("endDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("estimatedEndDateTime").ToString()); Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> <Member MemberName="ImportProject"> <MemberSignature Language="C#" Value="public virtual Azure.Operation<BinaryData> ImportProject (Azure.WaitUntil waitUntil, string projectName, Azure.Core.RequestContent content, string exportedProjectFormat = default, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation`1<class System.BinaryData> ImportProject(valuetype Azure.WaitUntil waitUntil, string projectName, class Azure.Core.RequestContent content, string exportedProjectFormat, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.ImportProject(Azure.WaitUntil,System.String,Azure.Core.RequestContent,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function ImportProject (waitUntil As WaitUntil, projectName As String, content As RequestContent, Optional exportedProjectFormat As String = Nothing, Optional context As RequestContext = Nothing) As Operation(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member ImportProject : Azure.WaitUntil * string * Azure.Core.RequestContent * string * Azure.RequestContext -> Azure.Operation<BinaryData>
override this.ImportProject : Azure.WaitUntil * string * Azure.Core.RequestContent * string * Azure.RequestContext -> Azure.Operation<BinaryData>" Usage="conversationAuthoringClient.ImportProject (waitUntil, projectName, content, exportedProjectFormat, 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="projectName" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="exportedProjectFormat" Type="System.String" /> <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="projectName"> The name of the project to use. </param> <param name="content"> The content to send as the body of the request. </param> <param name="exportedProjectFormat"> The format of the exported project file to use. Allowed values: "Conversation" | "Luis". </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] Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced. <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/conversational-analysis-authoring/import </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call ImportProject 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 ConversationAuthoringClient(endpoint, credential); var data = new { projectFileVersion = "<projectFileVersion>", stringIndexType = "Utf16CodeUnit", metadata = new { projectKind = "Conversation", projectName = "<projectName>", language = "<language>", }, }; var operation = client.ImportProject(WaitUntil.Completed, "<projectName>", RequestContent.Create(data)); BinaryData responseData = operation.Value; JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement; Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); ]]></code> This sample shows how to call ImportProject 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 ConversationAuthoringClient(endpoint, credential); var data = new { projectFileVersion = "<projectFileVersion>", stringIndexType = "Utf16CodeUnit", metadata = new { projectKind = "Conversation", settings = new { confidenceThreshold = 123.45f, }, projectName = "<projectName>", multilingual = true, description = "<description>", language = "<language>", }, assets = new { intents = new[] { new { category = "<category>", } }, entities = new[] { new { category = "<category>", compositionSetting = "returnLongestOverlap", list = new { sublists = new[] { new { listKey = "<listKey>", synonyms = new[] { new { language = "<language>", values = new[] { "<String>" }, } }, } }, }, prebuilts = new[] { new { category = "<category>", } }, regex = new { expressions = new[] { new { regexKey = "<regexKey>", language = "<language>", regexPattern = "<regexPattern>", } }, }, requiredComponents = new[] { "<String>" }, } }, utterances = new[] { new { entities = new[] { new { category = "<category>", offset = 1234, length = 1234, } }, text = "<text>", language = "<language>", intent = "<intent>", dataset = "<dataset>", } }, projectKind = "Conversation", }, }; var operation = client.ImportProject(WaitUntil.Completed, "<projectName>", RequestContent.Create(data), "<exportedProjectFormat>"); BinaryData responseData = operation.Value; JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement; Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> <Member MemberName="ImportProjectAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation<BinaryData>> ImportProjectAsync (Azure.WaitUntil waitUntil, string projectName, Azure.Core.RequestContent content, string exportedProjectFormat = default, 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>> ImportProjectAsync(valuetype Azure.WaitUntil waitUntil, string projectName, class Azure.Core.RequestContent content, string exportedProjectFormat, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.ImportProjectAsync(Azure.WaitUntil,System.String,Azure.Core.RequestContent,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function ImportProjectAsync (waitUntil As WaitUntil, projectName As String, content As RequestContent, Optional exportedProjectFormat As String = Nothing, Optional context As RequestContext = Nothing) As Task(Of Operation(Of BinaryData))" /> <MemberSignature Language="F#" Value="abstract member ImportProjectAsync : Azure.WaitUntil * string * Azure.Core.RequestContent * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>
override this.ImportProjectAsync : Azure.WaitUntil * string * Azure.Core.RequestContent * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>" Usage="conversationAuthoringClient.ImportProjectAsync (waitUntil, projectName, content, exportedProjectFormat, 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="projectName" Type="System.String" /> <Parameter Name="content" Type="Azure.Core.RequestContent" /> <Parameter Name="exportedProjectFormat" Type="System.String" /> <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="projectName"> The name of the project to use. </param> <param name="content"> The content to send as the body of the request. </param> <param name="exportedProjectFormat"> The format of the exported project file to use. Allowed values: "Conversation" | "Luis". </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] Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced. <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/conversational-analysis-authoring/import </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call ImportProjectAsync 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 ConversationAuthoringClient(endpoint, credential); var data = new { projectFileVersion = "<projectFileVersion>", stringIndexType = "Utf16CodeUnit", metadata = new { projectKind = "Conversation", projectName = "<projectName>", language = "<language>", }, }; var operation = await client.ImportProjectAsync(WaitUntil.Completed, "<projectName>", RequestContent.Create(data)); BinaryData responseData = operation.Value; JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement; Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); ]]></code> This sample shows how to call ImportProjectAsync 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 ConversationAuthoringClient(endpoint, credential); var data = new { projectFileVersion = "<projectFileVersion>", stringIndexType = "Utf16CodeUnit", metadata = new { projectKind = "Conversation", settings = new { confidenceThreshold = 123.45f, }, projectName = "<projectName>", multilingual = true, description = "<description>", language = "<language>", }, assets = new { intents = new[] { new { category = "<category>", } }, entities = new[] { new { category = "<category>", compositionSetting = "returnLongestOverlap", list = new { sublists = new[] { new { listKey = "<listKey>", synonyms = new[] { new { language = "<language>", values = new[] { "<String>" }, } }, } }, }, prebuilts = new[] { new { category = "<category>", } }, regex = new { expressions = new[] { new { regexKey = "<regexKey>", language = "<language>", regexPattern = "<regexPattern>", } }, }, requiredComponents = new[] { "<String>" }, } }, utterances = new[] { new { entities = new[] { new { category = "<category>", offset = 1234, length = 1234, } }, text = "<text>", language = "<language>", intent = "<intent>", dataset = "<dataset>", } }, projectKind = "Conversation", }, }; var operation = await client.ImportProjectAsync(WaitUntil.Completed, "<projectName>", RequestContent.Create(data), "<exportedProjectFormat>"); BinaryData responseData = operation.Value; JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement; Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> <Member MemberName="LoadSnapshot"> <MemberSignature Language="C#" Value="public virtual Azure.Operation LoadSnapshot (Azure.WaitUntil waitUntil, string projectName, string trainedModelLabel, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation LoadSnapshot(valuetype Azure.WaitUntil waitUntil, string projectName, string trainedModelLabel, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.LoadSnapshot(Azure.WaitUntil,System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function LoadSnapshot (waitUntil As WaitUntil, projectName As String, trainedModelLabel As String, Optional context As RequestContext = Nothing) As Operation" /> <MemberSignature Language="F#" Value="abstract member LoadSnapshot : Azure.WaitUntil * string * string * Azure.RequestContext -> Azure.Operation
override this.LoadSnapshot : Azure.WaitUntil * string * string * Azure.RequestContext -> Azure.Operation" Usage="conversationAuthoringClient.LoadSnapshot (waitUntil, projectName, trainedModelLabel, 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="projectName" Type="System.String" /> <Parameter Name="trainedModelLabel" Type="System.String" /> <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="projectName"> The name of the project to use. </param> <param name="trainedModelLabel"> The trained model label. </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] Restores the snapshot of this trained model to be the current working directory of the project. <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/conversational-analysis-authoring/load-snapshot </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="trainedModelLabel" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> or <paramref name="trainedModelLabel" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call LoadSnapshot with required parameters. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); var operation = client.LoadSnapshot(WaitUntil.Completed, "<projectName>", "<trainedModelLabel>"); Console.WriteLine(operation.GetRawResponse().Status); ]]></code></example> </Docs> </Member> <Member MemberName="LoadSnapshotAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation> LoadSnapshotAsync (Azure.WaitUntil waitUntil, string projectName, string trainedModelLabel, Azure.RequestContext context = default);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Operation> LoadSnapshotAsync(valuetype Azure.WaitUntil waitUntil, string projectName, string trainedModelLabel, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.LoadSnapshotAsync(Azure.WaitUntil,System.String,System.String,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function LoadSnapshotAsync (waitUntil As WaitUntil, projectName As String, trainedModelLabel As String, Optional context As RequestContext = Nothing) As Task(Of Operation)" /> <MemberSignature Language="F#" Value="abstract member LoadSnapshotAsync : Azure.WaitUntil * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation>
override this.LoadSnapshotAsync : Azure.WaitUntil * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation>" Usage="conversationAuthoringClient.LoadSnapshotAsync (waitUntil, projectName, trainedModelLabel, 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="projectName" Type="System.String" /> <Parameter Name="trainedModelLabel" Type="System.String" /> <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="projectName"> The name of the project to use. </param> <param name="trainedModelLabel"> The trained model label. </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] Restores the snapshot of this trained model to be the current working directory of the project. <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/conversational-analysis-authoring/load-snapshot </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="trainedModelLabel" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> or <paramref name="trainedModelLabel" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call LoadSnapshotAsync with required parameters. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); var operation = await client.LoadSnapshotAsync(WaitUntil.Completed, "<projectName>", "<trainedModelLabel>"); Console.WriteLine(operation.GetRawResponse().Status); ]]></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.Authoring.ConversationAuthoringClient.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.Authoring.ConversationAuthoringClient.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> <Member MemberName="SwapDeployments"> <MemberSignature Language="C#" Value="public virtual Azure.Operation<BinaryData> SwapDeployments (Azure.WaitUntil waitUntil, string projectName, 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> SwapDeployments(valuetype Azure.WaitUntil waitUntil, string projectName, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.SwapDeployments(Azure.WaitUntil,System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function SwapDeployments (waitUntil As WaitUntil, projectName As String, content As RequestContent, Optional context As RequestContext = Nothing) As Operation(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member SwapDeployments : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Operation<BinaryData>
override this.SwapDeployments : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Operation<BinaryData>" Usage="conversationAuthoringClient.SwapDeployments (waitUntil, projectName, 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="projectName" Type="System.String" /> <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="projectName"> The name of the project to use. </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] Swaps two existing deployments with each other. <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/conversational-analysis-authoring/swap-deployments </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call SwapDeployments with required parameters and request content and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); var data = new { firstDeploymentName = "<firstDeploymentName>", secondDeploymentName = "<secondDeploymentName>", }; var operation = client.SwapDeployments(WaitUntil.Completed, "<projectName>", RequestContent.Create(data)); BinaryData responseData = operation.Value; JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement; Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> <Member MemberName="SwapDeploymentsAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation<BinaryData>> SwapDeploymentsAsync (Azure.WaitUntil waitUntil, string projectName, 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>> SwapDeploymentsAsync(valuetype Azure.WaitUntil waitUntil, string projectName, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.SwapDeploymentsAsync(Azure.WaitUntil,System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function SwapDeploymentsAsync (waitUntil As WaitUntil, projectName As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Operation(Of BinaryData))" /> <MemberSignature Language="F#" Value="abstract member SwapDeploymentsAsync : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>
override this.SwapDeploymentsAsync : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>" Usage="conversationAuthoringClient.SwapDeploymentsAsync (waitUntil, projectName, 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="projectName" Type="System.String" /> <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="projectName"> The name of the project to use. </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] Swaps two existing deployments with each other. <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/conversational-analysis-authoring/swap-deployments </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call SwapDeploymentsAsync with required parameters and request content and parse the result. <code><![CDATA[ var credential = new AzureKeyCredential("<key>"); var endpoint = new Uri("<https://my-service.azure.com>"); var client = new ConversationAuthoringClient(endpoint, credential); var data = new { firstDeploymentName = "<firstDeploymentName>", secondDeploymentName = "<secondDeploymentName>", }; var operation = await client.SwapDeploymentsAsync(WaitUntil.Completed, "<projectName>", RequestContent.Create(data)); BinaryData responseData = operation.Value; JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement; Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> <Member MemberName="Train"> <MemberSignature Language="C#" Value="public virtual Azure.Operation<BinaryData> Train (Azure.WaitUntil waitUntil, string projectName, 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> Train(valuetype Azure.WaitUntil waitUntil, string projectName, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.Train(Azure.WaitUntil,System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function Train (waitUntil As WaitUntil, projectName As String, content As RequestContent, Optional context As RequestContext = Nothing) As Operation(Of BinaryData)" /> <MemberSignature Language="F#" Value="abstract member Train : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Operation<BinaryData>
override this.Train : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Operation<BinaryData>" Usage="conversationAuthoringClient.Train (waitUntil, projectName, 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="projectName" Type="System.String" /> <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="projectName"> The name of the project to use. </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] Triggers a training job for a project. <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/conversational-analysis-authoring/train </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call Train 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 ConversationAuthoringClient(endpoint, credential); var data = new { modelLabel = "<modelLabel>", trainingMode = "advanced", }; var operation = client.Train(WaitUntil.Completed, "<projectName>", RequestContent.Create(data)); BinaryData responseData = operation.Value; JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement; Console.WriteLine(result.GetProperty("result").GetProperty("modelLabel").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingConfigVersion").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("percentComplete").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); ]]></code> This sample shows how to call Train 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 ConversationAuthoringClient(endpoint, credential); var data = new { modelLabel = "<modelLabel>", trainingConfigVersion = "<trainingConfigVersion>", trainingMode = "advanced", evaluationOptions = new { kind = "percentage", trainingSplitPercentage = 1234, testingSplitPercentage = 1234, }, }; var operation = client.Train(WaitUntil.Completed, "<projectName>", RequestContent.Create(data)); BinaryData responseData = operation.Value; JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement; Console.WriteLine(result.GetProperty("result").GetProperty("modelLabel").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingConfigVersion").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingMode").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("percentComplete").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("startDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("endDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("percentComplete").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("startDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("endDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("estimatedEndDateTime").ToString()); Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> <Member MemberName="TrainAsync"> <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation<BinaryData>> TrainAsync (Azure.WaitUntil waitUntil, string projectName, 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>> TrainAsync(valuetype Azure.WaitUntil waitUntil, string projectName, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" /> <MemberSignature Language="DocId" Value="M:Azure.AI.Language.Conversations.Authoring.ConversationAuthoringClient.TrainAsync(Azure.WaitUntil,System.String,Azure.Core.RequestContent,Azure.RequestContext)" /> <MemberSignature Language="VB.NET" Value="Public Overridable Function TrainAsync (waitUntil As WaitUntil, projectName As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Operation(Of BinaryData))" /> <MemberSignature Language="F#" Value="abstract member TrainAsync : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>
override this.TrainAsync : Azure.WaitUntil * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>" Usage="conversationAuthoringClient.TrainAsync (waitUntil, projectName, 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="projectName" Type="System.String" /> <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="projectName"> The name of the project to use. </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] Triggers a training job for a project. <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/conversational-analysis-authoring/train </remarks> <exception cref="T:System.ArgumentNullException"> <paramref name="projectName" /> or <paramref name="content" /> is null. </exception> <exception cref="T:System.ArgumentException"> <paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception> <exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception> <example> This sample shows how to call TrainAsync 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 ConversationAuthoringClient(endpoint, credential); var data = new { modelLabel = "<modelLabel>", trainingMode = "advanced", }; var operation = await client.TrainAsync(WaitUntil.Completed, "<projectName>", RequestContent.Create(data)); BinaryData responseData = operation.Value; JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement; Console.WriteLine(result.GetProperty("result").GetProperty("modelLabel").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingConfigVersion").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("percentComplete").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); ]]></code> This sample shows how to call TrainAsync 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 ConversationAuthoringClient(endpoint, credential); var data = new { modelLabel = "<modelLabel>", trainingConfigVersion = "<trainingConfigVersion>", trainingMode = "advanced", evaluationOptions = new { kind = "percentage", trainingSplitPercentage = 1234, testingSplitPercentage = 1234, }, }; var operation = await client.TrainAsync(WaitUntil.Completed, "<projectName>", RequestContent.Create(data)); BinaryData responseData = operation.Value; JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement; Console.WriteLine(result.GetProperty("result").GetProperty("modelLabel").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingConfigVersion").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingMode").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("percentComplete").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("startDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("endDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("trainingStatus").GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("percentComplete").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("startDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("endDateTime").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("evaluationStatus").GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("result").GetProperty("estimatedEndDateTime").ToString()); Console.WriteLine(result.GetProperty("jobId").ToString()); Console.WriteLine(result.GetProperty("createdDateTime").ToString()); Console.WriteLine(result.GetProperty("lastUpdatedDateTime").ToString()); Console.WriteLine(result.GetProperty("expirationDateTime").ToString()); Console.WriteLine(result.GetProperty("status").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("code").ToString()); Console.WriteLine(result.GetProperty("warnings")[0].GetProperty("message").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()); ]]></code></example> </Docs> </Member> </Members> </Type>

xml/Azure.AI.Language.Conversations.Authoring/ConversationAuthoringClient.xml (4,868 lines of code) (raw):