Models - Get Base Model

Service:

Azure AI Services

API Version:

v3.2-preview.2

Obtient le modèle de base identifié par l’ID donné.

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

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).
id	path	True	string uuid	Identificateur du modèle de base.

Réponses

Nom	Type	Description
200 OK	BaseModel	Ok
Other Status Codes	Error	Une erreur est survenue.

Sécurité

Ocp-Apim-Subscription-Key

Fournissez la clé de votre compte Cognitive Services ici.

Type: apiKey
In: 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
In: header

Exemples

Get a base model

Sample Request

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/models/base/827712a5-f942-4997-91c3-7c6cde35600b

Sample Response

Status code:

200

{
  "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	ErrorCode
InnerError	InnerError
OutputFormatType	OutputFormatType
Status	Statut

BaseModel

BaseModel

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

BaseModelDeprecationDates

BaseModelDeprecationDates

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

BaseModelFeatures

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 dynamique 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

BaseModelLinks

Nom	Type	Description
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 ».

BaseModelProperties

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

DatasetKind

Nom	Type	Description
Acoustic	string	Jeu de données acoustique.
AudioFiles	string	Jeu de données de fichiers audio.
Language	string	Jeu de données de langue.
LanguageMarkdown	string	Jeu de données markdown de langue.
OutputFormatting	string	Jeu de données qui contient des règles pour personnaliser la normalisation du texte inverse, la mise en majuscule, la reformulation, le blasphème et définit également des tests pour la validation du jeu de données
Pronunciation	string	Jeu de données de prononciation.

DetailedErrorCode

DetailedErrorCode

Nom	Type	Description
DataImportFailed	string	Échec de l’importation des données.
DeleteNotAllowed	string	Supprimer non autorisé.
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	Dépassement du nombre d’URI d’enregistrements.
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é de sas non valide.
InvalidSkipTokenForLogs	string	Jeton d’ignorer non valide pour les journaux.
InvalidSourceAzureResourceId	string	ID de ressource Azure source non valide.
InvalidSubscription	string	Abonnement non valide.
InvalidTest	string	Test non valide.
InvalidTimeToLive	string	Durée de vie non valide.
InvalidTopForLogs	string	Top 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.
ModelCopyOperationExists	string	L’opération de copie de modèle existe.
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é de modèle.
ModelNotDeployable	string	Modèle non déployable.
ModelVersionIncorrect	string	Version du modèle incorrecte.
NoUtf8WithBom	string	Pas de utf8 avec bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Une seule url ou 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	Des limites de référence SKU existent.
SubscriptionNotFound	string	Abonnement introuvable.
UnexpectedError	string	Erreur inattendue.
UnsupportedClassBasedAdaptation	string	Adaptation basée sur les 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, disponible à l’adresse https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Ce format contient les propriétés obligatoires ErrorCode, message et les propriétés facultatives target, details (paire clé-valeur), et l’erreur interne (qui peut être imbriquée).
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	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, disponible à l’adresse https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Ce format contient les propriétés obligatoires ErrorCode, message et les propriétés facultatives target, details (paire clé-valeur), et l’erreur interne (qui peut être imbriquée).
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.

OutputFormatType

OutputFormatType

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

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.