ConversationAuthoringClient.ExportProject Method

Reference

Definition

Namespace:: Azure.AI.Language.Conversations.Authoring

Assembly:: Azure.AI.Language.Conversations.dll

Package:: Azure.AI.Language.Conversations v1.1.0

Source:: ConversationAuthoringClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

[Protocol Method] Triggers a job to export a project's data.

This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

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);

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>

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)

Parameters

waitUntil: WaitUntil

Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.

projectName: String

The name of the project to use.

exportedProjectFormat: String

The format of the exported project file to use. Allowed values: "Conversation" | "Luis".

assetKind: String

Kind of asset to export.

stringIndexType: String

Specifies the method used to interpret string offsets. Set this to "Utf16CodeUnit" for .NET strings, which are encoded as UTF-16. Allowed values: "Utf16CodeUnit".

trainedModelLabel: String

Trained model label to export. If the trainedModelLabel is null, the default behavior is to export the current working copy.

context: RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Operation<BinaryData>

The Operation representing an asynchronous operation on the service.

Exceptions

ArgumentNullException

projectName or stringIndexType is null.

ArgumentException

projectName is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call ExportProject with required parameters and parse the result.

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());

This sample shows how to call ExportProject with all parameters, and how to parse the result.

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());

Remarks

Additional information can be found in the service REST API documentation: https://video2.skills-academy.com/rest/api/language/2023-04-01/conversational-analysis-authoring/export

Applies to

Share via