Iteration Operations - Create Iteration

Serviço:: Azure AI Services

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

Cria uma iteração.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	Pontos de extremidade de Serviços Cognitivos suportados (protocolo e nome do host, por exemplo: 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]$	ID da iteração
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 utilizar para esta operação.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Operation-Id	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID da operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
input	True	IterationInput	Entrada de iteração.
description		string	Descrição da iteração

Respostas

Name	Tipo	Description
200 OK	Iteration	O pedido foi bem-sucedido. Cabeçalhos Operation-Location: string
201 Created	Iteration	O pedido foi bem-sucedido e, como resultado, foi criado um novo recurso. Cabeçalhos Operation-Location: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Name

Tipo

Description

200 OK

Iteration

O pedido foi bem-sucedido.

Cabeçalhos

Operation-Location: string

201 Created

Iteration

O pedido foi bem-sucedido e, como resultado, foi criado um novo recurso.

Cabeçalhos

Operation-Location: string

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

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

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

Âmbitos

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

Exemplos

Create Iteration

Pedido de amostra

HTTP

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


{
  "description": "Fix segment duration issue and update subtitle max char.",
  "input": {
    "enableEmotionalPlatformVoice": "Auto",
    "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"
    }
  }
}

Resposta da amostra

Código de estado:: 200

Operation-Location: https://eastus.api.cognitive.microsoft.com/videotranslation/operations/Create-TranslateMyZhCNVideo-ContentEditing-2?api-version=2024-02-01-preview
Operation-Id: TranslateMyZhCNVideo-ContentEditing-1

{
  "id": "TranslateMyZhCNVideo-ContentEditing-2",
  "description": "Fix segment duration issue and update subtitle max char.",
  "status": "NotStarted",
  "createdDateTime": "2023-04-10T05:30:00.000Z",
  "lastActionDateTime": "2023-04-10T05:15:30.000Z",
  "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"
    }
  }
}

Código de estado:: 201

Operation-Location: https://eastus.api.cognitive.microsoft.com/videotranslation/operations/Create-TranslateMyZhCNVideo-ContentEditing-2?api-version=2024-02-01-preview
Operation-Id: TranslateMyZhCNVideo-ContentEditing-1

{
  "id": "TranslateMyZhCNVideo-ContentEditing-2",
  "description": "Fix segment duration issue and update subtitle max char.",
  "status": "NotStarted",
  "createdDateTime": "2023-04-10T05:30:00.000Z",
  "lastActionDateTime": "2023-04-10T05:15:30.000Z",
  "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"
    }
  }
}

Definições

Name	Description
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta contendo 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, webvtt para edição de conteúdo é opcional para solicitar parâmetro.
IterationInput	Entrada de iteração.
IterationResult	Resultado da iteração.
Status	Status da tarefa.
WebvttFile	Tradução de arquivo webvtt.
WebvttFileKind	Tipo de arquivo Webvtt.

Azure.Core.Foundations.Error

Object

O objeto de erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
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 por humanos do erro.
target	string	O alvo do erro.

Azure.Core.Foundations.ErrorResponse

Object

Uma resposta contendo detalhes do erro.

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

Azure.Core.Foundations.InnerError

Object

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.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
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	Desative a emoção de voz da plataforma para a localidade de destino.
Enable	Força para habilitar a voz emocional se houver emoção suportada por voz para a localidade alvo.

Iteration

Object

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

Name	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 ("AAAA-MM-DDThh:mm:ssZ", ver 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 ("AAAA-MM-DDThh:mm:ssZ", ver 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

Object

Entrada de iteração.

Name	Tipo	Description
enableEmotionalPlatformVoice	EnableEmotionalPlatformVoice	Este parâmetro especifica se a emoção deve ser habilitada para a voz da plataforma. Por padrão, o servidor determina se a emoção deve ser aplicada com base na localidade de destino para otimizar a qualidade. Se não for especificado, a API decidirá automaticamente se deseja habilitar 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 OCR.
enableVideoSpeedAdjustment	boolean	Este parâmetro permite o ajuste da velocidade de reprodução de vídeo para garantir um melhor alinhamento com o áudio traduzido. Quando ativada, a API pode abrandar ou acelerar o vídeo para corresponder ao tempo do áudio traduzido, proporcionando uma experiência de visualização mais sincronizada e perfeita, 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, herdará o valor definido na entrada da 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 legendas pode especificar estilos de fonte e cores, 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). Usando 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 alto-falantes no vídeo, se não for especificado, ele herdará o valor definido na entrada da criação da tradução.
subtitleFontSize	integer (int32)	Este parâmetro especifica o tamanho da fonte das legendas na saída de 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)	A contagem máxima de caracteres de exibição da legenda por segmento, se não for especificada, herdará o valor definido na entrada da criação da tradução.
subtitleOutlineColor	string minLength: 6 maxLength: 9 pattern: ^#?(?:[0-9A-Fa-f]{6}\|[0-9A-Fa-f]{8})$	Este parâmetro especifica a cor do contorno das legendas na saída de 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})$	Este parâmetro especifica a cor primária das legendas na saída de 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 o 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, o pedido será considerado inválido.
ttsCustomLexiconFileUrl	string (uri)	Traduza com o 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, o pedido será considerado inválido.
webvttFile	WebvttFile	Webvtt para edição de conteúdo, este parâmetro é necessário a partir da segunda solicitação de criação de iteração da tradução.

IterationResult

Object

Resultado da iteração.

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

Status

Enumeração

Status da tarefa.

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

WebvttFile

Object

Tradução de arquivo webvtt.

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

WebvttFileKind

Enumeração

Tipo de arquivo Webvtt.

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

Partilhar via

Iteration Operations - Create Iteration

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

AADToken

Âmbitos

Exemplos

Create Iteration

Pedido de amostra

Resposta da amostra

Definições

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

EnableEmotionalPlatformVoice

Iteration

IterationInput

IterationResult

Status

WebvttFile

WebvttFileKind