Evaluations - Update

Updates die veränderlichen Details der Auswertung, die durch ihre ID identifiziert werden.

PATCH {endpoint}/speechtotext/v3.2-preview.2/evaluations/{id}

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
path True

string

Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. ). https://westus.api.cognitive.microsoft.com

id
path True

string

uuid

Der Bezeichner der Auswertung.

Anforderungstext

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

Name Typ Beschreibung
customProperties

object

Die benutzerdefinierten Eigenschaften dieser Entität. Die maximal zulässige Schlüssellänge beträgt 64 Zeichen, die maximal zulässige Wertlänge 256 Zeichen und die Anzahl der zulässigen Einträge beträgt 10.

description

string

Die Beschreibung des -Objekts.

displayName

string

Der Name des Objekts.

project

EntityReference

EntityReference

Antworten

Name Typ Beschreibung
200 OK

Evaluation

OK

Header

Retry-After: integer

Other Status Codes

Error

Ein Fehler ist aufgetreten.

Sicherheit

Ocp-Apim-Subscription-Key

Geben Sie hier Ihren Cognitive Services-Kontoschlüssel an.

Typ: apiKey
In: header

Authorization

Stellen Sie ein Zugriffstoken aus dem JWT bereit, das vom STS dieser Region zurückgegeben wird. Fügen Sie dem Token den Verwaltungsbereich hinzu, indem Sie der STS-URL die folgende Abfragezeichenfolge hinzufügen: ?scope=speechservicesmanagement

Typ: apiKey
In: header

Beispiele

Update a evaluation

Beispielanforderung

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

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

Beispiel für eine Antwort

{
  "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"
}

Definitionen

Name Beschreibung
DetailedErrorCode

DetailedErrorCode

EntityError

EntityError

EntityReference

EntityReference

Error

Fehler

ErrorCode

ErrorCode

Evaluation

Auswertung

EvaluationLinks

EvaluationLinks

EvaluationProperties

EvaluationProperties

EvaluationUpdate

EvaluationUpdate

InnerError

InnerError

Status

Status

DetailedErrorCode

DetailedErrorCode

Name Typ Beschreibung
DataImportFailed

string

Fehler beim Datenimport.

DeleteNotAllowed

string

Löschen nicht zulässig.

DeployNotAllowed

string

Bereitstellen ist nicht zulässig.

DeployingFailedModel

string

Bereitstellen eines fehlerhaften Modells.

EmptyRequest

string

Leere Anforderung.

EndpointCannotBeDefault

string

Der Endpunkt kann nicht standardmäßig sein.

EndpointNotUpdatable

string

Endpunkt nicht aktualisierbar.

EndpointWithoutLogging

string

Endpunkt ohne Protokollierung.

ExceededNumberOfRecordingsUris

string

Die Anzahl der Aufzeichnungsuris wurde überschritten.

FailedDataset

string

Fehlgeschlagenes Dataset.

Forbidden

string

Unzulässig.

InUseViolation

string

In der Nutzungsverletzung.

InaccessibleCustomerStorage

string

Nicht zugänglicher Kundenspeicher.

InvalidAdaptationMapping

string

Ungültige Anpassungszuordnung.

InvalidBaseModel

string

Ungültiges Basismodell.

InvalidCallbackUri

string

Ungültiger Rückruf-URI.

InvalidCollection

string

Ungültige Auflistung.

InvalidDataset

string

Ungültiges Dataset.

InvalidDocument

string

Ungültiges Dokument.

InvalidDocumentBatch

string

Ungültiger Dokumentbatch.

InvalidLocale

string

Ungültiges Gebietsschema.

InvalidLogDate

string

Ungültiges Protokolldatum.

InvalidLogEndTime

string

Ungültige Protokollendzeit.

InvalidLogId

string

Ungültige Protokoll-ID.

InvalidLogStartTime

string

Ungültige Protokollstartzeit.

InvalidModel

string

Ungültiges Modell.

InvalidModelUri

string

Ungültiger Modell-URI.

InvalidParameter

string

Ungültiger Parameter.

InvalidParameterValue

string

Ungültiger Parameterwert.

InvalidPayload

string

Ungültige Nutzlast.

InvalidPermissions

string

Ungültige Berechtigungen.

InvalidPrerequisite

string

Ungültige Voraussetzung.

InvalidProductId

string

Ungültige Produkt-ID.

InvalidProject

string

Ungültiges Projekt.

InvalidProjectKind

string

Ungültige Projektart.

InvalidRecordingsUri

string

Ungültiger Aufzeichnungs-URI.

InvalidRequestBodyFormat

string

Ungültiges Anforderungstextformat.

InvalidSasValidityDuration

string

Ungültige sas-Gültigkeitsdauer.

InvalidSkipTokenForLogs

string

Ungültiges Überspringen von Token für Protokolle.

InvalidSourceAzureResourceId

string

Ungültige Azure-Quellressourcen-ID.

InvalidSubscription

string

Ungültiges Abonnement.

InvalidTest

string

Ungültiger Test.

InvalidTimeToLive

string

Ungültige Gültigkeitsdauer.

InvalidTopForLogs

string

Ungültiger Oberteil für Protokolle.

InvalidTranscription

string

Ungültige Transkription.

InvalidWebHookEventKind

string

Ungültige Web hook-Ereignisart.

MissingInputRecords

string

Fehlende Eingabedatensätze.

ModelCopyOperationExists

string

Der Modellkopiervorgang ist vorhanden.

ModelDeploymentNotCompleteState

string

Der Zustand der Modellbereitstellung ist nicht abgeschlossen.

ModelDeprecated

string

Das Modell ist veraltet.

ModelExists

string

Das Modell ist vorhanden.

ModelMismatch

string

Modellkonflikt.

ModelNotDeployable

string

Das Modell kann nicht bereitgestellt werden.

ModelVersionIncorrect

string

Modellversion falsch.

NoUtf8WithBom

string

Kein utf8 mit Bom.

OnlyOneOfUrlsOrContainerOrDataset

string

Nur eine der URLs, container oder datasets.

ProjectGenderMismatch

string

Projekt gender mismatch.

QuotaViolation

string

Kontingentverletzung.

SingleDefaultEndpoint

string

Einzelner Standardendpunkt.

SkuLimitsExist

string

Sku-Grenzwerte sind vorhanden.

SubscriptionNotFound

string

Abonnement wurde nicht gefunden.

UnexpectedError

string

Unerwarteter Fehler.

UnsupportedClassBasedAdaptation

string

Nicht unterstützte klassenbasierte Anpassung.

UnsupportedDelta

string

Nicht unterstütztes Delta.

UnsupportedDynamicConfiguration

string

Nicht unterstützte dynamische Konfiguration.

UnsupportedFilter

string

Nicht unterstützter Filter.

UnsupportedLanguageCode

string

Nicht unterstützter Sprachcode.

UnsupportedOrderBy

string

Nicht unterstützte Reihenfolge nach.

UnsupportedPagination

string

Nicht unterstützte Paginierung.

UnsupportedTimeRange

string

Nicht unterstützte Zeitbereiche.

EntityError

EntityError

Name Typ Beschreibung
code

string

Der Code dieses Fehlers.

message

string

Die Meldung für diesen Fehler.

EntityReference

EntityReference

Name Typ Beschreibung
self

string

Der Speicherort der Entität, auf die verwiesen wird.

Error

Fehler

Name Typ Beschreibung
code

ErrorCode

ErrorCode
Allgemeine Fehlercodes.

details

Error[]

Zusätzliche unterstützende Details zum Fehler und/oder zu den erwarteten Richtlinien.

innerError

InnerError

InnerError
Neues Format für innere Fehler, das den Cognitive Services-API-Richtlinien entspricht, die unter https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owverfügbar sind. Enthält die erforderlichen Eigenschaften ErrorCode, Message und Optional Properties Target, Details (Key Value Pair), Inner Error (kann geschachtelt werden).

message

string

Allgemeine Fehlermeldung.

target

string

Die Ursache des Fehlers. Dies wäre z. B. „Dokumente“ oder „Dokument-ID“ im Falle eines ungültigen Dokuments.

ErrorCode

ErrorCode

Name Typ Beschreibung
Conflict

string

Stellt den Konfliktfehlercode dar.

Forbidden

string

Stellt den unzulässigen Fehlercode dar.

InternalCommunicationFailed

string

Stellt den Fehlercode für interne Kommunikationsfehler dar.

InternalServerError

string

Stellt den Fehlercode des internen Servers dar.

InvalidArgument

string

Stellt den Fehlercode des ungültigen Arguments dar.

InvalidRequest

string

Stellt den ungültigen Anforderungsfehlercode dar.

NotAllowed

string

Stellt den nicht zulässigen Fehlercode dar.

NotFound

string

Stellt den Fehlercode nicht gefunden dar.

PipelineError

string

Stellt den Fehlercode für die Pipeline dar.

ServiceUnavailable

string

Stellt den Nicht verfügbaren Fehlercode des Diensts dar.

TooManyRequests

string

Stellt den Fehlercode für zu viele Anforderungen dar.

Unauthorized

string

Stellt den nicht autorisierten Fehlercode dar.

UnprocessableEntity

string

Stellt den Fehlercode für nicht bearbeitbare Entitäten dar.

UnsupportedMediaType

string

Stellt den fehlercode für den nicht unterstützten Medientyp dar.

Evaluation

Auswertung

Name Typ Beschreibung
createdDateTime

string

Der Zeitstempel, zu dem das Objekt erstellt wurde. Der Zeitstempel ist als ISO 8601-Datums- und Uhrzeitformat codiert ("JJJJ-MM-TTThh:mm:ssZ", siehe https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

customProperties

object

Die benutzerdefinierten Eigenschaften dieser Entität. Die maximal zulässige Schlüssellänge beträgt 64 Zeichen, die maximal zulässige Wertlänge beträgt 256 Zeichen und die Anzahl der zulässigen Einträge beträgt 10.

dataset

EntityReference

EntityReference

description

string

Die Beschreibung des -Objekts.

displayName

string

Der Anzeigename des Objekts.

lastActionDateTime

string

Der Zeitstempel, bei dem der aktuelle status eingegeben wurde. Der Zeitstempel ist als ISO 8601-Datums- und Uhrzeitformat codiert ("JJJJ-MM-TTThh:mm:ssZ", siehe https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

links

EvaluationLinks

EvaluationLinks

locale

string

Das Gebietsschema der enthaltenen Daten.

model1

EntityReference

EntityReference

model2

EntityReference

EntityReference

project

EntityReference

EntityReference

properties

EvaluationProperties

EvaluationProperties

self

string

Der Speicherort dieser Entität.

status

Status

Status
Beschreiben des aktuellen Zustands der API

transcription1

EntityReference

EntityReference

transcription2

EntityReference

EntityReference

EvaluationLinks

Name Typ Beschreibung
files

string

Der Speicherort, an dem alle Dateien dieser Entität abgerufen werden sollen. Weitere Informationen finden Sie unter Operation "Evaluations_ListFiles".

EvaluationProperties

EvaluationProperties

Name Typ Beschreibung
correctTokenCount1

integer

Die Anzahl der ordnungsgemäß erkannten Token nach model1.

correctTokenCount2

integer

Die Anzahl der ordnungsgemäß erkannten Token nach model2.

correctWordCount1

integer

Die Anzahl der ordnungsgemäß erkannten Wörter nach model1.

correctWordCount2

integer

Die Anzahl der ordnungsgemäß erkannten Wörter nach model2.

email

string

Die E-Mail-Adresse, an die E-Mail-Benachrichtigungen gesendet werden sollen, falls der Vorgang abgeschlossen ist. Der Wert wird entfernt, nachdem die E-Mail erfolgreich gesendet wurde.

error

EntityError

EntityError

sentenceCount1

integer

Die Anzahl der verarbeiteten Sätze nach model1.

sentenceCount2

integer

Die Anzahl der verarbeiteten Sätze nach model2.

sentenceErrorRate1

number

Die Satzfehlerrate der Erkennung mit model1.

sentenceErrorRate2

number

Die Satzfehlerrate der Erkennung mit model2.

tokenCount1

integer

Die Anzahl der verarbeiteten Token nach model1.

tokenCount2

integer

Die Anzahl der verarbeiteten Token nach model2.

tokenDeletionCount1

integer

Die Anzahl der erkannten Token nach Model1, bei denen es sich um Löschungen handelt.

tokenDeletionCount2

integer

Die Anzahl der erkannten Token nach model2, bei denen es sich um Löschungen handelt.

tokenErrorRate1

number

Die Tokenfehlerrate der Erkennung mit model1.

tokenErrorRate2

number

Die Tokenfehlerrate der Erkennung mit model2.

tokenInsertionCount1

integer

Die Anzahl der erkannten Token nach model1, bei denen es sich um Einfügungen handelt.

tokenInsertionCount2

integer

Die Anzahl der erkannten Token nach model2, bei denen es sich um Einfügungen handelt.

tokenSubstitutionCount1

integer

Die Anzahl der erkannten Token nach Model1, bei denen es sich um Ersetzungen handelt.

tokenSubstitutionCount2

integer

Die Anzahl der erkannten Token nach model2, bei denen es sich um Ersetzungen handelt.

wordCount1

integer

Die Anzahl der verarbeiteten Wörter nach Model1.

wordCount2

integer

Die Anzahl der verarbeiteten Wörter nach Model2.

wordDeletionCount1

integer

Die Anzahl der erkannten Wörter nach model1, bei denen es sich um Löschungen handelt.

wordDeletionCount2

integer

Die Anzahl der erkannten Wörter nach model2, d. h. Löschvorgänge.

wordErrorRate1

number

Die Wortfehlerrate der Erkennung mit model1.

wordErrorRate2

number

Die Wortfehlerrate der Erkennung mit model2.

wordInsertionCount1

integer

Die Anzahl der erkannten Wörter nach model1, d. h. Einfügungen.

wordInsertionCount2

integer

Die Anzahl der erkannten Wörter nach model2, d. h. Einfügungen.

wordSubstitutionCount1

integer

Die Anzahl der erkannten Wörter nach model1, bei denen es sich um Ersetzungen handelt.

wordSubstitutionCount2

integer

Die Anzahl der erkannten Wörter nach Model2, bei denen es sich um Ersetzungen handelt.

EvaluationUpdate

EvaluationUpdate

Name Typ Beschreibung
customProperties

object

Die benutzerdefinierten Eigenschaften dieser Entität. Die maximal zulässige Schlüssellänge beträgt 64 Zeichen, die maximal zulässige Wertlänge beträgt 256 Zeichen und die Anzahl der zulässigen Einträge beträgt 10.

description

string

Die Beschreibung des -Objekts.

displayName

string

Der Name des Objekts.

project

EntityReference

EntityReference

InnerError

InnerError

Name Typ Beschreibung
code

DetailedErrorCode

DetailedErrorCode
Detaillierte Fehlercodeenume.

details

object

Zusätzliche unterstützende Details zum Fehler und/oder zu den erwarteten Richtlinien.

innerError

InnerError

InnerError
Neues Innere Fehlerformat, das den Cognitive Services-API-Richtlinien entspricht, die unter https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owverfügbar ist. Enthält die erforderlichen Eigenschaften ErrorCode, Message und Optional Properties Target, Details (Key Value Pair), Inner Error (kann geschachtelt werden).

message

string

Allgemeine Fehlermeldung.

target

string

Die Ursache des Fehlers. Dies wäre z. B. „Dokumente“ oder „Dokument-ID“ im Falle eines ungültigen Dokuments.

Status

Status

Name Typ Beschreibung
Failed

string

Der Vorgang mit langer Ausführungsdauer ist fehlgeschlagen.

NotStarted

string

Der lang andauernde Vorgang wurde noch nicht gestartet.

Running

string

Der Vorgang mit langer Ausführungszeit wird derzeit verarbeitet.

Succeeded

string

Der lang andauernde Vorgang wurde erfolgreich abgeschlossen.