Conversational Analysis Authoring - Get Model Evaluation Results

Reference

Service:: Azure AI Services

API Version:: 2022-05-01

Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process.

GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/result?stringIndexType=Utf16CodeUnit&api-version=2022-05-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=2022-05-01

URI Parameters

Name	In	Required	Type	Description
Endpoint	path	True	string	Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100	The name of the project to use.
trainedModelLabel	path	True	string	The trained model label.
api-version	query	True	string	Client API version.
stringIndexType	query	True	StringIndexType	Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.
maxpagesize	query		integer (int32)	The maximum number of resources to include in a single response.
skip	query		integer (int32)	An offset into the collection of the first resource to be returned.
top	query		integer (int32)	The maximum number of resources to return from the collection.

Request Header

Name	Required	Type	Description
Ocp-Apim-Subscription-Key	True	string	A subscription key for a Language service resource.

Responses

Name	Type	Description
200 OK	ConversationalAnalysisAuthoringEvaluationResults	List of the evaluation predictions.
Other Status Codes	ErrorResponse	Error response.

Security

Ocp-Apim-Subscription-Key

A subscription key for a Language service resource.

Type: apiKey
In: header

Examples

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=2022-05-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 [email protected]",
      "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=2022-05-01&top=2147483637&skip=10&maxpagesize=10"
}

Definitions

Name	Description
ConversationalAnalysisAuthoringEvaluationResults	Represent a list of utterances' evaluation results.
ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult	Represents the comparison between the expected and predicted entities for an utterance.
ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult	Represents the evaluation output of an entity label or prediction.
ConversationalAnalysisAuthoringUtteranceEvaluationResult	Represents the evaluation result for an utterance.
ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult	Represents the comparison between the expected and the predicted intent for an utterance.
Error	The error object.
ErrorCode	Human-readable error code.
ErrorResponse	Error response.
InnerErrorCode	Human-readable error code.
InnerErrorModel	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
StringIndexType	Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.

ConversationalAnalysisAuthoringEvaluationResults

Object

Represent a list of utterances' evaluation results.

Name	Type	Description
nextLink	string	The next page link.
value	ConversationalAnalysisAuthoringUtteranceEvaluationResult[]	The utterances evaluation results.

ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult

Object

Represents the comparison between the expected and predicted entities for an utterance.

Name	Type	Description
expectedEntities	ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult[]	Represents the expected entity labels.
predictedEntities	ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult[]	Represents the predicted entity labels.

ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult

Object

Represents the evaluation output of an entity label or prediction.

Name	Type	Description
category	string	Represents the entity category.
length	integer (int32)	Represents the entity length.
offset	integer (int32)	Represents the entity offset index relative to the original text.

ConversationalAnalysisAuthoringUtteranceEvaluationResult

Object

Represents the evaluation result for an utterance.

Name	Type	Description
entitiesResult	ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult	Represents the entities results for the utterance.
intentsResult	ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult	Represents the intents results for the utterance.
language	string	Represents the utterance language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc.
text	string	Represents the utterance text.

ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult

Object

Represents the comparison between the expected and the predicted intent for an utterance.

Name	Type	Description
expectedIntent	string	Represents the utterance's expected intent.
predictedIntent	string	Represents the utterance's predicted intent.

Error

Object

The error object.

Name	Type	Description
code	ErrorCode	One of a server-defined set of error codes.
details	Error[]	An array of details about specific errors that led to this reported error.
innererror	InnerErrorModel	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

ErrorCode

Enumeration

Human-readable error code.

Value	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Conflict
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
QuotaExceeded
ServiceUnavailable
Timeout
TooManyRequests
Unauthorized
Warning

ErrorResponse

Object

Error response.

Name	Type	Description
error	Error	The error object.

InnerErrorCode

Enumeration

Human-readable error code.

Value	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Object

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	InnerErrorCode	One of a server-defined set of error codes.
details	object	Error details.
innererror	InnerErrorModel	An object containing more specific information than the current object about the error.
message	string	Error message.
target	string	Error target.

StringIndexType

Enumeration

Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.

Value	Description
Utf16CodeUnit	The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript.

Share via

Conversational Analysis Authoring - Get Model Evaluation Results

URI Parameters

Request Header

Responses

Security

Ocp-Apim-Subscription-Key

Examples

Successful Get Model Evaluation

Sample request

Sample response

Definitions

ConversationalAnalysisAuthoringEvaluationResults

ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult

ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult

ConversationalAnalysisAuthoringUtteranceEvaluationResult

ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

StringIndexType