Projects - Get

Ссылка

Служба:: Azure AI Services

Версия API:: v3.2-preview.2

Возвращает проект, определенный заданным идентификатором.

GET {endpoint}/speechtotext/v3.2-preview.2/projects/{id}

Параметры URI

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

Ответы

Имя	Тип	Описание
200 OK	Project	ОК
Other Status Codes	Error	Произошла ошибка.

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

Ocp-Apim-Subscription-Key

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

Тип: apiKey
В: header

Authorization

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

Тип: apiKey
В: header

Примеры

Get a project

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

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0

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

Код состояния:: 200

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
  "links": {
    "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
    "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
    "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
    "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
    "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
  },
  "properties": {
    "datasetCount": 23,
    "evaluationCount": 42,
    "modelCount": 2,
    "transcriptionCount": 1994,
    "endpointCount": 12
  },
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "My speech project"
}

Определения

Имя	Описание
DetailedErrorCode	DetailedErrorCode
Error	Ошибка
ErrorCode	ErrorCode
InnerError	InnerError
Project	Project
ProjectLinks	ProjectLinks
ProjectProperties	Свойства проекта

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	Неподдерживаемый диапазон времени.

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	Представляет код ошибки типа неподдерживаемого носителя.

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	Источник ошибки. Например, в случае недействительного документа это будет "документы" или "идентификатор документа".

Project

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

ProjectLinks

Имя	Тип	Описание
datasets	string	Расположение для получения списка всех наборов данных этого проекта. Дополнительные сведения см. в разделе операция "Projects_ListDatasets".
endpoints	string	Расположение для получения списка всех конечных точек этого проекта. Дополнительные сведения см. в разделе операция "Projects_ListEndpoints".
evaluations	string	Расположение для получения списка всех оценок этого проекта. Дополнительные сведения см. в разделе операция "Projects_ListEvaluations".
models	string	Расположение для получения списка всех моделей этого проекта. Дополнительные сведения см. в разделе операция "Projects_ListModels".
transcriptions	string	Расположение для получения списка всех транскрибирования этого проекта. Дополнительные сведения см. в разделе Операция "Projects_ListTranscriptions".

ProjectProperties

Свойства проекта

Имя	Тип	Описание
datasetCount	integer	Количество наборов данных, связанных с этим проектом.
endpointCount	integer	Количество конечных точек, связанных с этим проектом.
evaluationCount	integer	Количество оценок, связанных с этим проектом.
modelCount	integer	Количество моделей, связанных с этим проектом.
transcriptionCount	integer	Количество транскрибирования, связанных с этим проектом.

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