Text Analysis Authoring - Get Model Evaluation Results

Referens

Tjänst:: Azure AI Services

API-version:: 2023-04-01

Hämtar detaljerade resultat av utvärderingen för en tränad modell. Detta inkluderar råa slutsatsdragningsresultat för de data som ingår i utvärderingsprocessen.

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

Med valfria parametrar:

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-parametrar

Name	I	Obligatorisk	Typ	Description
Endpoint	path	True	string url	Cognitive Services-slutpunkt som stöds, t.ex. https://.api.cognitiveservices.azure.com.
projectName	path	True	string	Det nya projektnamnet.
trainedModelLabel	path	True	string	Den tränade modelletiketten.
api-version	query	True	string	DEN API-version som ska användas för den här åtgärden.
stringIndexType	query	True	StringIndexType	Anger den metod som används för att tolka strängförskjutningar. Mer information finns i https://aka.ms/text-analytics-offsets.
maxpagesize	query		integer int32	Det maximala antalet resultatobjekt per sida.
skip	query		integer int32	Antalet resultatobjekt som ska hoppa över.
top	query		integer int32	Antalet resultatobjekt som ska returneras.

Svar

Name	Typ	Description
200 OK	PagedTextAnalysisAuthoringDocumentEvaluationResult	Begäran har slutförts.
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

OAuth2Auth

Typ: oauth2
Flow: accessCode
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize
Token-webbadress: https://login.microsoftonline.com/common/oauth2/token

Omfattningar

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

Exempel

SuccessfulGetModelEvaluation

Exempelbegäran

HTTP

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

Exempelsvar

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

Definitioner

Name	Description
Error	Felobjektet.
ErrorCode	Felkod som kan läsas av människor.
ErrorResponse	Felsvar.
InnerErrorCode	Felkod som kan läsas av människor.
InnerErrorModel	Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
PagedTextAnalysisAuthoringDocumentEvaluationResult	Paged collection of TextAnalysisAuthoringDocumentEvaluationResult items
ProjectKind
StringIndexType
TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult	Representerar resultatet av dokumentutvärderingen för ett anpassat entitetsigenkänningsprojekt.
TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult	Representerar resultatet av dokumentutvärderingen för ett anpassat klassificeringsprojekt med flera etiketter.
TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult	Representerar resultatet av dokumentutvärderingen för ett anpassat klassificeringsprojekt med en etikett.
TextAnalysisAuthoringDocumentEntityLabelEvaluationResult	Representerar en entitetsetikett för utvärderingsresultat.
TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult	Representerar utvärderingsresultatet för entitetsigenkänning för ett dokument.
TextAnalysisAuthoringDocumentEntityRegionEvaluationResult	Representerar utvärderingsjämförelsen mellan förväntade och förutsagda entiteter i en dokumentregion.
TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult	Representerar jämförelsen mellan de förväntade och förutsagda klasserna som är resultatet av utvärderingsåtgärden.
TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult	Representerar jämförelsen mellan den förväntade och förutsagda klassen som är resultatet av en utvärderingsåtgärd.

Error

Felobjektet.

Name	Typ	Description
code	ErrorCode	En av en serverdefinierad uppsättning felkoder.
details	Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

ErrorCode

Felkod som kan läsas av människor.

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

Felsvar.

Name	Typ	Description
error	Error	Felobjektet.

InnerErrorCode

Felkod som kan läsas av människor.

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

Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	InnerErrorCode	En av en serverdefinierad uppsättning felkoder.
details	object	Felinformation.
innererror	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	Felmeddelande.
target	string	Felmål.

PagedTextAnalysisAuthoringDocumentEvaluationResult

Paged collection of TextAnalysisAuthoringDocumentEvaluationResult items

Name	Typ	Description
nextLink	string	Länken till nästa sida med objekt
value	TextAnalysisAuthoringDocumentEvaluationResult[]: TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult[] TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult[] TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult[]	Objekten TextAnalysisAuthoringDocumentEvaluationResult på den här sidan

ProjectKind

Name	Typ	Description
CustomEntityRecognition	string	För att skapa en extraheringsmodell för att identifiera dina domänkategorier med dina egna data.
CustomMultiLabelClassification	string	För att skapa en klassificeringsmodell för att klassificera text med dina egna data. Varje fil kan ha en eller flera etiketter. Till exempel klassificeras fil 1 som A, B och C och fil 2 klassificeras som B och C.
CustomSingleLabelClassification	string	För att skapa en klassificeringsmodell för att klassificera text med dina egna data. Varje fil har bara en etikett. Till exempel klassificeras fil 1 som A och fil 2 klassificeras som B.

StringIndexType

Name	Typ	Description
Utf16CodeUnit	string	Förskjutnings- och längdvärdena motsvarar UTF-16-kodenheter. Använd det här alternativet om ditt program är skrivet på ett språk som stöder Unicode, till exempel Java, JavaScript.

TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult

Representerar resultatet av dokumentutvärderingen för ett anpassat entitetsigenkänningsprojekt.

Name	Typ	Description
customEntityRecognitionResult	TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult	Representerar utvärderingsförutsägelse för entitetsigenkänning.
language	string	Representerar dokumentspråket. Det här är BCP-47-representation av ett språk. Använd till exempel "en" för engelska, "en-gb" för engelska (Storbritannien), "es" för spanska osv.
location	string	Representerar dokumentsökvägen.
projectKind	string: CustomEntityRecognition	Representerar projekttypen.

TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult

Representerar resultatet av dokumentutvärderingen för ett anpassat klassificeringsprojekt med flera etiketter.

Name	Typ	Description
customMultiLabelClassificationResult	TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult	Representerar utvärderingsförutsägelse för klassificering av flera etiketter.
language	string	Representerar dokumentspråket. Det här är BCP-47-representation av ett språk. Använd till exempel "en" för engelska, "en-gb" för engelska (Storbritannien), "es" för spanska osv.
location	string	Representerar dokumentsökvägen.
projectKind	string: CustomMultiLabelClassification	Representerar projekttypen.

TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult

Representerar resultatet av dokumentutvärderingen för ett anpassat klassificeringsprojekt med en etikett.

Name	Typ	Description
customSingleLabelClassificationResult	TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult	Representerar utvärderingsförutsägelse för klassificering med en etikett.
language	string	Representerar dokumentspråket. Det här är BCP-47-representation av ett språk. Använd till exempel "en" för engelska, "en-gb" för engelska (Storbritannien), "es" för spanska osv.
location	string	Representerar dokumentsökvägen.
projectKind	string: CustomSingleLabelClassification	Representerar projekttypen.

TextAnalysisAuthoringDocumentEntityLabelEvaluationResult

Representerar en entitetsetikett för utvärderingsresultat.

Name	Typ	Description
category	string	Representerar entitetskategorin.
length	integer	Representerar entitetslängden.
offset	integer	Representerar entitetsförskjutningsindexet i förhållande till den ursprungliga texten.

TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult

Representerar utvärderingsresultatet för entitetsigenkänning för ett dokument.

Name	Typ	Description
entities	TextAnalysisAuthoringDocumentEntityRegionEvaluationResult[]	Representerar dokumentet märkta entiteter.

TextAnalysisAuthoringDocumentEntityRegionEvaluationResult

Representerar utvärderingsjämförelsen mellan förväntade och förutsagda entiteter i en dokumentregion.

Name	Typ	Description
expectedEntities	TextAnalysisAuthoringDocumentEntityLabelEvaluationResult[]	Representerar regionens förväntade entitetsetiketter.
predictedEntities	TextAnalysisAuthoringDocumentEntityLabelEvaluationResult[]	Representerar regionens förutsagda entitetsetiketter.
regionLength	integer	Representerar regionens längd.
regionOffset	integer	Representerar regionförskjutningen.

TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult

Representerar jämförelsen mellan de förväntade och förutsagda klasserna som är resultatet av utvärderingsåtgärden.

Name	Typ	Description
expectedClasses	string[]	Representerar dokumentets förväntade klasser.
predictedClasses	string[]	Representerar dokumentets förutsagda klasser.

TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult

Representerar jämförelsen mellan den förväntade och förutsagda klassen som är resultatet av en utvärderingsåtgärd.

Name	Typ	Description
expectedClass	string	Representerar dokumentets förväntade klass.
predictedClass	string	Representerar dokumentets förutsagda klass.

Dela via