Iteration Operations - Get Iteration

Служба:

Azure AI Services

Версия API:

2024-05-20-preview

Получение итерации по идентификатору.

GET {endpoint}/videotranslation/translations/{translationId}/iterations/{iterationId}?api-version=2024-05-20-preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например https://eastus.api.cognitive.microsoft.com).
iterationId	path	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Идентификатор итерации
translationId	path	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Идентификатор ресурса перевода.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	Iteration	Запрос выполнен успешно.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Непредвиденное сообщение об ошибке. Заголовки x-ms-error-code: string

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

Ocp-Apim-Subscription-Key

Укажите здесь ключ ресурса службы "Речь".

Тип: apiKey
В: header

AADToken

Это потоки платформы удостоверений Майкрософт.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
https://cognitiveservices.azure.com/.default

Примеры

Get Iteration

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

HTTP

GET {endpoint}/videotranslation/translations/TranslateMyZhCNVideo/iterations/TranslateMyZhCNVideo-Iteration-1?api-version=2024-05-20-preview

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

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

200

{
  "id": "TranslateMyZhCNVideo-Iteration-1",
  "description": "Translate video from en-US to zh-CN, fix segment issue.",
  "status": "Succeeded",
  "createdDateTime": "2023-04-10T05:30:00.000Z",
  "lastActionDateTime": "2023-04-10T05:15:30.000Z",
  "input": {
    "speakerCount": 3,
    "subtitleMaxCharCountPerSegment": 80,
    "webvttFile": {
      "url": "https://xxx.blob.core.windows.net/container1/myvtt.vtt?sv=2023-01-03&st=2024-05-20T08%3A27%3A15Z&se=2024-05-21T08%3A27%3A15Z&sr=b&sp=r&sig=xxx",
      "kind": "MetadataJson"
    }
  },
  "result": {
    "translatedVideoFileUrl": "https://xxx.blob.core.windows.net/container1/video.mp4?sv=2023-01-03&st=2024-05-20T08%3A27%3A15Z&se=2024-05-21T08%3A27%3A15Z&sr=b&sp=r&sig=xxx",
    "sourceLocaleSubtitleWebvttFileUrl": "https://xxx.blob.core.windows.net/container1/sourceLocale.vtt?sv=2023-01-03&st=2024-05-20T08%3A27%3A15Z&se=2024-05-21T08%3A27%3A15Z&sr=b&sp=r&sig=xxx",
    "targetLocaleSubtitleWebvttFileUrl": "https://xxx.blob.core.windows.net/container1/targetLocale.vtt?sv=2023-01-03&st=2024-05-20T08%3A27%3A15Z&se=2024-05-21T08%3A27%3A15Z&sr=b&sp=r&sig=xxx",
    "metadataJsonWebvttFileUrl": "https://xxx.blob.core.windows.net/container1/metadataJsonLocale.vtt?sv=2023-01-03&st=2024-05-20T08%3A27%3A15Z&se=2024-05-21T08%3A27%3A15Z&sr=b&sp=r&sig=xxx"
  }
}

Определения

Имя	Описание
Azure.Core.Foundations.Error	Объект ошибки.
Azure.Core.Foundations.ErrorResponse	Ответ, содержащий сведения об ошибке.
Azure.Core.Foundations.InnerError	Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Iteration	Выполните одну итерацию, чтобы перевести один видеофайл из исходного языкового стандарта в целевой языковой стандарт, webvtt для редактирования содержимого является необязательным для запроса параметра.
IterationInput	Входные данные итерации.
IterationResult	Результат итерации.
Status	Состояние задачи.
WebvttFile	Файл webvtt перевода.
WebvttFileKind	Тип файла Webvtt.

Azure.Core.Foundations.Error

Object

Объект ошибки.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
details	Azure.Core.Foundations.Error[]	Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror	Azure.Core.Foundations.InnerError	Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message	string	Читаемое пользователем представление ошибки.
target	string	Целевой объект ошибки.

Azure.Core.Foundations.ErrorResponse

Object

Ответ, содержащий сведения об ошибке.

Имя	Тип	Описание
error	Azure.Core.Foundations.Error	Объект ошибки.

Azure.Core.Foundations.InnerError

Object

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
innererror	Azure.Core.Foundations.InnerError	Внутренняя ошибка.

Iteration

Object

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

Имя	Тип	Описание
createdDateTime	string (date-time)	Метка времени создания объекта. Метка времени закодирована как формат даты и времени ISO 8601 ("ГГГГ-ММ-DDThh:мм:ssZ", см. https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Описание итерации
failureReason	string	Причина сбоя итерации
id	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Идентификатор итерации
input	IterationInput	Входные данные итерации.
lastActionDateTime	string (date-time)	Метка времени ввода текущего состояния. Метка времени закодирована как формат даты и времени ISO 8601 ("ГГГГ-ММ-DDThh:мм:ssZ", см. https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
result	IterationResult	Результат итерации.
status	Status	Состояние итерации

IterationInput

Object

Входные данные итерации.

Имя	Тип	Описание
exportSubtitleInVideo	boolean	Экспорт субтитров в видео.
speakerCount	integer (int32)	Количество динамиков в видео.
subtitleMaxCharCountPerSegment	integer (int32)	Максимальное число символов подзаголовок для каждого сегмента.
webvttFile	WebvttFile	Webvtt-файл для редактирования содержимого этот параметр необходим во втором запросе на создание итерации перевода.

IterationResult

Object

Результат итерации.

Имя	Тип	Описание
metadataJsonWebvttFileUrl	string (uri)	URL-адрес файла webvtt json метаданных.
reportFileUrl	string (uri)	URL-адрес файла отчета.
sourceLocaleSubtitleWebvttFileUrl	string (uri)	URL-адрес исходного файла субтитров языкового стандарта.
targetLocaleSubtitleWebvttFileUrl	string (uri)	Целевой URL-адрес файла субтитров языкового стандарта.
translatedVideoFileUrl	string (uri)	URL-адрес преобразованного видеофайла.

Status

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

Состояние задачи.

Значение	Описание
Canceled	Состояние отменено
Failed	Состояние выполнения завершилось сбоем
NotStarted	Состояние "Не запущено"
Running	Состояние выполнения
Succeeded	Состояние успешного выполнения

WebvttFile

Object

Файл webvtt перевода.

Имя	Тип	Описание
kind	WebvttFileKind	Тип файла webvtt перевода.
url	string (uri)	URL-адрес файла webvtt перевода.

WebvttFileKind

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

Тип файла Webvtt.

Значение	Описание
MetadataJson	Целевой файл webvtt метаданных языкового стандарта JSON
SourceLocaleSubtitle	Исходный файл webvtt для обычного текста
TargetLocaleSubtitle	Целевой файл веб-vtt для обычного текста языкового стандарта