Partager via

Datasets - List

  • Référence
Service:
Azure AI Services
Version d'API:
v3.1

Obtient une liste de jeux de données pour l’abonnement authentifié.

GET {endpoint}/speechtotext/v3.1/datasets
Avec des paramètres facultatifs: 
GET {endpoint}/speechtotext/v3.1/datasets?skip={skip}&top={top}&filter={filter}

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

string

Expression de filtrage permettant de sélectionner un sous-ensemble des jeux de données disponibles.

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

        - 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 and displayName eq 'My dataset'
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.

Réponses

Nom Type Description
200 OK

PaginatedDatasets

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

Authorization

Fournissez un jeton d’accès à partir du JWT retourné par le STS de cette région. Veillez à ajouter l’étendue de gestion au jeton en ajoutant la chaîne de requête suivante à l’URL STS : ?scope=speechservicesmanagement

Type: apiKey
Dans: header

Exemples

Get all acoustic datasets
Get all datasets

Get all acoustic datasets

Exemple de requête

GET {endpoint}/speechtotext/v3.1/datasets?skip=0&top=10&filter=kind%20eq%20'Acoustic'

Exemple de réponse

Code d’état:
200 
{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1",
      "kind": "Acoustic",
      "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation",
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files"
      },
      "properties": {
        "acceptedLineCount": 11,
        "rejectedLineCount": 2,
        "duration": "PT4M12S"
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Acoustic dataset"
    }
  ]
}

Get all datasets

Exemple de requête

GET {endpoint}/speechtotext/v3.1/datasets?skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z

Exemple de réponse

Code d’état:
200 
{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1",
      "kind": "Acoustic",
      "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation",
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files"
      },
      "properties": {
        "acceptedLineCount": 11,
        "rejectedLineCount": 2,
        "duration": "PT4M12S"
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Acoustic dataset"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c",
      "kind": "Language",
      "contentUrl": "https://www.contoso.com/LanguageData/SourceLocation",
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files"
      },
      "properties": {
        "acceptedLineCount": 11,
        "rejectedLineCount": 2
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Language dataset"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z"
}

Définitions

Nom Description
Dataset

Jeu de données
DatasetKind

DatasetKind
DatasetLinks

DatasetLinks
DatasetProperties

DatasetProperties
DetailedErrorCode

DetailedErrorCode
EntityError

EntityError
EntityReference

EntityReference
Error

Erreur
ErrorCode

Code d'erreur
InnerError

InnerError
PaginatedDatasets

PaginédDatasets
Status

Statut

Dataset

Object

Jeu de données

Nom Type Description
contentUrl

string (uri)

URL des données du jeu de données.
createdDateTime

string (date-time)

Horodatage de la création de l’objet. L’horodatage est encodé en tant que format de date et d’heure ISO 8601 (« AAAA-MM-DDThh :mm :ssZ », voir https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties

object

Propriétés personnalisées de cette entité. La longueur maximale de la clé autorisée est de 64 caractères, la longueur maximale de la valeur autorisée est de 256 caractères et le nombre d’entrées autorisées est de 10.
description

string

Description de l’objet.
displayName

string

minLength: 1

Nom complet de l’objet.
kind

DatasetKind

DatasetKind
Type d’importation de données.
lastActionDateTime

string (date-time)

Horodatage lorsque l’état actuel a été entré. L’horodatage est encodé en tant que format de date et d’heure ISO 8601 (« AAAA-MM-DDThh :mm :ssZ », voir https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links

DatasetLinks

DatasetLinks
locale

string

minLength: 1

Paramètres régionaux des données contenues.
project

EntityReference

EntityReference
properties

DatasetProperties

DatasetProperties
self

string (uri)

Emplacement de cette entité.
status

Status

Statut
Décrire l’état actuel de l’API

DatasetKind

Énumération

DatasetKind

Valeur Description
Acoustic

Jeu de données acoustique.
AudioFiles

Jeu de données de fichiers audio.
Language

Jeu de données de langage.
LanguageMarkdown

Jeu de données markdown de langue.
Pronunciation

Jeu de données de prononciation.
Object

DatasetLinks

Nom Type Description
commitBlocks

string (uri)

Emplacement pour valider la liste des blocs lors du chargement d’un jeu de données à l’aide de blocs. Pour plus d’informations, consultez l’opération « Datasets_CommitBlocks ».
files

string (uri)

Emplacement pour obtenir tous les fichiers de cette entité. Pour plus d’informations, consultez l’opération « Datasets_ListFiles ».
listBlocks

string (uri)

Emplacement pour répertorier les blocs déjà chargés de cette entité lors du chargement d’un jeu de données à l’aide de blocs. Pour plus d’informations, consultez l’opération « Datasets_GetDatasetBlocks ».
uploadBlocks

string (uri)

Emplacement vers lequel charger des blocs lors du chargement d’un jeu de données à l’aide de blocs. Pour plus d’informations, consultez l’opération « Datasets_UploadBlock ».

DatasetProperties

Object

DatasetProperties

Nom Type Description
acceptedLineCount

integer (int32)

Nombre de lignes acceptées pour ce jeu de données.
duration

string

Durée totale des jeux de données s’il contient des fichiers audio. La durée est encodée en tant que durée ISO 8601 (« PnYnMnDTnHnMnS », voir https://en.wikipedia.org/wiki/ISO_8601#Durations).
email

string

Adresse e-mail à laquelle envoyer des notifications par e-mail au cas où l’opération se termine. La valeur est supprimée après l’envoi de l’e-mail.
error

EntityError

EntityError
rejectedLineCount

integer (int32)

Nombre de lignes rejetées pour ce jeu de données.

DetailedErrorCode

Énumération

DetailedErrorCode

Valeur Description
DataImportFailed

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

Supprimer non autorisé.
DeployNotAllowed

Déployer non autorisé.
DeployingFailedModel

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

Requête vide.
EndpointCannotBeDefault

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

Point de terminaison non modifiable.
EndpointWithoutLogging

Point de terminaison sans journalisation.
ExceededNumberOfRecordingsUris

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

Jeu de données ayant échoué.
Forbidden

Interdit.
InUseViolation

En cas de violation d’utilisation.
InaccessibleCustomerStorage

Stockage client inaccessible.
InvalidAdaptationMapping

Mappage d’adaptation non valide.
InvalidBaseModel

Modèle de base non valide.
InvalidCallbackUri

URI de rappel non valide.
InvalidCollection

Collection non valide.
InvalidDataset

Jeu de données non valide.
InvalidDocument

Document non valide.
InvalidDocumentBatch

Lot de documents non valide.
InvalidLocale

Paramètres régionaux non valides.
InvalidLogDate

Date de journal non valide.
InvalidLogEndTime

Heure de fin du journal non valide.
InvalidLogId

ID de journal non valide.
InvalidLogStartTime

Heure de début du journal non valide.
InvalidModel

Modèle non valide.
InvalidModelUri

URI de modèle non valide.
InvalidParameter

Paramètre non valide.
InvalidParameterValue

Valeur de paramètre non valide.
InvalidPayload

Charge utile non valide.
InvalidPermissions

Autorisations non valides.
InvalidPrerequisite

Prérequis non valides.
InvalidProductId

ID de produit non valide.
InvalidProject

Projet non valide.
InvalidProjectKind

Type de projet non valide.
InvalidRecordingsUri

Uri des enregistrements non valides.
InvalidRequestBodyFormat

Format du corps de la demande non valide.
InvalidSasValidityDuration

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

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

Abonnement non valide.
InvalidTest

Test non valide.
InvalidTimeToLive

Heure de vie non valide.
InvalidTopForLogs

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

Transcription non valide.
InvalidWebHookEventKind

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

Enregistrements d’entrée manquants.
ModelDeploymentNotCompleteState

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

Modèle déconseillé.
ModelExists

Le modèle existe.
ModelMismatch

Incompatibilité du modèle.
ModelNotDeployable

Modèle non déployable.
ModelVersionIncorrect

Version du modèle incorrecte.
NoUtf8WithBom

Pas d’utf8 avec bom.
OnlyOneOfUrlsOrContainerOrDataset

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

Incompatibilité entre les sexes du projet.
QuotaViolation

Violation de quota.
SingleDefaultEndpoint

Point de terminaison par défaut unique.
SkuLimitsExist

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

Abonnement introuvable.
UnexpectedError

Erreur inattendue.
UnsupportedClassBasedAdaptation

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

Delta non pris en charge.
UnsupportedDynamicConfiguration

Configuration dynamique non prise en charge.
UnsupportedFilter

Filtre non pris en charge.
UnsupportedLanguageCode

Code de langue non pris en charge.
UnsupportedOrderBy

Commande non prise en charge par.
UnsupportedPagination

Pagination non prise en charge.
UnsupportedTimeRange

Intervalle de temps non pris en charge.

EntityError

Object

EntityError

Nom Type Description
code

string

Code de cette erreur.
message

string

Message de cette erreur.

EntityReference

Object

EntityReference

Nom Type Description
self

string (uri)

Emplacement de l’entité référencée.

Error

Object

Erreur

Nom Type Description
code

ErrorCode

Code d'erreur
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

Énumération

Code d'erreur

Valeur Description
Conflict

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

Représentant le code d’erreur interdit.
InternalCommunicationFailed

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

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

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

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

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

Représentant le code d’erreur introuvable.
PipelineError

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

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

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

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

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

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

InnerError

Object

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.

PaginatedDatasets

Object

PaginédDatasets

Nom Type Description
@nextLink

string (uri)

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

Dataset[]

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.

Status

Énumération

Statut

Valeur Description
Failed

L’opération de longue durée a échoué.
NotStarted

L’opération de longue durée n’a pas encore démarré.
Running

L’opération de longue durée est en cours de traitement.
Succeeded

L’opération de longue durée s’est terminée.