Partager via

Datasets - Get File

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

Obtient un fichier spécifique (identifié avec fileId) à partir d’un jeu de données (identifié avec l’ID).

GET {endpoint}/speechtotext/v3.1/datasets/{id}/files/{fileId}
Avec des paramètres facultatifs: 
GET {endpoint}/speechtotext/v3.1/datasets/{id}/files/{fileId}?sasValidityInSeconds={sasValidityInSeconds}

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).
fileId
 path True

string (uuid)

Identificateur du fichier.
id
 path True

string (uuid)

Identificateur du jeu de données.
sasValidityInSeconds
 query

integer (int32)

Durée en secondes pendant laquelle une URL SAP doit être valide. La durée par défaut est de 12 heures. Lors de l’utilisation de BYOS (https://docs.microsoft.com/en-us/azure/cognitive-services/speech-service/speech-encryption-of-data-at-rest#bring-your-own-storage-byos-for-customization-and-logging) : une valeur de 0 signifie qu’un URI d’objet blob brut sans jeton SAP sera généré.

Réponses

Nom Type Description
200 OK

File

D’ACCORD
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 a file

Exemple de requête

GET {endpoint}/speechtotext/v3.1/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?sasValidityInSeconds=120

Exemple de réponse

Code d’état:
200 
{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/ee4733cd-b1a7-4813-87e2-00d582c28a29",
  "name": "report.json",
  "kind": "DatasetReport",
  "properties": {
    "size": 200
  },
  "createdDateTime": "2020-01-13T08:00:00Z",
  "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"
  }
}

Définitions

Nom Description
DetailedErrorCode

DetailedErrorCode
Error

Erreur
ErrorCode

Code d'erreur
File

Fichier
FileKind

FileKind
FileLinks

FileLinks
FileProperties

FileProperties
InnerError

InnerError

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.

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.

File

Object

Fichier

Nom Type Description
createdDateTime

string (date-time)

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 (uri)

Emplacement de cette entité.

FileKind

Énumération

FileKind

Valeur Description
AcousticDataArchive

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

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

Le type de données est audio.
DatasetReport

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

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

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

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

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

Le type de données est la transcription.
TranscriptionReport

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

FileLinks

Nom Type Description
contentUrl

string (uri)

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

FileProperties

Object

FileProperties

Nom Type Description
duration

string

Durée dans le cas où ce fichier est un fichier audio. La durée est encodée en tant que durée ISO 8601 (« PnYnMnDTnHnMnS », voir https://en.wikipedia.org/wiki/ISO_8601#Durations).
size

integer (int64)

Taille des données en octets.

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.