Transcriptions - List Files

Referencia

Servicio:: Azure AI Services

Versión de la API:: v3.2-preview.2

Obtiene los archivos de la transcripción identificada por el identificador especificado.

GET {endpoint}/speechtotext/v3.2-preview.2/transcriptions/{id}/files

Con parámetros opcionales:

GET {endpoint}/speechtotext/v3.2-preview.2/transcriptions/{id}/files?sasValidityInSeconds={sasValidityInSeconds}&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 de la transcripción.
filter	query		string	Expresión de filtrado para seleccionar un subconjunto de los archivos disponibles. `- Supported properties: name, createdDateTime, kind. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime. - and, or, not are supported. - Example: filter=name eq 'myaudio.wav.json' and kind eq 'Transcription'`
sasValidityInSeconds	query		integer int32	Duración en segundos que una dirección URL de SAS debe ser válida. La duración predeterminada es de 12 horas. Cuando se usa BYOS (https://learn.microsoft.com/en-us/azure/cognitive-services/speech-service/speech-encryption-of-data-at-rest#bring-your-own-storage-byos-for-customization-and-logging): un valor de 0 significa que se generará un URI de blob sin formato sin token de SAS.
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	PaginatedFiles	Aceptar Encabezados Retry-After: integer
Other Status Codes	Error	Se produjo un error.

Nombre

Tipo

Description

200 OK

PaginatedFiles

Aceptar

Encabezados

Retry-After: integer

Other Status Codes

Error

Se produjo un error.

Seguridad

Ocp-Apim-Subscription-Key

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

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 files

Get all transcription files the name of which starts with the specified string

Get all files

Solicitud de ejemplo

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?sasValidityInSeconds=120&skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z

Respuesta de muestra

status code:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/ee4733cd-b1a7-4813-87e2-00d582c28a29",
      "name": "mywavefile1.wav.json",
      "kind": "Transcription",
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5"
      }
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/28bc946b-c251-4a86-84f6-ea0f0a2373ef",
      "name": "mywavefile2.wav.json",
      "kind": "Transcription",
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile2.wav.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5"
      }
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?skip=2&top=2"
}

Get all transcription files the name of which starts with the specified string

Solicitud de ejemplo

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?sasValidityInSeconds=120&skip=0&top=10&filter=name%20eq%20'mywavefile1.wav.json'

Respuesta de muestra

status code:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/ee4733cd-b1a7-4813-87e2-00d582c28a29",
      "name": "mywavefile1.wav.json",
      "kind": "Transcription",
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5"
      }
    }
  ]
}

Definiciones

Nombre	Description
DetailedErrorCode	DetailedErrorCode
Error	Error
ErrorCode	ErrorCode
File	Archivo
FileKind	FileKind
FileLinks	FileLinks
FileProperties	FileProperties
InnerError	InnerError
PaginatedFiles	PaginatedFiles

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	Se ha producido un error en la implementación del 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 errores.
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álidas.
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	Período 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 webhook 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	Modelo no implementable.
ModelVersionIncorrect	string	La versión del modelo es incorrecta.
NoUtf8WithBom	string	No hay utf8 con bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Solo una de las direcciones URL, el contenedor o el conjunto de datos.
ProjectGenderMismatch	string	No coinciden los sexos 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.

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á disponible 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

Nombre	Tipo	Description
Conflict	string	Representa el código de error en 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 no disponible del servicio.
TooManyRequests	string	Representa el código de error demasiadas solicitudes.
Unauthorized	string	Representa el código de error no autorizado.
UnprocessableEntity	string	Representa el código de error de entidad noprocesable.
UnsupportedMediaType	string	Representa el código de error de tipo de medio no admitido.

File

Archivo

Nombre	Tipo	Description
createdDateTime	string	Hora de creación de este archivo. La marca de tiempo se codifica como formato de fecha y hora ISO 8601 (consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
kind	FileKind	FileKind Tipo de datos.
links	FileLinks	FileLinks
name	string	Nombre de este archivo.
properties	FileProperties	FileProperties
self	string	Ubicación de esta entidad.

FileKind

Nombre	Tipo	Description
AcousticDataArchive	string	El tipo de datos es el archivo de datos acústico.
AcousticDataTranscriptionV2	string	El tipo de datos es la transcripción de datos acústica v2.
Audio	string	El tipo de datos es audio.
DatasetReport	string	El tipo de datos es el informe del conjunto de datos.
EvaluationDetails	string	El tipo de datos es detalles de evaluación.
LanguageData	string	El tipo de datos es datos de idioma.
ModelReport	string	El tipo de datos es el informe del modelo.
OutputFormattingData	string	El tipo de datos es el archivo de entrada de formato de salida.
PronunciationData	string	El tipo de datos es datos de pronunciación.
Transcription	string	El tipo de datos es la transcripción.
TranscriptionReport	string	El tipo de datos es el informe de transcripción.

FileLinks

Nombre	Tipo	Description
contentUrl	string	Dirección URL para recuperar el contenido de este archivo.

FileProperties

Nombre	Tipo	Description
duration	string	La duración en caso de que este archivo sea un archivo de audio. La duración se codifica como duración ISO 8601 ("PnYnMnDTnHnMnS", vea https://en.wikipedia.org/wiki/ISO_8601#Durations).
size	integer	Tamaño de los datos en bytes.

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á disponible 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.

PaginatedFiles

Nombre	Tipo	Description
@nextLink	string	Vínculo al siguiente conjunto de resultados paginados si hay más entidades disponibles; en caso contrario, null.
values	File[]	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 paginación y eliminación de entidades en paralelo, algunas entidades se omitirán en los resultados. Se recomienda crear una lista en el cliente y eliminar después de la captura de la lista completa.

Nombre

Tipo

Description

@nextLink

string

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

values

File[]

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 paginación y eliminación de entidades en paralelo, algunas entidades se omitirán en los resultados. Se recomienda crear una lista en el cliente y eliminar después de la captura de la lista completa.

Compartir a través de

Transcriptions - List Files

Parámetros de identificador URI

Respuestas

Seguridad

Ocp-Apim-Subscription-Key

Authorization

Ejemplos

Get all files

Solicitud de ejemplo

Respuesta de muestra

Get all transcription files the name of which starts with the specified string

Solicitud de ejemplo

Respuesta de muestra

Definiciones

DetailedErrorCode

Error

ErrorCode

File

FileKind

FileLinks

FileProperties

InnerError

PaginatedFiles

Recursos adicionales