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


Endpoints - List Logs

Возвращает список журналов аудио и транскрибирования, хранящихся для данной конечной точки.

GET {endpoint}/speechtotext/v3.2-preview.2/endpoints/{id}/files/logs
GET {endpoint}/speechtotext/v3.2-preview.2/endpoints/{id}/files/logs?sasValidityInSeconds={sasValidityInSeconds}&skipToken={skipToken}&top={top}

Параметры URI

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

string

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

id
path True

string (uuid)

Идентификатор конечной точки.

sasValidityInSeconds
query

integer (int32)

Длительность в секундах, когда URL-адрес SAS должен быть допустимым. Длительность по умолчанию составляет 12 часов. При использовании BYOS (https://learn.microsoft.com/en-us/azure/cognitive-services/speech-service/speech-encryption-of-data-at-rest#bring-your-own-storage-byos-for-customization-and-logging): значение 0 означает, что будет создан обычный URI BLOB-объектов без маркера SAS.

skipToken
query

string

Маркер для пропуска журналов, которые уже были получены в предыдущих запросах. Разбиение на страницы начинается с начала, когда не определено.

top
query

integer (int32)

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

Ответы

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

PaginatedFiles

ХОРОШО

Заголовки

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 endpoint logs

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

GET {endpoint}/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs?sasValidityInSeconds=120&skipToken=2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--&top=2

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

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav",
      "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav",
      "kind": "Audio",
      "properties": {
        "size": 12345
      },
      "createdDateTime": "2020-01-13T08:00:00Z",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.wav?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5"
      }
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json",
      "name": "2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json",
      "kind": "Transcription",
      "properties": {
        "size": 12345
      },
      "createdDateTime": "2020-01-13T08:00:00Z",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/2019-09-20_080000_3b5f4628-e225-439d-bd27-8804f9eed13f.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5"
      }
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs?top=2&skipToken=2!188!MDAwMDk1ITZhMjhiMDllLTg0MDYtNDViMi1hMGRkLWFlNzRlOGRhZWJkNi8yMDIwLTA0LTAxLzEyNDY0M182MzI5NGRkMi1mZGYzLTRhZmEtOTA0NC1mODU5ZTcxOWJiYzYud2F2ITAwMDAyOCE5OTk5LTEyLTMxVDIzOjU5OjU5Ljk5OTk5OTlaIQ--"
}

Определения

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

DetailedErrorCode

Error

Ошибка

ErrorCode

Код ошибки

File

Файл

FileKind

FileKind

FileLinks

FileLinks

FileProperties

FileProperties

InnerError

InnerError

PaginatedFiles

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

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

Ошибка

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

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

File

Файл

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

string (date-time)

Время создания этого файла. Метка времени кодируется как формат даты и времени ISO 8601 (см. https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

kind

FileKind

FileKind
Тип данных.

links

FileLinks

FileLinks

name

string

Имя этого файла.

properties

FileProperties

FileProperties

self

string (uri)

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

FileKind

FileKind

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

Тип данных — это архив акустических данных.

AcousticDataTranscriptionV2

Тип данных — акустическое транскрибирование данных версии 2.

Audio

Тип данных — звук.

DatasetReport

Тип данных — отчет о наборе данных.

EvaluationDetails

Тип данных — это сведения об оценке.

LanguageData

Тип данных — это языковые данные.

ModelReport

Тип данных — это отчет модели.

OutputFormattingData

Тип данных — выходной входной файл форматирования.

PronunciationData

Тип данных — это данные произношения.

Transcription

Тип данных — транскрибирование.

TranscriptionReport

Тип данных — отчет транскрибирования.

FileLinks

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

string (uri)

URL-адрес для получения содержимого этого файла.

FileProperties

FileProperties

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

string

Длительность в случае, если этот файл является звуковым файлом. Длительность закодирована как длительность ISO 8601 ("PnYnMnDTnHnMnS", см. https://en.wikipedia.org/wiki/ISO_8601#Durations).

size

integer (int64)

Размер данных в байтах.

InnerError

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

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

PaginatedFiles

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

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

string (uri)

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

values

File[]

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

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