Translation Operations - List Translation

Referens

Tjänst:: Azure AI Services

API-version:: 2024-05-20-preview

Lista översättningsresurser.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://eastus.api.cognitive.microsoft.com).
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.
maxpagesize	query		integer (int32)	Det maximala antalet resultatobjekt per sida.
skip	query		integer (int32)	Antalet resultatobjekt som ska hoppa över.
top	query		integer (int32)	Antalet resultatobjekt som ska returneras.

Svar

Name	Typ	Description
200 OK	PagedTranslation	Begäran har slutförts.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Name

Typ

Description

200 OK

PagedTranslation

Begäran har slutförts.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Ett oväntat felsvar.

Sidhuvuden

x-ms-error-code: string

Säkerhet

Ocp-Apim-Subscription-Key

Ange din Speech-resursnyckel här.

Typ: apiKey
I: header

AADToken

Det här är Microsofts identitetsplattform flöden.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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

Exempel

List translations

Exempelbegäran

HTTP

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

Exempelsvar

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

Definitioner

Name	Description
Azure.Core.Foundations.Error	Felobjektet.
Azure.Core.Foundations.ErrorResponse	Ett svar som innehåller felinformation.
Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Iteration	Gör en iteration för att översätta en videofil från källspråk till målspråk, webvtt för innehållsredigering är valfritt för att begära parameter.
IterationInput	Iterationsindata.
IterationResult	Iterationsresultat.
PagedTranslation	Sidsidig samling översättningsobjekt
Status	Uppgiftsstatus.
Translation	Skapa översättningsresurs som värd för iterationer av översättning av en videofil från källspråk till målspråk.
TranslationInput	Översättningsindata.
VoiceKind	TTS-rösttyp.
WebvttFile	Webvtt-översättningsfil.
WebvttFileKind	Webvtt-filtyp.

Azure.Core.Foundations.Error

Objekt

Felobjektet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	Azure.Core.Foundations.Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

Azure.Core.Foundations.ErrorResponse

Objekt

Ett svar som innehåller felinformation.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Felobjektet.

Azure.Core.Foundations.InnerError

Objekt

Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
innererror	Azure.Core.Foundations.InnerError	Inre fel.

Iteration

Objekt

Gör en iteration för att översätta en videofil från källspråk till målspråk, webvtt för innehållsredigering är valfritt för att begära parameter.

Name	Typ	Description
createdDateTime	string (date-time)	Tidsstämpeln när objektet skapades. Tidsstämpeln är kodad som ISO 8601-datum- och tidsformat ("ÅÅÅÅ-MM-DDThh:mm:ssZ", se https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Beskrivning av iteration
failureReason	string	Iterationsfelorsak
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	Iterationsindata.
lastActionDateTime	string (date-time)	Tidsstämpeln när den aktuella statusen angavs. Tidsstämpeln är kodad som ISO 8601-datum- och tidsformat ("ÅÅÅÅ-MM-DDThh:mm:ssZ", se https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
result	IterationResult	Iterationsresultat.
status	Status	Iterationsstatus

IterationInput

Objekt

Iterationsindata.

Name	Typ	Description
exportSubtitleInVideo	boolean	Exportera underrubrik i video.
speakerCount	integer (int32)	Antal talare i videon.
subtitleMaxCharCountPerSegment	integer (int32)	Maximalt antal visningstecken per segment underrubrik.
webvttFile	WebvttFile	Webvtt-fil för innehållsredigering, den här parametern krävs från den andra begäran om att skapa iteration av översättningen.

IterationResult

Objekt

Iterationsresultat.

Name	Typ	Description
metadataJsonWebvttFileUrl	string (uri)	Url för metadata-json webvtt-fil.
reportFileUrl	string (uri)	Rapportfilens URL.
sourceLocaleSubtitleWebvttFileUrl	string (uri)	Url för källspråksundertextfil.
targetLocaleSubtitleWebvttFileUrl	string (uri)	Url för undertextfil för målspråk.
translatedVideoFileUrl	string (uri)	Översatt videofils-URL.

PagedTranslation

Objekt

Sidsidig samling översättningsobjekt

Name	Typ	Description
nextLink	string (uri)	Länken till nästa sida med objekt
value	Translation[]	Översättningsobjekten på den här sidan

Status

Uppräkning

Uppgiftsstatus.

Värde	Description
Canceled	Avbruten status
Failed	Körningsstatusen misslyckades
NotStarted	Statusen Har inte startats
Running	Kör status
Succeeded	Kör statusen lyckades

Translation

Objekt

Skapa översättningsresurs som värd för iterationer av översättning av en videofil från källspråk till målspråk.

Name	Typ	Description
createdDateTime	string (date-time)	Tidsstämpeln när objektet skapades. Tidsstämpeln är kodad som ISO 8601-datum- och tidsformat ("ÅÅÅÅ-MM-DDThh:mm:ssZ", se https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Översättningsbeskrivning.
displayName	string	Översättningsvisningsnamn.
failureReason	string	Orsak till översättningsfel
id	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Översättningsresurs-ID.
input	TranslationInput	Översättningsindata.
latestIteration	Iteration	Den senaste iterationen av översättningen.
latestSucceededIteration	Iteration	Den senaste slutförda iterationen av översättningen.

TranslationInput

Objekt

Översättningsindata.

Name	Typ	Description
exportSubtitleInVideo	boolean	Exportera underrubrik i video.
sourceLocale	string minLength: 5 maxLength: 16 pattern: ^[A-Za-z]{2,4}([_-][A-Za-z]{4})?([_-]([A-Za-z]{2}\|[0-9]{3}))?$	Källspråket för videofilen. Språkkod följer BCP-47. Du hittar språklistan för text till tal här https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
speakerCount	integer (int32)	Antal talare i videon.
subtitleMaxCharCountPerSegment	integer (int32)	Maximalt antal visningstecken per segment underrubrik.
targetLocale	string minLength: 5 maxLength: 16 pattern: ^[A-Za-z]{2,4}([_-][A-Za-z]{4})?([_-]([A-Za-z]{2}\|[0-9]{3}))?$	Översättningens målspråk. Språkkod följer BCP-47. Du hittar språklistan för text till tal här https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
videoFileUrl	string (uri)	Url för översättningsvideofil.
voiceKind	VoiceKind	Översättningsrösttyp.

VoiceKind

Uppräkning

TTS-rösttyp.

Värde	Description
PersonalVoice	Personlig TTS-röst
PlatformVoice	TTS-plattformsröst

WebvttFile

Objekt

Webvtt-översättningsfil.

Name	Typ	Description
kind	WebvttFileKind	Översättning webvtt filtyp.
url	string (uri)	Url för webvtt-översättningsfil.

WebvttFileKind

Uppräkning

Webvtt-filtyp.

Värde	Description
MetadataJson	Målspråkmetadata för JSON webvtt-fil
SourceLocaleSubtitle	Webvtt-fil med källspråk för oformaterad text
TargetLocaleSubtitle	Webvtt-fil för målspråk för oformaterad text

Dela via

Translation Operations - List Translation

URI-parametrar

Svar

Säkerhet

Ocp-Apim-Subscription-Key

AADToken

Omfattningar

Exempel

List translations

Exempelbegäran

Exempelsvar

Definitioner

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

Iteration

IterationInput

IterationResult

PagedTranslation

Status

Translation

TranslationInput

VoiceKind

WebvttFile

WebvttFileKind

Ytterligare resurser