Models - List Custom Models

Référence

Service:: Azure AI Services

Version d'API:: 2024-11-15

Obtient la liste des modèles personnalisés pour l’abonnement authentifié.

GET {endpoint}/speechtotext/models?api-version=2024-11-15

Avec des paramètres facultatifs:

GET {endpoint}/speechtotext/models?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).
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 modèles disponibles. `- Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale. - 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=status eq 'NotStarted' or status eq 'Running'`
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	PaginatedCustomModels	D’ACCORD En-têtes Retry-After: integer
Other Status Codes	Error	Une erreur s’est produite.

Nom

Type

Description

200 OK

PaginatedCustomModels

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 models in state 'Running'

Exemple de requête

HTTP

GET {endpoint}/speechtotext/models?skip=0&top=2&filter=status%20eq%20'Running'&api-version=2024-11-15

Exemple de réponse

Code d’état:: 200

{
  "values": [
    {
      "baseModel": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-11-15"
      },
      "datasets": [
        {
          "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-11-15"
        }
      ],
      "links": {
        "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/manifest?api-version=2024-11-15",
        "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b:copy?api-version=2024-11-15",
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/files?api-version=2024-11-15"
      },
      "properties": {
        "deprecationDates": {
          "transcriptionDateTime": "2023-05-04T00:00:00Z"
        },
        "customModelWeightPercent": 30,
        "features": {
          "supportsTranscriptionsSubmit": true,
          "supportsTranscriptionsTranscribe": false,
          "supportsEndpoints": true,
          "supportsTranscriptionsOnSpeechContainers": false,
          "supportedOutputFormats": [
            "Lexical",
            "Display"
          ]
        }
      },
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-11-15",
      "displayName": "Language model",
      "description": "This is a language model",
      "locale": "en-US",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Running"
    },
    {
      "baseModel": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-11-15"
      },
      "datasets": [
        {
          "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-11-15"
        }
      ],
      "links": {
        "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b/manifest?api-version=2024-11-15",
        "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b:copy?api-version=2024-11-15",
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b/files?api-version=2024-11-15"
      },
      "properties": {
        "deprecationDates": {
          "transcriptionDateTime": "2023-05-04T00:00:00Z"
        },
        "customModelWeightPercent": 30,
        "features": {
          "supportsTranscriptionsSubmit": true,
          "supportsTranscriptionsTranscribe": false,
          "supportsEndpoints": true,
          "supportsTranscriptionsOnSpeechContainers": false,
          "supportedOutputFormats": [
            "Lexical",
            "Display"
          ]
        }
      },
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b?api-version=2024-11-15",
      "displayName": "Acoustic model",
      "description": "Example for an acoustic model",
      "locale": "en-US",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Running"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/models?skip=2&top=2&filter=status%20eq%20'Running'&api-version=2024-11-15"
}

Définitions

Nom	Description
CustomModel	CustomModel
CustomModelDeprecationDates	CustomModelDeprecationDates
CustomModelFeatures	CustomModelFeatures
CustomModelLinks	CustomModelLinks
CustomModelProperties	CustomModelProperties
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	EntityReference
Error	Erreur
ErrorCode	ErrorCode
InnerError	InnerError
OutputFormatType	OutputFormatType
PaginatedCustomModels	PaginédCustomModels
Status	Statut

CustomModel

Nom	Type	Description
baseModel	EntityReference	EntityReference
createdDateTime	string	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.
datasets	EntityReference[]	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 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	CustomModelLinks	CustomModelLinks
locale	string	Paramètres régionaux des données contenues.
properties	CustomModelProperties	CustomModelProperties
self	string	Emplacement de cette entité.
status	Status	Statut Décrire l’état actuel de l’API.

CustomModelDeprecationDates

Nom	Type	Description
transcriptionDateTime	string	Date à laquelle la transcription devient déconseillée.

CustomModelFeatures

Nom	Type	Description
supportedOutputFormats	OutputFormatType[]	Formats de sortie pris en charge.
supportsEndpoints	boolean	Valeur indiquant si la création de points de terminaison pour la transcription en direct 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 des modèles existants lorsqu’elle devient utilisable sur le conteneur speech.
supportsTranscriptionsSubmit	boolean	Valeur indiquant si la soumission de travaux de transcription est prise en charge (POST /transcriptions :submit).
supportsTranscriptionsTranscribe	boolean	Valeur indiquant si l’action de transcription est prise en charge (POST /transcriptions :transscribe).

CustomModelLinks

Nom	Type	Description
copy	string	Emplacement de l’action de copie de modèle. Pour plus d’informations, consultez l’opération « Models_Copy ».
files	string	Emplacement pour obtenir tous les fichiers de cette entité. Pour plus d’informations, consultez l’opération « Models_ListFiles ».
manifest	string	Emplacement permettant d’obtenir un manifeste pour que ce modèle soit utilisé dans le conteneur local. Pour plus d’informations, consultez l’opération « Models_GetCustomModelManifest ».

CustomModelProperties

Nom	Type	Description
customModelWeightPercent	integer	Poids du modèle personnalisé compris entre 1 (1% modèle personnalisé et 99% modèle de base) et 100 (100% modèle personnalisé et 0 modèle de base%). Lorsque cette propriété n’est pas définie, le service choisit une valeur appropriée (obtenez le modèle pour récupérer l’épaisseur sélectionnée). Commencez 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	CustomModelDeprecationDates
error	EntityError	EntityError
features	CustomModelFeatures	CustomModelFeatures Fonctionnalités prises en charge par le modèle.

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.

EntityError

Nom	Type	Description
code	string	Code de cette erreur.
message	string	Message de cette erreur.

EntityReference

Nom	Type	Description
self	string	Emplacement de l’entité référencée.

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.

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.

OutputFormatType

Nom	Type	Description
Display	string	Le modèle prend en charge l’affichage des transcriptions de mise en forme ou des points de terminaison.
Lexical	string	Le modèle fournit la sortie de transcription sans mise en forme.

PaginatedCustomModels

PaginédCustomModels

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	CustomModel[]	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.

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

CustomModel[]

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

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.

Partager via

Models - List Custom Models

Paramètres URI

En-tête de la demande

Réponses

Sécurité

Ocp-Apim-Subscription-Key

Exemples

Get all models in state 'Running'

Exemple de requête

Exemple de réponse

Définitions

CustomModel

CustomModelDeprecationDates

CustomModelFeatures

CustomModelLinks

CustomModelProperties

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

InnerError

OutputFormatType

PaginatedCustomModels

Status

Ressources supplémentaires