Text Analysis Authoring - Get Model Evaluation Results

Referencia

Service:: Cognitive Services - Language

API Version:: 2023-04-01

Lekéri a betanított modell kiértékelésének részletes eredményeit. Ez magában foglalja a kiértékelési folyamat során szereplő adatok nyers következtetési eredményeit.

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-paraméterek

Name	In	Kötelező	Típus	Description
Endpoint	path	True	string	Támogatott Cognitive Services-végpont (pl. https://.api.cognitiveservices.azure.com).
projectName	path	True	string	A használni kívánt projekt neve.
trainedModelLabel	path	True	string	A betanított modell címkéje.
api-version	query	True	string	Ügyfél API-verziója.
stringIndexType	query	True	StringIndexType	Megadja a sztringeltolások értelmezéséhez használt metódust. További információ: https://aka.ms/text-analytics-offsets.
maxpagesize	query		integer int32	Az egyetlen válaszba belefoglalandó erőforrások maximális száma.
skip	query		integer int32	Az első visszaadandó erőforrás gyűjteményének eltolása.
top	query		integer int32	A gyűjteményből visszatérni kívánt erőforrások maximális száma.

Válaszok

Name	Típus	Description
200 OK	TextAnalysisAuthoringEvaluationResults	A kiértékelési eredmények listája.
Other Status Codes	ErrorResponse	Hibaválasz.

Biztonság

AADToken

Ezek az Azure Active Directory OAuth2-folyamatok . Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva szabályozható a Azure Maps REST API-khoz való hozzáférés. Az Azure szerepköralapú hozzáférés-vezérlői egy vagy több Azure Maps erőforrásfiókhoz vagy alerőforrásokhoz való hozzáférés kijelölésére szolgálnak. Bármely felhasználó, csoport vagy szolgáltatásnév hozzáférést kaphat egy beépített szerepkörrel vagy egy vagy több, a REST API-khoz Azure Maps engedélyekkel rendelkező egyéni szerepkörrel.

A forgatókönyvek implementálásához javasoljuk, hogy tekintse meg a hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást nyújt az alkalmazások modellezésére olyan objektumokon keresztül, amelyek hozzáférés-vezérlésre képesek adott API-kon és hatókörökön.

Jegyzetek

Ez a biztonsági definíció a fejléc használatával x-ms-client-id jelzi, hogy az alkalmazás melyik Azure Maps erőforráshoz kér hozzáférést. Ez a Térképek felügyeleti API-ból szerezhető be.

Ez Authorization URL az Azure nyilvános felhőpéldányára jellemző. A szuverén felhők egyedi engedélyezési URL-címekkel és Azure Active Directory-konfigurációkkal rendelkeznek. * Az Azure szerepköralapú hozzáférés-vezérlés az Azure felügyeleti síkjáról van konfigurálva Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával. * A Azure Maps Web SDK használata lehetővé teszi egy alkalmazás konfigurációalapú beállítását több használati esetben.

Jelenleg az Azure Active Directory 1.0-s vagy 2.0-s verziója támogatja a Munkahelyi, iskolai és vendégfelhasználói verziót, de nem támogatja a személyes fiókokat.

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

Scopes

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

Ocp-Apim-Subscription-Key

Egy language service-erőforrás előfizetési kulcsa.

Type: apiKey
In: header

Példák

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

Definíciók

Name	Description
Error	A hibaobjektum.
ErrorCode	Emberi olvasásra alkalmas hibakód.
ErrorResponse	Hibaválasz.
InnerErrorCode	Emberi olvasásra alkalmas hibakód.
InnerErrorModel	Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	A projekt típusa.
StringIndexType	Megadja a sztringeltolások értelmezéséhez használt metódust. További információ: https://aka.ms/text-analytics-offsets.
TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult	Egy egyéni entitásfelismerő projekt dokumentum-kiértékelési eredményét jelöli.
TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult	Egy egyéni többcímke-besorolási projekt dokumentum-kiértékelési eredményét jelöli.
TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult	Egy egyéni egycímke-besorolási projekt dokumentum-kiértékelési eredményét jelöli.
TextAnalysisAuthoringDocumentEntityLabelEvaluationResult	A kiértékelési eredmény entitáscímkéjét jelöli.
TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult	Egy dokumentum entitásfelismerési kiértékelési eredményét jelöli.
TextAnalysisAuthoringDocumentEntityRegionEvaluationResult	Egy dokumentumrégió várt és előrejelzett entitásainak kiértékelési összehasonlítását jelöli.
TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult	A kiértékelési műveletből származó várt és előrejelzett osztályok összehasonlítását jelöli.
TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult	A kiértékelési műveletből származó várt és előrejelzett osztály összehasonlítását jelöli.
TextAnalysisAuthoringEvaluationResults	Egy kiértékelési művelet eredményeinek listáját jelöli.

Error

A hibaobjektum.

Name	Típus	Description
code	ErrorCode	A kiszolgáló által definiált hibakódok egyike.
details	Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	InnerErrorModel	Egy objektum, amely az aktuális objektumnál pontosabb információkat tartalmaz a hibáról.
message	string	A hiba emberi olvasásra alkalmas ábrázolása.
target	string	A hiba célja.

ErrorCode

Emberi olvasásra alkalmas hibakód.

Name	Típus	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

Hibaválasz.

Name	Típus	Description
error	Error	A hibaobjektum.

InnerErrorCode

Emberi olvasásra alkalmas hibakód.

Name	Típus	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

Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Típus	Description
code	InnerErrorCode	A kiszolgáló által definiált hibakódok egyike.
details	object	Hiba részletei.
innererror	InnerErrorModel	Egy objektum, amely az aktuális objektumnál pontosabb információkat tartalmaz a hibáról.
message	string	Hibaüzenet.
target	string	Hibacél.

ProjectKind

A projekt típusa.

Name	Típus	Description
CustomEntityRecognition	string	Kinyerési modell létrehozásához, amely a saját adataival azonosítja a tartománykategóriákat.
CustomMultiLabelClassification	string	Besorolási modell létrehozásához a szöveg saját adatokkal történő besorolásához. Minden fájlhoz tartozhat egy vagy több címke. Az 1. fájl például A, B és C, a 2. fájl pedig B és C besorolású.
CustomSingleLabelClassification	string	Besorolási modell létrehozásához a szöveg saját adatokkal történő besorolásához. Minden fájlnak csak egy címkéje lesz. Az 1. fájl például A, a 2. fájl pedig B.

StringIndexType

Megadja a sztringeltolások értelmezéséhez használt metódust. További információ: https://aka.ms/text-analytics-offsets.

Name	Típus	Description
Utf16CodeUnit	string	Az eltolás és a hosszértékek UTF-16 kódegységeknek felelnek meg. Akkor használja ezt a lehetőséget, ha az alkalmazás Unicode-ot támogató nyelven van megírva, például Java, JavaScript.

TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult

Egy egyéni entitásfelismerő projekt dokumentum-kiértékelési eredményét jelöli.

Name	Típus	Description
customEntityRecognitionResult	TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult	Az entitásfelismerés kiértékelési előrejelzését jelöli.
language	string	A dokumentum nyelvét jelöli. Ez egy nyelv BCP-47-es reprezentációja. Használja például az "en" szót angolra, az "en-gb" szót angolra (UK), "es" spanyolra stb.
location	string	A dokumentum elérési útját jelöli.
projectKind	string: CustomEntityRecognition	A projekttípust jelöli.

TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult

Egy egyéni többcímke-besorolási projekt dokumentum-kiértékelési eredményét jelöli.

Name	Típus	Description
customMultiLabelClassificationResult	TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult	A többcímke-besorolás kiértékelési előrejelzését jelöli.
language	string	A dokumentum nyelvét jelöli. Ez egy nyelv BCP-47-es reprezentációja. Használja például az "en" szót angolra, az "en-gb" szót angolra (UK), "es" spanyolra stb.
location	string	A dokumentum elérési útját jelöli.
projectKind	string: CustomMultiLabelClassification	A projekttípust jelöli.

TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult

Egy egyéni egycímke-besorolási projekt dokumentum-kiértékelési eredményét jelöli.

Name	Típus	Description
customSingleLabelClassificationResult	TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult	Az egycímke-besorolás kiértékelési előrejelzését jelöli.
language	string	A dokumentum nyelvét jelöli. Ez egy nyelv BCP-47-es reprezentációja. Használja például az "en" szót angolra, az "en-gb" szót angolra (UK), "es" spanyolra stb.
location	string	A dokumentum elérési útját jelöli.
projectKind	string: CustomSingleLabelClassification	A projekttípust jelöli.

TextAnalysisAuthoringDocumentEntityLabelEvaluationResult

A kiértékelési eredmény entitáscímkéjét jelöli.

Name	Típus	Description
category	string	Az entitáskategóriát jelöli.
length	integer	Az entitás hosszát jelöli.
offset	integer	Az entitás eltolásindexét jelöli az eredeti szöveghez képest.

TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult

Egy dokumentum entitásfelismerési kiértékelési eredményét jelöli.

Name	Típus	Description
entities	TextAnalysisAuthoringDocumentEntityRegionEvaluationResult[]	A dokumentum címkével ellátott entitásokat jelöli.

TextAnalysisAuthoringDocumentEntityRegionEvaluationResult

Egy dokumentumrégió várt és előrejelzett entitásainak kiértékelési összehasonlítását jelöli.

Name	Típus	Description
expectedEntities	TextAnalysisAuthoringDocumentEntityLabelEvaluationResult[]	A régió várt entitáscímkéit jelöli.
predictedEntities	TextAnalysisAuthoringDocumentEntityLabelEvaluationResult[]	A régió előrejelzett entitáscímkéit jelöli.
regionLength	integer	A régió hosszát jelöli.
regionOffset	integer	A régió eltolását jelöli.

TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult

A kiértékelési műveletből származó várt és előrejelzett osztályok összehasonlítását jelöli.

Name	Típus	Description
expectedClasses	string[]	A dokumentum várt osztályainak felel meg.
predictedClasses	string[]	A dokumentum előrejelzett osztályainak felel meg.

TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult

A kiértékelési műveletből származó várt és előrejelzett osztály összehasonlítását jelöli.

Name	Típus	Description
expectedClass	string	A dokumentum várt osztályát jelöli.
predictedClass	string	A dokumentum előrejelzett osztályát jelöli.

TextAnalysisAuthoringEvaluationResults

Egy kiértékelési művelet eredményeinek listáját jelöli.

Name	Típus	Description
nextLink	string	A következő oldal hivatkozása.
value	TextAnalysisAuthoringDocumentEvaluationResult[]: TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult[] TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult[] TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult[]	A dokumentumok kiértékelési eredményeinek THe-listája.

Megosztás a következőn keresztül: