Evaluations - Update

Référence

Service:: Azure AI Services

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

Met à jour les détails mutables de l’évaluation identifiée par son ID.

PATCH {endpoint}/speechtotext/evaluations/{id}?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).
id	path	True	string uuid	Identificateur de l’évaluation.
api-version	query	True	string	Version de l’API demandée.

Corps de la demande

Media Types: "application/json", "application/merge-patch+json"

Nom	Type	Description
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.
description	string	Description de l’objet.
displayName	string	Nom de l’objet.
project	EntityReference	EntityReference

Réponses

Nom	Type	Description
200 OK	Evaluation	D’ACCORD En-têtes Retry-After: integer
Other Status Codes	Error	Une erreur s’est produite.

Nom

Type

Description

200 OK

Evaluation

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

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

Update a evaluation

Exemple de requête

HTTP

PATCH {endpoint}/speechtotext/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6?api-version=2024-05-15-preview

{
  "displayName": "Updated evaluation",
  "description": "Updated evaluation description"
}

Exemple de réponse

Code d’état:: 200

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6?api-version=2024-05-15-preview",
  "model1": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-05-15-preview"
  },
  "model2": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-05-15-preview"
  },
  "dataset": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-05-15-preview"
  },
  "transcription2": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f?api-version=2024-05-15-preview"
  },
  "transcription1": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-05-15-preview"
  },
  "links": {
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/00000000-0000-0000-0000-000000000000/files?api-version=2024-05-15-preview"
  },
  "properties": {
    "wordErrorRate1": 0.065,
    "sentenceErrorRate1": 0.375,
    "tokenErrorRate1": 0.125,
    "sentenceCount1": 8,
    "wordCount1": 46,
    "correctWordCount1": 43,
    "wordSubstitutionCount1": 3,
    "wordDeletionCount1": 0,
    "wordInsertionCount1": 0,
    "tokenCount1": 48,
    "correctTokenCount1": 42,
    "tokenSubstitutionCount1": 6,
    "tokenDeletionCount1": 0,
    "tokenInsertionCount1": 0,
    "tokenErrors1": {
      "punctuation": {
        "numberOfEdits": 2,
        "percentageOfAllEdits": 0.66
      },
      "capitalization": {
        "numberOfEdits": 1,
        "percentageOfAllEdits": 0.33
      }
    },
    "wordErrorRate2": 0.065,
    "sentenceErrorRate2": 0.375,
    "tokenErrorRate2": 0.125,
    "sentenceCount2": 8,
    "wordCount2": 46,
    "correctWordCount2": 43,
    "wordSubstitutionCount2": 3,
    "wordDeletionCount2": 0,
    "wordInsertionCount2": 0,
    "tokenCount2": 48,
    "correctTokenCount2": 42,
    "tokenSubstitutionCount2": 6,
    "tokenDeletionCount2": 0,
    "tokenInsertionCount2": 0,
    "tokenErrors2": {
      "punctuation": {
        "numberOfEdits": 208,
        "percentageOfAllEdits": 1.22
      },
      "capitalization": {
        "numberOfEdits": 126,
        "percentageOfAllEdits": 0.74
      },
      "inverseTextNormalization": {
        "numberOfEdits": 409,
        "percentageOfAllEdits": 2.4
      },
      "lexical": {
        "numberOfEdits": 16284,
        "percentageOfAllEdits": 95.41
      },
      "others": {
        "numberOfEdits": 41,
        "percentageOfAllEdits": 0.24
      }
    }
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Succeeded",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "Evalution of one model against another model"
}

Définitions

Nom	Description
DetailedErrorCode	DetailedErrorCode
EditsSummary	EditsSummary
EntityError	EntityError
EntityReference	EntityReference
Error	Erreur
ErrorCode	ErrorCode
Evaluation	Évaluation
EvaluationLinks	EvaluationLinks
EvaluationProperties	EvaluationProperties
EvaluationUpdate	EvaluationUpdate
InnerError	InnerError
Status	Statut
TokenErrorDetails	TokenErrorDetails

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.

EditsSummary

Nom	Type	Description
numberOfEdits	integer	Nombre facultatif de modifications pour un type donné d’erreur de la transcription reconnue par rapport à la transcription humaine.
percentageOfAllEdits	number	Pourcentage facultatif de modifications pour un type donné d’erreur de la transcription reconnue par rapport à la transcription humaine.

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.

Evaluation

Évaluation

Nom	Type	Description
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.
dataset	EntityReference	EntityReference
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	EvaluationLinks	EvaluationLinks
locale	string	Paramètres régionaux des données contenues.
model1	EntityReference	EntityReference
model2	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EvaluationProperties	EvaluationProperties
self	string	Emplacement de cette entité.
status	Status	Statut Décrire l’état actuel de l’API.
transcription1	EntityReference	EntityReference
transcription2	EntityReference	EntityReference

EvaluationLinks

Nom	Type	Description
files	string	Emplacement pour obtenir tous les fichiers de cette entité. Pour plus d’informations, consultez l’opération « Evaluations_ListFiles ».

EvaluationProperties

Nom	Type	Description
correctTokenCount1	integer	Nombre facultatif de jetons correctement reconnus par model1.
correctTokenCount2	integer	Nombre facultatif de jetons correctement reconnus par model2.
correctWordCount1	integer	Nombre de mots correctement reconnus par model1.
correctWordCount2	integer	Nombre de mots correctement reconnus par modèle2.
email	string	Adresse e-mail à laquelle envoyer des notifications par e-mail au cas où l’opération se termine. La valeur est supprimée après l’envoi de l’e-mail.
error	EntityError	EntityError
sentenceCount1	integer	Nombre de phrases traitées par model1.
sentenceCount2	integer	Nombre de phrases traitées par modèle2.
sentenceErrorRate1	number	Taux d’erreur de phrase de reconnaissance avec model1.
sentenceErrorRate2	number	Taux d’erreur de phrase de reconnaissance avec model2.
tokenCount1	integer	Nombre facultatif de jetons traités par model1.
tokenCount2	integer	Nombre facultatif de jetons traités par modèle2.
tokenDeletionCount1	integer	Nombre facultatif de jetons reconnus par model1, qui sont des suppressions.
tokenDeletionCount2	integer	Nombre facultatif de jetons reconnus par modèle2, qui sont des suppressions.
tokenErrorRate1	number	Taux d’erreur de jeton facultatif de la reconnaissance avec model1.
tokenErrorRate2	number	Taux d’erreur de jeton facultatif de la reconnaissance avec model2.
tokenErrors1	TokenErrorDetails	TokenErrorDetails
tokenErrors2	TokenErrorDetails	TokenErrorDetails
tokenInsertionCount1	integer	Nombre facultatif de jetons reconnus par model1, qui sont des insertions.
tokenInsertionCount2	integer	Nombre facultatif de jetons reconnus par modèle2, qui sont des insertions.
tokenSubstitutionCount1	integer	Nombre facultatif de jetons reconnus par model1, qui sont des substitutions.
tokenSubstitutionCount2	integer	Nombre facultatif de jetons reconnus par modèle2, qui sont des substitutions.
wordCount1	integer	Nombre de mots traités par model1.
wordCount2	integer	Nombre de mots traités par modèle2.
wordDeletionCount1	integer	Nombre de mots reconnus par model1, qui sont des suppressions.
wordDeletionCount2	integer	Nombre de mots reconnus par modèle2, qui sont des suppressions.
wordErrorRate1	number	Taux d’erreur de mot de reconnaissance avec model1.
wordErrorRate2	number	Taux d’erreur de mot de reconnaissance avec model2.
wordInsertionCount1	integer	Nombre de mots reconnus par model1, qui sont des insertions.
wordInsertionCount2	integer	Nombre de mots reconnus par modèle2, qui sont des insertions.
wordSubstitutionCount1	integer	Nombre de mots reconnus par model1, qui sont des substitutions.
wordSubstitutionCount2	integer	Nombre de mots reconnus par modèle2, qui sont des substitutions.

EvaluationUpdate

Nom	Type	Description
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.
description	string	Description de l’objet.
displayName	string	Nom de l’objet.
project	EntityReference	EntityReference

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.

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.

TokenErrorDetails

Nom	Type	Description
capitalization	EditsSummary	EditsSummary
inverseTextNormalization	EditsSummary	EditsSummary
lexical	EditsSummary	EditsSummary
others	EditsSummary	EditsSummary
punctuation	EditsSummary	EditsSummary

Partager via

Evaluations - Update

Paramètres URI

Corps de la demande

Réponses

Sécurité

Ocp-Apim-Subscription-Key

Authorization

Exemples

Update a evaluation

Exemple de requête

Exemple de réponse

Définitions

DetailedErrorCode

EditsSummary

EntityError

EntityReference

Error

ErrorCode

Evaluation

EvaluationLinks

EvaluationProperties

EvaluationUpdate

InnerError

Status

TokenErrorDetails

Ressources supplémentaires