Iteration Operations - Create Iteration

Referencia

Servicio:: Azure AI Services

Versión de la API:: 2024-05-20-preview

Crea una iteración.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: 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]$	Identificador de iteración
translationId	path	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Id. de recurso de traducción.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Operation-Id	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identificador de la operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
input	True	IterationInput	Entrada de iteración.
description		string	Descripción de la iteración

Respuestas

Nombre	Tipo	Description
200 OK	Iteration	La solicitud se ha realizado correctamente. Encabezados Operation-Location: string
201 Created	Iteration	La solicitud se ha realizado correctamente y se ha creado un nuevo recurso como resultado. Encabezados Operation-Location: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Una respuesta de error inesperada. Encabezados x-ms-error-code: string

Nombre

Tipo

Description

200 OK

Iteration

La solicitud se ha realizado correctamente.

Encabezados

Operation-Location: string

201 Created

Iteration

La solicitud se ha realizado correctamente y se ha creado un nuevo recurso como resultado.

Encabezados

Operation-Location: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Una respuesta de error inesperada.

Encabezados

x-ms-error-code: string

Seguridad

Ocp-Apim-Subscription-Key

Proporcione la clave de recurso de voz aquí.

Tipo: apiKey
En: header

AADToken

Estos son los flujos de de la plataforma de identidad de Microsoft.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

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

Ejemplos

Create Iteration

Solicitud de ejemplo

HTTP

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


{
  "description": "Fix segment duration issue and update subtitle max char.",
  "input": {
    "speakerCount": 3,
    "subtitleMaxCharCountPerSegment": 60,
    "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"
    }
  }
}

Respuesta de muestra

status code:: 200

Operation-Location: https://eastus.api.cognitive.microsoft.com/videotranslation/operations/Create-TranslateMyZhCNVideo-ContentEditing-2?api-version=2024-02-01-preview
Operation-Id: TranslateMyZhCNVideo-ContentEditing-1

{
  "id": "TranslateMyZhCNVideo-ContentEditing-2",
  "description": "Fix segment duration issue and update subtitle max char.",
  "status": "NotStarted",
  "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"
    }
  }
}

status code:: 201

Operation-Location: https://eastus.api.cognitive.microsoft.com/videotranslation/operations/Create-TranslateMyZhCNVideo-ContentEditing-2?api-version=2024-02-01-preview
Operation-Id: TranslateMyZhCNVideo-ContentEditing-1

{
  "id": "TranslateMyZhCNVideo-ContentEditing-2",
  "description": "Fix segment duration issue and update subtitle max char.",
  "status": "NotStarted",
  "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"
    }
  }
}

Definiciones

Nombre	Description
Azure.Core.Foundations.Error	Objeto de error.
Azure.Core.Foundations.ErrorResponse	Respuesta que contiene los detalles del error.
Azure.Core.Foundations.InnerError	Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Iteration	Realice una iteración para traducir un archivo de vídeo de la configuración regional de origen a la configuración regional de destino, webvtt para la edición de contenido es opcional para solicitar el parámetro.
IterationInput	Entrada de iteración.
IterationResult	Resultado de la iteración.
Status	Estado de la tarea.
WebvttFile	Archivo webvtt de traducción.
WebvttFileKind	Tipo de archivo Webvtt.

Azure.Core.Foundations.Error

Object

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	Azure.Core.Foundations.Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	Azure.Core.Foundations.InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

Azure.Core.Foundations.ErrorResponse

Object

Respuesta que contiene los detalles del error.

Nombre	Tipo	Description
error	Azure.Core.Foundations.Error	Objeto de error.

Azure.Core.Foundations.InnerError

Object

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
innererror	Azure.Core.Foundations.InnerError	Error interno.

Iteration

Object

Realice una iteración para traducir un archivo de vídeo de la configuración regional de origen a la configuración regional de destino, webvtt para la edición de contenido es opcional para solicitar el parámetro.

Nombre	Tipo	Description
createdDateTime	string (date-time)	Marca de tiempo cuando se creó el objeto. La marca de tiempo se codifica como formato de fecha y hora ISO 8601 ("AAAA-MM-DDThh:mm:ssZ", vea https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Descripción de la iteración
failureReason	string	Motivo del error de iteración
id	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identificador de iteración
input	IterationInput	Entrada de iteración.
lastActionDateTime	string (date-time)	Marca de tiempo cuando se especificó el estado actual. La marca de tiempo se codifica como formato de fecha y hora ISO 8601 ("AAAA-MM-DDThh:mm:ssZ", vea https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
result	IterationResult	Resultado de la iteración.
status	Status	Estado de iteración

IterationInput

Object

Entrada de iteración.

Nombre	Tipo	Description
exportSubtitleInVideo	boolean	Exporte el subtítulo en el vídeo.
speakerCount	integer (int32)	Número de altavoces en el vídeo.
subtitleMaxCharCountPerSegment	integer (int32)	Número máximo de caracteres de visualización de subtítulos por segmento.
webvttFile	WebvttFile	Archivo webvtt para la edición de contenido, este parámetro es necesario a partir de la segunda solicitud de creación de iteración de la traducción.

IterationResult

Object

Resultado de la iteración.

Nombre	Tipo	Description
metadataJsonWebvttFileUrl	string (uri)	Dirección URL del archivo webvtt json de metadatos.
reportFileUrl	string (uri)	Dirección URL del archivo de informe.
sourceLocaleSubtitleWebvttFileUrl	string (uri)	Dirección URL del archivo de subtítulos de configuración regional de origen.
targetLocaleSubtitleWebvttFileUrl	string (uri)	Dirección URL del archivo de subtítulos de configuración regional de destino.
translatedVideoFileUrl	string (uri)	Dirección URL del archivo de vídeo traducido.

Status

Enumeración

Estado de la tarea.

Valor	Description
Canceled	Estado cancelado
Failed	Estado de error de ejecución
NotStarted	Estado no iniciado
Running	Estado de ejecución
Succeeded	Ejecutar el estado correcto

WebvttFile

Object

Archivo webvtt de traducción.

Nombre	Tipo	Description
kind	WebvttFileKind	Tipo de archivo webvtt de traducción.
url	string (uri)	Dirección URL del archivo webvtt de traducción.

WebvttFileKind

Enumeración

Tipo de archivo Webvtt.

Valor	Description
MetadataJson	Archivo webvtt JSON de metadatos de configuración regional de destino
SourceLocaleSubtitle	Archivo webvtt de subtítulo de texto sin formato de configuración regional de origen
TargetLocaleSubtitle	Archivo webvtt de subtítulo de texto sin formato de destino

Compartir a través de

Iteration Operations - Create Iteration

Parámetros de identificador URI

Encabezado de la solicitud

Cuerpo de la solicitud

Respuestas

Seguridad

Ocp-Apim-Subscription-Key

AADToken

Ámbitos

Ejemplos

Create Iteration

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

Iteration

IterationInput

IterationResult

Status

WebvttFile

WebvttFileKind

Recursos adicionales