最初に、リソースのキーとエンドポイントを取得する必要があります。
Azure portal でリソースの概要ページに移動します。 左側のメニューで [キーとエンドポイント] を選びます。 API 要求のエンドポイントとキーを使います
お使いのモデルのクエリを実行する
会話言語理解モデルのテストを開始するには、次の URL、ヘッダー、JSON 本文を使って POST 要求を作成します。
要求 URL
{ENDPOINT}/language/:analyze-conversations?api-version={API-VERSION}
| プレースホルダー |
値 |
例 |
{ENDPOINT} |
API 要求を認証するためのエンドポイント。 |
https://<your-custom-subdomain>.cognitiveservices.azure.com |
{API-VERSION} |
呼び出す API のバージョン。 |
2023-04-01 |
要求を認証するには、次のヘッダーを使います。
| Key |
値 |
Ocp-Apim-Subscription-Key |
リソースへのキー。 API 要求の認証に使われます。 |
要求本文
{
"kind": "Conversation",
"analysisInput": {
"conversationItem": {
"id": "1",
"participantId": "1",
"text": "Text 1"
}
},
"parameters": {
"projectName": "{PROJECT-NAME}",
"deploymentName": "{DEPLOYMENT-NAME}",
"stringIndexType": "TextElement_V8"
}
}
| キー |
プレースホルダー |
値 |
例 |
participantId |
{JOB-NAME} |
|
"MyJobName |
id |
{JOB-NAME} |
|
"MyJobName |
text |
{TEST-UTTERANCE} |
意図を予測してエンティティを抽出する発話。 |
"Read Matt's email |
projectName |
{PROJECT-NAME} |
プロジェクトの名前。 この値は、大文字と小文字が区別されます。 |
myProject |
deploymentName |
{DEPLOYMENT-NAME} |
デプロイの名前。 この値は、大文字と小文字が区別されます。 |
staging |
要求を送信すると、予測に関する次の応答を受け取ります
応答本文
{
"kind": "ConversationResult",
"result": {
"query": "Text1",
"prediction": {
"topIntent": "inten1",
"projectKind": "Conversation",
"intents": [
{
"category": "intent1",
"confidenceScore": 1
},
{
"category": "intent2",
"confidenceScore": 0
},
{
"category": "intent3",
"confidenceScore": 0
}
],
"entities": [
{
"category": "entity1",
"text": "text1",
"offset": 29,
"length": 12,
"confidenceScore": 1
}
]
}
}
}
| Key |
値の例 |
説明 |
| query |
"Matt のメールを読む" |
クエリ用に送信したテキスト。 |
| topIntent |
"読む" |
信頼度スコアが最も高い予測された意図。 |
| 意図 |
[] |
クエリ テキストに対して予測されたすべての意図と信頼度スコアのリスト。 |
| entities |
[] |
クエリ テキストから抽出されたエンティティのリストを含む配列。 |
会話プロジェクトの API 応答
会話プロジェクトでは、プロジェクト内に存在する意図とエンティティの両方の予測が得られます。
- 意図とエンティティには、プロジェクト内の特定の要素のモデルの予測がどの程度信頼できるかの確実性に関する、0.0 から 1.0 の信頼スコアが含まれます。
- 上位スコアの意図は、独自のパラメーター内に含まれています。
- 予測されたエンティティのみが応答に表示されます。
- エンティティによって、次が示されます。
- 抽出されたエンティティのテキスト
- オフセット値で示される開始位置
- 長さの値で表されるエンティティ テキストの長さ
