Conversational Analysis Authoring - Get Model Evaluation Results

サービス:

Azure AI Services

API バージョン:

2023-04-01

トレーニング済みモデルの評価の詳細な結果を取得します。 これには、評価プロセスに含まれるデータの生の推論結果が含まれます。

GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/result?api-version=2023-04-01&stringIndexType=Utf16CodeUnit

省略可能なパラメーターを含む:

GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/result?api-version=2023-04-01&top={top}&skip={skip}&maxpagesize={maxpagesize}&stringIndexType=Utf16CodeUnit

URI パラメーター

名前	/	必須	型	説明
Endpoint	path	True	string
projectName	path	True	string	新しいプロジェクト名。
trainedModelLabel	path	True	string	トレーニング済みのモデル ラベル。
api-version	query	True	string	この操作に使用する API バージョン。
stringIndexType	query	True	StringIndexType	文字列オフセットの解釈に使用するメソッドを指定します。 詳細については、https://aka.ms/text-analytics-offsetsを参照してください。
maxpagesize	query		integer int32	ページあたりの結果項目の最大数。
skip	query		integer int32	スキップする結果項目の数。
top	query		integer int32	返される結果項目の数。

応答

名前	型	説明
200 OK	PagedConversationalAnalysisAuthoringUtteranceEvaluationResult	要求は成功しました。
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

Ocp-Apim-Subscription-Key

型: apiKey
/: header

OAuth2Auth

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize
Token URL (トークン URL): https://login.microsoftonline.com/common/oauth2/token

スコープ

名前	説明
https://cognitiveservices.azure.com/.default

例

Successful Get Model Evaluation

要求のサンプル

HTTP

GET {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/models/model1/evaluation/result?api-version=2023-04-01&maxpagesize=10&stringIndexType=Utf16CodeUnit

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "text": "send the email",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [],
        "predictedEntities": []
      },
      "intentsResult": {
        "expectedIntent": "SendEmail",
        "predictedIntent": "SendEmail"
      }
    },
    {
      "text": "send a mail to daniel",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [
          {
            "category": "ContactName",
            "offset": 15,
            "length": 6
          }
        ],
        "predictedEntities": [
          {
            "category": "ContactName",
            "offset": 15,
            "length": 6
          }
        ]
      },
      "intentsResult": {
        "expectedIntent": "SendEmail",
        "predictedIntent": "SendEmail"
      }
    },
    {
      "text": "i forgot to add an important part to that email to james . please set it up to edit",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [
          {
            "category": "ContactName",
            "offset": 51,
            "length": 5
          }
        ],
        "predictedEntities": [
          {
            "category": "Category",
            "offset": 19,
            "length": 9
          },
          {
            "category": "ContactName",
            "offset": 51,
            "length": 5
          }
        ]
      },
      "intentsResult": {
        "expectedIntent": "AddMore",
        "predictedIntent": "AddMore"
      }
    },
    {
      "text": "send email to a and tian",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [
          {
            "category": "ContactName",
            "offset": 14,
            "length": 1
          },
          {
            "category": "ContactName",
            "offset": 20,
            "length": 4
          }
        ],
        "predictedEntities": [
          {
            "category": "ContactName",
            "offset": 14,
            "length": 1
          },
          {
            "category": "ContactName",
            "offset": 20,
            "length": 4
          }
        ]
      },
      "intentsResult": {
        "expectedIntent": "SendEmail",
        "predictedIntent": "SendEmail"
      }
    },
    {
      "text": "send thomas an email",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [
          {
            "category": "ContactName",
            "offset": 5,
            "length": 6
          }
        ],
        "predictedEntities": [
          {
            "category": "ContactName",
            "offset": 5,
            "length": 6
          }
        ]
      },
      "intentsResult": {
        "expectedIntent": "SendEmail",
        "predictedIntent": "SendEmail"
      }
    },
    {
      "text": "i need to add more to the email message i am sending to vincent",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [
          {
            "category": "ContactName",
            "offset": 56,
            "length": 7
          }
        ],
        "predictedEntities": [
          {
            "category": "ContactName",
            "offset": 56,
            "length": 7
          }
        ]
      },
      "intentsResult": {
        "expectedIntent": "AddMore",
        "predictedIntent": "AddMore"
      }
    },
    {
      "text": "send an email to lily roth and abc123@microsoft.com",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [
          {
            "category": "ContactName",
            "offset": 17,
            "length": 9
          }
        ],
        "predictedEntities": [
          {
            "category": "ContactName",
            "offset": 17,
            "length": 9
          }
        ]
      },
      "intentsResult": {
        "expectedIntent": "SendEmail",
        "predictedIntent": "SendEmail"
      }
    },
    {
      "text": "i need to add something else to my email to cheryl",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [
          {
            "category": "ContactName",
            "offset": 44,
            "length": 6
          }
        ],
        "predictedEntities": [
          {
            "category": "ContactName",
            "offset": 44,
            "length": 6
          }
        ]
      },
      "intentsResult": {
        "expectedIntent": "AddMore",
        "predictedIntent": "AddMore"
      }
    },
    {
      "text": "send an email to larry , joseph and billy larkson",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [
          {
            "category": "ContactName",
            "offset": 17,
            "length": 5
          },
          {
            "category": "ContactName",
            "offset": 25,
            "length": 6
          },
          {
            "category": "ContactName",
            "offset": 36,
            "length": 13
          }
        ],
        "predictedEntities": [
          {
            "category": "ContactName",
            "offset": 17,
            "length": 5
          },
          {
            "category": "ContactName",
            "offset": 25,
            "length": 6
          },
          {
            "category": "ContactName",
            "offset": 36,
            "length": 13
          }
        ]
      },
      "intentsResult": {
        "expectedIntent": "SendEmail",
        "predictedIntent": "SendEmail"
      }
    },
    {
      "text": "send mail to dorothy",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [
          {
            "category": "ContactName",
            "offset": 13,
            "length": 7
          }
        ],
        "predictedEntities": [
          {
            "category": "ContactName",
            "offset": 13,
            "length": 7
          }
        ]
      },
      "intentsResult": {
        "expectedIntent": "SendEmail",
        "predictedIntent": "SendEmail"
      }
    }
  ],
  "nextLink": "https://api.example.com/language/authoring/analyze-conversations/projects/EmailApp/models/model1/evaluation/result/?api-version=2023-04-01&top=2147483637&skip=100&maxpagesize=100"
}

定義

名前	説明
ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult	発話に対して予想されるエンティティと予測されるエンティティの比較を表します。
ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult	エンティティ ラベルまたは予測の評価出力を表します。
ConversationalAnalysisAuthoringUtteranceEvaluationResult	発話の評価結果を表します。
ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult	発話の予想される意図と予測される意図の比較を表します。
Error	エラー オブジェクト。
ErrorCode	人間が判読できるエラー コード。
ErrorResponse	エラー応答。
InnerErrorCode	人間が判読できるエラー コード。
InnerErrorModel	エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
PagedConversationalAnalysisAuthoringUtteranceEvaluationResult	ConversationalAnalysisAuthoringUtteranceEvaluationResult 項目の Paged コレクション
StringIndexType

ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult

発話に対して予想されるエンティティと予測されるエンティティの比較を表します。

名前	型	説明
expectedEntities	ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult[]	予期されるエンティティ ラベルを表します。
predictedEntities	ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult[]	予測されるエンティティ ラベルを表します。

ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult

エンティティ ラベルまたは予測の評価出力を表します。

名前	型	説明
category	string	エンティティ カテゴリを表します。
length	integer	エンティティの長さを表します。
offset	integer	元のテキストに対するエンティティ オフセット インデックスを表します。

ConversationalAnalysisAuthoringUtteranceEvaluationResult

発話の評価結果を表します。

名前	型	説明
entitiesResult	ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult	発話のエンティティの結果を表します。
intentsResult	ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult	発話の意図の結果を表します。
language	string	発話言語を表します。 これは、言語の BCP-47 表現です。 たとえば、英語の場合は "en"、英語 (英国) の場合は "en-gb"、スペイン語の場合は "es" を使用します。
text	string	発話テキストを表します。

ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult

発話の予想される意図と予測される意図の比較を表します。

名前	型	説明
expectedIntent	string	発話の予期される意図を表します。
predictedIntent	string	発話の予測された意図を表します。

Error

エラー オブジェクト。

名前	型	説明
code	ErrorCode	サーバー定義の一連のエラー コードの 1 つ。
details	Error[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	InnerErrorModel	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーの人間が判読できる表現。
target	string	エラーのターゲット。

ErrorCode

人間が判読できるエラー コード。

名前	型	説明
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Conflict	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
QuotaExceeded	string
ServiceUnavailable	string
Timeout	string
TooManyRequests	string
Unauthorized	string
Warning	string

ErrorResponse

エラー応答。

名前	型	説明
error	Error	エラー オブジェクト。

InnerErrorCode

人間が判読できるエラー コード。

名前	型	説明
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
EmptyRequest	string
ExtractionFailure	string
InvalidCountryHint	string
InvalidDocument	string
InvalidDocumentBatch	string
InvalidParameterValue	string
InvalidRequest	string
InvalidRequestBodyFormat	string
KnowledgeBaseNotFound	string
MissingInputDocuments	string
ModelVersionIncorrect	string
UnsupportedLanguageCode	string

InnerErrorModel

エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

名前	型	説明
code	InnerErrorCode	サーバー定義の一連のエラー コードの 1 つ。
details	object	エラーの詳細。
innererror	InnerErrorModel	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーメッセージ。
target	string	エラーターゲット。

PagedConversationalAnalysisAuthoringUtteranceEvaluationResult

ConversationalAnalysisAuthoringUtteranceEvaluationResult 項目の Paged コレクション

名前	型	説明
nextLink	string	アイテムの次のページへのリンク
value	ConversationalAnalysisAuthoringUtteranceEvaluationResult[]	このページの ConversationalAnalysisAuthoringUtteranceEvaluationResult アイテム

StringIndexType

名前	型	説明
Utf16CodeUnit	string	オフセットと長さの値は UTF-16 コード単位に対応します。 アプリケーションが Unicode (Java、JavaScript など) をサポートする言語で記述されている場合は、このオプションを使用します。