Iteration Operations - Get Iteration

Referenz

Dienst:: Azure AI Services

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

Rufen Sie eine Iteration nach ID ab.

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

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).
iterationId	path	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Iterations-ID
translationId	path	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Übersetzungsressourcen-ID.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

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

Name

Typ

Beschreibung

200 OK

Iteration

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

Get Iteration

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "TranslateMyZhCNVideo-Iteration-1",
  "description": "Translate video from en-US to zh-CN, fix segment issue.",
  "status": "Succeeded",
  "createdDateTime": "2023-04-10T05:30:00.000Z",
  "lastActionDateTime": "2023-04-10T05:15:30.000Z",
  "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"
    }
  },
  "result": {
    "translatedVideoFileUrl": "https://xxx.blob.core.windows.net/container1/video.mp4?sv=2023-01-03&st=2024-05-20T08%3A27%3A15Z&se=2024-05-21T08%3A27%3A15Z&sr=b&sp=r&sig=xxx",
    "sourceLocaleSubtitleWebvttFileUrl": "https://xxx.blob.core.windows.net/container1/sourceLocale.vtt?sv=2023-01-03&st=2024-05-20T08%3A27%3A15Z&se=2024-05-21T08%3A27%3A15Z&sr=b&sp=r&sig=xxx",
    "targetLocaleSubtitleWebvttFileUrl": "https://xxx.blob.core.windows.net/container1/targetLocale.vtt?sv=2023-01-03&st=2024-05-20T08%3A27%3A15Z&se=2024-05-21T08%3A27%3A15Z&sr=b&sp=r&sig=xxx",
    "metadataJsonWebvttFileUrl": "https://xxx.blob.core.windows.net/container1/metadataJsonLocale.vtt?sv=2023-01-03&st=2024-05-20T08%3A27%3A15Z&se=2024-05-21T08%3A27%3A15Z&sr=b&sp=r&sig=xxx"
  }
}

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.
Status	Vorgangsstatus.
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.

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"

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

Iteration Operations - Get Iteration

URI-Parameter

Antworten

Sicherheit

Ocp-Apim-Subscription-Key

AADToken

Bereiche

Beispiele

Get Iteration

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

Iteration

IterationInput

IterationResult

Status

WebvttFile

WebvttFileKind

Zusätzliche Ressourcen