Text Analysis Authoring - Get Model Evaluation Results

Referenz

Service:: Cognitive Services - Language

API Version:: 2023-04-01

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

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

With optional parameters:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
Endpoint	path	True	string	Unterstützter Cognitive Services-Endpunkt (z. B. https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Der Name des zu verwendenden Projekts.
trainedModelLabel	path	True	string	Die trainierte Modellbezeichnung.
api-version	query	True	string	Client-API-Version.
stringIndexType	query	True	StringIndexType	Gibt die Methode an, die zum Interpretieren von Zeichenfolgenoffsets verwendet wird. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets.
maxpagesize	query		integer int32	Die maximale Anzahl von Ressourcen, die in eine einzelne Antwort eingeschlossen werden sollen.
skip	query		integer int32	Ein Offset in die Auflistung der ersten ressource, die zurückgegeben werden soll.
top	query		integer int32	Die maximale Anzahl von Ressourcen, die aus der Auflistung zurückgegeben werden sollen.

Antworten

Name	Typ	Beschreibung
200 OK	TextAnalysisAuthoringEvaluationResults	Liste der Auswertungsergebnisse.
Other Status Codes	ErrorResponse	Fehlerantwort.

Sicherheit

AADToken

Dies sind die Azure Active Directory OAuth2 Flows. Wenn sie mit der rollenbasierten Zugriffssteuerung in Azure gekoppelt ist, kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps Ressourcenkonto oder Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder jedem Dienstprinzipal kann Zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps REST-APIs besteht.

Zum Implementieren von Szenarien empfiehlt es sich, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die auf bestimmte APIs und Bereiche zugreifen können.

Hinweise

Diese Sicherheitsdefinition erfordert die Verwendung des x-ms-client-id Headers, um anzugeben, auf welche Azure Maps Ressource die Anwendung Zugriff anfordert. Dies kann über die Kartenverwaltungs-API abgerufen werden.

Der Authorization URL ist spezifisch für die öffentliche Azure-Cloud-instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Azure Active Directory-Konfigurationen. * Die rollenbasierte Zugriffssteuerung in Azure wird über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert. * Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.

Derzeit unterstützt Azure Active Directory v1.0 oder v2.0 Work, School und Guests, aber keine persönlichen Konten.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Ocp-Apim-Subscription-Key

Ein Abonnementschlüssel für eine Sprachdienstressource.

Type: apiKey
In: header

Beispiele

Successful Get Model Evaluation

Sample Request

HTTP

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

Sample Response

Status code:: 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": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/models/model2/evaluation/result/?api-version=2023-04-01&top=2147483645&skip={maxpagesize}&maxpagesize={maxpagesize}"
}

Definitionen

Name	Beschreibung
Error	Das Fehlerobjekt.
ErrorCode	Für Menschen lesbarer Fehlercode.
ErrorResponse	Fehlerantwort.
InnerErrorCode	Für Menschen 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.
ProjectKind	Die Projektart.
StringIndexType	Gibt die Methode an, die zum Interpretieren von Zeichenfolgenoffsets verwendet wird. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets.
TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult	Stellt das Dokumentauswertungsergebnis für ein projekt zur Benutzerdefinierten Entitätserkennung dar.
TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult	Stellt das Dokumentauswertungsergebnis für ein benutzerdefiniertes Klassifizierungsprojekt mit mehreren Bezeichnungen dar.
TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult	Stellt das Dokumentauswertungsergebnis für ein benutzerdefiniertes Klassifizierungsprojekt mit nur einer Bezeichnung dar.
TextAnalysisAuthoringDocumentEntityLabelEvaluationResult	Stellt eine Bewertungsergebnisentitätsbezeichnung dar.
TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult	Stellt das Ergebnis der Entitätserkennungsbewertung für ein Dokument dar.
TextAnalysisAuthoringDocumentEntityRegionEvaluationResult	Stellt den Auswertungsvergleich zwischen den erwarteten und vorhergesagten Entitäten eines Dokumentbereichs dar.
TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult	Stellt den Vergleich zwischen den erwarteten und vorhergesagten Klassen dar, die sich aus dem Auswertungsvorgang ergeben.
TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult	Stellt den Vergleich zwischen der erwarteten und der vorhergesagten Klasse dar, die sich aus einem Auswertungsvorgang ergeben.
TextAnalysisAuthoringEvaluationResults	Stellt eine Liste der Ergebnisse für einen Auswertungsvorgang dar.

Error

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	ErrorCode	Einer der vom Server definierten 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 für Menschen lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

ErrorCode

Für Menschen 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

Für Menschen 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	Einer der vom Server definierten 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.

ProjectKind

Die Projektart.

Name	Typ	Beschreibung
CustomEntityRecognition	string	Zum Erstellen eines Extraktionsmodells zum Identifizieren Ihrer Domänenkategorien mithilfe Ihrer eigenen Daten.
CustomMultiLabelClassification	string	Zum Erstellen eines Klassifizierungsmodells zum Klassifizieren von Text mithilfe Ihrer eigenen Daten. Jede Datei kann eine oder mehrere Bezeichnungen aufweisen. Beispielsweise wird Datei 1 als A, B und C klassifiziert, und Datei 2 wird 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. Beispielsweise wird Datei 1 als A und Datei 2 als B klassifiziert.

StringIndexType

Gibt die Methode an, die zum Interpretieren von Zeichenfolgenoffsets verwendet wird. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets.

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 ist, die Unicode unterstützt, z. B. Java, JavaScript.

TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult

Stellt das Dokumentauswertungsergebnis für ein projekt zur Benutzerdefinierten Entitätserkennung dar.

Name	Typ	Beschreibung
customEntityRecognitionResult	TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult	Stellt die Auswertungsvorhersage für die Entitätserkennung dar.
language	string	Stellt die Dokumentsprache dar. Dies ist BCP-47-Darstellung einer Sprache. Verwenden Sie beispielsweise "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 Klassifizierungsprojekt mit mehreren Bezeichnungen 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 BCP-47-Darstellung einer Sprache. Verwenden Sie beispielsweise "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 Klassifizierungsprojekt mit nur einer Bezeichnung dar.

Name	Typ	Beschreibung
customSingleLabelClassificationResult	TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult	Stellt die Auswertungsvorhersage für die Klassifizierung mit einer einzelnen Bezeichnung dar.
language	string	Stellt die Dokumentsprache dar. Dies ist BCP-47-Darstellung einer Sprache. Verwenden Sie beispielsweise "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 Bewertungsergebnisentitätsbezeichnung 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ätserkennungsbewertung für ein Dokument dar.

Name	Typ	Beschreibung
entities	TextAnalysisAuthoringDocumentEntityRegionEvaluationResult[]	Stellt die mit Dokument beschrifteten Entitäten dar.

TextAnalysisAuthoringDocumentEntityRegionEvaluationResult

Stellt den Auswertungsvergleich zwischen den erwarteten und vorhergesagten Entitäten eines Dokumentbereichs 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 Regionsoffset dar.

TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult

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

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 der vorhergesagten Klasse dar, die sich aus einem Auswertungsvorgang ergeben.

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

TextAnalysisAuthoringEvaluationResults

Stellt eine Liste der Ergebnisse für einen Auswertungsvorgang dar.

Name	Typ	Beschreibung
nextLink	string	Der Link zur nächsten Seite.
value	TextAnalysisAuthoringDocumentEvaluationResult[]: TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult[] TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult[] TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult[]	Die Liste der Ergebnisse der Dokumentenauswertung.

Share via