你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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	支持的认知服务终结点（例如 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
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize
令牌 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一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
PagedTextAnalysisAuthoringDocumentEvaluationResult	TextAnalysisAuthoringDocumentEvaluationResult 项的分页集合
ProjectKind
StringIndexType
TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult	表示自定义实体识别项目的文档评估结果。
TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult	表示自定义多标签分类项目的文档评估结果。
TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult	表示自定义单标签分类项目的文档评估结果。
TextAnalysisAuthoringDocumentEntityLabelEvaluationResult	表示评估结果实体标签。
TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult	表示文档的实体识别评估结果。
TextAnalysisAuthoringDocumentEntityRegionEvaluationResult	表示文档区域的预期实体与预测实体之间的计算比较。
TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult	表示计算操作产生的预期类和预测类之间的比较。
TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult	表示计算操作产生的预期类和预测类之间的比较。

Error

错误对象。

名称	类型	说明
code	ErrorCode	服务器定义的错误代码集之一。
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一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名称	类型	说明
code	InnerErrorCode	服务器定义的错误代码集之一。
details	object	错误详细信息。
innererror	InnerErrorModel	包含与当前对象有关错误的更具体信息的对象。
message	string	错误信息。
target	string	错误目标。

PagedTextAnalysisAuthoringDocumentEvaluationResult

TextAnalysisAuthoringDocumentEvaluationResult 项的分页集合

名称	类型	说明
nextLink	string	指向下一页项的链接
value	TextAnalysisAuthoringDocumentEvaluationResult[]: TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult[] TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult[] TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult[]	此页面上的 TextAnalysisAuthoringDocumentEvaluationResult 项

ProjectKind

名称	类型	说明
CustomEntityRecognition	string	若要生成提取模型，以使用自己的数据标识域类别。
CustomMultiLabelClassification	string	用于生成分类模型以使用自己的数据对文本进行分类。每个文件可以有一个或多个标签。例如，文件 1 分类为 A、B 和 C，文件 2 分类为 B 和 C。
CustomSingleLabelClassification	string	用于生成分类模型以使用自己的数据对文本进行分类。每个文件将只有一个标签。例如，文件 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