Models - List Base Models

Service:: Azure AI Services

Version d'API:: v3.2-preview.2

Obtient la liste des modèles de base pour l’abonnement authentifié.

GET {endpoint}/speechtotext/v3.2-preview.2/models/base

Avec des paramètres facultatifs:

GET {endpoint}/speechtotext/v3.2-preview.2/models/base?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 de base 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.

Réponses

Nom	Type	Description
200 OK	PaginatedBaseModels	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 all english base models

Exemple de requête

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/models/base?skip=0&top=2&filter=locale%20eq%20'en-US'

Exemple de réponse

Code d’état:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/827712a5-f942-4997-91c3-7c6cde35600b",
      "links": {
        "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "properties": {
        "deprecationDates": {
          "adaptationDateTime": "2022-11-04T00:00:00Z",
          "transcriptionDateTime": "2023-05-04T00:00:00Z"
        },
        "features": {
          "supportsTranscriptions": true,
          "supportsEndpoints": true,
          "supportsTranscriptionsOnSpeechContainers": true,
          "supportsAdaptationsWith": [
            "Language",
            "Acoustic"
          ],
          "supportedOutputFormats": [
            "Display",
            "Lexical"
          ]
        },
        "chargeForAdaptation": true
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "en-US Base model"
    }
  ]
}

Définitions

Nom	Description
BaseModel	BaseModel
BaseModelDeprecationDates	BaseModelDeprecationDates
BaseModelFeatures	BaseModelFeatures
BaseModelLinks	BaseModelLinks
BaseModelProperties	BaseModelProperties
DatasetKind	DatasetKind
DetailedErrorCode	DetailedErrorCode
Error	Erreur
ErrorCode	Code d'erreur
InnerError	InnerError
OutputFormatType	OutputFormatType
PaginatedBaseModels	PaginédBaseModels
Status	Statut

BaseModel

Object

BaseModel

Nom	Type	Description
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).
description	string	Description de l’objet.
displayName	string minLength: 1	Nom complet de l’objet.
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	BaseModelLinks	BaseModelLinks
locale	string minLength: 1	Paramètres régionaux des données contenues.
properties	BaseModelProperties	BaseModelProperties
self	string (uri)	Emplacement de cette entité.
status	Status	Statut Décrire l’état actuel de l’API

BaseModelDeprecationDates

Object

BaseModelDeprecationDates

Nom	Type	Description
adaptationDateTime	string (date-time)	Date à laquelle l’adaptation devient déconseillée.
transcriptionDateTime	string (date-time)	Date à laquelle la transcription devient déconseillée.

BaseModelFeatures

Object

BaseModelFeatures

Nom	Type	Description
supportedOutputFormats	OutputFormatType[]	Formats de sortie pris en charge.
supportsAdaptationsWith	DatasetKind[]	Types de jeux de données pris en charge pour adapter le modèle.
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 des modèles existants lorsqu’elle devient utilisable sur le conteneur speech.

BaseModelLinks

Object

BaseModelLinks

Nom	Type	Description
manifest	string (uri)	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 ».

BaseModelProperties

Object

BaseModelProperties

Nom	Type	Description
chargeForAdaptation	boolean	Valeur indiquant si l’adaptation du modèle est facturée.
deprecationDates	BaseModelDeprecationDates	BaseModelDeprecationDates
features	BaseModelFeatures	BaseModelFeatures Fonctionnalités prises en charge par le modèle.

DatasetKind

Énumération

DatasetKind

Valeur	Description
Language	Jeu de données de langage.
Acoustic	Jeu de données acoustique.
Pronunciation	Jeu de données de prononciation.
AudioFiles	Jeu de données de fichiers audio.
LanguageMarkdown	Jeu de données markdown de langue.
OutputFormatting	Jeu de données qui contient des règles pour personnaliser la normalisation de texte inverse, la mise en majuscules, la reformulation, la profanité et définit également des tests pour la validation du jeu de données

DetailedErrorCode

Énumération

DetailedErrorCode

Valeur	Description
InvalidParameterValue	Valeur de paramètre non valide.
InvalidRequestBodyFormat	Format du corps de la demande non valide.
EmptyRequest	Requête vide.
MissingInputRecords	Enregistrements d’entrée manquants.
InvalidDocument	Document non valide.
ModelVersionIncorrect	Version du modèle incorrecte.
InvalidDocumentBatch	Lot de documents non valide.
UnsupportedLanguageCode	Code de langue non pris en charge.
DataImportFailed	Échec de l’importation de données.
InUseViolation	En cas de violation d’utilisation.
InvalidLocale	Paramètres régionaux non valides.
InvalidBaseModel	Modèle de base non valide.
InvalidAdaptationMapping	Mappage d’adaptation non valide.
InvalidDataset	Jeu de données non valide.
InvalidTest	Test non valide.
FailedDataset	Jeu de données ayant échoué.
InvalidModel	Modèle non valide.
InvalidTranscription	Transcription non valide.
InvalidPayload	Charge utile non valide.
InvalidParameter	Paramètre non valide.
EndpointWithoutLogging	Point de terminaison sans journalisation.
InvalidPermissions	Autorisations non valides.
InvalidPrerequisite	Prérequis non valides.
InvalidProductId	ID de produit non valide.
InvalidSubscription	Abonnement non valide.
InvalidProject	Projet non valide.
InvalidProjectKind	Type de projet non valide.
InvalidRecordingsUri	Uri des enregistrements non valides.
OnlyOneOfUrlsOrContainerOrDataset	Une seule URL ou conteneur ou jeu de données.
ExceededNumberOfRecordingsUris	Nombre dépassé d’uris d’enregistrement.
ModelMismatch	Incompatibilité du modèle.
ProjectGenderMismatch	Incompatibilité entre les sexes du projet.
ModelDeprecated	Modèle déconseillé.
ModelExists	Le modèle existe.
ModelNotDeployable	Modèle non déployable.
EndpointNotUpdatable	Point de terminaison non modifiable.
SingleDefaultEndpoint	Point de terminaison par défaut unique.
EndpointCannotBeDefault	Le point de terminaison ne peut pas être par défaut.
InvalidModelUri	URI de modèle non valide.
SubscriptionNotFound	Abonnement introuvable.
QuotaViolation	Violation de quota.
UnsupportedDelta	Delta non pris en charge.
UnsupportedFilter	Filtre non pris en charge.
UnsupportedPagination	Pagination non prise en charge.
UnsupportedDynamicConfiguration	Configuration dynamique non prise en charge.
UnsupportedOrderBy	Commande non prise en charge par.
NoUtf8WithBom	Pas d’utf8 avec bom.
ModelDeploymentNotCompleteState	Le déploiement du modèle n’est pas terminé.
SkuLimitsExist	Les limites de référence SKU existent.
DeployingFailedModel	Déploiement d’un modèle ayant échoué.
UnsupportedTimeRange	Intervalle de temps non pris en charge.
InvalidLogDate	Date de journal non valide.
InvalidLogId	ID de journal non valide.
InvalidLogStartTime	Heure de début du journal non valide.
InvalidLogEndTime	Heure de fin du journal non valide.
InvalidTopForLogs	Top non valide pour les journaux d’activité.
InvalidSkipTokenForLogs	Jeton d’ignorer non valide pour les journaux d’activité.
DeleteNotAllowed	Supprimer non autorisé.
Forbidden	Interdit.
DeployNotAllowed	Déployer non autorisé.
UnexpectedError	Erreur inattendue.
InvalidCollection	Collection non valide.
InvalidCallbackUri	URI de rappel non valide.
InvalidSasValidityDuration	Durée de validité de sas non valide.
InaccessibleCustomerStorage	Stockage client inaccessible.
UnsupportedClassBasedAdaptation	Adaptation basée sur des classes non prise en charge.
InvalidWebHookEventKind	Type d’événement web hook non valide.
InvalidTimeToLive	Heure de vie non valide.
InvalidSourceAzureResourceId	ID de ressource Azure source non valide.
ModelCopyOperationExists	L’opération de copie de modèle existe.

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
InvalidRequest	Représentant le code d’erreur de requête non valide.
InvalidArgument	Représentant le code d’erreur d’argument non valide.
InternalServerError	Représentant le code d’erreur du serveur interne.
ServiceUnavailable	Représentant le code d’erreur indisponible du service.
NotFound	Représentant le code d’erreur introuvable.
PipelineError	Représentant le code d’erreur du pipeline.
Conflict	Représentant le code d’erreur de conflit.
InternalCommunicationFailed	Représentant le code d’erreur de communication interne ayant échoué.
Forbidden	Représentant le code d’erreur interdit.
NotAllowed	Représentant le code d’erreur non autorisé.
Unauthorized	Représentant le code d’erreur non autorisé.
UnsupportedMediaType	Représentant le code d’erreur du type de média non pris en charge.
TooManyRequests	Représentant le code d’erreur trop grand nombre de requêtes.
UnprocessableEntity	Représentant le code d’erreur d’entité non traité.

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.

OutputFormatType

Énumération

OutputFormatType

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

PaginatedBaseModels

Object

PaginédBaseModels

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	BaseModel[]	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 (uri)

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

values

BaseModel[]

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
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.
Failed	L’opération de longue durée a échoué.