Conversational 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-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/result?stringIndexType=Utf16CodeUnit&api-version=2023-04-01

With optional parameters:

GET {Endpoint}/language/authoring/analyze-conversations/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	ConversationalAnalysisAuthoringEvaluationResults	A kiértékelési előrejelzések 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-conversations/projects/EmailApp/models/model1/evaluation/result?stringIndexType=Utf16CodeUnit&maxpagesize=10&api-version=2023-04-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "text": "send the email",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [],
        "predictedEntities": []
      },
      "intentsResult": {
        "expectedIntent": "SendEmail",
        "predictedIntent": "SendEmail"
      }
    },
    {
      "text": "send a mail to daniel",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [
          {
            "category": "ContactName",
            "offset": 15,
            "length": 6
          }
        ],
        "predictedEntities": [
          {
            "category": "ContactName",
            "offset": 15,
            "length": 6
          }
        ]
      },
      "intentsResult": {
        "expectedIntent": "SendEmail",
        "predictedIntent": "SendEmail"
      }
    },
    {
      "text": "i forgot to add an important part to that email to james . please set it up to edit",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [
          {
            "category": "ContactName",
            "offset": 51,
            "length": 5
          }
        ],
        "predictedEntities": [
          {
            "category": "Category",
            "offset": 19,
            "length": 9
          },
          {
            "category": "ContactName",
            "offset": 51,
            "length": 5
          }
        ]
      },
      "intentsResult": {
        "expectedIntent": "AddMore",
        "predictedIntent": "AddMore"
      }
    },
    {
      "text": "send email to a and tian",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [
          {
            "category": "ContactName",
            "offset": 14,
            "length": 1
          },
          {
            "category": "ContactName",
            "offset": 20,
            "length": 4
          }
        ],
        "predictedEntities": [
          {
            "category": "ContactName",
            "offset": 14,
            "length": 1
          },
          {
            "category": "ContactName",
            "offset": 20,
            "length": 4
          }
        ]
      },
      "intentsResult": {
        "expectedIntent": "SendEmail",
        "predictedIntent": "SendEmail"
      }
    },
    {
      "text": "send thomas an email",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [
          {
            "category": "ContactName",
            "offset": 5,
            "length": 6
          }
        ],
        "predictedEntities": [
          {
            "category": "ContactName",
            "offset": 5,
            "length": 6
          }
        ]
      },
      "intentsResult": {
        "expectedIntent": "SendEmail",
        "predictedIntent": "SendEmail"
      }
    },
    {
      "text": "i need to add more to the email message i am sending to vincent",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [
          {
            "category": "ContactName",
            "offset": 56,
            "length": 7
          }
        ],
        "predictedEntities": [
          {
            "category": "ContactName",
            "offset": 56,
            "length": 7
          }
        ]
      },
      "intentsResult": {
        "expectedIntent": "AddMore",
        "predictedIntent": "AddMore"
      }
    },
    {
      "text": "send an email to lily roth and abc123@microsoft.com",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [
          {
            "category": "ContactName",
            "offset": 17,
            "length": 9
          }
        ],
        "predictedEntities": [
          {
            "category": "ContactName",
            "offset": 17,
            "length": 9
          }
        ]
      },
      "intentsResult": {
        "expectedIntent": "SendEmail",
        "predictedIntent": "SendEmail"
      }
    },
    {
      "text": "i need to add something else to my email to cheryl",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [
          {
            "category": "ContactName",
            "offset": 44,
            "length": 6
          }
        ],
        "predictedEntities": [
          {
            "category": "ContactName",
            "offset": 44,
            "length": 6
          }
        ]
      },
      "intentsResult": {
        "expectedIntent": "AddMore",
        "predictedIntent": "AddMore"
      }
    },
    {
      "text": "send an email to larry , joseph and billy larkson",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [
          {
            "category": "ContactName",
            "offset": 17,
            "length": 5
          },
          {
            "category": "ContactName",
            "offset": 25,
            "length": 6
          },
          {
            "category": "ContactName",
            "offset": 36,
            "length": 13
          }
        ],
        "predictedEntities": [
          {
            "category": "ContactName",
            "offset": 17,
            "length": 5
          },
          {
            "category": "ContactName",
            "offset": 25,
            "length": 6
          },
          {
            "category": "ContactName",
            "offset": 36,
            "length": 13
          }
        ]
      },
      "intentsResult": {
        "expectedIntent": "SendEmail",
        "predictedIntent": "SendEmail"
      }
    },
    {
      "text": "send mail to dorothy",
      "language": "en-us",
      "entitiesResult": {
        "expectedEntities": [
          {
            "category": "ContactName",
            "offset": 13,
            "length": 7
          }
        ],
        "predictedEntities": [
          {
            "category": "ContactName",
            "offset": 13,
            "length": 7
          }
        ]
      },
      "intentsResult": {
        "expectedIntent": "SendEmail",
        "predictedIntent": "SendEmail"
      }
    }
  ],
  "nextLink": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/models/model1/evaluation/result/?api-version=2023-04-01&top=2147483637&skip={maxpagesize}&maxpagesize={maxpagesize}"
}

Definíciók

Name	Description
ConversationalAnalysisAuthoringEvaluationResults	A kimondott szövegek kiértékelési eredményeinek listáját jeleníti meg.
ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult	A kimondott szöveg várt és előrejelzett entitásainak összehasonlítását jelöli.
ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult	Egy entitáscímke vagy előrejelzés kiértékelési kimenetét jelöli.
ConversationalAnalysisAuthoringUtteranceEvaluationResult	Egy kimondott szöveg kiértékelési eredményét jelöli.
ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult	Egy kimondott szöveg várt és előrejelzett szándékának összehasonlítását jelöli.
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.
StringIndexType	Megadja a sztringeltolások értelmezéséhez használt metódust. További információ: https://aka.ms/text-analytics-offsets.

ConversationalAnalysisAuthoringEvaluationResults

A kimondott szövegek kiértékelési eredményeinek listáját jeleníti meg.

Name	Típus	Description
nextLink	string	A következő oldal hivatkozása.
value	ConversationalAnalysisAuthoringUtteranceEvaluationResult[]	A kimondott szövegek kiértékelési eredményei.

ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult

A kimondott szöveg várt és előrejelzett entitásainak összehasonlítását jelöli.

Name	Típus	Description
expectedEntities	ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult[]	A várt entitáscímkéket jelöli.
predictedEntities	ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult[]	Az előrejelzett entitáscímkéket jelöli.

ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult

Egy entitáscímke vagy előrejelzés kiértékelési kimeneté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.

ConversationalAnalysisAuthoringUtteranceEvaluationResult

Egy kimondott szöveg kiértékelési eredményét jelöli.

Name	Típus	Description
entitiesResult	ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult	A kimondott szöveg entitásainak eredményeit jelöli.
intentsResult	ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult	A kimondott szöveg szándékainak eredményeit jelöli.
language	string	A kimondott szöveg 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.
text	string	A kimondott szövegrészt jelöli.

ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult

Egy kimondott szöveg várt és előrejelzett szándékának összehasonlítását jelöli.

Name	Típus	Description
expectedIntent	string	A kimondott szöveg várt szándékát jelöli.
predictedIntent	string	A kimondott szöveg előrejelzett szándéká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