Evaluations - Update

  • Référence
Service:
Azure AI Services
Version d'API:
v3.2-preview.2

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

PATCH {endpoint}/speechtotext/v3.2-preview.2/evaluations/{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 de l’évaluation.

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 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.
description

string

Description de l'objet .
displayName

string

Nom de l'objet.
project

EntityReference

EntityReference

Réponses

Nom Type Description
200 OK

Evaluation

Ok

En-têtes

Retry-After: integer
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
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

PATCH {endpoint}/speechtotext/v3.2-preview.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6

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

Exemple de réponse

Code d’état:
200 
{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6",
  "model1": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "model2": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "dataset": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
  },
  "transcription2": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f"
  },
  "transcription1": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683"
  },
  "links": {
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/evaluations/00000000-0000-0000-0000-000000000000/files"
  },
  "properties": {
    "wordErrorRate2": 0.065,
    "wordErrorRate1": 0.065,
    "sentenceErrorRate2": 0.375,
    "sentenceCount2": 8,
    "wordCount2": 46,
    "correctWordCount2": 43,
    "wordSubstitutionCount2": 3,
    "wordDeletionCount2": 0,
    "wordInsertionCount2": 0,
    "sentenceErrorRate1": 0.375,
    "sentenceCount1": 8,
    "wordCount1": 46,
    "correctWordCount1": 43,
    "wordSubstitutionCount1": 3,
    "wordDeletionCount1": 0,
    "wordInsertionCount1": 0,
    "tokenErrorRate2": 0.125,
    "tokenErrorRate1": 0.125,
    "tokenCount2": 48,
    "correctTokenCount2": 42,
    "tokenSubstitutionCount2": 6,
    "tokenDeletionCount2": 0,
    "tokenInsertionCount2": 0,
    "tokenCount1": 48,
    "correctTokenCount1": 42,
    "tokenSubstitutionCount1": 6,
    "tokenDeletionCount1": 0,
    "tokenInsertionCount1": 0
  },
  "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
EntityError

EntityError
EntityReference

EntityReference
Error

Erreur
ErrorCode

ErrorCode
Evaluation

Évaluation
EvaluationLinks

EvaluationLinks
EvaluationProperties

EvaluationProperties
EvaluationUpdate

EvaluationUpdate
InnerError

InnerError
Status

Statut

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.

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

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 du serveur interne.
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 du service indisponible.
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 lors 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 de clé maximale 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 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

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 permettant d’obtenir tous les fichiers de cette entité. Pour plus d’informations, consultez l’opération « Evaluations_ListFiles ».

EvaluationProperties

EvaluationProperties

Nom Type Description
correctTokenCount1

integer

Nombre de jetons correctement reconnus par model1.
correctTokenCount2

integer

Nombre de jetons correctement reconnus par model2.
correctWordCount1

integer

Nombre de mots correctement reconnus par model1.
correctWordCount2

integer

Nombre de mots correctement reconnus par model2.
email

string

Adresse e-mail à laquelle envoyer Notifications par e-mail au cas où l’opération se terminerait. La valeur sera supprimée après l’envoi de l’e-mail.
error

EntityError

EntityError
sentenceCount1

integer

Nombre de phrases traitées par modèle1.
sentenceCount2

integer

Nombre de phrases traitées par model2.
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 de jetons traités par modèle1.
tokenCount2

integer

Nombre de jetons traités par model2.
tokenDeletionCount1

integer

Nombre de jetons reconnus par model1, qui sont des suppressions.
tokenDeletionCount2

integer

Nombre de jetons reconnus par model2, qui sont des suppressions.
tokenErrorRate1

number

Taux d’erreur de jeton de reconnaissance avec model1.
tokenErrorRate2

number

Taux d’erreur de jeton de reconnaissance avec model2.
tokenInsertionCount1

integer

Nombre de jetons reconnus par model1, qui sont des insertions.
tokenInsertionCount2

integer

Nombre de jetons reconnus par model2, qui sont des insertions.
tokenSubstitutionCount1

integer

Nombre de jetons reconnus par model1, qui sont des substitutions.
tokenSubstitutionCount2

integer

Nombre de jetons reconnus par model2, qui sont des substitutions.
wordCount1

integer

Nombre de mots traités par modèle1.
wordCount2

integer

Nombre de mots traités par model2.
wordDeletionCount1

integer

Nombre de mots reconnus par model1, qui sont des suppressions.
wordDeletionCount2

integer

Nombre de mots reconnus par model2, qui sont des suppressions.
wordErrorRate1

number

Taux d’erreur de mot de la 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 model2, qui sont des insertions.
wordSubstitutionCount1

integer

Nombre de mots reconnus par model1, qui sont des substitutions.
wordSubstitutionCount2

integer

Nombre de mots reconnus par model2, qui sont des substitutions.

EvaluationUpdate

EvaluationUpdate

Nom Type Description
customProperties

object

Propriétés personnalisées de cette entité. La longueur de clé maximale 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

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.

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.