Translation Operations - List Translation
翻訳リソースを一覧表示します。
GET {endpoint}/videotranslation/translations?api-version=2025-05-20
GET {endpoint}/videotranslation/translations?api-version=2025-05-20&top={top}&skip={skip}&maxpagesize={maxpagesize}
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
endpoint
|
path | True |
string |
サポートされている Cognitive Services エンドポイント (プロトコルとホスト名、例: https://eastus.api.cognitive.microsoft.com)。 |
api-version
|
query | True |
string minLength: 1 |
この操作に使用する API バージョン。 |
maxpagesize
|
query |
integer (int32) |
ページあたりの結果項目の最大数。 |
|
skip
|
query |
integer (int32) |
スキップする結果項目の数。 |
|
top
|
query |
integer (int32) |
返される結果項目の数。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
要求は成功しました。 |
|
Other Status Codes |
予期しないエラー応答。 ヘッダー x-ms-error-code: string |
セキュリティ
Ocp-Apim-Subscription-Key
ここで Speech リソース キーを指定します。
型:
apiKey
/:
header
AADToken
これらは 、Microsoft ID プラットフォーム のフローです。
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
https://cognitiveservices.azure.com/.default |
例
List translations
要求のサンプル
GET {endpoint}/videotranslation/translations?api-version=2025-05-20
応答のサンプル
{
"value": [
{
"id": "TranslateMyZhCNVideo1",
"displayName": "hello.mp4",
"description": "Translate video from en-US to zh-CN.",
"input": {
"sourceLocale": "en-US",
"targetLocale": "zh-CN",
"voiceKind": "PlatformVoice",
"videoFileUrl": "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"
},
"createdDateTime": "2023-04-01T05:30:00.000Z",
"latestIteration": {
"id": "TranslateMyZhCNVideo1-Edit1",
"description": "Iteration1",
"status": "Running",
"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"
}
}
},
"latestSucceededIteration": {
"id": "xxx",
"description": "Iteration1",
"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"
}
}
}
},
{
"id": "TranslateMyZhCNVideo2",
"displayName": "hello.mp4",
"description": "Translate video from en-US to zh-CN.",
"input": {
"sourceLocale": "en-US",
"targetLocale": "zh-CN",
"voiceKind": "PlatformVoice",
"videoFileUrl": "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"
},
"createdDateTime": "2023-04-01T05:30:00.000Z",
"latestIteration": {
"id": "TranslateMyZhCNVideo2-Edit2",
"description": "Iteration1",
"status": "Failed",
"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"
}
}
},
"latestSucceededIteration": {
"id": "xxx",
"description": "Iteration1",
"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"
}
}
}
},
{
"id": "TranslateMyZhCNVideo3",
"displayName": "hello.mp4",
"description": "Translate video from en-US to zh-CN.",
"input": {
"sourceLocale": "en-US",
"targetLocale": "zh-CN",
"voiceKind": "PlatformVoice",
"videoFileUrl": "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"
},
"createdDateTime": "2023-04-01T05:30:00.000Z",
"latestIteration": {
"id": "Initial",
"description": "Iteration1",
"status": "Completed",
"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"
}
}
},
"latestSucceededIteration": {
"id": "Initial",
"description": "Iteration1",
"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"
}
}
}
}
],
"nextLink": "https://eastus.api.cognitive.microsoft.com/video-translation/translations?skip=2&maxpagesize=2&api-version=2025-05-20"
}
定義
名前 | 説明 |
---|---|
Azure. |
エラー オブジェクト。 |
Azure. |
エラーの詳細を含む応答。 |
Azure. |
エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. |
Enable |
感情的なプラットフォームの音声の種類を有効にします。 |
Iteration |
1 つのビデオ ファイルをソース ロケールからターゲット ロケールに変換するイテレーションを 1 回実行します。コンテンツ編集用の webvtt は、パラメーターを要求する場合は省略可能です。 |
Iteration |
繰り返し入力。 |
Iteration |
イテレーションの結果。 |
Paged |
翻訳項目のページング されたコレクション |
Status |
タスクの状態。 |
Translation |
1 つのビデオ ファイルをソース ロケールからターゲット ロケールに変換するイテレーションをホストするための翻訳リソースを作成します。 |
Translation |
翻訳入力。 |
Voice |
TTS 音声の種類。 |
Webvtt |
翻訳 webvtt ファイル。 |
Webvtt |
Webvtt ファイルの種類。 |
Azure.Core.Foundations.Error
エラー オブジェクト。
名前 | 型 | 説明 |
---|---|---|
code |
string |
サーバー定義の一連のエラー コードの 1 つ。 |
details |
この報告されたエラーの原因となった特定のエラーに関する詳細の配列。 |
|
innererror |
エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。 |
|
message |
string |
エラーの人間が判読できる表現。 |
target |
string |
エラーのターゲット。 |
Azure.Core.Foundations.ErrorResponse
エラーの詳細を含む応答。
名前 | 型 | 説明 |
---|---|---|
error |
エラー オブジェクト。 |
Azure.Core.Foundations.InnerError
エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
名前 | 型 | 説明 |
---|---|---|
code |
string |
サーバー定義の一連のエラー コードの 1 つ。 |
innererror |
内部エラー。 |
EnableEmotionalPlatformVoice
感情的なプラットフォームの音声の種類を有効にします。
値 | 説明 |
---|---|
Auto |
API に、ターゲット ロケールで感情的な音声を有効にするかどうかを決定させます。 |
Disable |
ターゲット ロケールのプラットフォーム音声感情を無効にします。 |
Enable |
ターゲット ロケールに音声でサポートされている感情がある場合に、感情的な音声を強制的に有効にします。 |
Iteration
1 つのビデオ ファイルをソース ロケールからターゲット ロケールに変換するイテレーションを 1 回実行します。コンテンツ編集用の webvtt は、パラメーターを要求する場合は省略可能です。
名前 | 型 | 説明 |
---|---|---|
createdDateTime |
string (date-time) |
オブジェクトが作成されたときのタイムスタンプ。 タイムスタンプは ISO 8601 日時形式でエンコードされます (「YYYY-MM-DDThh:mm:ssZ」を参照してください https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)。 |
description |
string |
イテレーションの説明 |
failureReason |
string |
繰り返しエラーの理由 |
id |
string minLength: 3maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$ |
イテレーション ID |
input |
繰り返し入力。 |
|
lastActionDateTime |
string (date-time) |
現在の状態が入力されたときのタイムスタンプ。 タイムスタンプは ISO 8601 日時形式でエンコードされます (「YYYY-MM-DDThh:mm:ssZ」を参照してください https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)。 |
result |
イテレーションの結果。 |
|
status |
反復処理の状態 |
IterationInput
繰り返し入力。
名前 | 型 | 説明 |
---|---|---|
enableEmotionalPlatformVoice |
このパラメーターは、プラットフォーム音声の感情を有効にするかどうかを指定します。 デフォルトでは、サーバーは、品質を最適化するためにターゲットロケールに基づいて感情を適用するかどうかを決定します。 指定しない場合、サーバー側で感情表現を有効にするかどうかはAPIが自動的に決定します。 |
|
enableOcrCorrectionFromSubtitle |
boolean |
API が元のビデオ ファイルの字幕を使用して音声認識 (SR) の結果を修正することを許可するかどうかを示します。 既存の字幕を活用することで、APIは文字起こしされたテキストの精度を向上させることができ、最終出力がより正確で信頼性が高いことを保証します。指定されていない場合、翻訳はOCR字幕からの修正を行いません。 |
enableVideoSpeedAdjustment |
boolean |
このパラメータを使用すると、ビデオの再生速度を調整して、翻訳されたオーディオとの整合性を確保できます。 有効にすると、API は翻訳されたオーディオのタイミングに合わせてビデオを遅くしたり速くしたりして、より同期されたシームレスな視聴エクスペリエンスを提供できます。指定されていない場合、ビデオ速度は調整されません。 |
exportSubtitleInVideo |
boolean |
ビデオの字幕をエクスポートし、指定しない場合、翻訳作成の入力で定義された値を継承します。 |
exportTargetLocaleAdvancedSubtitleFile |
boolean |
このパラメータを有効にすると、API は字幕を Advanced SubStation Alpha 形式でエクスポートできます。 字幕ファイルでは、フォントのスタイルと色を指定できるため、アラビア語 (Ar)、日本語 (Ja)、韓国語 (Ko)、中国語 (Ch) などの特定のターゲット ロケールでの文字表示の問題に対処するのに役立ちます。 このパラメーターを使用すると、字幕が視覚的に魅力的で、さまざまな言語や地域で正しくレンダリングされていることを確認できます。指定されていない場合、イテレーション応答には高度な字幕は含まれません。 |
speakerCount |
integer (int32) |
ビデオ内のスピーカーの数は、指定されていない場合は、翻訳作成の入力で定義された値を継承します。 |
subtitleFontSize |
integer (int32) |
このパラメータは、ビデオ翻訳出力の字幕のフォントサイズを5から30の間で指定します。指定しない場合は、言語に依存するデフォルト値が使用されます。 |
subtitleMaxCharCountPerSegment |
integer (int32) |
セグメントあたりの字幕の最大表示文字数、指定しない場合は、翻訳作成の入力で定義された値を継承します。 |
subtitleOutlineColor |
string minLength: 6maxLength: 9 pattern: ^#?(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$ |
このパラメータは、ビデオ翻訳出力の字幕のアウトラインカラーを指定します。 値は、 #、または # の形式で指定する必要があります。ここで、 は色の赤成分、 緑の成分、 青 成分、 アルファ 成分を表します。 たとえば、EBA205 または EBA205 #EBA205 は、字幕の色を特定の色調の黄色に設定します。 このパラメーターを使用すると、字幕の外観をカスタマイズして読みやすさと視覚的な魅力を向上させることができます。指定されていない場合は、デフォルトの黒色が使用されます。 |
subtitlePrimaryColor |
string minLength: 6maxLength: 9 pattern: ^#?(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$ |
このパラメータは、ビデオ翻訳出力の字幕の原色を指定します。 値は、 #、または # の形式で指定する必要があります。ここで、 は色の赤成分、 緑の成分、 青 成分、 アルファ 成分を表します。 たとえば、EBA205 または EBA205 #EBA205 は、字幕の色を特定の色調の黄色に設定します。 このパラメーターを使用すると、読みやすさと視覚的な魅力を向上させるために字幕の外観をカスタマイズできます。指定されていない場合は、デフォルトの白色が使用されます。 |
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}$ |
音声合成のためのTTSカスタム辞書で翻訳します。 ttsCustomLexiconFileUrl または ttsCustomLexiconFileIdInAudioContentCreation を使用して、カスタム辞書ファイルを提供します。 これらのパラメータは相互に排他的であり、必須なのは 1 つだけです。 両方が指定されている場合、リクエストは無効と見なされます。 |
ttsCustomLexiconFileUrl |
string (uri) |
音声合成のためのTTSカスタム辞書で翻訳します。 ttsCustomLexiconFileUrl または ttsCustomLexiconFileIdInAudioContentCreation を使用して、カスタム辞書ファイルを提供します。 これらのパラメータは相互に排他的であり、必須なのは 1 つだけです。 両方が指定されている場合、リクエストは無効と見なされます。 |
webvttFile |
コンテンツ編集用の Webvtt ファイル。このパラメーターは、翻訳の 2 番目の反復作成要求から必要です。 |
IterationResult
イテレーションの結果。
名前 | 型 | 説明 |
---|---|---|
metadataJsonWebvttFileUrl |
string (uri) |
メタデータ json webvtt ファイルの URL。 |
reportFileUrl |
string (uri) |
レポート ファイルの URL。 |
sourceLocaleSubtitleWebvttFileUrl |
string (uri) |
ソース ロケールサブタイトル ファイルの URL。 |
targetLocaleAdvancedSubtitleFileUrl |
string (uri) |
このプロパティは、ターゲット ロケールの Advanced SubStation Alpha (ASS) 字幕ファイルの URL を提供します。 これは、反復作成中に exportTargetLocaleAdvancedSubtitleFile が true に設定されている場合にのみ設定されます。それ以外の場合、このプロパティは応答に含まれません。 |
targetLocaleSubtitleWebvttFileUrl |
string (uri) |
ターゲット ロケールサブタイトル ファイルの URL。 |
translatedAudioFileUrl |
string (uri) |
翻訳されたオーディオファイルのURL。 |
translatedVideoFileUrl |
string (uri) |
翻訳されたビデオ ファイルの URL。 |
PagedTranslation
翻訳項目のページング されたコレクション
名前 | 型 | 説明 |
---|---|---|
nextLink |
string (uri) |
アイテムの次のページへのリンク |
value |
このページの翻訳項目 |
Status
タスクの状態。
値 | 説明 |
---|---|
Canceled |
取り消された状態 |
Failed |
失敗した状態を実行する |
NotStarted |
未開始状態 |
Running |
実行中の状態 |
Succeeded |
成功した状態を実行する |
Translation
1 つのビデオ ファイルをソース ロケールからターゲット ロケールに変換するイテレーションをホストするための翻訳リソースを作成します。
名前 | 型 | 説明 |
---|---|---|
createdDateTime |
string (date-time) |
オブジェクトが作成されたときのタイムスタンプ。 タイムスタンプは ISO 8601 日時形式でエンコードされます (「YYYY-MM-DDThh:mm:ssZ」を参照してください https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)。 |
description |
string |
翻訳の説明。 |
displayName |
string |
翻訳表示名。 |
failureReason |
string |
翻訳エラーの理由 |
id |
string minLength: 3maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$ |
翻訳リソース ID。 |
input |
翻訳入力。 |
|
latestIteration |
翻訳の最新のイテレーション。 |
|
latestSucceededIteration |
翻訳の最後に完了したイテレーション。 |
TranslationInput
翻訳入力。
名前 | 型 | 説明 |
---|---|---|
audioFileUrl |
string (uri) |
翻訳オーディオファイルAzure blobのURL、.mp3 または.wavファイル形式、最大5GBのファイルサイズ、4時間のビデオ再生時間。 videoFileUrl または audioFileUrl を使用して入力メディア ファイルを指定すると、これらのパラメーターは相互に排他的であり、どちらか 1 つだけ必要です。 両方が指定されている場合、リクエストは無効と見なされます。 |
enableLipSync |
boolean |
リップシンクを有効にするかどうかを示し、指定しない場合、デフォルト値は false でリップシンクを無効にします。 |
exportSubtitleInVideo |
boolean |
ビデオの字幕をエクスポートし、指定しない場合、デフォルト値はfalseで、翻訳されたビデオファイルに字幕を書き込みません。 |
sourceLocale |
string minLength: 5maxLength: 16 pattern: ^[A-Za-z]{2,4}([_-][A-Za-z]{4})?([_-]([A-Za-z]{2}|[0-9]{3}))?$ |
ビデオ ファイルのソース ロケール。 ロケール コードは BCP-47 に従います。 テキスト読み上げロケール リストはここにあります https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts 、指定されていない場合、ソース ロケールはビデオ ファイルから自動検出され、自動検出はバージョン 2025-05-20 以降でのみサポートされます。 |
speakerCount |
integer (int32) |
ビデオ内のスピーカーの数が指定されていない場合、ビデオ ファイルから自動検出されます。 |
subtitleMaxCharCountPerSegment |
integer (int32) |
セグメントあたりの字幕の最大表示文字数 (指定されていない場合、言語に依存する既定値が使用されます)。 |
targetLocale |
string minLength: 5maxLength: 16 pattern: ^[A-Za-z]{2,4}([_-][A-Za-z]{4})?([_-]([A-Za-z]{2}|[0-9]{3}))?$ |
翻訳のターゲット ロケール。 ロケール コードは BCP-47 に従います。 テキスト読み上げロケールの一覧については、https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=ttsを参照してください。 |
videoFileUrl |
string (uri) |
翻訳ビデオ ファイル: Azure BLOB の URL、.mp4 ファイル形式、最大 5 GB のファイル サイズ、4 時間のビデオ再生時間。 videoFileUrl または audioFileUrl を使用して入力メディア ファイルを指定すると、これらのパラメーターは相互に排他的であり、どちらか 1 つだけ必要です。 両方が指定されている場合、リクエストは無効と見なされます。 |
voiceKind |
翻訳音声の種類。 |
VoiceKind
TTS 音声の種類。
値 | 説明 |
---|---|
PersonalVoice |
TTS 個人用音声 |
PlatformVoice |
TTS プラットフォームの音声 |
WebvttFile
翻訳 webvtt ファイル。
名前 | 型 | 説明 |
---|---|---|
kind |
翻訳 webvtt ファイルの種類。 |
|
url |
string (uri) |
翻訳 webvtt ファイルの URL。 |
WebvttFileKind
Webvtt ファイルの種類。
値 | 説明 |
---|---|
MetadataJson |
ターゲット ロケール メタデータ JSON webvtt ファイル |
SourceLocaleSubtitle |
ソース ロケールのプレーン テキスト サブタイトル webvtt ファイル |
TargetLocaleSubtitle |
ターゲット ロケールプレーンテキストサブタイトル webvtt ファイル |