Partager via

Datasets - List Files

  • Référence
Service:
Azure AI Services
Version d'API:
2024-11-15

Obtient les fichiers du jeu de données identifiés par l’ID donné.

GET {endpoint}/speechtotext/datasets/{id}/files?api-version=2024-11-15
Avec des paramètres facultatifs: 
GET {endpoint}/speechtotext/datasets/{id}/files?sasLifetimeMinutes={sasLifetimeMinutes}&skip={skip}&top={top}&filter={filter}&api-version=2024-11-15

Paramètres URI

Nom Dans Obligatoire Type Description
endpoint
 path True

string

Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://westus.api.cognitive.microsoft.com).
id
 path True

string

uuid

Identificateur du jeu de données.
api-version
 query True

string

Version de l’API demandée.
filter
 query

string

Expression de filtrage permettant de sélectionner un sous-ensemble des fichiers 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' and kind eq 'Audio'
sasLifetimeMinutes
 query

integer

int32

Ce paramètre définit la durée en minutes pendant laquelle une URL SAP doit être valide.

        The parameter can only be used for operations on speech resources that don't have BYOS enabled. For speech resources

        that don't have BYOS enabled, the default SAS validity duration is 12 hours.

        For speech resources with BYOS, returned urls do not contain an SAS token.
skip
 query

integer

int32

Nombre de jeux de données ignorés.
top
 query

integer

int32

Nombre de jeux de données qui seront inclus après l’ignorer.

En-tête de la demande

Nom Obligatoire Type Description
Ocp-Apim-Subscription-Key True

string

Fournissez ici votre clé de compte Cognitive Services.

Réponses

Nom Type Description
200 OK

PaginatedFiles

D’ACCORD

En-têtes

Retry-After: integer
Other Status Codes

Error

Une erreur s’est produite.

Sécurité

Ocp-Apim-Subscription-Key

Fournissez ici votre clé de compte Cognitive Services.

Type: apiKey
Dans: header

Exemples

Get all dataset report files
Get all files

Get all dataset report files

Exemple de requête

GET {endpoint}/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?sasLifetimeMinutes=360&skip=0&top=10&filter=kind%20eq%20'DatasetReport'&api-version=2024-11-15

Exemple de réponse

Code d’état:
200 
{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2",
      "name": "report.json",
      "kind": "DatasetReport",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.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"
      },
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z"
    }
  ]
}

Get all files

Exemple de requête

GET {endpoint}/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?sasLifetimeMinutes=360&skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-11-15

Exemple de réponse

Code d’état:
200 
{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2",
      "name": "report.json",
      "kind": "DatasetReport",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.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"
      },
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/f035cf2d-4051-4131-85e7-97e3a7349c86?api-version=3.2",
      "name": "language_data.txt",
      "kind": "LanguageData",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/language_data.txt?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"
      },
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-11-15"
}

Définitions

Nom Description
DetailedErrorCode

DetailedErrorCode
Error

Erreur
ErrorCode

ErrorCode
File

Lime
FileKind

FileKind
FileLinks

FileLinks
FileProperties

FileProperties
InnerError

InnerError
PaginatedFiles

PaginéFiles

DetailedErrorCode

DetailedErrorCode

Nom Type Description
AudioLengthLimitExceeded

string

Le fichier audio est plus long que la durée maximale autorisée.
BadChannelConfiguration

string

Il existe une incompatibilité entre les canaux audio dans les données, dans la configuration ou les exigences de l’application.
DataImportFailed

string

Échec de l’importation de données.
DeleteNotAllowed

string

Supprimer non autorisé.
DeployNotAllowed

string

Déployer non autorisé.
DeployingFailedModel

string

Déploiement d’un modèle ayant échoué.
EmptyAudioFile

string

Le fichier audio est vide.
EmptyRequest

string

Requête vide.
EndpointCannotBeDefault

string

Le point de terminaison ne peut pas être par défaut.
EndpointLoggingNotSupported

string

La journalisation des points de terminaison n’est pas prise en charge.
EndpointNotUpdatable

string

Point de terminaison non modifiable.
EndpointWithoutLogging

string

Point de terminaison sans journalisation.
ExceededNumberOfRecordingsUris

string

Nombre dépassé d’uris d’enregistrement.
FailedDataset

string

Jeu de données ayant échoué.
Forbidden

string

Interdit.
InUseViolation

string

En cas de violation d’utilisation.
InaccessibleCustomerStorage

string

Stockage client inaccessible.
InvalidAdaptationMapping

string

Mappage d’adaptation non valide.
InvalidAudioFormat

string

Le format audio d’entrée n’est pas pris en charge.
InvalidBaseModel

string

Modèle de base non valide.
InvalidCallbackUri

string

URI de rappel non valide.
InvalidChannelSpecification

string

La sélection de canaux dans la demande de transcription n’est pas prise en charge (par exemple, ni 0 ni 1 n’ont été sélectionnés.)
InvalidChannels

string

Canaux non valides.
InvalidCollection

string

Collection non valide.
InvalidDataset

string

Jeu de données non valide.
InvalidDocument

string

Document non valide.
InvalidDocumentBatch

string

Lot de documents non valide.
InvalidLocale

string

Paramètres régionaux non valides.
InvalidLogDate

string

Date de journal non valide.
InvalidLogEndTime

string

Heure de fin du journal non valide.
InvalidLogId

string

ID de journal non valide.
InvalidLogStartTime

string

Heure de début du journal non valide.
InvalidModel

string

Modèle non valide.
InvalidModelUri

string

URI de modèle non valide.
InvalidParameter

string

Paramètre non valide.
InvalidParameterValue

string

Valeur de paramètre non valide.
InvalidPayload

string

Charge utile non valide.
InvalidPermissions

string

Autorisations non valides.
InvalidPrerequisite

string

Prérequis non valides.
InvalidProductId

string

ID de produit non valide.
InvalidProject

string

Projet non valide.
InvalidProjectKind

string

Type de projet non valide.
InvalidRecordingsUri

string

Uri des enregistrements non valides.
InvalidRequestBodyFormat

string

Format du corps de la demande non valide.
InvalidSasValidityDuration

string

Durée de validité de sas non valide.
InvalidSkipTokenForLogs

string

Jeton d’ignorer non valide pour les journaux d’activité.
InvalidSourceAzureResourceId

string

ID de ressource Azure source non valide.
InvalidSubscription

string

Abonnement non valide.
InvalidTest

string

Test non valide.
InvalidTimeToLive

string

Heure de vie non valide.
InvalidTopForLogs

string

Top non valide pour les journaux d’activité.
InvalidTranscription

string

Transcription non valide.
InvalidWebHookEventKind

string

Type d’événement web hook non valide.
MissingInputRecords

string

Enregistrements d’entrée manquants.
ModelCopyAuthorizationExpired

string

ModelCopyAuthorization expiré.
ModelDeploymentNotCompleteState

string

Le déploiement du modèle n’est pas terminé.
ModelDeprecated

string

Modèle déconseillé.
ModelExists

string

Le modèle existe.
ModelMismatch

string

Incompatibilité du modèle.
ModelNotDeployable

string

Modèle non déployable.
ModelVersionIncorrect

string

Version du modèle incorrecte.
MultipleLanguagesIdentified

string

L’identification linguistique a reconnu plusieurs langues. Aucune langue dominante ne peut être déterminée.
NoLanguageIdentified

string

L’identification linguistique n’a reconnu aucune langue.
NoUtf8WithBom

string

Pas d’utf8 avec bom.
OnlyOneOfUrlsOrContainerOrDataset

string

Une seule URL ou conteneur ou jeu de données.
ProjectGenderMismatch

string

Incompatibilité entre les sexes du projet.
QuotaViolation

string

Violation de quota.
SingleDefaultEndpoint

string

Point de terminaison par défaut unique.
SkuLimitsExist

string

Les limites de référence SKU existent.
SubscriptionNotFound

string

Abonnement introuvable.
UnexpectedError

string

Erreur inattendue.
UnsupportedClassBasedAdaptation

string

Adaptation basée sur des classes non prise en charge.
UnsupportedDelta

string

Delta non pris en charge.
UnsupportedDynamicConfiguration

string

Configuration dynamique non prise en charge.
UnsupportedFilter

string

Filtre non pris en charge.
UnsupportedLanguageCode

string

Code de langue non pris en charge.
UnsupportedOrderBy

string

Commande non prise en charge par.
UnsupportedPagination

string

Pagination non prise en charge.
UnsupportedTimeRange

string

Intervalle de temps non pris en charge.

Error

Erreur

Nom Type Description
code

ErrorCode

ErrorCode
Codes d’erreur de haut niveau.
details

Error[]

Détails supplémentaires concernant l’erreur et/ou les stratégies attendues.
innerError

InnerError

InnerError
Nouveau format d’erreur interne conforme aux instructions de l’API Cognitive Services qui est disponible à https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Cela contient les propriétés requises ErrorCode, le message et la cible de propriétés facultatives, les détails (paire valeur clé), l’erreur interne (cela peut être imbriqué).
message

string

Message d’erreur de haut niveau.
target

string

Source de l’erreur. Par exemple, il s’agirait de « documents » ou d'« ID de document » en cas de document non valide.

ErrorCode

ErrorCode

Nom Type Description
Conflict

string

Représentant le code d’erreur de conflit.
Forbidden

string

Représentant le code d’erreur interdit.
InternalCommunicationFailed

string

Représentant le code d’erreur de communication interne ayant échoué.
InternalServerError

string

Représentant le code d’erreur du serveur interne.
InvalidArgument

string

Représentant le code d’erreur d’argument non valide.
InvalidRequest

string

Représentant le code d’erreur de requête non valide.
NotAllowed

string

Représentant le code d’erreur non autorisé.
NotFound

string

Représentant le code d’erreur introuvable.
PipelineError

string

Représentant le code d’erreur du pipeline.
ServiceUnavailable

string

Représentant le code d’erreur indisponible du service.
TooManyRequests

string

Représentant le code d’erreur trop grand nombre de requêtes.
Unauthorized

string

Représentant le code d’erreur non autorisé.
UnprocessableEntity

string

Représentant le code d’erreur d’entité non traité.
UnsupportedMediaType

string

Représentant le code d’erreur du type de média non pris en charge.

File

Lime

Nom Type Description
createdDateTime

string

Heure de création de ce fichier. L’horodatage est encodé en tant que format de date et d’heure ISO 8601 (voir https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
kind

FileKind

FileKind
Type de données.
links

FileLinks

FileLinks
name

string

Nom de ce fichier.
properties

FileProperties

FileProperties
self

string

Emplacement de cette entité.

FileKind

FileKind

Nom Type Description
AcousticDataArchive

string

Le type de données est une archive de données acoustiques.
AcousticDataTranscriptionV2

string

Le type de données est la transcription de données acoustiques v2.
Audio

string

Le type de données est audio.
DatasetReport

string

Le type de données est un rapport de jeu de données.
EvaluationDetails

string

Le type de données est des détails d’évaluation.
LanguageData

string

Le type de données est des données linguistiques.
ModelReport

string

Le type de données est un rapport de modèle.
OutputFormattingData

string

Le type de données est le fichier d’entrée de mise en forme de sortie.
PronunciationData

string

Le type de données est des données de prononciation.
Transcription

string

Le type de données est la transcription.
TranscriptionReport

string

Le type de données est le rapport de transcription.

FileLinks

Nom Type Description
contentUrl

string

URL permettant de récupérer le contenu de ce fichier.

FileProperties

FileProperties

Nom Type Valeur par défaut Description
durationMilliseconds

integer

0

Durée totale en millisecondes du fichier dans le cas où ce fichier est un fichier audio.
size

integer

Taille des données en octets.

InnerError

InnerError

Nom Type Description
code

DetailedErrorCode

DetailedErrorCode
Énumération détaillée du code d’erreur.
details

object

Détails supplémentaires concernant l’erreur et/ou les stratégies attendues.
innerError

InnerError

InnerError
Nouveau format d’erreur interne conforme aux instructions de l’API Cognitive Services qui est disponible à https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Cela contient les propriétés requises ErrorCode, le message et la cible de propriétés facultatives, les détails (paire valeur clé), l’erreur interne (cela peut être imbriqué).
message

string

Message d’erreur de haut niveau.
target

string

Source de l’erreur. Par exemple, il s’agirait de « documents » ou d'« ID de document » en cas de document non valide.

PaginatedFiles

PaginéFiles

Nom Type Description
@nextLink

string

Lien vers l’ensemble suivant de résultats paginés s’il existe davantage d’entités disponibles ; sinon null.
values

File[]

Liste des entités limitées par les paramètres de requête passés « skip » et « top » ou leurs valeurs par défaut.

Lors de l’itération dans une liste à l’aide de la pagination et de la suppression d’entités en parallèle, certaines entités sont ignorées dans les résultats. Il est recommandé de créer une liste sur le client et de supprimer après la récupération de la liste complète.