Evaluations - Update

Odwołanie

Usługa:: Azure AI Services

Wersja interfejsu API:: v3.2-preview.2

Aktualizuje modyfikowalne szczegóły oceny zidentyfikowane przez jego identyfikator.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://westus.api.cognitive.microsoft.com).
id	path	True	string (uuid)	Identyfikator oceny.

Treść żądania

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

Nazwa	Typ	Opis
customProperties	object	Właściwości niestandardowe tej jednostki. Maksymalna dozwolona długość klucza to 64 znaki, maksymalna dozwolona długość wartości to 256 znaków, a liczba dozwolonych wpisów wynosi 10.
description	string	Opis obiektu.
displayName	string	Nazwa obiektu.
project	EntityReference	EntityReference

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Evaluation	OK Nagłówki Retry-After: integer
Other Status Codes	Error	Wystąpił błąd.

Nazwa

Typ

Opis

200 OK

Evaluation

Nagłówki

Retry-After: integer

Other Status Codes

Error

Wystąpił błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Tutaj podaj klucz konta usług Cognitive Services.

Typ: apiKey
W: header

Authorization

Podaj token dostępu z zestawu JWT zwróconego przez usługę STS tego regionu. Pamiętaj, aby dodać zakres zarządzania do tokenu, dodając następujący ciąg zapytania do adresu URL usługi STS: ?scope=speechservicesmanagement

Typ: apiKey
W: header

Przykłady

Update a evaluation

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:: 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"
}

Definicje

Nazwa	Opis
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	EntityReference
Error	Błąd
ErrorCode	Kod błędu
Evaluation	Ocena
EvaluationLinks	EvaluationLinks
EvaluationProperties	Właściwości ewaluacyjne
EvaluationUpdate	EvaluationUpdate
InnerError	InnerError
Status	Status

DetailedErrorCode

Wyliczanie

DetailedErrorCode

Wartość	Opis
DataImportFailed	Importowanie danych nie powiodło się.
DeleteNotAllowed	Usuń niedozwolone.
DeployNotAllowed	Wdrażanie jest niedozwolone.
DeployingFailedModel	Wdrażanie modelu nie powiodło się.
EmptyRequest	Puste żądanie.
EndpointCannotBeDefault	Punkt końcowy nie może być domyślny.
EndpointNotUpdatable	Punkt końcowy nie można aktualizować.
EndpointWithoutLogging	Punkt końcowy bez rejestrowania.
ExceededNumberOfRecordingsUris	Przekroczono liczbę nagrań uris.
FailedDataset	Zestaw danych, który zakończył się niepowodzeniem.
Forbidden	Zakazany.
InUseViolation	Naruszenie użycia.
InaccessibleCustomerStorage	Niedostępny magazyn klienta.
InvalidAdaptationMapping	Nieprawidłowe mapowanie adaptacji.
InvalidBaseModel	Nieprawidłowy model podstawowy.
InvalidCallbackUri	Nieprawidłowy identyfikator URI wywołania zwrotnego.
InvalidCollection	Nieprawidłowa kolekcja.
InvalidDataset	Nieprawidłowy zestaw danych.
InvalidDocument	Nieprawidłowy dokument.
InvalidDocumentBatch	Nieprawidłowa partia dokumentów.
InvalidLocale	Nieprawidłowe ustawienia regionalne.
InvalidLogDate	Nieprawidłowa data dziennika.
InvalidLogEndTime	Nieprawidłowy czas zakończenia dziennika.
InvalidLogId	Nieprawidłowy identyfikator dziennika.
InvalidLogStartTime	Nieprawidłowy czas rozpoczęcia dziennika.
InvalidModel	Nieprawidłowy model.
InvalidModelUri	Nieprawidłowy identyfikator URI modelu.
InvalidParameter	Nieprawidłowy parametr.
InvalidParameterValue	Nieprawidłowa wartość parametru.
InvalidPayload	Nieprawidłowy ładunek.
InvalidPermissions	Nieprawidłowe uprawnienia.
InvalidPrerequisite	Nieprawidłowe wymaganie wstępne.
InvalidProductId	Nieprawidłowy identyfikator produktu.
InvalidProject	Nieprawidłowy projekt.
InvalidProjectKind	Nieprawidłowy rodzaj projektu.
InvalidRecordingsUri	Nieprawidłowy identyfikator URI nagrań.
InvalidRequestBodyFormat	Nieprawidłowy format treści żądania.
InvalidSasValidityDuration	Nieprawidłowy czas ważności sygnatury dostępu współdzielonego.
InvalidSkipTokenForLogs	Nieprawidłowy token pomijania dzienników.
InvalidSourceAzureResourceId	Nieprawidłowy źródłowy identyfikator zasobu platformy Azure.
InvalidSubscription	Nieprawidłowa subskrypcja.
InvalidTest	Nieprawidłowy test.
InvalidTimeToLive	Nieprawidłowy czas wygaśnięcia.
InvalidTopForLogs	Nieprawidłowy górny element dla dzienników.
InvalidTranscription	Nieprawidłowa transkrypcja.
InvalidWebHookEventKind	Nieprawidłowy rodzaj zdarzenia elementu webhook.
MissingInputRecords	Brak rekordów wejściowych.
ModelCopyOperationExists	Istnieje operacja kopiowania modelu.
ModelDeploymentNotCompleteState	Wdrożenie modelu nie zostało ukończone.
ModelDeprecated	Model jest przestarzały.
ModelExists	Model istnieje.
ModelMismatch	Niezgodność modelu.
ModelNotDeployable	Nie można wdrożyć modelu.
ModelVersionIncorrect	Nieprawidłowa wersja modelu.
NoUtf8WithBom	Brak utf8 z bom.
OnlyOneOfUrlsOrContainerOrDataset	Tylko jeden z adresów URL lub kontenera lub zestawu danych.
ProjectGenderMismatch	Niezgodność płci projektu.
QuotaViolation	Naruszenie limitu przydziału.
SingleDefaultEndpoint	Pojedynczy domyślny punkt końcowy.
SkuLimitsExist	Istnieją limity jednostek SKU.
SubscriptionNotFound	Nie można odnaleźć subskrypcji.
UnexpectedError	Nieoczekiwany błąd.
UnsupportedClassBasedAdaptation	Nieobsługiwana adaptacja oparta na klasach.
UnsupportedDelta	Nieobsługiwana delta.
UnsupportedDynamicConfiguration	Nieobsługiwana konfiguracja dynamiczna.
UnsupportedFilter	Nieobsługiwany filtr.
UnsupportedLanguageCode	Nieobsługiwany kod języka.
UnsupportedOrderBy	Nieobsługiwana kolejność według.
UnsupportedPagination	Nieobsługiwane stronicowanie.
UnsupportedTimeRange	Nieobsługiwany zakres czasu.

EntityError

Objekt

EntityError

Nazwa	Typ	Opis
code	string	Kod tego błędu.
message	string	Komunikat o tym błędzie.

EntityReference

Objekt

EntityReference

Nazwa	Typ	Opis
self	string (uri)	Lokalizacja odwoływania się do jednostki.

Error

Objekt

Błąd

Nazwa	Typ	Opis
code	ErrorCode	Kod błędu Kody błędów wysokiego poziomu.
details	Error[]	Dodatkowe szczegóły pomocnicze dotyczące błędów i/lub oczekiwanych zasad.
innerError	InnerError	InnerError Nowy format błędu wewnętrznego zgodny z wytycznymi interfejsu API usług Cognitive Services dostępnymi w witrynie https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Zawiera to wymagane właściwości ErrorCode, komunikat i opcjonalny obiekt docelowy właściwości, szczegóły (para wartości klucza), błąd wewnętrzny (można to zagnieżdżać).
message	string	Komunikat o błędzie wysokiego poziomu.
target	string	Źródło błędu. Na przykład będzie to "dokumenty" lub "identyfikator dokumentu" w przypadku nieprawidłowego dokumentu.

ErrorCode

Wyliczanie

Kod błędu

Wartość	Opis
Conflict	Reprezentowanie kodu błędu powodującego konflikt.
Forbidden	Reprezentowanie niedozwolonego kodu błędu.
InternalCommunicationFailed	Reprezentowanie wewnętrznego kodu błędu komunikacji nie powiodło się.
InternalServerError	Reprezentowanie wewnętrznego kodu błędu serwera.
InvalidArgument	Reprezentowanie nieprawidłowego kodu błędu argumentu.
InvalidRequest	Reprezentowanie nieprawidłowego kodu błędu żądania.
NotAllowed	Reprezentowanie niedozwolonego kodu błędu.
NotFound	Reprezentacja kodu błędu, który nie został znaleziony.
PipelineError	Reprezentowanie kodu błędu potoku.
ServiceUnavailable	Reprezentowanie niedostępnego kodu błędu usługi.
TooManyRequests	Reprezentując kod błędu zbyt wielu żądań.
Unauthorized	Reprezentowanie nieautoryzowanego kodu błędu.
UnprocessableEntity	Reprezentowanie nieprzetworzonego kodu błędu jednostki.
UnsupportedMediaType	Reprezentowanie nieobsługiwanego kodu błędu typu nośnika.

Evaluation

Objekt

Ocena

Nazwa	Typ	Opis
createdDateTime	string (date-time)	Sygnatura czasowa utworzenia obiektu. Sygnatura czasowa jest kodowana jako format daty i godziny ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", zobacz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	Właściwości niestandardowe tej jednostki. Maksymalna dozwolona długość klucza to 64 znaki, maksymalna dozwolona długość wartości to 256 znaków, a liczba dozwolonych wpisów wynosi 10.
dataset	EntityReference	EntityReference
description	string	Opis obiektu.
displayName	string minLength: 1	Nazwa wyświetlana obiektu.
lastActionDateTime	string (date-time)	Sygnatura czasowa po wprowadzeniu bieżącego stanu. Sygnatura czasowa jest kodowana jako format daty i godziny ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", zobacz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	EvaluationLinks	EvaluationLinks
locale	string minLength: 1	Ustawienia regionalne zawartych danych.
model1	EntityReference	EntityReference
model2	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EvaluationProperties	Właściwości ewaluacyjne
self	string (uri)	Lokalizacja tej jednostki.
status	Status	Status Opis bieżącego stanu interfejsu API
transcription1	EntityReference	EntityReference
transcription2	EntityReference	EntityReference

EvaluationLinks

Objekt

EvaluationLinks

Nazwa	Typ	Opis
files	string (uri)	Lokalizacja pobierania wszystkich plików tej jednostki. Aby uzyskać więcej informacji, zobacz operację "Evaluations_ListFiles".

EvaluationProperties

Objekt

Właściwości ewaluacyjne

Nazwa	Typ	Opis
correctTokenCount1	integer (int32)	Liczba poprawnie rozpoznanych tokenów według modelu Model1.
correctTokenCount2	integer (int32)	Liczba poprawnie rozpoznanych tokenów według modelu 2.
correctWordCount1	integer (int32)	Liczba poprawnie rozpoznanych wyrazów według modelu model1.
correctWordCount2	integer (int32)	Liczba poprawnie rozpoznanych wyrazów według modelu model2.
email	string	Adres e-mail do wysyłania powiadomień e-mail na adres w przypadku zakończenia operacji. Wartość zostanie usunięta po pomyślnym wysłaniu wiadomości e-mail.
error	EntityError	EntityError
sentenceCount1	integer (int32)	Liczba przetworzonych zdań według modelu Model1.
sentenceCount2	integer (int32)	Liczba przetworzonych zdań według modelu Model2.
sentenceErrorRate1	number (double)	Wskaźnik błędów zdania rozpoznawania za pomocą modelu Model1.
sentenceErrorRate2	number (double)	Wskaźnik błędów zdania rozpoznawania za pomocą modelu Model2.
tokenCount1	integer (int32)	Liczba przetworzonych tokenów według modelu model1.
tokenCount2	integer (int32)	Liczba przetworzonych tokenów według modelu Model2.
tokenDeletionCount1	integer (int32)	Liczba rozpoznanych tokenów według modelu model1, które są usuwane.
tokenDeletionCount2	integer (int32)	Liczba rozpoznanych tokenów według modelu Model2, które są usuwane.
tokenErrorRate1	number (double)	Współczynnik błędów tokenu rozpoznawania za pomocą modelu Model1.
tokenErrorRate2	number (double)	Współczynnik błędów tokenu rozpoznawania za pomocą modelu Model2.
tokenInsertionCount1	integer (int32)	Liczba rozpoznanych tokenów według modelu model1, które są wstawiania.
tokenInsertionCount2	integer (int32)	Liczba rozpoznanych tokenów według modelu Model2, które są wstawiania.
tokenSubstitutionCount1	integer (int32)	Liczba rozpoznanych tokenów według modelu model1, które są podstawieniami.
tokenSubstitutionCount2	integer (int32)	Liczba rozpoznanych tokenów według modelu Model2, które są podstawieniami.
wordCount1	integer (int32)	Liczba przetworzonych wyrazów według modelu model1.
wordCount2	integer (int32)	Liczba przetworzonych wyrazów według modelu model2.
wordDeletionCount1	integer (int32)	Liczba rozpoznanych wyrazów według modelu model1, które są usuwane.
wordDeletionCount2	integer (int32)	Liczba rozpoznanych wyrazów według modelu model2, które są usuwane.
wordErrorRate1	number (double)	Szybkość rozpoznawania wyrazów z model1.
wordErrorRate2	number (double)	Szybkość rozpoznawania słów o błędach za pomocą modelu Model2.
wordInsertionCount1	integer (int32)	Liczba rozpoznanych wyrazów według modelu model1, które są wstawiania.
wordInsertionCount2	integer (int32)	Liczba rozpoznanych wyrazów według modelu model2, które są wstawiania.
wordSubstitutionCount1	integer (int32)	Liczba rozpoznanych wyrazów według modelu model1, które są podstawieniami.
wordSubstitutionCount2	integer (int32)	Liczba rozpoznanych wyrazów według modelu model2, które są podstawieniami.

EvaluationUpdate

Objekt

EvaluationUpdate

Nazwa	Typ	Opis
customProperties	object	Właściwości niestandardowe tej jednostki. Maksymalna dozwolona długość klucza to 64 znaki, maksymalna dozwolona długość wartości to 256 znaków, a liczba dozwolonych wpisów wynosi 10.
description	string	Opis obiektu.
displayName	string	Nazwa obiektu.
project	EntityReference	EntityReference

InnerError

Objekt

InnerError

Nazwa	Typ	Opis
code	DetailedErrorCode	DetailedErrorCode Szczegółowy wyliczenie kodu błędu.
details	object	Dodatkowe szczegóły pomocnicze dotyczące błędów i/lub oczekiwanych zasad.
innerError	InnerError	InnerError Nowy format błędu wewnętrznego zgodny z wytycznymi interfejsu API usług Cognitive Services dostępnymi w witrynie https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Zawiera to wymagane właściwości ErrorCode, komunikat i opcjonalny obiekt docelowy właściwości, szczegóły (para wartości klucza), błąd wewnętrzny (można to zagnieżdżać).
message	string	Komunikat o błędzie wysokiego poziomu.
target	string	Źródło błędu. Na przykład będzie to "dokumenty" lub "identyfikator dokumentu" w przypadku nieprawidłowego dokumentu.

Status

Wyliczanie

Status

Wartość	Opis
Failed	Długotrwała operacja nie powiodła się.
NotStarted	Długotrwała operacja nie została jeszcze uruchomiona.
Running	Długotrwała operacja jest obecnie przetwarzana.
Succeeded	Długotrwała operacja została pomyślnie ukończona.

Udostępnij za pośrednictwem

Evaluations - Update

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

Ocp-Apim-Subscription-Key

Authorization

Przykłady

Update a evaluation

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

Evaluation

EvaluationLinks

EvaluationProperties

EvaluationUpdate

InnerError

Status

Dodatkowe zasoby