Models - List Custom Models
Obtient la liste des modèles personnalisés pour l’abonnement authentifié.
GET {endpoint}/speechtotext/v3.1/models
GET {endpoint}/speechtotext/v3.1/models?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 modèles disponibles.
|
|
skip
|
query |
integer int32 |
Nombre de jeux de données qui seront ignorés. |
|
top
|
query |
integer int32 |
Nombre de jeux de données qui seront inclus après avoir ignoré. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Ok En-têtes Retry-After: integer |
|
Other Status Codes |
Une erreur est survenue. |
Sécurité
Ocp-Apim-Subscription-Key
Fournissez votre clé de compte Cognitive Services ici.
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 models in state 'Running'
Exemple de requête
GET {endpoint}/speechtotext/v3.1/models?skip=0&top=2&filter=status%20eq%20'Running'
Exemple de réponse
{
"values": [
{
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b",
"baseModel": {
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
},
"datasets": [
{
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
}
],
"links": {
"manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b",
"copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b:copyto",
"files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b/files"
},
"properties": {
"deprecationDates": {
"transcriptionDateTime": "2023-05-04T00:00:00Z"
},
"customModelWeightPercent": 30,
"features": {
"supportsTranscriptions": true,
"supportsEndpoints": true,
"supportsTranscriptionsOnSpeechContainers": false
}
},
"lastActionDateTime": "2019-01-07T11:36:07Z",
"status": "Running",
"createdDateTime": "2019-01-07T11:34:12Z",
"locale": "en-US",
"displayName": "Language model",
"description": "This is a language model"
},
{
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b",
"baseModel": {
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
},
"datasets": [
{
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
}
],
"links": {
"manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/endpoints/manifest/a04e77e6-2009-462c-8d1c-65d718ee4b7b",
"copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b:copyto",
"files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b/files"
},
"properties": {
"deprecationDates": {
"transcriptionDateTime": "2023-05-04T00:00:00Z"
},
"customModelWeightPercent": 30,
"features": {
"supportsTranscriptions": true,
"supportsEndpoints": true,
"supportsTranscriptionsOnSpeechContainers": false
}
},
"lastActionDateTime": "2019-01-07T11:36:07Z",
"status": "Running",
"createdDateTime": "2019-01-07T11:34:12Z",
"locale": "en-US",
"displayName": "Acoustic model",
"description": "Example for an acoustic model"
}
],
"@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models?skip=2&top=2&filter=status%20eq%20'Running'"
}
Définitions
Nom | Description |
---|---|
Custom |
CustomModel |
Custom |
CustomModelDeprecationDates |
Custom |
CustomModelFeatures |
Custom |
CustomModelLinks |
Custom |
CustomModelProperties |
Detailed |
DetailedErrorCode |
Entity |
EntityError |
Entity |
EntityReference |
Error |
Erreur |
Error |
ErrorCode |
Inner |
InnerError |
Paginated |
PaginatedCustomModels |
Status |
Statut |
CustomModel
CustomModel
Nom | Type | Description |
---|---|---|
baseModel |
EntityReference |
|
createdDateTime |
string |
Horodatage de la création de l’objet. L’horodatage est encodé au format de date et d’heure ISO 8601 (« AAAA-MM-JJThh :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 autorisée de la clé 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. |
datasets |
Jeux de données utilisés pour l’adaptation. |
|
description |
string |
Description de l'objet . |
displayName |
string |
Nom complet de l’objet. |
lastActionDateTime |
string |
Horodatage lorsque le status actuel a été entré. L’horodatage est encodé au format de date et d’heure ISO 8601 (« AAAA-MM-JJThh :mm :ssZ », voir https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). |
links |
CustomModelLinks |
|
locale |
string |
Paramètres régionaux des données contenues. |
project |
EntityReference |
|
properties |
CustomModelProperties |
|
self |
string |
Emplacement de cette entité. |
status |
Statut |
|
text |
string |
Texte utilisé pour adapter ce modèle de langage. |
CustomModelDeprecationDates
CustomModelDeprecationDates
Nom | Type | Description |
---|---|---|
transcriptionDateTime |
string |
Date à laquelle la transcription devient déconseillée. |
CustomModelFeatures
CustomModelFeatures
Nom | Type | Description |
---|---|---|
supportsEndpoints |
boolean |
Valeur indiquant si la création de points de terminaison pour la transcription en direct est prise en charge. |
supportsTranscriptions |
boolean |
Valeur indiquant si la transcription par lots est prise en charge. |
supportsTranscriptionsOnSpeechContainers |
boolean |
Valeur indiquant si ce modèle peut être utilisé pour la transcription sur le conteneur speech. Cette fonctionnalité peut être ajoutée sur les modèles existants lorsqu’elle devient utilisable sur le conteneur speech. |
CustomModelLinks
CustomModelLinks
Nom | Type | Description |
---|---|---|
copyTo |
string |
Emplacement de l’action de copie du modèle. Pour plus d’informations, consultez l’opération « Models_CopyTo ». |
files |
string |
Emplacement pour obtenir tous les fichiers de cette entité. Pour plus d’informations, consultez l’opération « Models_ListFiles ». |
manifest |
string |
Emplacement d’obtention d’un manifeste pour ce modèle à utiliser dans le conteneur local. Pour plus d’informations, consultez l’opération « Models_GetCustomModelManifest ». |
CustomModelProperties
CustomModelProperties
Nom | Type | Description |
---|---|---|
customModelWeightPercent |
integer |
Poids du modèle personnalisé compris entre 1 (modèle personnalisé à 1 % et modèle de base à 99 %) et 100 (modèle 100 % personnalisé et 0 % modèle de base). Lorsque cette propriété n’est pas définie, le service choisit une valeur appropriée (obtenir le modèle pour récupérer le poids sélectionné). Démarrez sans utiliser cette propriété. Si nécessaire, choisissez un poids plus grand (ou plus petit) pour augmenter (ou diminuer) l’impact du modèle personnalisé. |
deprecationDates |
CustomModelDeprecationDates |
|
string |
Adresse e-mail à laquelle envoyer Notifications par e-mail au cas où l’opération se termine. La valeur sera supprimée après l’envoi de l’e-mail. |
|
error |
EntityError |
|
features |
CustomModelFeatures |
DetailedErrorCode
DetailedErrorCode
Nom | Type | Description |
---|---|---|
DataImportFailed |
string |
Échec de l’importation des données. |
DeleteNotAllowed |
string |
Suppression non autorisée. |
DeployNotAllowed |
string |
Déploiement 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’URI d’enregistrements dépassé. |
FailedDataset |
string |
Échec du jeu de données. |
Forbidden |
string |
Interdit. |
InUseViolation |
string |
Violation en cours 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. |
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é sas non valide. |
InvalidSkipTokenForLogs |
string |
Jeton d’évitement non valide pour les journaux. |
InvalidSubscription |
string |
Abonnement non valide. |
InvalidTest |
string |
Test non valide. |
InvalidTimeToLive |
string |
Durée de vie non valide. |
InvalidTopForLogs |
string |
Haut non valide pour les journaux. |
InvalidTranscription |
string |
Transcription non valide. |
InvalidWebHookEventKind |
string |
Type d’événement web hook non valide. |
MissingInputRecords |
string |
Enregistrements d’entrée manquants. |
ModelDeploymentNotCompleteState |
string |
État non terminé du déploiement du modèle. |
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 des URL, conteneur ou jeu de données. |
ProjectGenderMismatch |
string |
Projet d’incompatibilité entre les sexes. |
QuotaViolation |
string |
Violation de quota. |
SingleDefaultEndpoint |
string |
Point de terminaison par défaut unique. |
SkuLimitsExist |
string |
Il existe des limites de référence SKU. |
SubscriptionNotFound |
string |
Abonnement introuvable. |
UnexpectedError |
string |
Erreur inattendue. |
UnsupportedClassBasedAdaptation |
string |
Adaptation basée sur la classe 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. |
EntityError
EntityError
Nom | Type | Description |
---|---|---|
code |
string |
Code de cette erreur. |
message |
string |
Message correspondant à cette erreur. |
EntityReference
EntityReference
Nom | Type | Description |
---|---|---|
self |
string |
Emplacement de l’entité référencée. |
Error
Erreur
Nom | Type | Description |
---|---|---|
code |
ErrorCode |
|
details |
Error[] |
Détails supplémentaires concernant l’erreur et/ou les stratégies attendues. |
innerError |
InnerError |
|
message |
string |
Message d’erreur de haut niveau. |
target |
string |
Source de l’erreur. Par exemple, « documents » ou « document id » en présence d’un 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 d’échec de la communication interne. |
InternalServerError |
string |
Représentant le code d’erreur interne du serveur. |
InvalidArgument |
string |
Représentant le code d’erreur de l’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 de trop 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 de type multimédia non pris en charge. |
InnerError
InnerError
Nom | Type | Description |
---|---|---|
code |
DetailedErrorCode |
|
details |
object |
Détails supplémentaires concernant l’erreur et/ou les stratégies attendues. |
innerError |
InnerError |
|
message |
string |
Message d’erreur de haut niveau. |
target |
string |
Source de l’erreur. Par exemple, « documents » ou « document id » en présence d’un document non valide. |
PaginatedCustomModels
PaginatedCustomModels
Nom | Type | Description |
---|---|---|
@nextLink |
string |
Lien vers l’ensemble suivant de résultats paginés s’il existe d’autres entités disponibles ; sinon null. |
values |
Liste d’entités limitées par les paramètres de requête « skip » et « top » passés, ou par leurs valeurs par défaut. Lors de l’itération d’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 l’extraction de la liste complète. |
Status
Statut
Nom | Type | Description |
---|---|---|
Failed |
string |
L’opération de longue durée a échoué. |
NotStarted |
string |
L’opération de longue durée n’a pas encore démarré. |
Running |
string |
L’opération de longue durée est en cours de traitement. |
Succeeded |
string |
L’opération de longue durée s’est terminée avec succès. |