Text Analysis Authoring - Get Model Evaluation Results

Ссылка

Служба:: Azure AI Services

Версия API:: 2022-05-01

Возвращает подробные результаты оценки для обученной модели. Сюда входят необработанные результаты вывода для данных, включенных в процесс оценки.

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
Endpoint	path	True	string	Поддерживаемая конечная точка Cognitive Services (например, https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100	Имя используемого проекта.
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)	Максимальное количество ресурсов, возвращаемых из коллекции.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Ocp-Apim-Subscription-Key	True	string	Ключ подписки для ресурса службы языка.

Ответы

Имя	Тип	Описание
200 OK	TextAnalysisAuthoringEvaluationResults	Список результатов оценки.
Other Status Codes	ErrorResponse	Ответ на ошибку.

Безопасность

Ocp-Apim-Subscription-Key

Ключ подписки для ресурса службы языка.

Тип: apiKey
В: header

Примеры

Successful Get Model Evaluation

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 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": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/models/model2/evaluation/result/?api-version=2022-05-01&top=2147483645&skip=2&maxpagesize=2"
}

Определения

Имя	Описание
Error	Объект ошибки.
ErrorCode	Код ошибки, доступный для чтения человеком.
ErrorResponse	Ответ на ошибку.
InnerErrorCode	Код ошибки, доступный для чтения человеком.
InnerErrorModel	Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	Тип проекта.
StringIndexType	Задает метод, используемый для интерпретации смещения строк. Дополнительные сведения см. в https://aka.ms/text-analytics-offsets.
TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult	Представляет результат оценки документа для проекта распознавания пользовательских сущностей.
TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult	Представляет результат оценки документа для пользовательского проекта классификации нескольких меток.
TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult	Представляет результат оценки документа для пользовательского проекта классификации одноклеек.
TextAnalysisAuthoringDocumentEntityLabelEvaluationResult	Представляет метку результата оценки.
TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult	Представляет результат оценки распознавания сущностей для документа.
TextAnalysisAuthoringDocumentEntityRegionEvaluationResult	Представляет сравнение оценки ожидаемых и прогнозируемых сущностей региона документа.
TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult	Представляет сравнение ожидаемых и прогнозируемых классов, которые являются результатом операции оценки.
TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult	Представляет сравнение ожидаемого и прогнозируемого класса, результатом операции оценки.
TextAnalysisAuthoringEvaluationResults	Представляет список результатов для операции оценки.

Error

Object

Объект ошибки.

Имя	Тип	Описание
code	ErrorCode	Один из определяемых сервером кодов ошибок.
details	Error[]	Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror	InnerErrorModel	Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message	string	Читаемое пользователем представление ошибки.
target	string	Целевой объект ошибки.

ErrorCode

Перечисление

Код ошибки, доступный для чтения человеком.

Значение	Описание
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Conflict
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
QuotaExceeded
ServiceUnavailable
Timeout
TooManyRequests
Unauthorized
Warning

ErrorResponse

Object

Ответ на ошибку.

Имя	Тип	Описание
error	Error	Объект ошибки.

InnerErrorCode

Перечисление

Код ошибки, доступный для чтения человеком.

Значение	Описание
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Object

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Имя	Тип	Описание
code	InnerErrorCode	Один из определяемых сервером кодов ошибок.
details	object	Сведения об ошибке.
innererror	InnerErrorModel	Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ProjectKind

Перечисление

Тип проекта.

Значение	Описание
CustomEntityRecognition	Для создания модели извлечения для идентификации категорий домена с помощью собственных данных.
CustomMultiLabelClassification	Для создания модели классификации для классификации текста с помощью собственных данных. Каждый файл может иметь одну или несколько меток. Например, файл 1 классифицируется как A, B и C, а файл 2 классифицируется как B и C.
CustomSingleLabelClassification	Для создания модели классификации для классификации текста с помощью собственных данных. Каждый файл будет иметь только одну метку. Например, файл 1 классифицируется как A, а файл 2 классифицируется как B.

StringIndexType

Перечисление

Задает метод, используемый для интерпретации смещения строк. Дополнительные сведения см. в https://aka.ms/text-analytics-offsets.

Значение	Описание
Utf16CodeUnit	Значения смещения и длины будут соответствовать единицам кода UTF-16. Используйте этот параметр, если приложение написано на языке, поддерживающем Юникод, например Java, JavaScript.

TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult

Object

Представляет результат оценки документа для проекта распознавания пользовательских сущностей.

Имя	Тип	Описание
customEntityRecognitionResult	TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult	Представляет прогноз оценки для распознавания сущностей.
language	string	Представляет язык документа. Это представление языка BCP-47. Например, используйте "en" для английского, "en-gb" для английского (Великобритания), "es" для испанского и т. д.
location	string	Представляет путь к документу.
projectKind	string: CustomEntityRecognition	Представляет тип проекта.

TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult

Object

Представляет результат оценки документа для пользовательского проекта классификации нескольких меток.

Имя	Тип	Описание
customMultiLabelClassificationResult	TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult	Представляет прогноз оценки для классификации нескольких меток.
language	string	Представляет язык документа. Это представление языка BCP-47. Например, используйте "en" для английского, "en-gb" для английского (Великобритания), "es" для испанского и т. д.
location	string	Представляет путь к документу.
projectKind	string: CustomMultiLabelClassification	Представляет тип проекта.

TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult

Object

Представляет результат оценки документа для пользовательского проекта классификации одноклеек.

Имя	Тип	Описание
customSingleLabelClassificationResult	TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult	Представляет прогноз оценки для классификации отдельных меток.
language	string	Представляет язык документа. Это представление языка BCP-47. Например, используйте "en" для английского, "en-gb" для английского (Великобритания), "es" для испанского и т. д.
location	string	Представляет путь к документу.
projectKind	string: CustomSingleLabelClassification	Представляет тип проекта.

TextAnalysisAuthoringDocumentEntityLabelEvaluationResult

Object

Представляет метку результата оценки.

Имя	Тип	Описание
category	string	Представляет категорию сущностей.
length	integer (int32)	Представляет длину сущности.
offset	integer (int32)	Представляет индекс смещения сущности относительно исходного текста.

TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult

Object

Представляет результат оценки распознавания сущностей для документа.

Имя	Тип	Описание
entities	TextAnalysisAuthoringDocumentEntityRegionEvaluationResult[]	Представляет сущности, помеченные документом.

TextAnalysisAuthoringDocumentEntityRegionEvaluationResult

Object

Представляет сравнение оценки ожидаемых и прогнозируемых сущностей региона документа.

Имя	Тип	Описание
expectedEntities	TextAnalysisAuthoringDocumentEntityLabelEvaluationResult[]	Представляет ожидаемые метки сущностей региона.
predictedEntities	TextAnalysisAuthoringDocumentEntityLabelEvaluationResult[]	Представляет прогнозируемые метки сущностей региона.
regionLength	integer (int32)	Представляет длину региона.
regionOffset	integer (int32)	Представляет смещение региона.

TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult

Object

Представляет сравнение ожидаемых и прогнозируемых классов, которые являются результатом операции оценки.

Имя	Тип	Описание
expectedClasses	string[]	Представляет ожидаемые классы документа.
predictedClasses	string[]	Представляет прогнозируемые классы документа.

TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult

Object

Представляет сравнение ожидаемого и прогнозируемого класса, результатом операции оценки.

Имя	Тип	Описание
expectedClass	string	Представляет ожидаемый класс документа.
predictedClass	string	Представляет прогнозируемый класс документа.

TextAnalysisAuthoringEvaluationResults

Object

Представляет список результатов для операции оценки.

Имя	Тип	Описание
nextLink	string	Следующая ссылка на страницу.
value	TextAnalysisAuthoringDocumentEvaluationResult[]: TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult[] TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult[] TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult[]	Список результатов оценки документов.

Поделиться через

Text Analysis Authoring - Get Model Evaluation Results

Параметры URI

Заголовок запроса

Ответы

Безопасность

Ocp-Apim-Subscription-Key

Примеры

Successful Get Model Evaluation

Образец запроса

Пример ответа

Определения

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

ProjectKind

StringIndexType

TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult

TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult

TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult

TextAnalysisAuthoringDocumentEntityLabelEvaluationResult

TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult

TextAnalysisAuthoringDocumentEntityRegionEvaluationResult

TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult

TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult

TextAnalysisAuthoringEvaluationResults

Дополнительные ресурсы