Projects - List Endpoints

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

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

GET {endpoint}/speechtotext/v3.2-preview.2/projects/{id}/endpoints
С использованием необязательных параметров: 
GET {endpoint}/speechtotext/v3.2-preview.2/projects/{id}/endpoints?skip={skip}&top={top}&filter={filter}

Параметры URI

Имя В Обязательно Тип Описание
endpoint
 path True

string

Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например https://westus.api.cognitive.microsoft.com).
id
 path True

string (uuid)

Идентификатор проекта.
filter
 query

string

Выражение фильтрации для выбора подмножества доступных конечных точек.

        - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.

        - Operators:

          - eq, ne are supported for all properties.

          - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.

          - and, or, not are supported.

        - Example:

          filter=locale eq 'en-US'
skip
 query

integer (int32)

Количество наборов данных, которые будут пропущены.
top
 query

integer (int32)

Количество наборов данных, которые будут включены после пропуска.

Ответы

Имя Тип Описание
200 OK

PaginatedEndpoints

ХОРОШО

Заголовки

Retry-After: integer
Other Status Codes

Error

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

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

Ocp-Apim-Subscription-Key

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

Тип: apiKey
В: header

Authorization

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

Тип: apiKey
В: header

Примеры

Get all endpoints

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

GET {endpoint}/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints?skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z

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

Код состояния:
200 
{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "links": {
        "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs",
        "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6"
      },
      "properties": {
        "timeToLive": "PT30M",
        "loggingEnabled": true
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Speech endpoint",
      "description": "Example for speech endpoint"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
      },
      "links": {
        "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs",
        "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6"
      },
      "properties": {
        "timeToLive": "PT30M",
        "loggingEnabled": false
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "NotStarted",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Speech endpoint",
      "description": "Example for speech endpoint"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z"
}

Определения

Имя Описание
DetailedErrorCode

DetailedErrorCode
Endpoint

Конечная точка
EndpointLinks

EndpointLinks
EndpointProperties

EndpointProperties
EntityError

EntityError
EntityReference

EntityReference
Error

Ошибка
ErrorCode

Код ошибки
InnerError

InnerError
PaginatedEndpoints

Разбиение на страницы
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

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

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

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

Endpoint

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

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

string (date-time)

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

EndpointLinks

EndpointLinks
locale

string

minLength: 1

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

EntityReference

EntityReference
project

EntityReference

EntityReference
properties

EndpointProperties

EndpointProperties
self

string (uri)

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

Status

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

string

Текст, используемый для адаптации языковой модели для этой конечной точки.
Object

EndpointLinks

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

string (uri)

Журналы аудио и транскрибирования для этой конечной точки. Дополнительные сведения см. в операции "Endpoints_ListLogs".
restConversation

string (uri)

Конечная точка REST для запросов до 60 секунд.
restDictation

string (uri)

Конечная точка REST для запросов до 60 секунд, поддерживающая диктовку знаков препинания.
restInteractive

string (uri)

Конечная точка REST для коротких запросов до 15 секунд.
webSocketConversation

string (uri)

Конечная точка пакета SDK службы "Речь" для длительных запросов с несколькими конечными результатами.
webSocketDictation

string (uri)

Конечная точка пакета SDK службы "Речь" для длинных запросов с несколькими конечными результатами, поддерживающая диктовку знаков препинания.
webSocketInteractive

string (uri)

Конечная точка пакета SDK службы "Речь" для коротких запросов до 15 секунд с одним конечным результатом.

EndpointProperties

Object

EndpointProperties

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

string

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

EntityError

EntityError
loggingEnabled

boolean

Значение, указывающее, используется ли ведение журнала содержимого (аудио & транскрибирования) для развертывания.
timeToLive

string

Сколько времени конечная точка будет храниться в системе. Когда конечная точка достигнет времени жизни после завершения (успешно или неудачно), она будет автоматически удалена. Не задано это значение или значение 0 отключает автоматическое удаление. Самая длинная поддерживаемая длительность — 31 дней. Длительность закодирована как длительность ISO 8601 ("PnYnMnDTnHnMnS", см. https://en.wikipedia.org/wiki/ISO_8601#Durations).

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

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

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

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

PaginatedEndpoints

Object

Разбиение на страницы

Имя Тип Описание
@nextLink

string (uri)

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

Endpoint[]

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

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

Status

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

Состояние

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

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

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

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

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