Text Analysis Authoring - Get Model Evaluation Results

Riferimento

Service:: Cognitive Services - Language

API Version:: 2023-04-01

Ottiene i risultati dettagliati della valutazione per un modello sottoposto a training. Ciò include i risultati dell'inferenza non elaborata per i dati inclusi nel processo di valutazione.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
Endpoint	path	True	string	Endpoint servizi cognitivi supportati (ad esempio, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Nome del progetto da usare.
trainedModelLabel	path	True	string	Etichetta del modello con training.
api-version	query	True	string	Versione API client.
stringIndexType	query	True	StringIndexType	Specifica il metodo usato per interpretare gli offset di stringa. Per ulteriori informazioni, vedere https://aka.ms/text-analytics-offsets.
maxpagesize	query		integer int32	Numero massimo di risorse da includere in una singola risposta.
skip	query		integer int32	Offset nella raccolta della prima risorsa da restituire.
top	query		integer int32	Numero massimo di risorse da restituire dalla raccolta.

Risposte

Nome	Tipo	Descrizione
200 OK	TextAnalysisAuthoringEvaluationResults	Elenco dei risultati della valutazione.
Other Status Codes	ErrorResponse	Risposta di errore.

Sicurezza

AADToken

Si tratta dei flussi OAuth2 di Azure Active Directory . Quando è associato al controllo degli accessi in base al ruolo di Azure, può essere usato per controllare l'accesso alle API REST Mappe di Azure. I controlli di accesso basati sul ruolo di Azure vengono usati per designare l'accesso a uno o più Mappe di Azure account delle risorse o alle sotto-risorse. Qualsiasi utente, gruppo o entità servizio può essere concesso l'accesso tramite un ruolo predefinito o un ruolo personalizzato composto da una o più autorizzazioni per Mappe di Azure API REST.

Per implementare scenari, è consigliabile visualizzare i concetti di autenticazione. In riepilogo, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso in API e ambiti specifici.

Note

Questa definizione di sicurezza richiede l'uso dell'intestazione x-ms-client-id per indicare quale Mappe di Azure risorsa a cui l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione mappe.

L'oggetto Authorization URL è specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani dispongono di URL di autorizzazione univoci e configurazioni di Azure Active Directory. * Il controllo degli accessi in base al ruolo di Azure viene configurato dal piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, SDK di Azure o API REST. * L'utilizzo dell'SDK Web Mappe di Azure consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.

Attualmente, Azure Active Directory v1.0 o v2.0 supporta Work, School e Guest, ma non supporta gli account Personali.

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

Scopes

Nome	Descrizione
https://cognitiveservices.azure.com/.default	https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

Chiave di sottoscrizione per una risorsa del servizio lingua.

Type: apiKey
In: header

Esempio

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

Definizioni

Nome	Descrizione
Error	Oggetto error.
ErrorCode	Codice di errore leggibile dall'utente.
ErrorResponse	Risposta di errore.
InnerErrorCode	Codice di errore leggibile dall'utente.
InnerErrorModel	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida per l'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	Tipo di progetto.
StringIndexType	Specifica il metodo usato per interpretare gli offset di stringa. Per ulteriori informazioni, vedere https://aka.ms/text-analytics-offsets.
TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult	Rappresenta il risultato della valutazione del documento per un progetto di riconoscimento delle entità personalizzato.
TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult	Rappresenta il risultato della valutazione del documento per un progetto di classificazione multi-etichetta personalizzato.
TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult	Rappresenta il risultato della valutazione del documento per un progetto di classificazione a etichetta singola personalizzato.
TextAnalysisAuthoringDocumentEntityLabelEvaluationResult	Rappresenta un'etichetta di entità dei risultati della valutazione.
TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult	Rappresenta il risultato della valutazione del riconoscimento delle entità per un documento.
TextAnalysisAuthoringDocumentEntityRegionEvaluationResult	Rappresenta il confronto di valutazione tra le entità previste e stimate di un'area del documento.
TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult	Rappresenta il confronto tra le classi previste e stimate risultanti dall'operazione di valutazione.
TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult	Rappresenta il confronto tra la classe prevista e stimata risultante da un'operazione di valutazione.
TextAnalysisAuthoringEvaluationResults	Rappresenta un elenco di risultati per un'operazione di valutazione.

Error

Oggetto error.

Nome	Tipo	Descrizione
code	ErrorCode	Uno di un set definito dal server di codici di errore.
details	Error[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

ErrorCode

Codice di errore leggibile dall'utente.

Nome	Tipo	Descrizione
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

Risposta di errore.

Nome	Tipo	Descrizione
error	Error	Oggetto error.

InnerErrorCode

Codice di errore leggibile dall'utente.

Nome	Tipo	Descrizione
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

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida per l'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Descrizione
code	InnerErrorCode	Uno di un set definito dal server di codici di errore.
details	object	Dettagli degli errori.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Messaggio di errore.
target	string	Destinazione errore.

ProjectKind

Tipo di progetto.

Nome	Tipo	Descrizione
CustomEntityRecognition	string	Per creare un modello di estrazione per identificare le categorie di dominio usando i propri dati.
CustomMultiLabelClassification	string	Per creare un modello di classificazione per classificare il testo usando i propri dati. Ogni file può avere una o più etichette. Ad esempio, il file 1 viene classificato come A, B e C e file 2 è classificato come B e C.
CustomSingleLabelClassification	string	Per creare un modello di classificazione per classificare il testo usando i propri dati. Ogni file avrà solo un'etichetta. Ad esempio, il file 1 viene classificato come A e file 2 è classificato come B.

StringIndexType

Specifica il metodo usato per interpretare gli offset di stringa. Per ulteriori informazioni, vedere https://aka.ms/text-analytics-offsets.

Nome	Tipo	Descrizione
Utf16CodeUnit	string	I valori di offset e lunghezza corrispondono alle unità di codice UTF-16. Usare questa opzione se l'applicazione è scritta in un linguaggio che supporta Unicode, ad esempio JavaScript.

TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult

Rappresenta il risultato della valutazione del documento per un progetto di riconoscimento delle entità personalizzato.

Nome	Tipo	Descrizione
customEntityRecognitionResult	TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult	Rappresenta la stima di valutazione per il riconoscimento delle entità.
language	string	Rappresenta la lingua del documento. Si tratta della rappresentazione BCP-47 di una lingua. Ad esempio, usare "en" per inglese, "en-gb" per inglese (UK), "es" per spagnolo e così via.
location	string	Rappresenta il percorso del documento.
projectKind	string: CustomEntityRecognition	Rappresenta il tipo di progetto.

TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult

Rappresenta il risultato della valutazione del documento per un progetto di classificazione multi-etichetta personalizzato.

Nome	Tipo	Descrizione
customMultiLabelClassificationResult	TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult	Rappresenta la stima di valutazione per la classificazione a più etichette.
language	string	Rappresenta la lingua del documento. Si tratta della rappresentazione BCP-47 di una lingua. Ad esempio, usare "en" per inglese, "en-gb" per inglese (UK), "es" per spagnolo e così via.
location	string	Rappresenta il percorso del documento.
projectKind	string: CustomMultiLabelClassification	Rappresenta il tipo di progetto.

TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult

Rappresenta il risultato della valutazione del documento per un progetto di classificazione a etichetta singola personalizzato.

Nome	Tipo	Descrizione
customSingleLabelClassificationResult	TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult	Rappresenta la stima di valutazione per la classificazione dell'etichetta singola.
language	string	Rappresenta la lingua del documento. Si tratta della rappresentazione BCP-47 di una lingua. Ad esempio, usare "en" per inglese, "en-gb" per inglese (UK), "es" per spagnolo e così via.
location	string	Rappresenta il percorso del documento.
projectKind	string: CustomSingleLabelClassification	Rappresenta il tipo di progetto.

TextAnalysisAuthoringDocumentEntityLabelEvaluationResult

Rappresenta un'etichetta di entità dei risultati della valutazione.

Nome	Tipo	Descrizione
category	string	Rappresenta la categoria di entità.
length	integer	Rappresenta la lunghezza dell'entità.
offset	integer	Rappresenta l'indice di offset dell'entità rispetto al testo originale.

TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult

Rappresenta il risultato della valutazione del riconoscimento delle entità per un documento.

Nome	Tipo	Descrizione
entities	TextAnalysisAuthoringDocumentEntityRegionEvaluationResult[]	Rappresenta le entità etichettate dal documento.

TextAnalysisAuthoringDocumentEntityRegionEvaluationResult

Rappresenta il confronto di valutazione tra le entità previste e stimate di un'area del documento.

Nome	Tipo	Descrizione
expectedEntities	TextAnalysisAuthoringDocumentEntityLabelEvaluationResult[]	Rappresenta le etichette di entità previste dell'area.
predictedEntities	TextAnalysisAuthoringDocumentEntityLabelEvaluationResult[]	Rappresenta le etichette di entità stimate dell'area.
regionLength	integer	Rappresenta la lunghezza dell'area.
regionOffset	integer	Rappresenta l'offset dell'area.

TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult

Rappresenta il confronto tra le classi previste e stimate risultanti dall'operazione di valutazione.

Nome	Tipo	Descrizione
expectedClasses	string[]	Rappresenta le classi previste del documento.
predictedClasses	string[]	Rappresenta le classi stimate del documento.

TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult

Rappresenta il confronto tra la classe prevista e stimata risultante da un'operazione di valutazione.

Nome	Tipo	Descrizione
expectedClass	string	Rappresenta la classe prevista del documento.
predictedClass	string	Rappresenta la classe stimata del documento.

TextAnalysisAuthoringEvaluationResults

Rappresenta un elenco di risultati per un'operazione di valutazione.

Nome	Tipo	Descrizione
nextLink	string	Collegamento alla pagina successiva.
value	TextAnalysisAuthoringDocumentEvaluationResult[]: TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult[] TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult[] TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult[]	Elenco dei risultati della valutazione dei documenti.

Condividi tramite