Text Analysis Authoring - Get Model Evaluation Results

Referenz

Dienst:: Azure AI Services

API-Version:: 2023-04-01

Ruft die detaillierten Ergebnisse der Auswertung für ein trainiertes Modell ab. Dazu gehören die rohen Ableitungsergebnisse für die daten, die im Auswertungsprozess enthalten sind.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
Endpoint	path	True	string url	Unterstützter Cognitive Services-Endpunkt (z. B. https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Der neue Projektname.
trainedModelLabel	path	True	string	Das trainierte Modelletikett.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.
stringIndexType	query	True	StringIndexType	Gibt die Methode an, die zum Interpretieren von Zeichenfolgenversatzen verwendet wird. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets.
maxpagesize	query		integer int32	Die maximale Anzahl von Ergebniselementen pro Seite.
skip	query		integer int32	Die Anzahl der zu überspringenden Ergebniselemente.
top	query		integer int32	Die Anzahl der zurückzugebenden Ergebniselemente.

Antworten

Name	Typ	Beschreibung
200 OK	PagedTextAnalysisAuthoringDocumentEvaluationResult	Die Anforderung ist erfolgreich.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiche

Name	Beschreibung
https://cognitiveservices.azure.com/.default

Beispiele

SuccessfulGetModelEvaluation

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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"
}

Definitionen

Name	Beschreibung
Error	Das Fehlerobjekt.
ErrorCode	Lesbarer Fehlercode.
ErrorResponse	Fehlerantwort.
InnerErrorCode	Lesbarer Fehlercode.
InnerErrorModel	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
PagedTextAnalysisAuthoringDocumentEvaluationResult	Paged-Auflistung von TextAnalysisAuthoringDocumentEvaluationResult-Elementen
ProjectKind
StringIndexType
TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult	Stellt das Dokumentauswertungsergebnis für ein benutzerdefiniertes Entitätserkennungsprojekt dar.
TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult	Stellt das Dokumentauswertungsergebnis für ein benutzerdefiniertes Mehrbezeichnungsklassifizierungsprojekt dar.
TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult	Stellt das Dokumentauswertungsergebnis für ein benutzerdefiniertes Einzelbezeichnungsklassifizierungsprojekt dar.
TextAnalysisAuthoringDocumentEntityLabelEvaluationResult	Stellt eine Bezeichnung für die Auswertungsergebnisentität dar.
TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult	Stellt das Ergebnis der Entitätserkennungsauswertung für ein Dokument dar.
TextAnalysisAuthoringDocumentEntityRegionEvaluationResult	Stellt den Auswertungsvergleich zwischen den erwarteten und vorhergesagten Entitäten einer Dokumentregion dar.
TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult	Stellt den Vergleich zwischen den erwarteten und vorhergesagten Klassen dar, die aus dem Auswertungsvorgang resultieren.
TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult	Stellt den Vergleich zwischen der erwarteten und vorhergesagten Klasse dar, die aus einem Auswertungsvorgang resultiert.

Error

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	ErrorCode	Eine serverdefinierte Gruppe von Fehlercodes.
details	Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerErrorModel	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

ErrorCode

Lesbarer Fehlercode.

Name	Typ	Beschreibung
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

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

InnerErrorCode

Lesbarer Fehlercode.

Name	Typ	Beschreibung
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

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Beschreibung
code	InnerErrorCode	Eine serverdefinierte Gruppe von Fehlercodes.
details	object	Fehlerdetails.
innererror	InnerErrorModel	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Fehlermeldung.
target	string	Fehlerziel.

PagedTextAnalysisAuthoringDocumentEvaluationResult

Paged-Auflistung von TextAnalysisAuthoringDocumentEvaluationResult-Elementen

Name	Typ	Beschreibung
nextLink	string	Der Link zur nächsten Seite von Elementen
value	TextAnalysisAuthoringDocumentEvaluationResult[]: TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult[] TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult[] TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult[]	Die TextAnalysisAuthoringDocumentEvaluationResult-Elemente auf dieser Seite

ProjectKind

Name	Typ	Beschreibung
CustomEntityRecognition	string	Um ein Extraktionsmodell zu erstellen, um Ihre Domänenkategorien mithilfe Ihrer eigenen Daten zu identifizieren.
CustomMultiLabelClassification	string	Zum Erstellen eines Klassifizierungsmodells zum Klassifizieren von Text mithilfe ihrer eigenen Daten. Jede Datei kann über eine oder mehrere Bezeichnungen verfügen. Beispielsweise wird Datei 1 als A, B und C klassifiziert und Datei 2 als B und C klassifiziert.
CustomSingleLabelClassification	string	Zum Erstellen eines Klassifizierungsmodells zum Klassifizieren von Text mithilfe ihrer eigenen Daten. Jede Datei hat nur eine Bezeichnung. Die Datei 1 wird beispielsweise als A klassifiziert, und Datei 2 wird als B klassifiziert.

StringIndexType

Name	Typ	Beschreibung
Utf16CodeUnit	string	Die Offset- und Längenwerte entsprechen UTF-16-Codeeinheiten. Verwenden Sie diese Option, wenn Ihre Anwendung in einer Sprache geschrieben wird, die Unicode unterstützt, z. B. JavaScript.

TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult

Stellt das Dokumentauswertungsergebnis für ein benutzerdefiniertes Entitätserkennungsprojekt dar.

Name	Typ	Beschreibung
customEntityRecognitionResult	TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult	Stellt die Auswertungsvorhersage für die Entitätserkennung dar.
language	string	Stellt die Dokumentsprache dar. Dies ist die BCP-47-Darstellung einer Sprache. Verwenden Sie z. B. "en" für Englisch, "en-gb" für Englisch (UK), "es" für Spanisch usw.
location	string	Stellt den Dokumentpfad dar.
projectKind	string: CustomEntityRecognition	Stellt die Projektart dar.

TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult

Stellt das Dokumentauswertungsergebnis für ein benutzerdefiniertes Mehrbezeichnungsklassifizierungsprojekt dar.

Name	Typ	Beschreibung
customMultiLabelClassificationResult	TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult	Stellt die Auswertungsvorhersage für die Klassifizierung mit mehreren Bezeichnungen dar.
language	string	Stellt die Dokumentsprache dar. Dies ist die BCP-47-Darstellung einer Sprache. Verwenden Sie z. B. "en" für Englisch, "en-gb" für Englisch (UK), "es" für Spanisch usw.
location	string	Stellt den Dokumentpfad dar.
projectKind	string: CustomMultiLabelClassification	Stellt die Projektart dar.

TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult

Stellt das Dokumentauswertungsergebnis für ein benutzerdefiniertes Einzelbezeichnungsklassifizierungsprojekt dar.

Name	Typ	Beschreibung
customSingleLabelClassificationResult	TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult	Stellt die Auswertungsvorhersage für die Klassifizierung einzelner Bezeichnungen dar.
language	string	Stellt die Dokumentsprache dar. Dies ist die BCP-47-Darstellung einer Sprache. Verwenden Sie z. B. "en" für Englisch, "en-gb" für Englisch (UK), "es" für Spanisch usw.
location	string	Stellt den Dokumentpfad dar.
projectKind	string: CustomSingleLabelClassification	Stellt die Projektart dar.

TextAnalysisAuthoringDocumentEntityLabelEvaluationResult

Stellt eine Bezeichnung für die Auswertungsergebnisentität dar.

Name	Typ	Beschreibung
category	string	Stellt die Entitätskategorie dar.
length	integer	Stellt die Entitätslänge dar.
offset	integer	Stellt den Entitätsoffsetindex relativ zum ursprünglichen Text dar.

TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult

Stellt das Ergebnis der Entitätserkennungsauswertung für ein Dokument dar.

Name	Typ	Beschreibung
entities	TextAnalysisAuthoringDocumentEntityRegionEvaluationResult[]	Stellt die Entitäten des Dokuments dar.

TextAnalysisAuthoringDocumentEntityRegionEvaluationResult

Stellt den Auswertungsvergleich zwischen den erwarteten und vorhergesagten Entitäten einer Dokumentregion dar.

Name	Typ	Beschreibung
expectedEntities	TextAnalysisAuthoringDocumentEntityLabelEvaluationResult[]	Stellt die erwarteten Entitätsbezeichnungen der Region dar.
predictedEntities	TextAnalysisAuthoringDocumentEntityLabelEvaluationResult[]	Stellt die vorhergesagten Entitätsbezeichnungen der Region dar.
regionLength	integer	Stellt die Länge der Region dar.
regionOffset	integer	Stellt den Bereichsoffset dar.

TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult

Stellt den Vergleich zwischen den erwarteten und vorhergesagten Klassen dar, die aus dem Auswertungsvorgang resultieren.

Name	Typ	Beschreibung
expectedClasses	string[]	Stellt die erwarteten Klassen des Dokuments dar.
predictedClasses	string[]	Stellt die vorhergesagten Klassen des Dokuments dar.

TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult

Stellt den Vergleich zwischen der erwarteten und vorhergesagten Klasse dar, die aus einem Auswertungsvorgang resultiert.

Name	Typ	Beschreibung
expectedClass	string	Stellt die erwartete Klasse des Dokuments dar.
predictedClass	string	Stellt die vorhergesagte Klasse des Dokuments dar.

Freigeben über