Projects - List Evaluations

Odwołanie

Usługa:: Azure AI Services

Wersja interfejsu API:: v3.1

Pobiera listę ocen dla określonego projektu.

GET {endpoint}/speechtotext/v3.1/projects/{id}/evaluations

Z parametrami opcjonalnymi:

GET {endpoint}/speechtotext/v3.1/projects/{id}/evaluations?skip={skip}&top={top}&filter={filter}

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 projektu.
filter	query		string	Wyrażenie filtrowania do wybierania podzestawu dostępnych ocen. `- Supported properties: displayName, description, createdDateTime, lastActionDateTime, status and locale. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime. - and, or, not are supported. - Example filter=displayName eq 'My evaluation'`
skip	query		integer int32	Liczba zestawów danych, które zostaną pominięte.
top	query		integer int32	Liczba zestawów danych, które zostaną uwzględnione po pomijaniu.

Odpowiedzi

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

Nazwa

Typ

Opis

200 OK

PaginatedEvaluations

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 JWT zwrócony 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

Get all evaluations

Przykładowe żądanie

HTTP

GET {endpoint}/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations?skip=0&top=2

Przykładowa odpowiedź

Kod stanu:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/evaluations/a55a327b-c866-40b3-a08d-9c0945738633",
      "model1": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
      },
      "model2": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "dataset": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
      },
      "transcription2": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f"
      },
      "transcription1": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683"
      },
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/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
      },
      "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"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/evaluations/daaa45a7-38f0-4918-87d2-bf55fec32ac5",
      "model1": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
      },
      "model2": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "dataset": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
      },
      "transcription2": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f"
      },
      "transcription1": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683"
      },
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/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
      },
      "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"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files?skip=2&top=2"
}

Definicje

Nazwa	Opis
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	Odwołanie do jednostki
Error	Błąd
ErrorCode	ErrorCode
Evaluation	Ocena
EvaluationLinks	Linki ewaluacyjne
EvaluationProperties	Właściwości ewaluacyjne
InnerError	InnerError
PaginatedEvaluations	Stronicowane oceny
Status	Stan

DetailedErrorCode

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

EntityError

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

EntityReference

Odwołanie do jednostki

Nazwa	Typ	Opis
self	string	Lokalizacja przywołynej jednostki.

Error

Błąd

Nazwa	Typ	Opis
code	ErrorCode	ErrorCode 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 pod adresem 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

Nazwa	Typ	Opis
Conflict	string	Reprezentowanie kodu błędu powodującego konflikt.
Forbidden	string	Reprezentuje kod błędu zabronionego.
InternalCommunicationFailed	string	Reprezentowanie kodu błędu komunikacji wewnętrznej nie powiodło się.
InternalServerError	string	Reprezentowanie wewnętrznego kodu błędu serwera.
InvalidArgument	string	Reprezentowanie nieprawidłowego kodu błędu argumentu.
InvalidRequest	string	Reprezentowanie nieprawidłowego kodu błędu żądania.
NotAllowed	string	Reprezentowanie niedozwolonego kodu błędu.
NotFound	string	Reprezentując kod błędu nie znaleziono.
PipelineError	string	Reprezentowanie kodu błędu potoku.
ServiceUnavailable	string	Reprezentuje kod błędu niedostępności usługi.
TooManyRequests	string	Reprezentowanie zbyt wielu żądań kod błędu.
Unauthorized	string	Reprezentowanie nieautoryzowanego kodu błędu.
UnprocessableEntity	string	Reprezentowanie nieprzetworzonego kodu błędu jednostki.
UnsupportedMediaType	string	Reprezentowanie nieobsługiwanego kodu błędu typu nośnika.

Evaluation

Ocena

Nazwa	Typ	Opis
createdDateTime	string	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	Odwołanie do jednostki
description	string	Opis obiektu.
displayName	string	Nazwa wyświetlana obiektu.
lastActionDateTime	string	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	Linki ewaluacyjne
locale	string	Ustawienia regionalne zawartych danych.
model1	EntityReference	Odwołanie do jednostki
model2	EntityReference	Odwołanie do jednostki
project	EntityReference	Odwołanie do jednostki
properties	EvaluationProperties	Właściwości ewaluacyjne
self	string	Lokalizacja tej jednostki.
status	Status	Stan Opis bieżącego stanu interfejsu API
transcription1	EntityReference	Odwołanie do jednostki
transcription2	EntityReference	Odwołanie do jednostki

EvaluationLinks

Linki ewaluacyjne

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

EvaluationProperties

Właściwości ewaluacyjne

Nazwa	Typ	Opis
correctWordCount1	integer	Liczba poprawnie rozpoznanych słów według modelu model1.
correctWordCount2	integer	Liczba poprawnie rozpoznanych słów według modelu model2.
email	string	Adres e-mail do wysyłania powiadomień e-mail na wypadek zakończenia operacji. Wartość zostanie usunięta po pomyślnym wysłaniu wiadomości e-mail.
error	EntityError	EntityError
sentenceCount1	integer	Liczba przetworzonych zdań według modelu model1.
sentenceCount2	integer	Liczba przetworzonych zdań według modelu Model2.
sentenceErrorRate1	number	Wskaźnik błędów zdania rozpoznawania za pomocą modelu model1.
sentenceErrorRate2	number	Wskaźnik błędów zdania rozpoznawania przy użyciu modelu Model2.
wordCount1	integer	Liczba przetworzonych słów według modelu model1.
wordCount2	integer	Liczba przetworzonych słów według modelu model2.
wordDeletionCount1	integer	Liczba rozpoznanych słów według modelu model1, które są usuwane.
wordDeletionCount2	integer	Liczba rozpoznanych słów według modelu model2, które są usuwane.
wordErrorRate1	number	Słowo współczynnik błędów rozpoznawania za pomocą modelu model1.
wordErrorRate2	number	Słowo współczynnik błędów rozpoznawania za pomocą modelu Model2.
wordInsertionCount1	integer	Liczba rozpoznanych słów według modelu model1, które są wstawiania.
wordInsertionCount2	integer	Liczba rozpoznanych słów według modelu model2, które są wstawiania.
wordSubstitutionCount1	integer	Liczba rozpoznanych słów według modelu model1, które są podstawianie.
wordSubstitutionCount2	integer	Liczba rozpoznanych słów według modelu model2, które są podstawianie.

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 pod adresem 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.

PaginatedEvaluations

Stronicowane oceny

Nazwa	Typ	Opis
@nextLink	string	Link do następnego zestawu wyników podzielonych na strony, jeśli dostępnych jest więcej jednostek; w przeciwnym razie wartość null.
values	Evaluation[]	Lista jednostek ograniczonych przez przekazane parametry zapytania "skip" i "top" lub ich wartości domyślne. Podczas iteracji listy przy użyciu stronicowania i usuwania jednostek równolegle niektóre jednostki zostaną pominięte w wynikach. Zaleca się utworzenie listy na kliencie i usunięcie po pobraniu pełnej listy.

Nazwa

Typ

Opis

@nextLink

string

Link do następnego zestawu wyników podzielonych na strony, jeśli dostępnych jest więcej jednostek; w przeciwnym razie wartość null.

values

Evaluation[]

Lista jednostek ograniczonych przez przekazane parametry zapytania "skip" i "top" lub ich wartości domyślne.

Podczas iteracji listy przy użyciu stronicowania i usuwania jednostek równolegle niektóre jednostki zostaną pominięte w wynikach. Zaleca się utworzenie listy na kliencie i usunięcie po pobraniu pełnej listy.

Status

Stan

Nazwa	Typ	Opis
Failed	string	Długotrwała operacja nie powiodła się.
NotStarted	string	Długotrwała operacja nie została jeszcze uruchomiona.
Running	string	Długotrwała operacja jest obecnie przetwarzana.
Succeeded	string	Operacja długotrwała została pomyślnie ukończona.

Udostępnij za pośrednictwem

Projects - List Evaluations

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

Ocp-Apim-Subscription-Key

Authorization

Przykłady

Get all evaluations

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

Evaluation

EvaluationLinks

EvaluationProperties

InnerError

PaginatedEvaluations

Status

Dodatkowe zasoby