Iteration Operations - Create Iteration

Layanan:: Azure AI Services

Versi API:: 2025-05-20

Membuat perulangan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string	Titik akhir Cognitive Services yang didukung (protokol dan nama host, misalnya: 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 Perulangan
translationId	path	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID sumber daya terjemahan.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
Operation-Id	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Operasi ID.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
input	True	IterationInput	Input perulangan.
description		string	Deskripsi perulangan

Respons

Nama	Jenis	Deskripsi
200 OK	Iteration	Permintaan telah berhasil. Header Operation-Location: string
201 Created	Iteration	Permintaan telah berhasil dan sumber daya baru telah dibuat sebagai hasilnya. Header Operation-Location: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Respons kesalahan tak terduga. Header x-ms-error-code: string

Nama

Jenis

Deskripsi

200 OK

Iteration

Permintaan telah berhasil.

Header

Operation-Location: string

201 Created

Iteration

Permintaan telah berhasil dan sumber daya baru telah dibuat sebagai hasilnya.

Header

Operation-Location: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Respons kesalahan tak terduga.

Header

x-ms-error-code: string

Keamanan

Ocp-Apim-Subscription-Key

Berikan kunci sumber daya Ucapan Anda di sini.

Jenis: apiKey
Dalam: header

AADToken

Ini adalah alur platform identitas Microsoft .

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
https://cognitiveservices.azure.com/.default

Contoh

Create Iteration

Permintaan sampel

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"
    }
  }
}

Respon sampel

Kode status:: 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"
    }
  }
}

Kode status:: 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"
    }
  }
}

Definisi

Nama	Deskripsi
Azure.Core.Foundations.Error	Objek kesalahan.
Azure.Core.Foundations.ErrorResponse	Respons yang berisi detail kesalahan.
Azure.Core.Foundations.InnerError	Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai panduan Microsoft One API - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
EnableEmotionalPlatformVoice	Aktifkan jenis suara platform emosional.
Iteration	Lakukan satu iterasi untuk menerjemahkan satu file video dari lokal sumber ke lokal target, webvtt untuk pengeditan konten bersifat opsional untuk meminta parameter.
IterationInput	Input perulangan.
IterationResult	Hasil iterasi.
Status	Status tugas.
WebvttFile	File webvtt terjemahan.
WebvttFileKind	Jenis file Webvtt.

Azure.Core.Foundations.Error

Objek

Objek kesalahan.

Nama	Jenis	Deskripsi
code	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.
details	Azure.Core.Foundations.Error[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
innererror	Azure.Core.Foundations.InnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Representasi kesalahan yang dapat dibaca manusia.
target	string	Target kesalahan.

Azure.Core.Foundations.ErrorResponse

Objek

Respons yang berisi detail kesalahan.

Nama	Jenis	Deskripsi
error	Azure.Core.Foundations.Error	Objek kesalahan.

Azure.Core.Foundations.InnerError

Objek

Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai panduan Microsoft One API - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Nama	Jenis	Deskripsi
code	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.
innererror	Azure.Core.Foundations.InnerError	Kesalahan dalam.

EnableEmotionalPlatformVoice

Enumeration

Aktifkan jenis suara platform emosional.

Nilai	Deskripsi
Auto	Biarkan API memutuskan apakah akan mengaktifkan suara emosional untuk lokal target.
Disable	Nonaktifkan emosi suara platform untuk lokal target.
Enable	Paksa untuk mengaktifkan suara emosional jika ada emosi yang didukung suara untuk lokal target.

Iteration

Objek

Lakukan satu iterasi untuk menerjemahkan satu file video dari lokal sumber ke lokal target, webvtt untuk pengeditan konten bersifat opsional untuk meminta parameter.

Nama	Jenis	Deskripsi
createdDateTime	string (date-time)	Tanda waktu saat objek dibuat. Tanda waktu dikodekan sebagai format tanggal dan waktu ISO 8601 ("YYYY-MM-DDThh:mm:ssZ", lihat https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Deskripsi perulangan
failureReason	string	Alasan kegagalan perulangan
id	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID Perulangan
input	IterationInput	Input perulangan.
lastActionDateTime	string (date-time)	Tanda waktu ketika status saat ini dimasukkan. Tanda waktu dikodekan sebagai format tanggal dan waktu ISO 8601 ("YYYY-MM-DDThh:mm:ssZ", lihat https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
result	IterationResult	Hasil iterasi.
status	Status	Status perulangan

IterationInput

Objek

Input perulangan.

Nama	Jenis	Deskripsi
enableEmotionalPlatformVoice	EnableEmotionalPlatformVoice	Parameter ini menentukan apakah akan mengaktifkan emosi untuk suara platform. Secara default, server menentukan apakah akan menerapkan emosi berdasarkan lokal target untuk mengoptimalkan kualitas. Jika tidak ditentukan, API akan secara otomatis memutuskan apakah akan mengaktifkan ekspresi emosional di sisi server.
enableOcrCorrectionFromSubtitle	boolean	Tunjukkan apakah akan mengizinkan API untuk mengoreksi hasil pengenalan ucapan (SR) menggunakan subtitle dari file video asli. Dengan memanfaatkan subtitle yang ada, API dapat meningkatkan akurasi teks yang ditranskripsi, memastikan bahwa output akhir lebih tepat dan andal, jika tidak ditentukan, terjemahan tidak akan melakukan koreksi dari subtitle OCR.
enableVideoSpeedAdjustment	boolean	Parameter ini memungkinkan penyesuaian kecepatan pemutaran video untuk memastikan penyelarasan yang lebih baik dengan audio yang diterjemahkan. Saat diaktifkan, API dapat memperlambat atau mempercepat video agar sesuai dengan waktu audio yang diterjemahkan, memberikan pengalaman menonton yang lebih tersinkronisasi dan mulus, jika tidak ditentukan, kecepatan video tidak akan disesuaikan.
exportSubtitleInVideo	boolean	Ekspor subtitle dalam video, jika tidak ditentukan, itu akan mewarisi nilai yang ditentukan dalam input pembuatan terjemahan.
exportTargetLocaleAdvancedSubtitleFile	boolean	Parameter ini, jika diaktifkan, memungkinkan API untuk mengekspor subtitle dalam format Advanced SubStation Alpha. File subtitle dapat menentukan gaya dan warna font, yang membantu mengatasi masalah tampilan karakter di lokal target tertentu seperti Arab (Ar), Jepang (Ja), Korea (Ko), dan Cina (Ch). Dengan menggunakan parameter ini, Anda dapat memastikan bahwa subtitle menarik secara visual dan dirender dengan benar di berbagai bahasa dan wilayah, jika tidak ditentukan, respons iterasi tidak akan menyertakan subtitle lanjutan.
speakerCount	integer (int32)	Jumlah pembicara dalam video, jika tidak ditentukan, itu akan mewarisi nilai yang ditentukan dalam input pembuatan terjemahan.
subtitleFontSize	integer (int32)	Parameter ini menentukan ukuran font subtitle dalam output terjemahan video antara 5 dan 30, jika tidak ditentukan, itu akan menggunakan nilai default yang bergantung pada bahasa.
subtitleMaxCharCountPerSegment	integer (int32)	Jumlah karakter tampilan maksimum subtitle per segmen, jika tidak ditentukan, itu akan mewarisi nilai yang ditentukan dalam input pembuatan terjemahan.
subtitleOutlineColor	string minLength: 6 maxLength: 9 pattern: ^#?(?:[0-9A-Fa-f]{6}\|[0-9A-Fa-f]{8})$	Parameter ini menentukan warna garis besar subtitle dalam output terjemahan video. Nilai harus disediakan dalam format , #, atau #, di mana mewakili komponen merah warna, mewakili komponen hijau, mewakili komponen biru, mewakili komponen alfa. Misalnya, EBA205 atau #EBA205 akan mengatur warna subtitle ke warna kuning tertentu. Parameter ini memungkinkan penyesuaian tampilan subtitle untuk meningkatkan keterbacaan dan daya tarik visual, jika tidak ditentukan, itu akan menggunakan warna hitam default.
subtitlePrimaryColor	string minLength: 6 maxLength: 9 pattern: ^#?(?:[0-9A-Fa-f]{6}\|[0-9A-Fa-f]{8})$	Parameter ini menentukan warna utama subtitle dalam output terjemahan video. Nilai harus disediakan dalam format , #, atau #, di mana mewakili komponen merah warna, mewakili komponen hijau, mewakili komponen biru, mewakili komponen alfa. Misalnya, EBA205 atau #EBA205 akan mengatur warna subtitle ke warna kuning tertentu. Parameter ini memungkinkan penyesuaian tampilan subtitle untuk meningkatkan keterbacaan dan daya tarik visual, jika tidak ditentukan, itu akan menggunakan warna putih default.
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}$	Terjemahkan dengan leksikon kustom TTS untuk sintesis ucapan. Berikan file leksikon kustom menggunakan ttsCustomLexiconFileUrl atau ttsCustomLexiconFileIdInAudioContentCreation. Parameter ini saling eksklusif—hanya satu dari mereka yang diperlukan. Jika keduanya disediakan, permintaan akan dianggap tidak valid.
ttsCustomLexiconFileUrl	string (uri)	Terjemahkan dengan leksikon kustom TTS untuk sintesis ucapan. Berikan file leksikon kustom menggunakan ttsCustomLexiconFileUrl atau ttsCustomLexiconFileIdInAudioContentCreation. Parameter ini saling eksklusif—hanya satu dari mereka yang diperlukan. Jika keduanya disediakan, permintaan akan dianggap tidak valid.
webvttFile	WebvttFile	File webvtt untuk pengeditan konten, parameter ini diperlukan dari permintaan pembuatan iterasi kedua dari terjemahan.

IterationResult

Objek

Hasil iterasi.

Nama	Jenis	Deskripsi
metadataJsonWebvttFileUrl	string (uri)	URL file webvtt metadata json.
reportFileUrl	string (uri)	Laporkan URL file.
sourceLocaleSubtitleWebvttFileUrl	string (uri)	URL file subtitel lokal sumber.
targetLocaleAdvancedSubtitleFileUrl	string (uri)	Properti ini menyediakan URL file subtitle Advanced SubStation Alpha (ASS) lokal target. Ini hanya diisi ketika exportTargetLocaleAdvancedSubtitleFile diatur ke true selama pembuatan iterasi; Jika tidak, properti ini tidak akan disertakan dalam respons.
targetLocaleSubtitleWebvttFileUrl	string (uri)	URL file subtitel lokal target.
translatedAudioFileUrl	string (uri)	URL file audio yang diterjemahkan.
translatedVideoFileUrl	string (uri)	URL file video yang diterjemahkan.

Status

Enumeration

Status tugas.

Nilai	Deskripsi
Canceled	Status dibatalkan
Failed	Jalankan status gagal
NotStarted	Status belum dimulai
Running	Status berjalan
Succeeded	Jalankan status berhasil

WebvttFile

Objek

File webvtt terjemahan.

Nama	Jenis	Deskripsi
kind	WebvttFileKind	Jenis file webvtt terjemahan.
url	string (uri)	Url file webvtt terjemahan.

WebvttFileKind

Enumeration

Jenis file Webvtt.

Nilai	Deskripsi
MetadataJson	Menargetkan file webvtt JSON metadata lokal
SourceLocaleSubtitle	File webvtt subtitel teks biasa lokal sumber
TargetLocaleSubtitle	File webvtt subtitel teks biasa lokal target

Bagikan melalui

Iteration Operations - Create Iteration

Parameter URI

Header Permintaan

Isi Permintaan

Respons

Keamanan

Ocp-Apim-Subscription-Key

AADToken

Cakupan

Contoh

Create Iteration

Permintaan sampel

Respon sampel

Definisi

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

EnableEmotionalPlatformVoice

Iteration

IterationInput

IterationResult

Status

WebvttFile

WebvttFileKind