Iteration Operations - List Iteration

Referentie

Service:: Azure AI Services

API-versie:: 2024-05-20-preview

Iteratiebronnen weergeven.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://eastus.api.cognitive.microsoft.com).
translationId	path	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resource-id voor vertaling.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.
maxpagesize	query		integer (int32)	Het maximum aantal resultaatitems per pagina.
skip	query		integer (int32)	Het aantal resultaatitems dat moet worden overgeslagen.
top	query		integer (int32)	Het aantal resultaatitems dat moet worden geretourneerd.

Antwoorden

Name	Type	Description
200 OK	PagedIteration	De aanvraag is voltooid.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Name

Type

Description

200 OK

PagedIteration

De aanvraag is voltooid.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Een onverwachte foutreactie.

Kopteksten

x-ms-error-code: string

Beveiliging

Ocp-Apim-Subscription-Key

Geef hier uw spraakresourcesleutel op.

Type: apiKey
In: header

AADToken

Dit zijn de Microsoft Identity Platform stromen.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

Voorbeelden

List Iteration

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 200

{
  "value": [
    {
      "id": "Initial",
      "description": "Translate video from en-US to zh-CN, fix segment issue.",
      "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"
        }
      },
      "status": "Succeeded",
      "createdDateTime": "2023-04-10T05:30:00.000Z",
      "lastActionDateTime": "2023-04-10T05:15:30.000Z"
    },
    {
      "id": "TranslateMyZhCNVideo-Iteration-1",
      "description": "Translate video from en-US to zh-CN.",
      "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"
        }
      },
      "status": "Failed",
      "createdDateTime": "2023-04-01T05:30:00.000Z",
      "lastActionDateTime": "2023-04-10T05:15:30.000Z"
    },
    {
      "id": "TranslateMyZhCNVideo-Iteration-2",
      "description": "Translate video from en-US to zh-CN.",
      "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"
        }
      },
      "status": "Running",
      "createdDateTime": "2023-04-01T05:30:00.000Z",
      "lastActionDateTime": "2023-04-10T05:15:30.000Z"
    }
  ],
  "nextLink": "https://eastus.api.cognitive.microsoft.com/video-translation/translations/TranslateMyZhCNVideo/iterations?skip=2&maxpagesize=2&api-version=2024-05-20-preview"
}

Definities

Name	Description
Azure.Core.Foundations.Error	Het foutobject.
Azure.Core.Foundations.ErrorResponse	Een antwoord met foutdetails.
Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Iteration	Voer één iteratie uit om één videobestand te vertalen van de bronlocatie naar de doellocatie. Webvtt voor het bewerken van inhoud is optioneel voor het aanvragen van de parameter.
IterationInput	Iteratie-invoer.
IterationResult	Iteratieresultaat.
PagedIteration	Gepaginade verzameling iteratie-items
Status	Taakstatus.
WebvttFile	Webvtt-bestand vertalen.
WebvttFileKind	Webvtt-bestandstype.

Azure.Core.Foundations.Error

Object

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	Azure.Core.Foundations.Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

Azure.Core.Foundations.ErrorResponse

Object

Een antwoord met foutdetails.

Name	Type	Description
error	Azure.Core.Foundations.Error	Het foutobject.

Azure.Core.Foundations.InnerError

Object

Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
innererror	Azure.Core.Foundations.InnerError	Interne fout.

Iteration

Object

Voer één iteratie uit om één videobestand te vertalen van de bronlocatie naar de doellocatie. Webvtt voor het bewerken van inhoud is optioneel voor het aanvragen van de parameter.

Name	Type	Description
createdDateTime	string (date-time)	De tijdstempel waarop het object is gemaakt. De tijdstempel wordt gecodeerd als ISO 8601-datum- en tijdnotatie ('JJJJ-MM-DDThh:mm:ssZ', zie https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Beschrijving van iteratie
failureReason	string	Reden van iteratiefout
id	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Iteratie-id
input	IterationInput	Iteratie-invoer.
lastActionDateTime	string (date-time)	De tijdstempel waarop de huidige status is ingevoerd. De tijdstempel wordt gecodeerd als ISO 8601-datum- en tijdnotatie ('JJJJ-MM-DDThh:mm:ssZ', zie https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
result	IterationResult	Iteratieresultaat.
status	Status	Iteratiestatus

IterationInput

Object

Iteratie-invoer.

Name	Type	Description
exportSubtitleInVideo	boolean	Ondertitel exporteren in video.
speakerCount	integer (int32)	Aantal sprekers in de video.
subtitleMaxCharCountPerSegment	integer (int32)	Maximum aantal ondertiteltekens per segment.
webvttFile	WebvttFile	Webvtt-bestand voor het bewerken van inhoud is deze parameter vereist vanaf de tweede aanvraag voor het maken van de iteratie van de vertaling.

IterationResult

Object

Iteratieresultaat.

Name	Type	Description
metadataJsonWebvttFileUrl	string (uri)	URL van json-webvtt-bestand met metagegevens.
reportFileUrl	string (uri)	URL van rapportbestand.
sourceLocaleSubtitleWebvttFileUrl	string (uri)	URL van subtitelbestand van bronlandinstelling.
targetLocaleSubtitleWebvttFileUrl	string (uri)	Url van doelondertitelbestand voor landinstellingen.
translatedVideoFileUrl	string (uri)	Vertaalde URL van videobestand.

PagedIteration

Object

Gepaginade verzameling iteratie-items

Name	Type	Description
nextLink	string (uri)	De koppeling naar de volgende pagina met items
value	Iteration[]	De iteratie-items op deze pagina

Status

Inventarisatie

Taakstatus.

Waarde	Description
Canceled	Geannuleerde status
Failed	Mislukte uitvoeringsstatus
NotStarted	Status niet gestart
Running	Status wordt uitgevoerd
Succeeded	Geslaagde status uitvoeren

WebvttFile

Object

Webvtt-bestand vertalen.

Name	Type	Description
kind	WebvttFileKind	Type vertaling van webvtt-bestand.
url	string (uri)	URL van webvtt-bestand vertalen.

WebvttFileKind

Inventarisatie

Webvtt-bestandstype.

Waarde	Description
MetadataJson	JSON-webvtt-bestand met doelmetagegevens van landinstellingen
SourceLocaleSubtitle	Webvtt-bestand met tekst zonder opmaak voor brontekst
TargetLocaleSubtitle	Doellandinstelling webvtt-bestand met tekst zonder opmaak

Delen via

Iteration Operations - List Iteration

URI-parameters

Antwoorden

Beveiliging

Ocp-Apim-Subscription-Key

AADToken

Bereiken

Voorbeelden

List Iteration

Voorbeeldaanvraag

Voorbeeldrespons

Definities

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

Iteration

IterationInput

IterationResult

PagedIteration

Status

WebvttFile

WebvttFileKind

Aanvullende resources