Iteration Operations - List Iteration

Serviço:: Azure AI Services

Versão da API:: 2025-05-20

Listar recursos de iteração.

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

Com parâmetros opcionais:

GET {endpoint}/videotranslation/translations/{translationId}/iterations?api-version=2025-05-20&top={top}&skip={skip}&maxpagesize={maxpagesize}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string	Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://eastus.api.cognitive.microsoft.com).
translationId	path	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID do recurso de tradução.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
maxpagesize	query		integer (int32)	O número máximo de itens de resultado por página.
skip	query		integer (int32)	O número de itens de resultado a serem ignoradas.
top	query		integer (int32)	O número de itens de resultado a serem retornados.

Respostas

Nome	Tipo	Description
200 OK	PagedIteration	A solicitação foi bem-sucedida.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Nome

Tipo

Description

200 OK

PagedIteration

A solicitação foi bem-sucedida.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Segurança

Ocp-Apim-Subscription-Key

Forneça sua chave de recurso de Fala aqui.

Tipo: apiKey
Em: header

AADToken

Esses são os fluxos da plataforma de identidade da Microsoft .

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

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

Exemplos

List Iteration

Solicitação de exemplo

HTTP

GET {endpoint}/videotranslation/translations/TranslateMyZhCNVideo/iterations?api-version=2025-05-20

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "id": "Initial",
      "description": "Translate video from en-US to zh-CN, fix segment issue.",
      "input": {
        "speakerCount": 3,
        "subtitleMaxCharCountPerSegment": 60,
        "enableVideoSpeedAdjustment": true,
        "exportTargetLocaleAdvancedSubtitleFile": true,
        "enableOcrCorrectionFromSubtitle": true,
        "subtitlePrimaryColor": "ffffff",
        "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"
        }
      },
      "status": "Succeeded",
      "createdDateTime": "2023-04-10T05:30:00.000Z",
      "lastActionDateTime": "2023-04-10T05:15:30.000Z"
    },
    {
      "id": "TranslateMyZhCNVideo-Iteration-1",
      "description": "Translate video from en-US to zh-CN.",
      "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"
        }
      },
      "status": "Failed",
      "createdDateTime": "2023-04-01T05:30:00.000Z",
      "lastActionDateTime": "2023-04-10T05:15:30.000Z"
    },
    {
      "id": "TranslateMyZhCNVideo-Iteration-2",
      "description": "Translate video from en-US to zh-CN.",
      "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"
        }
      },
      "status": "Running",
      "createdDateTime": "2023-04-01T05:30:00.000Z",
      "lastActionDateTime": "2023-04-10T05:15:30.000Z"
    }
  ],
  "nextLink": "https://eastus.api.cognitive.microsoft.com/video-translation/translations/TranslateMyZhCNVideo/iterations?skip=2&maxpagesize=2&api-version=2025-05-20"
}

Definições

Nome	Description
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta que contém detalhes do erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
EnableEmotionalPlatformVoice	Habilite o tipo de voz da plataforma emocional.
Iteration	Faça uma iteração para traduzir um arquivo de vídeo da localidade de origem para a localidade de destino, o webvtt para edição de conteúdo é opcional para solicitar o parâmetro.
IterationInput	Entrada de iteração.
IterationResult	Resultado da iteração.
PagedIteration	Coleção de páginas de itens de iteração
Status	Status da tarefa.
WebvttFile	Arquivo webvtt de tradução.
WebvttFileKind	Tipo de arquivo Webvtt.

Azure.Core.Foundations.Error

Objeto

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível pelo ser humano do erro.
target	string	O destino do erro.

Azure.Core.Foundations.ErrorResponse

Objeto

Uma resposta que contém detalhes do erro.

Nome	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Objeto

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

EnableEmotionalPlatformVoice

Enumeração

Habilite o tipo de voz da plataforma emocional.

Valor	Description
Auto	Deixe a API decidir se deseja habilitar a voz emocional para a localidade de destino.
Disable	Desabilite a emoção de voz da plataforma para a localidade de destino.
Enable	Force para habilitar a voz emocional se houver emoção com suporte de voz para a localidade de destino.

Iteration

Objeto

Faça uma iteração para traduzir um arquivo de vídeo da localidade de origem para a localidade de destino, o webvtt para edição de conteúdo é opcional para solicitar o parâmetro.

Nome	Tipo	Description
createdDateTime	string (date-time)	O carimbo de data/hora quando o objeto foi criado. O carimbo de data/hora é codificado como formato de data e hora ISO 8601 ("YYYYY-MM-DDThh:mm:ssZ", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Descrição da iteração
failureReason	string	Motivo da falha de iteração
id	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID da Iteração
input	IterationInput	Entrada de iteração.
lastActionDateTime	string (date-time)	O carimbo de data/hora quando o status atual foi inserido. O carimbo de data/hora é codificado como formato de data e hora ISO 8601 ("YYYYY-MM-DDThh:mm:ssZ", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
result	IterationResult	Resultado da iteração.
status	Status	Status da iteração

IterationInput

Objeto

Entrada de iteração.

Nome	Tipo	Description
enableEmotionalPlatformVoice	EnableEmotionalPlatformVoice	Esse parâmetro especifica se a emoção deve ser ativada para a voz da plataforma. Por padrão, o servidor determina se deve aplicar emoção com base na localidade de destino para otimizar a qualidade. Se não for especificado, a API decidirá automaticamente se habilita a expressão emocional no lado do servidor.
enableOcrCorrectionFromSubtitle	boolean	Indique se deseja permitir que a API corrija os resultados do reconhecimento de fala (SR) usando as legendas do arquivo de vídeo original. Ao aproveitar as legendas existentes, a API pode aumentar a precisão do texto transcrito, garantindo que a saída final seja mais precisa e confiável, se não for especificada, a tradução não fará a correção da legenda do OCR.
enableVideoSpeedAdjustment	boolean	Este parâmetro permite o ajuste da velocidade de reprodução do vídeo para garantir um melhor alinhamento com o áudio traduzido. Quando ativada, a API pode desacelerar ou acelerar o vídeo para corresponder ao tempo do áudio traduzido, proporcionando uma experiência de visualização mais sincronizada e contínua, se não for especificada, a velocidade do vídeo não será ajustada.
exportSubtitleInVideo	boolean	Exportar legenda em vídeo, se não for especificado, ele herdará o valor definido na entrada de criação da tradução.
exportTargetLocaleAdvancedSubtitleFile	boolean	Este parâmetro, quando ativado, permite que a API exporte legendas no formato Advanced SubStation Alpha. O arquivo de legenda pode especificar estilos e cores de fonte, o que ajuda a resolver problemas de exibição de caracteres em determinadas localidades de destino, como árabe (Ar), japonês (Ja), coreano (Ko) e chinês (Ch). Ao usar esse parâmetro, você pode garantir que as legendas sejam visualmente atraentes e renderizadas corretamente em diferentes idiomas e regiões, se não for especificado, a resposta de iteração não incluirá legendas avançadas.
speakerCount	integer (int32)	Número de palestrantes no vídeo, se não for especificado, ele herdará o valor definido na entrada de criação da tradução.
subtitleFontSize	integer (int32)	Este parâmetro especifica o tamanho da fonte das legendas na saída da tradução de vídeo entre 5 e 30, se não for especificado, ele usará o valor padrão dependente do idioma.
subtitleMaxCharCountPerSegment	integer (int32)	Contagem máxima de caracteres de exibição de legenda por segmento, se não for especificado, ele herdará o valor definido na entrada de criação da tradução.
subtitleOutlineColor	string minLength: 6 maxLength: 9 pattern: ^#?(?:[0-9A-Fa-f]{6}\|[0-9A-Fa-f]{8})$	Esse parâmetro especifica a cor do contorno das legendas na saída da tradução de vídeo. O valor deve ser fornecido no formato , # ou #, onde representa o componente vermelho da cor, representa o componente verde, representa o componente azul, representa o componente alfa. Por exemplo, EBA205 ou #EBA205 definiria a cor da legenda para um tom específico de amarelo. Este parâmetro permite a personalização da aparência da legenda para melhorar a legibilidade e o apelo visual, se não for especificado, ele usará a cor preta padrão.
subtitlePrimaryColor	string minLength: 6 maxLength: 9 pattern: ^#?(?:[0-9A-Fa-f]{6}\|[0-9A-Fa-f]{8})$	Esse parâmetro especifica a cor primária das legendas na saída da tradução de vídeo. O valor deve ser fornecido no formato , # ou #, onde representa o componente vermelho da cor, representa o componente verde, representa o componente azul, representa o componente alfa. Por exemplo, EBA205 ou #EBA205 definiria a cor da legenda para um tom específico de amarelo. Este parâmetro permite a personalização da aparência da legenda para melhorar a legibilidade e o apelo visual, se não for especificado, ele usará a cor branca padrão.
ttsCustomLexiconFileIdInAudioContentCreation	string pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$	Traduza com léxico personalizado TTS para síntese de fala. Forneça o arquivo de léxico personalizado usando ttsCustomLexiconFileUrl ou ttsCustomLexiconFileIdInAudioContentCreation. Esses parâmetros são mutuamente exclusivos — apenas um deles é necessário. Se ambos forem fornecidos, a solicitação será considerada inválida.
ttsCustomLexiconFileUrl	string (uri)	Traduza com léxico personalizado TTS para síntese de fala. Forneça o arquivo de léxico personalizado usando ttsCustomLexiconFileUrl ou ttsCustomLexiconFileIdInAudioContentCreation. Esses parâmetros são mutuamente exclusivos — apenas um deles é necessário. Se ambos forem fornecidos, a solicitação será considerada inválida.
webvttFile	WebvttFile	Arquivo Webvtt para edição de conteúdo, esse parâmetro é necessário na segunda solicitação de criação de iteração da tradução.

IterationResult

Objeto

Resultado da iteração.

Nome	Tipo	Description
metadataJsonWebvttFileUrl	string (uri)	URL do arquivo webvtt json de metadados.
reportFileUrl	string (uri)	URL do arquivo de relatório.
sourceLocaleSubtitleWebvttFileUrl	string (uri)	URL do arquivo de subtítulo de localidade de origem.
targetLocaleAdvancedSubtitleFileUrl	string (uri)	Essa propriedade fornece a URL do arquivo de legenda Advanced SubStation Alpha (ASS) de destino. Ele é preenchido somente quando exportTargetLocaleAdvancedSubtitleFile é definido como true durante a criação da iteração; caso contrário, essa propriedade não será incluída na resposta.
targetLocaleSubtitleWebvttFileUrl	string (uri)	URL do arquivo de subtítulo de localidade de destino.
translatedAudioFileUrl	string (uri)	URL do arquivo de áudio traduzido.
translatedVideoFileUrl	string (uri)	URL do arquivo de vídeo traduzido.

PagedIteration

Objeto

Coleção de páginas de itens de iteração

Nome	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	Iteration[]	Os itens de iteração nesta página

Status

Enumeração

Status da tarefa.

Valor	Description
Canceled	Status cancelado
Failed	Status de execução com falha
NotStarted	Status não iniciado
Running	Status de execução
Succeeded	Executar o status bem-sucedido

WebvttFile

Objeto

Arquivo webvtt de tradução.

Nome	Tipo	Description
kind	WebvttFileKind	Tipo de arquivo webvtt de tradução.
url	string (uri)	Url do arquivo webvtt de tradução.

WebvttFileKind

Enumeração

Tipo de arquivo Webvtt.

Valor	Description
MetadataJson	Arquivo webvtt JSON de metadados de localidade de destino
SourceLocaleSubtitle	Arquivo webvtt de legenda de texto sem formatação de localidade de origem
TargetLocaleSubtitle	Arquivo webvtt de legenda de texto sem formatação de localidade de destino

Compartilhar via

Iteration Operations - List Iteration

Parâmetros de URI

Respostas

Segurança

Ocp-Apim-Subscription-Key

AADToken

Escopos

Exemplos

List Iteration

Solicitação de exemplo

Resposta de exemplo

Definições

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

EnableEmotionalPlatformVoice

Iteration

IterationInput

IterationResult

PagedIteration

Status

WebvttFile

WebvttFileKind