Text Analysis Authoring - Get Model Evaluation Results

リファレンス

サービス:: Azure AI Services

API バージョン:: 2023-04-01

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

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

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

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

URI パラメーター

名前	/	必須	型	説明
Endpoint	path	True	string url	サポートされている Cognitive Services エンドポイント (例: https://.api.cognitiveservices.azure.com.)
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	PagedTextAnalysisAuthoringDocumentEvaluationResult	要求は成功しました。
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

例

SuccessfulGetModelEvaluation

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "location": "11.txt",
      "language": "en-us",
      "projectKind": "CustomEntityRecognition",
      "customEntityRecognitionResult": {
        "entities": [
          {
            "expectedEntities": [
              {
                "category": "Date",
                "offset": 5,
                "length": 9
              },
              {
                "category": "BorrowerName",
                "offset": 160,
                "length": 13
              },
              {
                "category": "BorrowerAddress",
                "offset": 181,
                "length": 34
              },
              {
                "category": "BorrowerCity",
                "offset": 225,
                "length": 6
              },
              {
                "category": "BorrowerState",
                "offset": 242,
                "length": 8
              },
              {
                "category": "LenderName",
                "offset": 271,
                "length": 12
              },
              {
                "category": "LenderAddress",
                "offset": 310,
                "length": 20
              },
              {
                "category": "LenderCity",
                "offset": 340,
                "length": 8
              },
              {
                "category": "LenderState",
                "offset": 359,
                "length": 11
              },
              {
                "category": "LoanAmountWords",
                "offset": 448,
                "length": 52
              },
              {
                "category": "LoanAmountNumbers",
                "offset": 502,
                "length": 10
              },
              {
                "category": "Interest",
                "offset": 588,
                "length": 2
              }
            ],
            "predictedEntities": [
              {
                "category": "Date",
                "offset": 5,
                "length": 9
              },
              {
                "category": "BorrowerName",
                "offset": 160,
                "length": 13
              },
              {
                "category": "BorrowerAddress",
                "offset": 200,
                "length": 15
              },
              {
                "category": "BorrowerCity",
                "offset": 225,
                "length": 6
              },
              {
                "category": "BorrowerState",
                "offset": 242,
                "length": 8
              },
              {
                "category": "LenderName",
                "offset": 271,
                "length": 12
              },
              {
                "category": "LenderAddress",
                "offset": 310,
                "length": 20
              },
              {
                "category": "LenderCity",
                "offset": 340,
                "length": 8
              },
              {
                "category": "LenderState",
                "offset": 359,
                "length": 11
              },
              {
                "category": "LoanAmountWords",
                "offset": 448,
                "length": 52
              },
              {
                "category": "LoanAmountNumbers",
                "offset": 502,
                "length": 10
              },
              {
                "category": "Interest",
                "offset": 588,
                "length": 2
              }
            ],
            "regionOffset": 0,
            "regionLength": 1780
          }
        ]
      }
    },
    {
      "location": "01.txt",
      "language": "en-us",
      "projectKind": "CustomEntityRecognition",
      "customEntityRecognitionResult": {
        "entities": [
          {
            "expectedEntities": [
              {
                "category": "Date",
                "offset": 5,
                "length": 9
              },
              {
                "category": "BorrowerName",
                "offset": 160,
                "length": 13
              },
              {
                "category": "BorrowerAddress",
                "offset": 200,
                "length": 13
              },
              {
                "category": "BorrowerCity",
                "offset": 223,
                "length": 9
              },
              {
                "category": "BorrowerState",
                "offset": 243,
                "length": 8
              },
              {
                "category": "LenderName",
                "offset": 273,
                "length": 14
              },
              {
                "category": "LenderAddress",
                "offset": 314,
                "length": 15
              },
              {
                "category": "LenderCity",
                "offset": 339,
                "length": 10
              },
              {
                "category": "LenderState",
                "offset": 360,
                "length": 8
              },
              {
                "category": "LoanAmountWords",
                "offset": 446,
                "length": 66
              },
              {
                "category": "LoanAmountNumbers",
                "offset": 514,
                "length": 11
              },
              {
                "category": "Interest",
                "offset": 601,
                "length": 2
              }
            ],
            "predictedEntities": [
              {
                "category": "Date",
                "offset": 5,
                "length": 9
              },
              {
                "category": "BorrowerName",
                "offset": 160,
                "length": 13
              },
              {
                "category": "BorrowerAddress",
                "offset": 200,
                "length": 13
              },
              {
                "category": "BorrowerCity",
                "offset": 223,
                "length": 9
              },
              {
                "category": "BorrowerState",
                "offset": 243,
                "length": 8
              },
              {
                "category": "LenderName",
                "offset": 273,
                "length": 14
              },
              {
                "category": "LenderAddress",
                "offset": 314,
                "length": 15
              },
              {
                "category": "LenderCity",
                "offset": 339,
                "length": 10
              },
              {
                "category": "LenderState",
                "offset": 360,
                "length": 8
              },
              {
                "category": "LoanAmountWords",
                "offset": 446,
                "length": 66
              },
              {
                "category": "LoanAmountNumbers",
                "offset": 514,
                "length": 11
              },
              {
                "category": "Interest",
                "offset": 601,
                "length": 2
              }
            ],
            "regionOffset": 0,
            "regionLength": 1793
          }
        ]
      }
    }
  ],
  "nextLink": "https://api.example.com/language/authoring/analyze-text/projects/LoanAgreements/models/model2/evaluation/result/?api-version=2023-04-15-preview&top=2147483645&skip=100&maxpagesize=100"
}

定義

名前	説明
Error	エラーオブジェクト。
ErrorCode	人間が判読できるエラーコード。
ErrorResponse	エラー応答。
InnerErrorCode	人間が判読できるエラーコード。
InnerErrorModel	エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
PagedTextAnalysisAuthoringDocumentEvaluationResult	TextAnalysisAuthoringDocumentEvaluationResult アイテムの Paged コレクション
ProjectKind
StringIndexType
TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult	カスタムエンティティ認識プロジェクトのドキュメント評価結果を表します。
TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult	カスタムの複数ラベル分類プロジェクトのドキュメント評価結果を表します。
TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult	カスタムの単一ラベル分類プロジェクトのドキュメント評価結果を表します。
TextAnalysisAuthoringDocumentEntityLabelEvaluationResult	評価結果エンティティラベルを表します。
TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult	ドキュメントのエンティティ認識評価結果を表します。
TextAnalysisAuthoringDocumentEntityRegionEvaluationResult	ドキュメント領域の予想されるエンティティと予測されるエンティティの間の評価比較を表します。
TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult	評価操作の結果として予想されるクラスと予測されるクラスの比較を表します。
TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult	評価操作の結果として予想されるクラスと予測されるクラスの比較を表します。

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	エラーターゲット。

PagedTextAnalysisAuthoringDocumentEvaluationResult

TextAnalysisAuthoringDocumentEvaluationResult アイテムの Paged コレクション

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

ProjectKind

名前	型	説明
CustomEntityRecognition	string	独自のデータを使用してドメインカテゴリを識別する抽出モデルを構築する場合。
CustomMultiLabelClassification	string	独自のデータを使用してテキストを分類する分類モデルを構築する場合。各ファイルには、1 つまたは複数のラベルを含めることができます。たとえば、ファイル 1 は A、B、C に分類され、ファイル 2 は B と C に分類されます。
CustomSingleLabelClassification	string	独自のデータを使用してテキストを分類する分類モデルを構築する場合。各ファイルにはラベルが 1 つだけ含まれます。たとえば、ファイル 1 は A に分類され、ファイル 2 は B として分類されます。

StringIndexType

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

TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult

カスタムエンティティ認識プロジェクトのドキュメント評価結果を表します。

名前	型	説明
customEntityRecognitionResult	TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult	エンティティ認識の評価予測を表します。
language	string	ドキュメント言語を表します。これは、言語の BCP-47 表現です。たとえば、英語の場合は "en"、英語 (英国) の場合は "en-gb"、スペイン語の場合は "es" を使用します。
location	string	ドキュメントパスを表します。
projectKind	string: CustomEntityRecognition	プロジェクトの種類を表します。

TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult

カスタムの複数ラベル分類プロジェクトのドキュメント評価結果を表します。

名前	型	説明
customMultiLabelClassificationResult	TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult	複数ラベル分類の評価予測を表します。
language	string	ドキュメント言語を表します。これは、言語の BCP-47 表現です。たとえば、英語の場合は "en"、英語 (英国) の場合は "en-gb"、スペイン語の場合は "es" を使用します。
location	string	ドキュメントパスを表します。
projectKind	string: CustomMultiLabelClassification	プロジェクトの種類を表します。

TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult

カスタムの単一ラベル分類プロジェクトのドキュメント評価結果を表します。

名前	型	説明
customSingleLabelClassificationResult	TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult	単一ラベル分類の評価予測を表します。
language	string	ドキュメント言語を表します。これは、言語の BCP-47 表現です。たとえば、英語の場合は "en"、英語 (英国) の場合は "en-gb"、スペイン語の場合は "es" を使用します。
location	string	ドキュメントパスを表します。
projectKind	string: CustomSingleLabelClassification	プロジェクトの種類を表します。

TextAnalysisAuthoringDocumentEntityLabelEvaluationResult

評価結果エンティティラベルを表します。

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

TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult

ドキュメントのエンティティ認識評価結果を表します。

名前	型	説明
entities	TextAnalysisAuthoringDocumentEntityRegionEvaluationResult[]	ドキュメントラベル付きエンティティを表します。

TextAnalysisAuthoringDocumentEntityRegionEvaluationResult

ドキュメント領域の予想されるエンティティと予測されるエンティティの間の評価比較を表します。

名前	型	説明
expectedEntities	TextAnalysisAuthoringDocumentEntityLabelEvaluationResult[]	リージョンの予期されるエンティティラベルを表します。
predictedEntities	TextAnalysisAuthoringDocumentEntityLabelEvaluationResult[]	リージョンの予測エンティティラベルを表します。
regionLength	integer	領域の長さを表します。
regionOffset	integer	領域オフセットを表します。

TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult

評価操作の結果として予想されるクラスと予測されるクラスの比較を表します。

名前	型	説明
expectedClasses	string[]	ドキュメントの期待されるクラスを表します。
predictedClasses	string[]	ドキュメントの予測クラスを表します。

TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult