Models - Get File

Référence

Service:: Azure AI Services

Version d'API:: 2024-05-15-preview

Obtient un fichier spécifique (identifié avec fileId) à partir d’un modèle (identifié avec l’ID).

GET {endpoint}/speechtotext/models/{id}/files/{fileId}?api-version=2024-05-15-preview

Avec des paramètres facultatifs:

GET {endpoint}/speechtotext/models/{id}/files/{fileId}?sasValidityInSeconds={sasValidityInSeconds}&api-version=2024-05-15-preview

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 modèle.
api-version	query	True	string	Version de l’API demandée.
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://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) : 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

HTTP

GET {endpoint}/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?sasValidityInSeconds=120&api-version=2024-05-15-preview

Exemple de réponse

Code d’état:: 200

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2",
  "name": "report.json",
  "kind": "ModelReport",
  "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	ErrorCode
File	Lime
FileKind	FileKind
FileLinks	FileLinks
FileProperties	FileProperties
InnerError	InnerError

DetailedErrorCode

Nom	Type	Description
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é.
EmptyRequest	string	Requête vide.
EndpointCannotBeDefault	string	Le point de terminaison ne peut pas être par défaut.
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.
InvalidBaseModel	string	Modèle de base non valide.
InvalidCallbackUri	string	URI de rappel non valide.
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.
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

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

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

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	Taille des données en octets.

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.

Partager via