Compartir a través de


Projects - List Transcriptions

Obtiene la lista de transcripciones del proyecto especificado.

GET {endpoint}/speechtotext/v3.2-preview.2/projects/{id}/transcriptions
GET {endpoint}/speechtotext/v3.2-preview.2/projects/{id}/transcriptions?skip={skip}&top={top}&filter={filter}

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://westus.api.cognitive.microsoft.com).

id
path True

string

uuid

Identificador del proyecto.

filter
query

string

Expresión de filtrado para seleccionar un subconjunto de las transcripciones disponibles.

        - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.

        - Operators:

          - eq, ne are supported for all properties.

          - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.

          - and, or, not are supported.

        - Example:

          filter=createdDateTime gt 2022-02-01T11:00:00Z
skip
query

integer

int32

Número de conjuntos de datos que se omitirán.

top
query

integer

int32

Número de conjuntos de datos que se incluirán después de omitir.

Respuestas

Nombre Tipo Description
200 OK

PaginatedTranscriptions

Aceptar

Encabezados

Retry-After: integer

Other Status Codes

Error

Se produjo un error.

Seguridad

Ocp-Apim-Subscription-Key

Proporcione aquí la clave de la cuenta de Cognitive Services.

Tipo: apiKey
En: header

Authorization

Proporcione un token de acceso del JWT devuelto por el STS de esta región. Asegúrese de agregar el ámbito de administración al token agregando la siguiente cadena de consulta a la dirección URL de STS: ?scope=speechservicesmanagement.

Tipo: apiKey
En: header

Ejemplos

Get all transcriptions

Solicitud de ejemplo

GET {endpoint}/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions?skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z

Respuesta de muestra

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683",
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files"
      },
      "properties": {
        "diarizationEnabled": false,
        "wordLevelTimestampsEnabled": false,
        "displayFormWordLevelTimestampsEnabled": false,
        "channels": [
          0,
          1
        ],
        "punctuationMode": "DictatedAndAutomatic",
        "profanityFilterMode": "Masked",
        "duration": "PT42S"
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Transcription using adapted model en-US",
      "customProperties": {
        "key": "value"
      }
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683",
      "contentUrls": [
        "https://contoso.com/",
        "https://contoso2.com/"
      ],
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files"
      },
      "properties": {
        "diarizationEnabled": false,
        "wordLevelTimestampsEnabled": false,
        "displayFormWordLevelTimestampsEnabled": true,
        "channels": [
          0,
          1
        ],
        "punctuationMode": "DictatedAndAutomatic",
        "profanityFilterMode": "Masked",
        "duration": "PT42S"
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Failed",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Transcription using adapted model en-US",
      "customProperties": {
        "key": "value"
      }
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z"
}

Definiciones

Nombre Description
DetailedErrorCode

DetailedErrorCode

DiarizationProperties

DiarizationProperties

DiarizationSpeakersProperties

DiarizationSpeakersProperties

EntityError

EntityError

EntityReference

EntityReference

Error

Error

ErrorCode

ErrorCode

InnerError

InnerError

LanguageIdentificationMode

LanguageIdentificationMode

LanguageIdentificationProperties

LanguageIdentificationProperties

PaginatedTranscriptions

PaginatedTranscriptions

ProfanityFilterMode

ProfanityFilterMode

PunctuationMode

PuntuaciónMode

Status

Estado

Transcription

Transcripción

TranscriptionLinks

TranscriptionLinks

TranscriptionProperties

TranscriptionProperties

DetailedErrorCode

DetailedErrorCode

Nombre Tipo Description
DataImportFailed

string

Error en la importación de datos.

DeleteNotAllowed

string

No se permite eliminar.

DeployNotAllowed

string

No se permite la implementación.

DeployingFailedModel

string

Error al implementar el modelo.

EmptyRequest

string

Solicitud vacía.

EndpointCannotBeDefault

string

El punto de conexión no puede ser predeterminado.

EndpointNotUpdatable

string

Punto de conexión no actualizable.

EndpointWithoutLogging

string

Punto de conexión sin registro.

ExceededNumberOfRecordingsUris

string

Se superó el número de URI de grabaciones.

FailedDataset

string

Conjunto de datos con error.

Forbidden

string

Prohibido.

InUseViolation

string

En infracción de uso.

InaccessibleCustomerStorage

string

Almacenamiento de cliente inaccesible.

InvalidAdaptationMapping

string

Asignación de adaptación no válida.

InvalidBaseModel

string

Modelo base no válido.

InvalidCallbackUri

string

URI de devolución de llamada no válido.

InvalidCollection

string

Colección no válida.

InvalidDataset

string

Conjunto de datos no válido.

InvalidDocument

string

Documento no válido.

InvalidDocumentBatch

string

Lote de documentos no válido.

InvalidLocale

string

Configuración regional no válida.

InvalidLogDate

string

Fecha de registro no válida.

InvalidLogEndTime

string

Hora de finalización del registro no válida.

InvalidLogId

string

Identificador de registro no válido.

InvalidLogStartTime

string

Hora de inicio del registro no válida.

InvalidModel

string

Modelo no válido.

InvalidModelUri

string

URI de modelo no válido.

InvalidParameter

string

Parámetro no válido.

InvalidParameterValue

string

Valor de parámetro no válido.

InvalidPayload

string

Carga no válida.

InvalidPermissions

string

Permisos no válidos.

InvalidPrerequisite

string

Requisito previo no válido.

InvalidProductId

string

Id. de producto no válido.

InvalidProject

string

Proyecto no válido.

InvalidProjectKind

string

Tipo de proyecto no válido.

InvalidRecordingsUri

string

URI de grabaciones no válidos.

InvalidRequestBodyFormat

string

Formato de cuerpo de la solicitud no válido.

InvalidSasValidityDuration

string

Duración de validez de sas no válida.

InvalidSkipTokenForLogs

string

Token de omisión no válido para los registros.

InvalidSourceAzureResourceId

string

Identificador de recurso de Azure de origen no válido.

InvalidSubscription

string

Suscripción no válida.

InvalidTest

string

Prueba no válida.

InvalidTimeToLive

string

Tiempo de vida no válido.

InvalidTopForLogs

string

Top no válido para los registros.

InvalidTranscription

string

Transcripción no válida.

InvalidWebHookEventKind

string

Tipo de evento web hook no válido.

MissingInputRecords

string

Faltan registros de entrada.

ModelCopyOperationExists

string

Existe la operación de copia del modelo.

ModelDeploymentNotCompleteState

string

La implementación del modelo no está completa.

ModelDeprecated

string

Modelo en desuso.

ModelExists

string

El modelo existe.

ModelMismatch

string

Error de coincidencia del modelo.

ModelNotDeployable

string

El modelo no se puede implementar.

ModelVersionIncorrect

string

Versión del modelo incorrecta.

NoUtf8WithBom

string

No hay utf8 con bom.

OnlyOneOfUrlsOrContainerOrDataset

string

Solo una de las direcciones URL o el contenedor o el conjunto de datos.

ProjectGenderMismatch

string

Error de coincidencia de género del proyecto.

QuotaViolation

string

Infracción de cuota.

SingleDefaultEndpoint

string

Punto de conexión predeterminado único.

SkuLimitsExist

string

Existen límites de SKU.

SubscriptionNotFound

string

No se encontró la suscripción.

UnexpectedError

string

error inesperado.

UnsupportedClassBasedAdaptation

string

Adaptación basada en clases no admitida.

UnsupportedDelta

string

Delta no admitido.

UnsupportedDynamicConfiguration

string

Configuración dinámica no admitida.

UnsupportedFilter

string

Filtro no admitido.

UnsupportedLanguageCode

string

Código de idioma no admitido.

UnsupportedOrderBy

string

Orden no admitido por.

UnsupportedPagination

string

Paginación no admitida.

UnsupportedTimeRange

string

Intervalo de tiempo no admitido.

DiarizationProperties

DiarizationProperties

Nombre Tipo Description
speakers

DiarizationSpeakersProperties

DiarizationSpeakersProperties

DiarizationSpeakersProperties

DiarizationSpeakersProperties

Nombre Tipo Description
maxCount

integer

Número máximo de altavoces para la diarización. Debe ser menor que 36 y mayor o igual que la propiedad minSpeakers.

minCount

integer

Sugerencia para el número mínimo de altavoces para la diarización. Debe ser menor o igual que la propiedad maxSpeakers.

EntityError

EntityError

Nombre Tipo Description
code

string

Código de este error.

message

string

Mensaje para este error.

EntityReference

EntityReference

Nombre Tipo Description
self

string

Ubicación de la entidad a la que se hace referencia.

Error

Error

Nombre Tipo Description
code

ErrorCode

ErrorCode
Códigos de error de alto nivel.

details

Error[]

Detalles adicionales de apoyo relacionados con el error o las directivas esperadas.

innerError

InnerError

InnerError
Nuevo formato de error interno que se ajusta a las directrices de cognitive Services API que están disponibles en https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Contiene las propiedades necesarias ErrorCode, message y las propiedades opcionales, target, details (par clave-valor), innerError (se puede anidar).

message

string

Mensaje de error de alto nivel.

target

string

Origen del error. Por ejemplo, sería "documentos" o "id. de documento" en el caso de un documento no válido.

ErrorCode

ErrorCode

Nombre Tipo Description
Conflict

string

Representa el código de error de conflicto.

Forbidden

string

Representa el código de error prohibido.

InternalCommunicationFailed

string

Representando el código de error de comunicación interna con errores.

InternalServerError

string

Representa el código de error interno del servidor.

InvalidArgument

string

Representa el código de error de argumento no válido.

InvalidRequest

string

Representa el código de error de solicitud no válido.

NotAllowed

string

Representa el código de error no permitido.

NotFound

string

Representa el código de error no encontrado.

PipelineError

string

Representa el código de error de canalización.

ServiceUnavailable

string

Representa el código de error del servicio no disponible.

TooManyRequests

string

Representa el código de error de demasiadas solicitudes.

Unauthorized

string

Representa el código de error no autorizado.

UnprocessableEntity

string

Representa el código de error de entidad no procesado.

UnsupportedMediaType

string

Representa el código de error de tipo de medio no admitido.

InnerError

InnerError

Nombre Tipo Description
code

DetailedErrorCode

DetailedErrorCode
Enumeración detallada del código de error.

details

object

Detalles adicionales de apoyo relacionados con el error o las directivas esperadas.

innerError

InnerError

InnerError
Nuevo formato de error interno que se ajusta a las directrices de cognitive Services API que están disponibles en https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Contiene las propiedades necesarias ErrorCode, message y las propiedades opcionales, target, details (par clave-valor), innerError (se puede anidar).

message

string

Mensaje de error de alto nivel.

target

string

Origen del error. Por ejemplo, sería "documentos" o "id. de documento" en el caso de un documento no válido.

LanguageIdentificationMode

LanguageIdentificationMode

Nombre Tipo Description
Continuous

string

Identificación continua del idioma (valor predeterminado).

Single

string

Identificación de idioma único.

LanguageIdentificationProperties

LanguageIdentificationProperties

Nombre Tipo Valor predeterminado Description
candidateLocales

string[]

Las configuraciones regionales candidatas para la identificación del idioma (ejemplo ["en-US", "de-DE", "es-ES"]). Se admite un mínimo de 2 y un máximo de 10 configuraciones regionales candidatas, incluyendo la configuración regional principal para la transcripción.

mode

LanguageIdentificationMode

Continuous

LanguageIdentificationMode
Modo utilizado para la identificación del idioma.

speechModelMapping

<string,  EntityReference>

Una asignación opcional de configuraciones regionales a las entidades del modelo de voz. Si no se da ningún modelo para una configuración regional, se usa el modelo base predeterminado. Las claves deben ser configuraciones regionales contenidas en las configuraciones regionales candidatas, los valores son entidades para los modelos de las configuraciones regionales respectivas.

PaginatedTranscriptions

PaginatedTranscriptions

Nombre Tipo Description
@nextLink

string

Vínculo al siguiente conjunto de resultados paginados si hay más entidades disponibles; de lo contrario, es null.

values

Transcription[]

Una lista de entidades limitadas por los parámetros de consulta pasados "skip" y "top" o sus valores predeterminados.

Al recorrer en iteración una lista mediante la paginación y la eliminación de entidades en paralelo, algunas entidades se omitirán en los resultados. Se recomienda compilar una lista en el cliente y eliminar después de la captura de la lista completa.

ProfanityFilterMode

ProfanityFilterMode

Nombre Tipo Description
Masked

string

Enmascarar la palabra soece con * excepto la primera letra, por ejemplo, f***

None

string

Deshabilite el filtrado de palabras soeces.

Removed

string

Quitar palabras soeces.

Tags

string

Agregar etiquetas< XML "soeces" o palabras soeces>

PunctuationMode

PuntuaciónMode

Nombre Tipo Description
Automatic

string

Puntuación automática.

Dictated

string

Signos de puntuación dictados solo, es decir, puntuación explícita.

DictatedAndAutomatic

string

Signos de puntuación dictados o puntuación automática.

None

string

Sin puntuación.

Status

Estado

Nombre Tipo Description
Failed

string

Error en la operación de larga duración.

NotStarted

string

La operación de larga duración aún no se ha iniciado.

Running

string

La operación de larga duración está procesando actualmente.

Succeeded

string

La operación de larga duración se ha completado correctamente.

Transcription

Transcripción

Nombre Tipo Description
contentContainerUrl

string

Dirección URL de un contenedor de blobs de Azure que contiene los archivos de audio. Se permite que un contenedor tenga un tamaño máximo de 5 GB y un número máximo de 10000 blobs. El tamaño máximo de un blob es 2,5 GB. La SAS de contenedor debe contener permisos "r" (lectura) y "l" (lista). Esta propiedad no se devolverá en una respuesta.

contentUrls

string[]

Lista de direcciones URL de contenido para obtener archivos de audio para transcribir. Se permiten hasta 1000 direcciones URL. Esta propiedad no se devolverá en una respuesta.

createdDateTime

string

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).

customProperties

object

Propiedades personalizadas de esta entidad. La longitud máxima permitida de la clave es de 64 caracteres, la longitud máxima permitida del valor es de 256 caracteres y el recuento de entradas permitidas es de 10.

dataset

EntityReference

EntityReference

description

string

Descripción del objeto .

displayName

string

Nombre para mostrar del objeto.

lastActionDateTime

string

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).

links

TranscriptionLinks

TranscriptionLinks

locale

string

Configuración regional de los datos contenidos. Si se usa la identificación del idioma, esta configuración regional se usa para transcribir la voz para la que no se pudo detectar ningún idioma.

model

EntityReference

EntityReference

project

EntityReference

EntityReference

properties

TranscriptionProperties

TranscriptionProperties

self

string

Ubicación de esta entidad.

status

Status

Estado
Describir el estado actual de la API

TranscriptionLinks

Nombre Tipo Description
files

string

Ubicación para obtener todos los archivos de esta entidad. Consulte la operación "Transcriptions_ListFiles" para obtener más detalles.

TranscriptionProperties

TranscriptionProperties

Nombre Tipo Description
channels

integer[]

Colección de los números de canal solicitados. En el caso predeterminado, se tienen en cuenta los canales 0 y 1.

destinationContainerUrl

string

Contenedor de destino solicitado.

Comentarios

Cuando se usa un contenedor de destino en combinación con timeToLive, los metadatos de una transcripción se eliminarán normalmente, pero los datos almacenados en el contenedor de destino, incluidos los resultados de la transcripción, permanecerán intactos, porque no se requieren permisos de eliminación para este contenedor.
Para admitir la limpieza automática, configure las duraciones de blobs en el contenedor o use "Bring your own Storage (BYOS)" en lugar de destinationContainerUrl, donde se pueden limpiar los blobs.

diarization

DiarizationProperties

DiarizationProperties

diarizationEnabled

boolean

Valor que indica si se solicita la diarización (identificación del hablante). El valor predeterminado es false. Si este campo se establece en true y el sistema de diarización mejorado se configura especificando DiarizationProperties, el sistema de diarización mejorado proporcionará diarización para un intervalo configurable de altavoces. Si este campo se establece en true y el sistema de diarización mejorado no está habilitado (no especificando DiarizationProperties), el sistema de diarización básica distinguirá entre hasta dos altavoces. No se aplican cargos adicionales para la diarización básica.

El sistema de diarización básica está en desuso y se quitará en la siguiente versión principal de la API. Esta diarizationEnabled configuración también se quitará.

displayFormWordLevelTimestampsEnabled

boolean

Valor que indica si se solicitan marcas de tiempo de nivel de palabra para el formulario para mostrar. El valor predeterminado es false.

duration

string

Duración de la transcripción. La duración se codifica como duración ISO 8601 ("PnYnMnDTnHnMnS", vea https://en.wikipedia.org/wiki/ISO_8601#Durations).

email

string

Dirección de correo electrónico a la que se enviarán notificaciones por correo electrónico en caso de que se complete la operación. El valor se quitará después de enviar correctamente el correo electrónico.

error

EntityError

EntityError

languageIdentification

LanguageIdentificationProperties

LanguageIdentificationProperties

profanityFilterMode

ProfanityFilterMode

ProfanityFilterMode
Modo de filtrado de palabras soeces.

punctuationMode

PunctuationMode

PuntuaciónMode
Modo utilizado para la puntuación.

timeToLive

string

Cuánto tiempo se conservará la transcripción en el sistema una vez completada. Una vez que la transcripción alcanza el período de vida después de la finalización (correcta o con errores), se eliminará automáticamente. No establecer este valor o establecerlo en 0 deshabilitará la eliminación automática. La duración admitida más larga es de 31 días. La duración se codifica como duración ISO 8601 ("PnYnMnDTnHnMnS", vea https://en.wikipedia.org/wiki/ISO_8601#Durations).

wordLevelTimestampsEnabled

boolean

Valor que indica si se solicitan marcas de tiempo de nivel de palabra. El valor predeterminado es false.