オーケストレーション ワークフローでプロジェクトを作成する方法

1. Language Studio で [質問と会話言語を理解する] というラベルのセクションを見つけて、[オーケストレーション ワークフロー] を選択します。

   

2. これにより、オーケストレーション ワークフロー プロジェクト ページに移動します。 [新しいプロジェクトの作成] を選択します。 プロジェクトを作成するには、次の詳細を指定する必要があります。

完了したら、[次へ] を選択し、詳細を確認します。 [プロジェクトの作成] を選択してプロセスを完了します。 プロジェクトの [Build Schema](スキーマのビルド) 画面が表示されます。

新しいプロジェクトを作成するには、次の URL、ヘッダー、JSON 本文を使って PATCH 要求を送信します。

要求 URL

API 要求を作るときは、次の URL を使います。 次のプレースホルダーの値を実際の値に置き換えてください。

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}?api-version={API-VERSION}

ヘッダー

要求を認証するには、次のヘッダーを使います。

Body

次のサンプル JSON を本文として使います。

{
  "projectName": "{PROJECT-NAME}",
  "language": "{LANGUAGE-CODE}",
  "projectKind": "Orchestration",
  "description": "Project description"
 }

オーケストレーション ワークフロー プロジェクトのページに移動してプロジェクトを選択し、上部のメニューで [エクスポート] をクリックすれば、いつでもオーケストレーション ワークフロー プロジェクトを JSON ファイルとしてエクスポートできます。

そのプロジェクトを新しいプロジェクトとしてインポートし直すことができます。 まったく同じ名前でプロジェクトをインポートすると、プロジェクトのデータが新しくインポートしたプロジェクトのデータに置き換えられます。

プロジェクトをインポートするには、[新しいプロジェクトの作成] の横にある矢印ボタンを選択し、[インポート] を選択してから、JSON ファイルを選択します。

オーケストレーション ワークフローの JSON を、サービスにインポートできます

プロジェクトをインポートするには、次の URL、ヘッダー、JSON 本文を使って POST 要求を送信します。

要求 URL

API 要求を作るときは、次の URL を使います。 次のプレースホルダーの値を実際の値に置き換えてください。

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/:import?api-version={API-VERSION}

ヘッダー

要求を認証するには、次のヘッダーを使います。

Body

次のサンプル JSON を本文として使います。

{
  "projectFileVersion": "{API-VERSION}",
  "stringIndexType": "Utf16CodeUnit",
  "metadata": {
    "projectKind": "Orchestration",
    "settings": {
      "confidenceThreshold": 0
    },
    "projectName": "{PROJECT-NAME}",
    "description": "Project description",
    "language": "{LANGUAGE-CODE}"
  },
  "assets": {
    "projectKind": "Orchestration",
    "intents": [
      {
        "category": "string",
        "orchestration": {
          "kind": "luis",
          "luisOrchestration": {
            "appId": "00001111-aaaa-2222-bbbb-3333cccc4444",
            "appVersion": "string",
            "slotName": "string"
          },
          "cluOrchestration": {
            "projectName": "string",
            "deploymentName": "string"
          },
          "qnaOrchestration": {
            "projectName": "string"
          }
        }
      }
    ],
    "utterances": [
      {
        "text": "Trying orchestration",
        "language": "{LANGUAGE-CODE}",
        "intent": "string"
      }
    ]
  }
}

オーケストレーション ワークフロー プロジェクトのページに移動し、プロジェクトを選択して、[エクスポート] をクリックすることで、いつでもオーケストレーション ワークフロー プロジェクトを JSON ファイルとしてエクスポートできます。

オーケストレーション ワークフロー プロジェクトは、いつでも JSON ファイルとしてエクスポートできます。

プロジェクトをエクスポートするには、次の URL、ヘッダー、JSON 本文を使って POST 要求を作成します。

要求 URL

API 要求を作るときは、次の URL を使います。 次のプレースホルダーの値を実際の値に置き換えてください。

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/:export?stringIndexType=Utf16CodeUnit&api-version={API-VERSION}

ヘッダー

要求を認証するには、次のヘッダーを使います。

API 要求を送信すると、成功を示す 202 応答が返されます。 応答ヘッダーで、operation-___location の値を抽出します。 それは次のように書式設定されています。

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/jobs/{JOB-ID}?api-version={API-VERSION}

この操作は非同期であるため、JOB-ID を使って要求が識別されます。 同じ認証方法を使用し、エクスポートされたプロジェクトの JSON をこの URL を使用して取得します。

1. Language Studio でプロジェクト設定のページに移動します。

2. プロジェクトの詳細を確認できます。

3. このページでは、プロジェクトの説明を更新できます。

4. このページからリソースの主キーを取得することもできます。

   

オーケストレーション ワークフロー プロジェクトの詳細を取得するには、次の URL とヘッダーを使用して GET 要求を送信します。 プレースホルダーの値は、実際の値に置き換えます。

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}?api-version={API-VERSION}

ヘッダー

要求を認証するには、次のヘッダーを使います。

応答本文

要求を送信すると、次の応答を受け取ります。

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "lastTrainedDateTime": "2022-04-18T14:14:28Z",
  "lastDeployedDateTime": "2022-04-18T14:49:01Z",
  "projectKind": "Orchestration",
  "projectName": "{PROJECT-NAME}",
  "description": "This is a sample orchestration project.",
  "language": "{LANGUAGE-CODE}"
}

API 要求を送信すると、成功を示す 200 応答とプロジェクトの詳細を含む JSON 応答本文が返されます。

プロジェクトが不要な場合は、Language Studio を使ってプロジェクトを削除できます。 左側のナビゲーション メニューで [プロジェクト] を選択し、削除するプロジェクトを選択して、上部のメニューで [削除] を選択します。

プロジェクトが不要になったら、API を使用してプロジェクトを削除できます。

会話言語理解プロジェクトを削除するには、次の URL、ヘッダー、JSON 本文を使って DELETE 要求を作成します。

要求 URL

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}?api-version={API-VERSION}

ヘッダー

要求を認証するには、次のヘッダーを使います。

API 要求を送信すると、成功を示す 202 応答を受け取ります。これは、プロジェクトが削除されたことを意味します。