ConversationAuthoringClient.ExportProjectAsync メソッド

定義

名前空間:

Azure.AI.Language.Conversations.Authoring

アセンブリ:

Azure.AI.Language.Conversations.dll

パッケージ:

Azure.AI.Language.Conversations v1.1.0

Source:

ConversationAuthoringClient.cs

[プロトコルメソッド]プロジェクトのデータをエクスポートするジョブをトリガーします。

• この プロトコル メソッド を使用すると、高度なシナリオで応答の要求と処理を明示的に作成できます。

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

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

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

パラメーター

waitUntil

WaitUntil

Completed メソッドが、サービスで実行時間の長い操作が完了するまで戻るまで待機する必要がある場合。 Started 操作を開始した後に が返される場合は 。 実行時間の長い操作の詳細については、「 Azure.Core Long-Running 操作のサンプル」を参照してください。

projectName

String

使用するプロジェクトの名前。

exportedProjectFormat

String

使用するエクスポートされたプロジェクト ファイルの形式。 使用できる値: "Conversation" |"Luis"

assetKind

String

エクスポートする資産の種類。

stringIndexType

String

文字列オフセットを解釈するために使用するメソッドを指定します。 これは、UTF-16 としてエンコードされる .NET 文字列の "Utf16CodeUnit" に設定します。 使用できる値: "Utf16CodeUnit"。

trainedModelLabel

String

エクスポートするトレーニング済みモデル ラベル。 trainedModelLabel が null の場合、既定の動作では、現在の作業コピーがエクスポートされます。

context

RequestContext

要求コンテキスト。これは、クライアント パイプラインの既定の動作を呼び出しごとにオーバーライドできます。

戻り値

Task<Operation<BinaryData>>

Operationサービスの非同期操作を表す 。

例外

ArgumentNullException

projectName または stringIndexType が null です。

ArgumentException

projectName は空の文字列であり、空でないと予想されていました。

RequestFailedException

サービスから成功以外の状態コードが返されました。

例

このサンプルでは、必要なパラメーターを使用して ExportProjectAsync を呼び出し、結果を解析する方法を示します。

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

このサンプルでは、すべてのパラメーターを使用して ExportProjectAsync を呼び出す方法と、結果を解析する方法を示します。

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

注釈

その他の情報については、サービス REST API のドキュメントを参照してください。 https://learn.microsoft.com/rest/api/language/2023-04-01/conversational-analysis-authoring/export