Text Analysis Authoring - Get Model Evaluation Results

Odwołanie

Usługa:: Azure AI Services

Wersja interfejsu API:: 2023-04-01

Pobiera szczegółowe wyniki oceny dla wytrenowanego modelu. Obejmuje to nieprzetworzone wyniki wnioskowania dla danych uwzględnionych w procesie oceny.

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/result?api-version=2023-04-01&stringIndexType=Utf16CodeUnit

Z parametrami opcjonalnymi:

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/result?api-version=2023-04-01&top={top}&skip={skip}&maxpagesize={maxpagesize}&stringIndexType=Utf16CodeUnit

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string url	Obsługiwany punkt końcowy usług Cognitive Services (np. https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Nowa nazwa projektu.
trainedModelLabel	path	True	string	Wytrenowana etykieta modelu.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.
stringIndexType	query	True	StringIndexType	Określa metodę używaną do interpretowania przesunięć ciągów. Aby uzyskać dodatkowe informacje, zobacz https://aka.ms/text-analytics-offsets.
maxpagesize	query		integer int32	Maksymalna liczba elementów wyników na stronę.
skip	query		integer int32	Liczba elementów wyników do pominięcia.
top	query		integer int32	Liczba elementów wyników do zwrócenia.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PagedTextAnalysisAuthoringDocumentEvaluationResult	Żądanie zakończyło się pomyślnie.
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

OAuth2Auth

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize
Adres URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Zakresy

Nazwa	Opis
https://cognitiveservices.azure.com/.default

Przykłady

SuccessfulGetModelEvaluation

Przykładowe żądanie

HTTP

GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/models/model2/evaluation/result?api-version=2023-04-01&maxpagesize=10&stringIndexType=Utf16CodeUnit

Przykładowa odpowiedź

Kod stanu:: 200

{
  "value": [
    {
      "location": "11.txt",
      "language": "en-us",
      "projectKind": "CustomEntityRecognition",
      "customEntityRecognitionResult": {
        "entities": [
          {
            "expectedEntities": [
              {
                "category": "Date",
                "offset": 5,
                "length": 9
              },
              {
                "category": "BorrowerName",
                "offset": 160,
                "length": 13
              },
              {
                "category": "BorrowerAddress",
                "offset": 181,
                "length": 34
              },
              {
                "category": "BorrowerCity",
                "offset": 225,
                "length": 6
              },
              {
                "category": "BorrowerState",
                "offset": 242,
                "length": 8
              },
              {
                "category": "LenderName",
                "offset": 271,
                "length": 12
              },
              {
                "category": "LenderAddress",
                "offset": 310,
                "length": 20
              },
              {
                "category": "LenderCity",
                "offset": 340,
                "length": 8
              },
              {
                "category": "LenderState",
                "offset": 359,
                "length": 11
              },
              {
                "category": "LoanAmountWords",
                "offset": 448,
                "length": 52
              },
              {
                "category": "LoanAmountNumbers",
                "offset": 502,
                "length": 10
              },
              {
                "category": "Interest",
                "offset": 588,
                "length": 2
              }
            ],
            "predictedEntities": [
              {
                "category": "Date",
                "offset": 5,
                "length": 9
              },
              {
                "category": "BorrowerName",
                "offset": 160,
                "length": 13
              },
              {
                "category": "BorrowerAddress",
                "offset": 200,
                "length": 15
              },
              {
                "category": "BorrowerCity",
                "offset": 225,
                "length": 6
              },
              {
                "category": "BorrowerState",
                "offset": 242,
                "length": 8
              },
              {
                "category": "LenderName",
                "offset": 271,
                "length": 12
              },
              {
                "category": "LenderAddress",
                "offset": 310,
                "length": 20
              },
              {
                "category": "LenderCity",
                "offset": 340,
                "length": 8
              },
              {
                "category": "LenderState",
                "offset": 359,
                "length": 11
              },
              {
                "category": "LoanAmountWords",
                "offset": 448,
                "length": 52
              },
              {
                "category": "LoanAmountNumbers",
                "offset": 502,
                "length": 10
              },
              {
                "category": "Interest",
                "offset": 588,
                "length": 2
              }
            ],
            "regionOffset": 0,
            "regionLength": 1780
          }
        ]
      }
    },
    {
      "location": "01.txt",
      "language": "en-us",
      "projectKind": "CustomEntityRecognition",
      "customEntityRecognitionResult": {
        "entities": [
          {
            "expectedEntities": [
              {
                "category": "Date",
                "offset": 5,
                "length": 9
              },
              {
                "category": "BorrowerName",
                "offset": 160,
                "length": 13
              },
              {
                "category": "BorrowerAddress",
                "offset": 200,
                "length": 13
              },
              {
                "category": "BorrowerCity",
                "offset": 223,
                "length": 9
              },
              {
                "category": "BorrowerState",
                "offset": 243,
                "length": 8
              },
              {
                "category": "LenderName",
                "offset": 273,
                "length": 14
              },
              {
                "category": "LenderAddress",
                "offset": 314,
                "length": 15
              },
              {
                "category": "LenderCity",
                "offset": 339,
                "length": 10
              },
              {
                "category": "LenderState",
                "offset": 360,
                "length": 8
              },
              {
                "category": "LoanAmountWords",
                "offset": 446,
                "length": 66
              },
              {
                "category": "LoanAmountNumbers",
                "offset": 514,
                "length": 11
              },
              {
                "category": "Interest",
                "offset": 601,
                "length": 2
              }
            ],
            "predictedEntities": [
              {
                "category": "Date",
                "offset": 5,
                "length": 9
              },
              {
                "category": "BorrowerName",
                "offset": 160,
                "length": 13
              },
              {
                "category": "BorrowerAddress",
                "offset": 200,
                "length": 13
              },
              {
                "category": "BorrowerCity",
                "offset": 223,
                "length": 9
              },
              {
                "category": "BorrowerState",
                "offset": 243,
                "length": 8
              },
              {
                "category": "LenderName",
                "offset": 273,
                "length": 14
              },
              {
                "category": "LenderAddress",
                "offset": 314,
                "length": 15
              },
              {
                "category": "LenderCity",
                "offset": 339,
                "length": 10
              },
              {
                "category": "LenderState",
                "offset": 360,
                "length": 8
              },
              {
                "category": "LoanAmountWords",
                "offset": 446,
                "length": 66
              },
              {
                "category": "LoanAmountNumbers",
                "offset": 514,
                "length": 11
              },
              {
                "category": "Interest",
                "offset": 601,
                "length": 2
              }
            ],
            "regionOffset": 0,
            "regionLength": 1793
          }
        ]
      }
    }
  ],
  "nextLink": "https://api.example.com/language/authoring/analyze-text/projects/LoanAgreements/models/model2/evaluation/result/?api-version=2023-04-15-preview&top=2147483645&skip=100&maxpagesize=100"
}

Definicje

Nazwa	Opis
Error	Obiekt błędu.
ErrorCode	Kod błędu czytelny dla człowieka.
ErrorResponse	Odpowiedź na błąd.
InnerErrorCode	Kod błędu czytelny dla człowieka.
InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
PagedTextAnalysisAuthoringDocumentEvaluationResult	Stronicowana kolekcja elementów TextAnalysisAuthoringDocumentEvaluationResult
ProjectKind
StringIndexType
TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult	Reprezentuje wynik oceny dokumentu dla niestandardowego projektu rozpoznawania jednostek.
TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult	Reprezentuje wynik oceny dokumentu dla niestandardowego projektu klasyfikacji z wieloma etykietami.
TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult	Reprezentuje wynik oceny dokumentu dla niestandardowego projektu klasyfikacji pojedynczej etykiety.
TextAnalysisAuthoringDocumentEntityLabelEvaluationResult	Reprezentuje etykietę jednostki wyniku oceny.
TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult	Reprezentuje wynik oceny rozpoznawania jednostek dla dokumentu.
TextAnalysisAuthoringDocumentEntityRegionEvaluationResult	Reprezentuje porównanie oceny między oczekiwaną i przewidywaną jednostkami regionu dokumentu.
TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult	Reprezentuje porównanie oczekiwanych i przewidywanych klas, które są wynikiem operacji oceny.
TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult	Reprezentuje porównanie oczekiwanej i przewidywanej klasy, która wynika z operacji oceny.

Error

Obiekt błędu.

Nazwa	Typ	Opis
code	ErrorCode	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ErrorCode

Kod błędu czytelny dla człowieka.

Nazwa	Typ	Opis
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Conflict	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
QuotaExceeded	string
ServiceUnavailable	string
Timeout	string
TooManyRequests	string
Unauthorized	string
Warning	string

ErrorResponse

Odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Obiekt błędu.

InnerErrorCode

Kod błędu czytelny dla człowieka.

Nazwa	Typ	Opis
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
EmptyRequest	string
ExtractionFailure	string
InvalidCountryHint	string
InvalidDocument	string
InvalidDocumentBatch	string
InvalidParameterValue	string
InvalidRequest	string
InvalidRequestBodyFormat	string
KnowledgeBaseNotFound	string
MissingInputDocuments	string
ModelVersionIncorrect	string
UnsupportedLanguageCode	string

InnerErrorModel

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa	Typ	Opis
code	InnerErrorCode	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	object	Szczegóły błędu.
innererror	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

PagedTextAnalysisAuthoringDocumentEvaluationResult

Stronicowana kolekcja elementów TextAnalysisAuthoringDocumentEvaluationResult

Nazwa	Typ	Opis
nextLink	string	Link do następnej strony elementów
value	TextAnalysisAuthoringDocumentEvaluationResult[]: TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult[] TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult[] TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult[]	Elementy TextAnalysisAuthoringDocumentEvaluationResult na tej stronie

ProjectKind

Nazwa	Typ	Opis
CustomEntityRecognition	string	Aby sbudować model wyodrębniania w celu zidentyfikowania kategorii domen przy użyciu własnych danych.
CustomMultiLabelClassification	string	Tworzenie modelu klasyfikacji w celu klasyfikowania tekstu przy użyciu własnych danych. Każdy plik może mieć jedną lub wiele etykiet. Na przykład plik 1 jest klasyfikowany jako A, B i C, a plik 2 jest klasyfikowany jako B i C.
CustomSingleLabelClassification	string	Tworzenie modelu klasyfikacji w celu klasyfikowania tekstu przy użyciu własnych danych. Każdy plik będzie miał tylko jedną etykietę. Na przykład plik 1 jest klasyfikowany jako A, a plik 2 jest klasyfikowany jako B.

StringIndexType

Nazwa	Typ	Opis
Utf16CodeUnit	string	Wartości przesunięcia i długości odpowiadają jednostkom kodu UTF-16. Użyj tej opcji, jeśli aplikacja jest napisana w języku obsługującym kod Unicode, na przykład JavaScript.

TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult

Reprezentuje wynik oceny dokumentu dla niestandardowego projektu rozpoznawania jednostek.

Nazwa	Typ	Opis
customEntityRecognitionResult	TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult	Reprezentuje przewidywanie oceny dla rozpoznawania jednostek.
language	string	Reprezentuje język dokumentu. Jest to reprezentacja języka BCP-47. Na przykład użyj "en" dla języka angielskiego, "en-gb" dla języka angielskiego (Uk), "es" dla języka hiszpańskiego itp.
location	string	Reprezentuje ścieżkę dokumentu.
projectKind	string: CustomEntityRecognition	Reprezentuje rodzaj projektu.

TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult

Reprezentuje wynik oceny dokumentu dla niestandardowego projektu klasyfikacji z wieloma etykietami.

Nazwa	Typ	Opis
customMultiLabelClassificationResult	TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult	Reprezentuje przewidywanie oceny dla klasyfikacji wielu etykiet.
language	string	Reprezentuje język dokumentu. Jest to reprezentacja języka BCP-47. Na przykład użyj "en" dla języka angielskiego, "en-gb" dla języka angielskiego (Uk), "es" dla języka hiszpańskiego itp.
location	string	Reprezentuje ścieżkę dokumentu.
projectKind	string: CustomMultiLabelClassification	Reprezentuje rodzaj projektu.

TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult

Reprezentuje wynik oceny dokumentu dla niestandardowego projektu klasyfikacji pojedynczej etykiety.

Nazwa	Typ	Opis
customSingleLabelClassificationResult	TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult	Reprezentuje przewidywanie oceny klasyfikacji pojedynczej etykiety.
language	string	Reprezentuje język dokumentu. Jest to reprezentacja języka BCP-47. Na przykład użyj "en" dla języka angielskiego, "en-gb" dla języka angielskiego (Uk), "es" dla języka hiszpańskiego itp.
location	string	Reprezentuje ścieżkę dokumentu.
projectKind	string: CustomSingleLabelClassification	Reprezentuje rodzaj projektu.

TextAnalysisAuthoringDocumentEntityLabelEvaluationResult

Reprezentuje etykietę jednostki wyniku oceny.

Nazwa	Typ	Opis
category	string	Reprezentuje kategorię jednostki.
length	integer	Reprezentuje długość jednostki.
offset	integer	Reprezentuje indeks przesunięcia jednostki względem oryginalnego tekstu.

TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult

Reprezentuje wynik oceny rozpoznawania jednostek dla dokumentu.

Nazwa	Typ	Opis
entities	TextAnalysisAuthoringDocumentEntityRegionEvaluationResult[]	Reprezentuje jednostki oznaczone dokumentem.

TextAnalysisAuthoringDocumentEntityRegionEvaluationResult

Reprezentuje porównanie oceny między oczekiwaną i przewidywaną jednostkami regionu dokumentu.

Nazwa	Typ	Opis
expectedEntities	TextAnalysisAuthoringDocumentEntityLabelEvaluationResult[]	Reprezentuje oczekiwane etykiety jednostek regionu.
predictedEntities	TextAnalysisAuthoringDocumentEntityLabelEvaluationResult[]	Reprezentuje przewidywane etykiety jednostek regionu.
regionLength	integer	Reprezentuje długość regionu.
regionOffset	integer	Reprezentuje przesunięcie regionu.

TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult

Reprezentuje porównanie oczekiwanych i przewidywanych klas, które są wynikiem operacji oceny.

Nazwa	Typ	Opis
expectedClasses	string[]	Reprezentuje oczekiwane klasy dokumentu.
predictedClasses	string[]	Reprezentuje przewidywane klasy dokumentu.

TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult

Reprezentuje porównanie oczekiwanej i przewidywanej klasy, która wynika z operacji oceny.

Nazwa	Typ	Opis
expectedClass	string	Reprezentuje oczekiwaną klasę dokumentu.
predictedClass	string	Reprezentuje przewidywaną klasę dokumentu.

Udostępnij za pośrednictwem