Create Evaluation - Create Evaluation

Служба:
Azure AI Services
Версия API:
v3.0

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

POST {Endpoint}/speechtotext/v3.0/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

Описание объекта.
links

Links

Ссылки.
project

EntityReference

EntityReference
properties

EvaluationProperties

EvaluationProperties
transcription1

EntityReference

EntityReference
transcription2

EntityReference

EntityReference

Ответы

Имя Тип Описание
201 Created

Evaluation

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

Заголовки

Location: string
Other Status Codes

Error

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

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

Ocp-Apim-Subscription-Key

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

Тип: apiKey
В: header

Authorization

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

Тип: apiKey
В: header

Примеры

Create a evaluation

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

POST https://westus.api.cognitive.microsoft.com//speechtotext/v3.0/evaluations

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

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

Код состояния:
201 
Location: https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6
{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6",
  "model1": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "model2": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "dataset": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
  },
  "transcription2": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f"
  },
  "transcription1": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683"
  },
  "links": {
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/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
  },
  "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

Код ошибки
Evaluation

Оценка
EvaluationProperties

EvaluationProperties
InnerError

InnerError
Links

Ссылки.
Status

Состояние

DetailedErrorCode

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

DetailedErrorCode

Значение Описание
InvalidParameterValue

Недопустимое значение параметра.
InvalidRequestBodyFormat

Недопустимый формат текста запроса.
EmptyRequest

Пустой запрос.
MissingInputRecords

Отсутствуют входные записи.
InvalidDocument

Недопустимый документ.
ModelVersionIncorrect

Неправильная версия модели.
InvalidDocumentBatch

Недопустимый пакет документов.
UnsupportedLanguageCode

Неподдерживаемый код языка.
DataImportFailed

Сбой импорта данных.
InUseViolation

Нарушение использования.
InvalidLocale

Недопустимый языковой стандарт.
InvalidBaseModel

Недопустимая базовая модель.
InvalidAdaptationMapping

Недопустимое сопоставление адаптации.
InvalidDataset

Недопустимый набор данных.
InvalidTest

Недопустимый тест.
FailedDataset

Не удалось выполнить набор данных.
InvalidModel

Недопустимая модель.
InvalidTranscription

Недопустимое транскрибирование.
InvalidPayload

Недопустимые полезные данные.
InvalidParameter

Недопустимый параметр.
EndpointWithoutLogging

Конечная точка без ведения журнала.
InvalidPermissions

Недопустимые разрешения.
InvalidPrerequisite

Недопустимое условие.
InvalidProductId

Недопустимый идентификатор продукта.
InvalidSubscription

Недопустимая подписка.
InvalidProject

Недопустимый проект.
InvalidProjectKind

Недопустимый тип проекта.
InvalidRecordingsUri

Недопустимые URI записей.
OnlyOneOfUrlsOrContainerOrDataset

Только один url-адрес или контейнер или набор данных.
ExceededNumberOfRecordingsUris

Превышено количество uri записей.
ModelMismatch

Несоответствие модели.
ProjectGenderMismatch

Несоответствие пола проекта.
ModelDeprecated

Модель устарела.
ModelExists

Существует модель.
ModelNotDeployable

Модель недоступна для развертывания.
EndpointNotUpdatable

Конечная точка не обновляемая.
SingleDefaultEndpoint

Одна конечная точка по умолчанию.
EndpointCannotBeDefault

Конечная точка не может быть по умолчанию.
InvalidModelUri

Недопустимый универсальный код ресурса (URI) модели.
SubscriptionNotFound

Подписка не найдена.
QuotaViolation

Нарушение квоты.
UnsupportedDelta

Неподдерживаемые разностные данные.
UnsupportedFilter

Неподдерживаемый фильтр.
UnsupportedPagination

Неподдерживаемая разбивка на страницы.
UnsupportedDynamicConfiguration

Неподдерживаемая динамическая конфигурация.
UnsupportedOrderBy

Неподдерживаемый заказ.
NoUtf8WithBom

Нет utf8 с бомом.
ModelDeploymentNotCompleteState

Развертывание модели не завершено.
SkuLimitsExist

Существуют ограничения SKU.
DeployingFailedModel

Развертывание неудачной модели.
UnsupportedTimeRange

Неподдерживаемый диапазон времени.
InvalidLogDate

Недопустимая дата журнала.
InvalidLogId

Недопустимый идентификатор журнала.
InvalidLogStartTime

Недопустимое время запуска журнала.
InvalidLogEndTime

Недопустимое время окончания журнала.
InvalidTopForLogs

Недопустимое начало для журналов.
InvalidSkipTokenForLogs

Недопустимый маркер пропуска для журналов.
DeleteNotAllowed

Удалить не разрешено.
Forbidden

Запретный.
DeployNotAllowed

Развертывание не разрешено.
UnexpectedError

Непредвиденная ошибка.
InvalidCollection

Недопустимая коллекция.
InvalidCallbackUri

Недопустимый универсальный код ресурса (URI) обратного вызова.
InvalidSasValidityDuration

Недопустимая длительность действия sas.
InaccessibleCustomerStorage

Недоступное хранилище клиентов.
UnsupportedClassBasedAdaptation

Неподдерживаемая адаптация на основе класса.
InvalidWebHookEventKind

Недопустимый тип события веб-перехватчика.
InvalidTimeToLive

Недопустимое время жизни.

EntityError

Object

EntityError

Имя Тип Описание
code

string

Код этой ошибки.
message

string

Сообщение об этой ошибке.

EntityReference

Object

EntityReference

Имя Тип Описание
self

string (uri)

Расположение указанной сущности.

Error

Object

Ошибка

Имя Тип Описание
code

ErrorCode

Код ошибки
Коды ошибок высокого уровня.
details

Error[]

Дополнительные сведения о поддержке ошибок и (или) ожидаемых политик.
innerError

InnerError

InnerError
Новый формат внутренней ошибки, соответствующий рекомендациям ПО API Cognitive Services, который доступен в https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Это содержит обязательные свойства ErrorCode, сообщение и необязательные свойства, сведения (пара значений ключа), внутренняя ошибка (это может быть вложено).
message

string

Сообщение об ошибке высокого уровня.
target

string

Источник ошибки. Например, это будет "документы" или "идентификатор документа" в случае недопустимого документа.

ErrorCode

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

Код ошибки

Значение Описание
InvalidRequest

Представляет недопустимый код ошибки запроса.
InvalidArgument

Представляет недопустимый код ошибки аргумента.
InternalServerError

Представляет код ошибки внутреннего сервера.
ServiceUnavailable

Представляет недоступный код ошибки службы.
NotFound

Представление не найденного кода ошибки.
PipelineError

Представляет код ошибки конвейера.
Conflict

Представляет код ошибки конфликта.
InternalCommunicationFailed

Представляет код ошибки внутренней связи.
Forbidden

Представляет запрещенный код ошибки.
NotAllowed

Представляет недопустимый код ошибки.
Unauthorized

Представляет несанкционированный код ошибки.
UnsupportedMediaType

Представляет неподдерживаемый код ошибки типа носителя.
TooManyRequests

Представление слишком большого количества запросов кода ошибки.
UnprocessableEntity

Представляет код ошибки необработанной сущности.

Evaluation

Object

Оценка

Имя Тип Описание
createdDateTime

string (date-time)

Метка времени при создании объекта. Метка времени закодирована как формат даты и времени ISO 8601 ("ГГГГ-ММ-DDThh:мм:ssZ", см. 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 (date-time)

Метка времени при вводе текущего состояния. Метка времени закодирована как формат даты и времени ISO 8601 ("ГГГГ-ММ-DDThh:мм:ssZ", см. https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links

Links

Ссылки.
locale

string

Языковой стандарт содержащихся данных.
model1

EntityReference

EntityReference
model2

EntityReference

EntityReference
project

EntityReference

EntityReference
properties

EvaluationProperties

EvaluationProperties
self

string (uri)

Расположение этой сущности.
status

Status

Состояние
Описание текущего состояния API
transcription1

EntityReference

EntityReference
transcription2

EntityReference

EntityReference

EvaluationProperties

Object

EvaluationProperties

Имя Тип Описание
correctWordCount1

integer (int32)

Число правильно распознанных слов по модели1.
correctWordCount2

integer (int32)

Число правильно распознанных слов по модели2.
email

string

Адрес электронной почты для отправки уведомлений по электронной почте в случае завершения операции. Значение будет удалено после успешной отправки сообщения электронной почты.
error

EntityError

EntityError
sentenceCount1

integer (int32)

Количество обработанных предложений по модели1.
sentenceCount2

integer (int32)

Количество обработанных предложений по модели2.
sentenceErrorRate1

number (double)

Частота ошибок предложения при распознавании с моделью 1.
sentenceErrorRate2

number (double)

Частота ошибок предложения при распознавании с моделью 2.
wordCount1

integer (int32)

Количество обработанных слов по модели1.
wordCount2

integer (int32)

Количество обработанных слов по модели2.
wordDeletionCount1

integer (int32)

Число распознанных слов по модели1, которые являются удалениями.
wordDeletionCount2

integer (int32)

Число распознанных слов по модели2, которые являются удалениями.
wordErrorRate1

number (double)

Скорость распознавания слов с моделью 1.
wordErrorRate2

number (double)

Скорость распознавания слов с моделью 2.
wordInsertionCount1

integer (int32)

Число распознанных слов по модели1, которые являются вставками.
wordInsertionCount2

integer (int32)

Число распознанных слов по модели2, которые являются вставками.
wordSubstitutionCount1

integer (int32)

Число распознанных слов по модели1, которые являются подстановками.
wordSubstitutionCount2

integer (int32)

Число распознанных слов по модели2, которые являются подстановками.

InnerError

Object

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, сообщение и необязательные свойства, сведения (пара значений ключа), внутренняя ошибка (это может быть вложено).
message

string

Сообщение об ошибке высокого уровня.
target

string

Источник ошибки. Например, это будет "документы" или "идентификатор документа" в случае недопустимого документа.
Object

Ссылки.

Имя Тип Описание
files

string (uri)

Расположение для получения всех файлов этой сущности.

Status

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

Состояние

Значение Описание
NotStarted

Долго выполняющаяся операция еще не запущена.
Running

В настоящее время выполняется длительная операция.
Succeeded

Долго выполняющаяся операция успешно завершена.
Failed

Сбой длительной операции.