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

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

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

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

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

DetailedErrorCode

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

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

Удаление запрещено.
DeployNotAllowed

Развертывание запрещено.
DeployingFailedModel

Развертывание модели со сбоем.
EmptyRequest

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

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

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

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

Превышено число URI записей.
FailedDataset

Сбой набора данных.
Forbidden

Запрещено.
InUseViolation

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

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

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

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

Недопустимый URI обратного вызова.
InvalidCollection

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

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

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

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

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

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

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

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

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

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

Недопустимый URI модели.
InvalidParameter

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

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

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

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

Недопустимое предварительное условие.
InvalidProductId

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Операция копирования модели существует.
ModelDeploymentNotCompleteState

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

Модель не рекомендуется.
ModelExists

Модель существует.
ModelMismatch

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

Модель не развертывается.
ModelVersionIncorrect

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

Нет utf8 с bom.
OnlyOneOfUrlsOrContainerOrDataset

Только один из URL-адресов, контейнера или набора данных.
ProjectGenderMismatch

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Error

Object

Ошибка

Имя Тип Описание
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

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

ErrorCode

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

string

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

string

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

Project

Object

Project

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

string (date-time)

Метка времени создания объекта. Метка времени закодирована в формате даты и времени ISO 8601 ("ГГГГ-ММ-ДДЧч:мм:ссЗ", см https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations. ).
customProperties

object

Пользовательские свойства этой сущности. Максимальная допустимая длина ключа составляет 64 символа, максимальная длина значения — 256 символов, а количество разрешенных записей — 10.
description

string

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

string

minLength: 1

Отображаемое имя объекта.
links

ProjectLinks

ProjectLinks
locale

string

minLength: 1

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

ProjectProperties

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

string (uri)

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

ProjectLinks

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

string (uri)

Расположение для получения списка всех наборов данных этого проекта. Дополнительные сведения см. в разделе операция "Projects_ListDatasets".
endpoints

string (uri)

Расположение для получения списка всех конечных точек этого проекта. Дополнительные сведения см. в разделе операция "Projects_ListEndpoints".
evaluations

string (uri)

Расположение для получения списка всех оценок этого проекта. Дополнительные сведения см. в разделе операция "Projects_ListEvaluations".
models

string (uri)

Расположение для получения списка всех моделей этого проекта. Дополнительные сведения см. в разделе операция "Projects_ListModels".
transcriptions

string (uri)

Расположение для получения списка всех транскрибирования этого проекта. Дополнительные сведения см. в разделе Операция "Projects_ListTranscriptions".

ProjectProperties

Object

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

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

integer (int32)

Количество наборов данных, связанных с этим проектом.
endpointCount

integer (int32)

Количество конечных точек, связанных с этим проектом.
evaluationCount

integer (int32)

Количество оценок, связанных с этим проектом.
modelCount

integer (int32)

Количество моделей, связанных с этим проектом.
transcriptionCount

integer (int32)

Количество транскрибирования, связанных с этим проектом.