Translation Operations - List Translation

Referenz

Dienst:: Azure AI Services

API-Version:: 2024-05-20-preview

Übersetzungsressourcen auflisten.

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

Mit optionalen Parametern:

GET {endpoint}/videotranslation/translations?api-version=2024-05-20-preview&top={top}&skip={skip}&maxpagesize={maxpagesize}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. https://eastus.api.cognitive.microsoft.com).
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
maxpagesize	query		integer (int32)	Die maximale Anzahl von Ergebniselementen pro Seite.
skip	query		integer (int32)	Die Anzahl der zu überspringenden Ergebniselemente.
top	query		integer (int32)	Die Anzahl der zurückzugebenden Ergebniselemente.

Antworten

Name	Typ	Beschreibung
200 OK	PagedTranslation	Die Anforderung ist erfolgreich.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Name

Typ

Beschreibung

200 OK

PagedTranslation

Die Anforderung ist erfolgreich.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Unerwartete Fehlerantwort.

Header

x-ms-error-code: string

Sicherheit

Ocp-Apim-Subscription-Key

Geben Sie hier Ihren Sprachressourcenschlüssel an.

Typ: apiKey
In: header

AADToken

Dies sind die Microsoft Identity Platform Flows.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

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

Beispiele

List translations

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "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=2024-05-20-preview"
}

Definitionen

Name	Beschreibung
Azure.Core.Foundations.Error	Das Fehlerobjekt.
Azure.Core.Foundations.ErrorResponse	Eine Antwort, die Fehlerdetails enthält.
Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Iteration	Führen Sie eine Iteration aus, um eine Videodatei aus dem Quellgebietsschema in das Zielgebietsschema zu übersetzen. Webvtt für die Inhaltsbearbeitung ist für das Anfordern von Parametern optional.
IterationInput	Iterationseingabe.
IterationResult	Iterationsergebnis.
PagedTranslation	Seitenauflistung von Übersetzungselementen
Status	Vorgangsstatus.
Translation	Erstellen Sie übersetzungsressource zum Hosten von Iterationen zum Übersetzen einer Videodatei aus dem Quellgebietsschema in das Zielgebietsschema.
TranslationInput	Übersetzungseingabe.
VoiceKind	TTS-Sprachart.
WebvttFile	Webvtt-Übersetzungsdatei.
WebvttFileKind	Webvtt-Dateiart.

Azure.Core.Foundations.Error

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
details	Azure.Core.Foundations.Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

Azure.Core.Foundations.ErrorResponse

Objekt

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	Azure.Core.Foundations.Error	Das Fehlerobjekt.

Azure.Core.Foundations.InnerError

Objekt

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
innererror	Azure.Core.Foundations.InnerError	Innerer Fehler.

Iteration

Objekt

Führen Sie eine Iteration aus, um eine Videodatei aus dem Quellgebietsschema in das Zielgebietsschema zu übersetzen. Webvtt für die Inhaltsbearbeitung ist für das Anfordern von Parametern optional.

Name	Typ	Beschreibung
createdDateTime	string (date-time)	Der Zeitstempel, zu dem das Objekt erstellt wurde. Der Zeitstempel wird als ISO 8601-Datums- und Uhrzeitformat codiert ("JJJJ-MM-DDThh:mm:ssZ", siehe https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Iterationsbeschreibung
failureReason	string	Grund für Iterationsfehler
id	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Iterations-ID
input	IterationInput	Iterationseingabe.
lastActionDateTime	string (date-time)	Der Zeitstempel, zu dem der aktuelle Status eingegeben wurde. Der Zeitstempel wird als ISO 8601-Datums- und Uhrzeitformat codiert ("JJJJ-MM-DDThh:mm:ssZ", siehe https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
result	IterationResult	Iterationsergebnis.
status	Status	Iterationsstatus

IterationInput

Objekt

Iterationseingabe.

Name	Typ	Beschreibung
exportSubtitleInVideo	boolean	Exportieren sie Untertitel im Video.
speakerCount	integer (int32)	Die Anzahl der Lautsprecher im Video.
subtitleMaxCharCountPerSegment	integer (int32)	Maximale Anzahl der Untertitelzeichen pro Segment.
webvttFile	WebvttFile	Webvtt-Datei für die Inhaltsbearbeitung, dieser Parameter ist aus der zweiten Iterationserstellungsanforderung der Übersetzung erforderlich.

IterationResult

Objekt

Iterationsergebnis.

Name	Typ	Beschreibung
metadataJsonWebvttFileUrl	string (uri)	Url der Metadaten-JSON-Webvtt-Datei.
reportFileUrl	string (uri)	Url der Berichtsdatei.
sourceLocaleSubtitleWebvttFileUrl	string (uri)	Url der Quellgebietsschema-Untertiteldatei.
targetLocaleSubtitleWebvttFileUrl	string (uri)	Zielgebietsschema-Untertiteldatei-URL.
translatedVideoFileUrl	string (uri)	Übersetzte Videodatei-URL.

PagedTranslation

Objekt

Seitenauflistung von Übersetzungselementen

Name	Typ	Beschreibung
nextLink	string (uri)	Der Link zur nächsten Seite von Elementen
value	Translation[]	Die Übersetzungselemente auf dieser Seite

Status

Enumeration

Vorgangsstatus.

Wert	Beschreibung
Canceled	Status "Abgebrochen"
Failed	Fehler beim Ausführen des Status
NotStarted	Status "Nicht gestartet"
Running	Ausführungsstatus
Succeeded	Status "Erfolgreich ausführen"

Translation

Objekt

Erstellen Sie übersetzungsressource zum Hosten von Iterationen zum Übersetzen einer Videodatei aus dem Quellgebietsschema in das Zielgebietsschema.

Name	Typ	Beschreibung
createdDateTime	string (date-time)	Der Zeitstempel, zu dem das Objekt erstellt wurde. Der Zeitstempel wird als ISO 8601-Datums- und Uhrzeitformat codiert ("JJJJ-MM-DDThh:mm:ssZ", siehe https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Übersetzungsbeschreibung.
displayName	string	Anzeigename der Übersetzung.
failureReason	string	Ursache für Übersetzungsfehler
id	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Übersetzungsressourcen-ID.
input	TranslationInput	Übersetzungseingabe.
latestIteration	Iteration	Neueste Iteration der Übersetzung.
latestSucceededIteration	Iteration	Letzte abgeschlossene Iteration der Übersetzung.

TranslationInput

Objekt

Übersetzungseingabe.

Name	Typ	Beschreibung
exportSubtitleInVideo	boolean	Exportieren sie Untertitel im Video.
sourceLocale	string minLength: 5 maxLength: 16 pattern: ^[A-Za-z]{2,4}([_-][A-Za-z]{4})?([_-]([A-Za-z]{2}\|[0-9]{3}))?$	Das Quellgebietsschema der Videodatei. Gebietsschemacode folgt BCP-47. Hier finden Sie den Text zur Sprachgebietsschemaliste https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
speakerCount	integer (int32)	Die Anzahl der Lautsprecher im Video.
subtitleMaxCharCountPerSegment	integer (int32)	Maximale Anzahl der Untertitelzeichen pro Segment.
targetLocale	string minLength: 5 maxLength: 16 pattern: ^[A-Za-z]{2,4}([_-][A-Za-z]{4})?([_-]([A-Za-z]{2}\|[0-9]{3}))?$	Das Zielgebietsschema der Übersetzung. Gebietsschemacode folgt BCP-47. Hier finden Sie den Text zur Sprachgebietsschemaliste https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
videoFileUrl	string (uri)	Url der Übersetzungsvideodatei.
voiceKind	VoiceKind	Übersetzungsstimme.

VoiceKind

Enumeration

TTS-Sprachart.

Wert	Beschreibung
PersonalVoice	PERSÖNLICHE TTS-Stimme
PlatformVoice	TTS-Plattformstimme

WebvttFile

Objekt

Webvtt-Übersetzungsdatei.

Name	Typ	Beschreibung
kind	WebvttFileKind	Webvtt-Übersetzungsdateiart.
url	string (uri)	Url der Webvtt-Datei für die Übersetzung.

WebvttFileKind

Enumeration

Webvtt-Dateiart.

Wert	Beschreibung
MetadataJson	JSON-Webvtt-Datei mit Zielgebietsschemametadaten
SourceLocaleSubtitle	Webvtt-Quellgebietsschemadatei für Nur-Text-Untertitel
TargetLocaleSubtitle	Webvtt-Datei für zielgebietsschema-Nur-Text-Untertitel

Freigeben über

Translation Operations - List Translation

URI-Parameter

Antworten

Sicherheit

Ocp-Apim-Subscription-Key

AADToken

Bereiche

Beispiele

List translations

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

Iteration

IterationInput

IterationResult

PagedTranslation

Status

Translation

TranslationInput

VoiceKind

WebvttFile

WebvttFileKind

Zusätzliche Ressourcen