Iteration Operations - Get Iteration

  • Reference
Service:
Azure AI Services
API Version:
2024-05-20-preview

Fetch a iteration by ID.

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

URI Parameters

Name In Required Type Description
endpoint
 path True

string

Supported Cognitive Services endpoints (protocol and hostname, for example: https://eastus.api.cognitive.microsoft.com).
iterationId
 path True

string

Iteration ID

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
translationId
 path True

string

Translation resource ID.

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
api-version
 query True

string

The API version to use for this operation.

Responses

Name Type Description
200 OK

Iteration

The request has succeeded.
Other Status Codes

Azure.Core.Foundations.ErrorResponse

An unexpected error response.

Headers

x-ms-error-code: string

Security

Ocp-Apim-Subscription-Key

Provide your Speech resource key here.

Type: apiKey
In: header

AADToken

These are the Microsoft identity platform flows.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
https://cognitiveservices.azure.com/.default

Examples

Get Iteration

Sample request

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

Sample response

Status code:
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"
  }
}

Definitions

Name Description
Azure.Core.Foundations.Error

The error object.
Azure.Core.Foundations.ErrorResponse

A response containing error details.
Azure.Core.Foundations.InnerError

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Iteration

Do one iteration to translate one video file from source locale to target locale, webvtt for content editing is optional for requesting parameter.
IterationInput

Iteration input.
IterationResult

Iteration result.
Status

Task status.
WebvttFile

Translation webvtt file.
WebvttFileKind

Webvtt file kind.

Azure.Core.Foundations.Error

The error object.

Name Type Description
code

string

One of a server-defined set of error codes.
details

Azure.Core.Foundations.Error[]

An array of details about specific errors that led to this reported error.
innererror

Azure.Core.Foundations.InnerError

An object containing more specific information than the current object about the error.
message

string

A human-readable representation of the error.
target

string

The target of the error.

Azure.Core.Foundations.ErrorResponse

A response containing error details.

Name Type Description
error

Azure.Core.Foundations.Error

The error object.

Azure.Core.Foundations.InnerError

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Type Description
code

string

One of a server-defined set of error codes.
innererror

Azure.Core.Foundations.InnerError

Inner error.

Iteration

Do one iteration to translate one video file from source locale to target locale, webvtt for content editing is optional for requesting parameter.

Name Type Description
createdDateTime

string

The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description

string

Iteration description
failureReason

string

Iteration failure reason
id

string

Iteration ID
input

IterationInput

Iteration input.
lastActionDateTime

string

The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
result

IterationResult

Iteration result.
status

Status

Iteration status

IterationInput

Iteration input.

Name Type Description
exportSubtitleInVideo

boolean

Export subtitle in video.
speakerCount

integer

Number of speakers in the video.
subtitleMaxCharCountPerSegment

integer

Subtitle max display character count per segment.
webvttFile

WebvttFile

Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation.

IterationResult

Iteration result.

Name Type Description
metadataJsonWebvttFileUrl

string

Metadata json webvtt file URL.
reportFileUrl

string

Report file URL.
sourceLocaleSubtitleWebvttFileUrl

string

Source locale subtitle file URL.
targetLocaleSubtitleWebvttFileUrl

string

Target locale subtitle file URL.
translatedVideoFileUrl

string

Translated video file URL.

Status

Task status.

Name Type Description
Canceled

string

Cancelled status
Failed

string

Run failed status
NotStarted

string

Not started status
Running

string

Running status
Succeeded

string

Run succeeded status

WebvttFile

Translation webvtt file.

Name Type Description
kind

WebvttFileKind

Translation webvtt file kind.
url

string

Translation webvtt file url.

WebvttFileKind

Webvtt file kind.

Name Type Description
MetadataJson

string

Target locale metadata JSON webvtt file
SourceLocaleSubtitle

string

Source locale plain text subtitle webvtt file
TargetLocaleSubtitle

string

Target locale plain text subtitle webvtt file