Text Analysis Authoring - Get Model Evaluation Results

Référence

Service:: Azure AI Services

Version d'API:: 2023-04-01

Obtient les résultats détaillés de l’évaluation pour un modèle entraîné. Cela inclut les résultats d’inférence bruts pour les données incluses dans le processus d’évaluation.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
Endpoint	path	True	string url	Point de terminaison Cognitive Services pris en charge, par exemple, https://.api.cognitiveservices.azure.com.
projectName	path	True	string	Nouveau nom du projet.
trainedModelLabel	path	True	string	Étiquette de modèle entraînée.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.
stringIndexType	query	True	StringIndexType	Spécifie la méthode utilisée pour interpréter les décalages de chaîne. Pour plus d’informations, consultez https://aka.ms/text-analytics-offsets.
maxpagesize	query		integer int32	Nombre maximal d’éléments de résultat par page.
skip	query		integer int32	Nombre d’éléments de résultat à ignorer.
top	query		integer int32	Nombre d’éléments de résultat à retourner.

Réponses

Nom	Type	Description
200 OK	PagedTextAnalysisAuthoringDocumentEvaluationResult	La demande a réussi.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
Dans: header

OAuth2Auth

Type: oauth2
Flux: accessCode
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize
URL du jeton: https://login.microsoftonline.com/common/oauth2/token

Étendues

Nom	Description
https://cognitiveservices.azure.com/.default

Exemples

SuccessfulGetModelEvaluation

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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"
}

Définitions

Nom	Description
Error	Objet d’erreur.
ErrorCode	Code d’erreur lisible par l’homme.
ErrorResponse	Réponse d’erreur.
InnerErrorCode	Code d’erreur lisible par l’homme.
InnerErrorModel	Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
PagedTextAnalysisAuthoringDocumentEvaluationResult	Collection paginée des éléments TextAnalysisAuthoringDocumentEvaluationResult
ProjectKind
StringIndexType
TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult	Représente le résultat de l’évaluation du document pour un projet de reconnaissance d’entité personnalisé.
TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult	Représente le résultat de l’évaluation du document pour un projet de classification multi-étiquette personnalisé.
TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult	Représente le résultat de l’évaluation du document pour un projet de classification d’étiquette unique personnalisé.
TextAnalysisAuthoringDocumentEntityLabelEvaluationResult	Représente une étiquette d’entité de résultat d’évaluation.
TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult	Représente le résultat de l’évaluation de la reconnaissance d’entité pour un document.
TextAnalysisAuthoringDocumentEntityRegionEvaluationResult	Représente la comparaison d’évaluation entre les entités attendues et prédites d’une région de document.
TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult	Représente la comparaison entre les classes attendues et prédites résultant de l’opération d’évaluation.
TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult	Représente la comparaison entre la classe attendue et prédite résultant d’une opération d’évaluation.

Error

Objet d’erreur.

Nom	Type	Description
code	ErrorCode	Un ensemble de codes d’erreur définis par le serveur.
details	Error[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	InnerErrorModel	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

ErrorCode

Code d’erreur lisible par l’homme.

Nom	Type	Description
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

Réponse d’erreur.

Nom	Type	Description
error	Error	Objet d’erreur.

InnerErrorCode

Code d’erreur lisible par l’homme.

Nom	Type	Description
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

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nom	Type	Description
code	InnerErrorCode	Un ensemble de codes d’erreur définis par le serveur.
details	object	Détails de l’erreur.
innererror	InnerErrorModel	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Message d'erreur.
target	string	Cible d’erreur.

PagedTextAnalysisAuthoringDocumentEvaluationResult

Collection paginée des éléments TextAnalysisAuthoringDocumentEvaluationResult

Nom	Type	Description
nextLink	string	Lien vers la page suivante des éléments
value	TextAnalysisAuthoringDocumentEvaluationResult[]: TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult[] TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult[] TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult[]	Éléments TextAnalysisAuthoringDocumentEvaluationResult sur cette page

ProjectKind

Nom	Type	Description
CustomEntityRecognition	string	Pour créer un modèle d’extraction pour identifier vos catégories de domaine à l’aide de vos propres données.
CustomMultiLabelClassification	string	Pour créer un modèle de classification pour classifier du texte à l’aide de vos propres données. Chaque fichier peut avoir une ou plusieurs étiquettes. Par exemple, le fichier 1 est classé comme A, B et C et le fichier 2 est classé en tant que B et C.
CustomSingleLabelClassification	string	Pour créer un modèle de classification pour classifier du texte à l’aide de vos propres données. Chaque fichier n’aura qu’une seule étiquette. Par exemple, le fichier 1 est classé comme A et le fichier 2 est classé comme B.

StringIndexType

Nom	Type	Description
Utf16CodeUnit	string	Les valeurs de décalage et de longueur correspondent aux unités de code UTF-16. Utilisez cette option si votre application est écrite dans un langage qui prend en charge Unicode, par exemple JavaScript.

TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult

Représente le résultat de l’évaluation du document pour un projet de reconnaissance d’entité personnalisé.

Nom	Type	Description
customEntityRecognitionResult	TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult	Représente la prédiction d’évaluation pour la reconnaissance d’entité.
language	string	Représente la langue du document. Il s’agit de la représentation BCP-47 d’une langue. Par exemple, utilisez « en » pour l’anglais, «en-gb» pour l’anglais (Royaume-Uni), « es » pour l’espagnol, etc.
location	string	Représente le chemin d’accès du document.
projectKind	string: CustomEntityRecognition	Représente le type de projet.

TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult

Représente le résultat de l’évaluation du document pour un projet de classification multi-étiquette personnalisé.

Nom	Type	Description
customMultiLabelClassificationResult	TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult	Représente la prédiction d’évaluation pour la classification multi-étiquette.
language	string	Représente la langue du document. Il s’agit de la représentation BCP-47 d’une langue. Par exemple, utilisez « en » pour l’anglais, «en-gb» pour l’anglais (Royaume-Uni), « es » pour l’espagnol, etc.
location	string	Représente le chemin d’accès du document.
projectKind	string: CustomMultiLabelClassification	Représente le type de projet.

TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult

Représente le résultat de l’évaluation du document pour un projet de classification d’étiquette unique personnalisé.

Nom	Type	Description
customSingleLabelClassificationResult	TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult	Représente la prédiction d’évaluation pour la classification d’étiquette unique.
language	string	Représente la langue du document. Il s’agit de la représentation BCP-47 d’une langue. Par exemple, utilisez « en » pour l’anglais, «en-gb» pour l’anglais (Royaume-Uni), « es » pour l’espagnol, etc.
location	string	Représente le chemin d’accès du document.
projectKind	string: CustomSingleLabelClassification	Représente le type de projet.

TextAnalysisAuthoringDocumentEntityLabelEvaluationResult

Représente une étiquette d’entité de résultat d’évaluation.

Nom	Type	Description
category	string	Représente la catégorie d’entité.
length	integer	Représente la longueur de l’entité.
offset	integer	Représente l’index de décalage d’entité par rapport au texte d’origine.

TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult

Représente le résultat de l’évaluation de la reconnaissance d’entité pour un document.

Nom	Type	Description
entities	TextAnalysisAuthoringDocumentEntityRegionEvaluationResult[]	Représente les entités étiquetées du document.

TextAnalysisAuthoringDocumentEntityRegionEvaluationResult

Représente la comparaison d’évaluation entre les entités attendues et prédites d’une région de document.

Nom	Type	Description
expectedEntities	TextAnalysisAuthoringDocumentEntityLabelEvaluationResult[]	Représente les étiquettes d’entité attendues de la région.
predictedEntities	TextAnalysisAuthoringDocumentEntityLabelEvaluationResult[]	Représente les étiquettes d’entité prédites de la région.
regionLength	integer	Représente la longueur de la région.
regionOffset	integer	Représente le décalage de région.

TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult

Représente la comparaison entre les classes attendues et prédites résultant de l’opération d’évaluation.

Nom	Type	Description
expectedClasses	string[]	Représente les classes attendues du document.
predictedClasses	string[]	Représente les classes prédites du document.

TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult

Représente la comparaison entre la classe attendue et prédite résultant d’une opération d’évaluation.

Nom	Type	Description
expectedClass	string	Représente la classe attendue du document.
predictedClass	string	Représente la classe prédite du document.

Partager via