Projects - List

Ссылка

Служба:: Azure AI Services

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

Возвращает список проектов для прошедшей проверку подлинности подписки.

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

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

GET {endpoint}/speechtotext/v3.2-preview.2/projects?skip={skip}&top={top}&filter={filter}

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например https://westus.api.cognitive.microsoft.com).
filter	query		string	Выражение фильтрации для выбора подмножества доступных проектов. `- Supported properties: displayName, description, createdDateTime, locale. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime. - and, or, not are supported. - Example: filter=displayName eq 'My test'`
skip	query		integer (int32)	Количество наборов данных, которые будут пропущены.
top	query		integer (int32)	Количество наборов данных, которые будут включены после пропуска.

Ответы

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

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

Ocp-Apim-Subscription-Key

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

Тип: apiKey
В: header

Authorization

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

Тип: apiKey
В: header

Примеры

Get all projects

Get all projects created in 2018 or 2019

Get all projects

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

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/projects?skip=0&top=3

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

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

{
  "values": [
    {
      "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"
    },
    {
      "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"
    },
    {
      "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"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects?skip=3&top=3"
}

Get all projects created in 2018 or 2019

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

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/projects?skip=0&top=3&filter=createdDateTime%20ge%202018-01-01T00:00:00Z%20and%20createdDateTime%20lt%202020-01-01T00:00:00Z

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

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

{
  "values": [
    {
      "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": "2018-03-03T12:45:27Z",
      "locale": "en-US",
      "displayName": "My speech project"
    },
    {
      "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": "2018-12-19T17:54:57Z",
      "locale": "en-US",
      "displayName": "My speech project"
    },
    {
      "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-02-01T00:45:27Z",
      "locale": "en-US",
      "displayName": "My speech project"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects?skip=6&top=3&filter=createdDateTime%20ge%202018-01-01T00:00:00Z%20and%20createdDateTime%20lt%202020-01-01T00:00:00Z"
}

Определения

Имя	Описание
DetailedErrorCode	DetailedErrorCode
Error	Ошибка
ErrorCode	Код ошибки
InnerError	InnerError
PaginatedProjects	Разбивка на страницы
Project	Проект
ProjectLinks	ProjectLinks
ProjectProperties	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 с бомом.
OnlyOneOfUrlsOrContainerOrDataset	Только один url-адрес или контейнер или набор данных.
ProjectGenderMismatch	Несоответствие пола проекта.
QuotaViolation	Нарушение квоты.
SingleDefaultEndpoint	Одна конечная точка по умолчанию.
SkuLimitsExist	Существуют ограничения SKU.
SubscriptionNotFound	Подписка не найдена.
UnexpectedError	Непредвиденная ошибка.
UnsupportedClassBasedAdaptation	Неподдерживаемая адаптация на основе класса.
UnsupportedDelta	Неподдерживаемые разностные данные.
UnsupportedDynamicConfiguration	Неподдерживаемая динамическая конфигурация.
UnsupportedFilter	Неподдерживаемый фильтр.
UnsupportedLanguageCode	Неподдерживаемый код языка.
UnsupportedOrderBy	Неподдерживаемый заказ.
UnsupportedPagination	Неподдерживаемая разбивка на страницы.
UnsupportedTimeRange	Неподдерживаемый диапазон времени.

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

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

Код ошибки

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

PaginatedProjects

Object

Разбивка на страницы

Имя	Тип	Описание
@nextLink	string (uri)	Ссылка на следующий набор результатов с разбивкой на страницы, если доступны дополнительные сущности; в противном случае значение NULL.
values	Project[]	Список сущностей, ограниченных переданными параметрами запроса "skip" и "top" или их значениями по умолчанию. При итерации по списку с помощью разбиения на страницы и удаления сущностей параллельно некоторые сущности будут пропущены в результатах. Рекомендуется создать список на клиенте и удалить после получения полного списка.

Имя

Тип

Описание

@nextLink

string (uri)

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

values

Project[]

Список сущностей, ограниченных переданными параметрами запроса "skip" и "top" или их значениями по умолчанию.

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

Project

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.
description	string	Описание объекта.
displayName	string minLength: 1	Отображаемое имя объекта.
links	ProjectLinks	ProjectLinks
locale	string minLength: 1	Языковой стандарт содержащихся данных.
properties	ProjectProperties	ProjectProperties
self	string (uri)	Расположение этой сущности.

ProjectLinks

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

ProjectProperties

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

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

Projects - List

Параметры URI

Ответы

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

Ocp-Apim-Subscription-Key

Authorization

Примеры

Get all projects

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

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

Get all projects created in 2018 or 2019

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

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

Определения

DetailedErrorCode

Error

ErrorCode

InnerError

PaginatedProjects

Project

ProjectLinks

ProjectProperties

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