Evaluations - Create

Ссылка

Service:: Azure AI Services

API Version:: v3.2-preview.2

Создание новой оценки.

POST {endpoint}/speechtotext/v3.2-preview.2/evaluations

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например : https://westus.api.cognitive.microsoft.com).

Текст запроса

Имя	Обязательно	Тип	Описание
dataset	True	EntityReference	EntityReference
displayName	True	string	Отображаемое имя объекта.
locale	True	string	Языковой стандарт содержащихся данных.
model1	True	EntityReference	EntityReference
model2	True	EntityReference	EntityReference
customProperties		object	Настраиваемые свойства этой сущности. Максимальная допустимая длина ключа — 64 символа, максимальная длина значения — 256 символов, а количество разрешенных записей — 10.
description		string	Описание объекта .
project		EntityReference	EntityReference
transcription1		EntityReference	EntityReference
transcription2		EntityReference	EntityReference

Ответы

Имя	Тип	Описание
201 Created	Evaluation	Ответ содержит сведения о сущности в качестве полезных данных и ее расположении в качестве заголовка. Headers Location: string
Other Status Codes	Error	Произошла ошибка.

Имя

Тип

Описание

201 Created

Evaluation

Ответ содержит сведения о сущности в качестве полезных данных и ее расположении в качестве заголовка.

Headers

Location: string

Other Status Codes

Error

Произошла ошибка.

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

Ocp-Apim-Subscription-Key

Укажите ключ учетной записи Cognitive Services здесь.

Type: apiKey
In: header

Authorization

Укажите маркер доступа из JWT, возвращенный stS этого региона. Обязательно добавьте область управления в маркер, добавив следующую строку запроса в URL-адрес службы маркеров безопасности: ?область=speechservicesmanagement

Type: apiKey
In: header

Примеры

Create a evaluation

Sample Request

HTTP

POST {endpoint}/speechtotext/v3.2-preview.2/evaluations

{
  "model1": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "model2": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "dataset": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
  },
  "locale": "en-US",
  "displayName": "My new evaluation",
  "description": "The description of the evaluation"
}

Sample Response

Status code:: 201

Location: https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6

Response Body

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6",
  "model1": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "model2": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "dataset": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
  },
  "transcription2": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f"
  },
  "transcription1": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683"
  },
  "links": {
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/evaluations/00000000-0000-0000-0000-000000000000/files"
  },
  "properties": {
    "wordErrorRate2": 0.065,
    "wordErrorRate1": 0.065,
    "sentenceErrorRate2": 0.375,
    "sentenceCount2": 8,
    "wordCount2": 46,
    "correctWordCount2": 43,
    "wordSubstitutionCount2": 3,
    "wordDeletionCount2": 0,
    "wordInsertionCount2": 0,
    "sentenceErrorRate1": 0.375,
    "sentenceCount1": 8,
    "wordCount1": 46,
    "correctWordCount1": 43,
    "wordSubstitutionCount1": 3,
    "wordDeletionCount1": 0,
    "wordInsertionCount1": 0,
    "tokenErrorRate2": 0.125,
    "tokenErrorRate1": 0.125,
    "tokenCount2": 48,
    "correctTokenCount2": 42,
    "tokenSubstitutionCount2": 6,
    "tokenDeletionCount2": 0,
    "tokenInsertionCount2": 0,
    "tokenCount1": 48,
    "correctTokenCount1": 42,
    "tokenSubstitutionCount1": 6,
    "tokenDeletionCount1": 0,
    "tokenInsertionCount1": 0
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Succeeded",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "Evalution of one model against another model"
}

Определения

Имя	Описание
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	EntityReference
Error	Ошибка
ErrorCode	ErrorCode
Evaluation	Ознакомительная версия
EvaluationLinks	EvaluationLinks
EvaluationProperties	EvaluationProperties
InnerError	InnerError
Status	Состояние

DetailedErrorCode

Имя	Тип	Описание
DataImportFailed	string	Сбой импорта данных.
DeleteNotAllowed	string	Удаление запрещено.
DeployNotAllowed	string	Развертывание запрещено.
DeployingFailedModel	string	Развертывание модели со сбоем.
EmptyRequest	string	Пустой запрос.
EndpointCannotBeDefault	string	Конечная точка не может быть по умолчанию.
EndpointNotUpdatable	string	Конечная точка не обновляема.
EndpointWithoutLogging	string	Конечная точка без ведения журнала.
ExceededNumberOfRecordingsUris	string	Превышено число URI записей.
FailedDataset	string	Сбой набора данных.
Forbidden	string	Запрещено.
InUseViolation	string	Нарушение при использовании.
InaccessibleCustomerStorage	string	Недоступное хранилище клиента.
InvalidAdaptationMapping	string	Недопустимое сопоставление адаптации.
InvalidBaseModel	string	Недопустимая базовая модель.
InvalidCallbackUri	string	Недопустимый URI обратного вызова.
InvalidCollection	string	Недопустимая коллекция.
InvalidDataset	string	Недопустимый набор данных.
InvalidDocument	string	Недопустимый документ.
InvalidDocumentBatch	string	Недопустимый пакет документа.
InvalidLocale	string	Недопустимый языковой стандарт.
InvalidLogDate	string	Недопустимая дата журнала.
InvalidLogEndTime	string	Недопустимое время окончания журнала.
InvalidLogId	string	Недопустимый идентификатор журнала.
InvalidLogStartTime	string	Недопустимое время начала журнала.
InvalidModel	string	Недопустимая модель.
InvalidModelUri	string	Недопустимый URI модели.
InvalidParameter	string	Недопустимый параметр.
InvalidParameterValue	string	Недопустимое значение параметра.
InvalidPayload	string	Недопустимые полезные данные.
InvalidPermissions	string	Недопустимые разрешения.
InvalidPrerequisite	string	Недопустимое условие.
InvalidProductId	string	Недопустимый идентификатор продукта.
InvalidProject	string	Недопустимый проект.
InvalidProjectKind	string	Недопустимый тип проекта.
InvalidRecordingsUri	string	Недопустимый URI записей.
InvalidRequestBodyFormat	string	Недопустимый формат текста запроса.
InvalidSasValidityDuration	string	Недопустимая длительность действия SAS.
InvalidSkipTokenForLogs	string	Недопустимый маркер пропуска для журналов.
InvalidSourceAzureResourceId	string	Недопустимый исходный идентификатор ресурса Azure.
InvalidSubscription	string	Недопустимая подписка.
InvalidTest	string	Недопустимый тест.
InvalidTimeToLive	string	Недопустимое время жизни.
InvalidTopForLogs	string	Недопустимый верхний для журналов.
InvalidTranscription	string	Недопустимое транскрибирование.
InvalidWebHookEventKind	string	Недопустимый тип события веб-перехватчика.
MissingInputRecords	string	Отсутствуют входные записи.
ModelCopyOperationExists	string	Операция копирования модели существует.
ModelDeploymentNotCompleteState	string	Развертывание модели не завершено.
ModelDeprecated	string	Модель не рекомендуется.
ModelExists	string	Модель существует.
ModelMismatch	string	Несоответствие модели.
ModelNotDeployable	string	Модель не развертывается.
ModelVersionIncorrect	string	Неправильная версия модели.
NoUtf8WithBom	string	Нет utf8 с bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Только один из URL-адресов, контейнера или набора данных.
ProjectGenderMismatch	string	Несоответствие пола проекта.
QuotaViolation	string	Нарушение квоты.
SingleDefaultEndpoint	string	Одна конечная точка по умолчанию.
SkuLimitsExist	string	Существуют ограничения SKU.
SubscriptionNotFound	string	Подписка не найдена.
UnexpectedError	string	Непредвиденная ошибка.
UnsupportedClassBasedAdaptation	string	Неподдерживаемая адаптация на основе класса.
UnsupportedDelta	string	Неподдерживаемая разностная разница.
UnsupportedDynamicConfiguration	string	Неподдерживаемая динамическая конфигурация.
UnsupportedFilter	string	Неподдерживаемый фильтр.
UnsupportedLanguageCode	string	Неподдерживаемый код языка.
UnsupportedOrderBy	string	Неподдерживаемый порядок.
UnsupportedPagination	string	Неподдерживаемое разбиение на страницы.
UnsupportedTimeRange	string	Неподдерживаемый диапазон времени.

EntityError

Имя	Тип	Описание
code	string	Код этой ошибки.
message	string	Сообщение для этой ошибки.

EntityReference

Имя	Тип	Описание
self	string	Расположение упоминаемой сущности.

Error

Ошибка

Имя	Тип	Описание
code	ErrorCode	ErrorCode Коды ошибок высокого уровня.
details	Error[]	Дополнительные сведения об ошибке и (или) ожидаемых политиках.
innerError	InnerError	InnerError Новый формат внутренней ошибки, соответствующий рекомендациям по API Cognitive Services, который доступен по адресу https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Формат содержит обязательные свойства ErrorCode, сообщение и необязательные свойства target, подробности (пара значений ключа), внутреннюю ошибку (это может быть вложено).
message	string	Сообщение об ошибке высокого уровня.
target	string	Источник ошибки. Например, в случае недействительного документа это будет "документы" или "идентификатор документа".

ErrorCode

Имя	Тип	Описание
Conflict	string	Представляет код ошибки конфликта.
Forbidden	string	Представляет код запрещенной ошибки.
InternalCommunicationFailed	string	Представляет код ошибки сбоя внутреннего взаимодействия.
InternalServerError	string	Представляет код ошибки внутреннего сервера.
InvalidArgument	string	Представляет код ошибки недопустимого аргумента.
InvalidRequest	string	Представляет недопустимый код ошибки запроса.
NotAllowed	string	Представляет недопустимый код ошибки.
NotFound	string	Представляет код ошибки "Не найден".
PipelineError	string	Представляет код ошибки конвейера.
ServiceUnavailable	string	Представляет код ошибки недоступности службы.
TooManyRequests	string	Представляет код ошибки слишком большого количества запросов.
Unauthorized	string	Представляет код неавторизованной ошибки.
UnprocessableEntity	string	Представляет код ошибки необработаемой сущности.
UnsupportedMediaType	string	Представляет код ошибки типа неподдерживаемого носителя.

Evaluation

Ознакомительная версия

Имя	Тип	Описание
createdDateTime	string	Метка времени создания объекта. Метка времени закодирована в формате даты и времени ISO 8601 ("ГГГГ-ММ-ДДЧч:мм:ссЗ", см https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations. ).
customProperties	object	Пользовательские свойства этой сущности. Максимальная допустимая длина ключа составляет 64 символа, максимальная длина значения — 256 символов, а количество разрешенных записей — 10.
dataset	EntityReference	EntityReference
description	string	Описание объекта .
displayName	string	Отображаемое имя объекта.
lastActionDateTime	string	Метка времени ввода текущего состояния. Метка времени закодирована в формате даты и времени ISO 8601 ("ГГГГ-ММ-ДДЧч:мм:ссЗ", см https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations. ).
links	EvaluationLinks	EvaluationLinks
locale	string	Языковой стандарт содержащихся данных.
model1	EntityReference	EntityReference
model2	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EvaluationProperties	EvaluationProperties
self	string	Расположение этой сущности.
status	Status	Состояние Описание текущего состояния API
transcription1	EntityReference	EntityReference
transcription2	EntityReference	EntityReference

EvaluationLinks

Имя	Тип	Описание
files	string	Расположение для получения всех файлов этой сущности. Дополнительные сведения см. в разделе операция "Evaluations_ListFiles".

EvaluationProperties

Имя	Тип	Описание
correctTokenCount1	integer	Число правильно распознаваемых маркеров по модели model1.
correctTokenCount2	integer	Количество правильно распознаваемых маркеров по модели model2.
correctWordCount1	integer	Количество правильно распознаваемых слов по модели1.
correctWordCount2	integer	Количество правильно распознаваемых слов по модели 2.
email	string	Адрес электронной почты для отправки Уведомления по электронной почте в случае завершения операции. Значение будет удалено после успешной отправки сообщения электронной почты.
error	EntityError	EntityError
sentenceCount1	integer	Количество обработанных предложений по модели model1.
sentenceCount2	integer	Количество обработанных предложений по модели 2.
sentenceErrorRate1	number	Частота ошибок при распознавании предложений с моделью model1.
sentenceErrorRate2	number	Частота ошибок при распознавании предложений с помощью model2.
tokenCount1	integer	Количество обработанных маркеров по модели model1.
tokenCount2	integer	Количество обработанных маркеров по модели 2.
tokenDeletionCount1	integer	Количество распознаваемых токенов по модели model1, которые являются удалениями.
tokenDeletionCount2	integer	Количество распознаваемых токенов по модели 2, которые являются удалениями.
tokenErrorRate1	number	Частота ошибок маркера при распознавании с помощью model1.
tokenErrorRate2	number	Частота ошибок маркера при распознавании с помощью model2.
tokenInsertionCount1	integer	Количество распознаваемых токенов по модели model1, которые являются вставками.
tokenInsertionCount2	integer	Количество распознаваемых токенов по модели 2, которые являются вставками.
tokenSubstitutionCount1	integer	Количество распознаваемых токенов по модели model1, которые являются подстановками.
tokenSubstitutionCount2	integer	Количество распознаваемых токенов по модели model2, которые являются подстановками.
wordCount1	integer	Количество обработанных слов по модели model1.
wordCount2	integer	Количество обработанных слов по модели 2.
wordDeletionCount1	integer	Количество распознаваемых слов по модели model1, которые являются удалениями.
wordDeletionCount2	integer	Количество распознаваемых слов по модели 2, которые являются удалениями.
wordErrorRate1	number	Частота ошибок при распознавании слов с моделью model1.
wordErrorRate2	number	Частота ошибок при распознавании слов с помощью model2.
wordInsertionCount1	integer	Количество распознаваемых слов по модели model1, которые являются вставками.
wordInsertionCount2	integer	Количество распознаваемых слов по модели 2, которые являются вставками.
wordSubstitutionCount1	integer	Количество распознаваемых слов по модели model1, которые являются подстановками.
wordSubstitutionCount2	integer	Количество распознаваемых слов по модели 2, которые являются подстановками.

InnerError

Имя	Тип	Описание
code	DetailedErrorCode	DetailedErrorCode Подробное перечисление кода ошибки.
details	object	Дополнительные сведения об ошибке и (или) ожидаемых политиках.
innerError	InnerError	InnerError Новый формат внутренней ошибки, соответствующий рекомендациям api Cognitive Services, которые доступны по адресу https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Формат содержит обязательные свойства ErrorCode, сообщение и необязательные свойства target, подробности (пара значений ключа), внутреннюю ошибку (это может быть вложено).
message	string	Сообщение об ошибке высокого уровня.
target	string	Источник ошибки. Например, в случае недействительного документа это будет "документы" или "идентификатор документа".

Status

Состояние

Имя	Тип	Описание
Failed	string	Долго выполняющаяся операция завершилась сбоем.
NotStarted	string	Долго выполняющаяся операция еще не запущена.
Running	string	В настоящее время выполняется длительная операция.
Succeeded	string	Длительная операция успешно завершена.

Evaluations - Create

Параметры URI

Текст запроса

Ответы

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

Ocp-Apim-Subscription-Key

Authorization

Примеры

Create a evaluation

Sample Request

Sample Response

Определения

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

Evaluation

EvaluationLinks

EvaluationProperties

InnerError

Status

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