Conversational Analysis Authoring - Get Model Evaluation Results

Служба:

Azure AI Services

Версия API:

2022-05-01

Возвращает подробные результаты оценки для обученной модели. Сюда входят необработанные результаты вывода для данных, включенных в процесс оценки.

GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/result?stringIndexType=Utf16CodeUnit&api-version=2022-05-01

С использованием необязательных параметров:

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

Имя	В	Обязательно	Тип	Описание
Endpoint	path	True	string	Поддерживаемая конечная точка Cognitive Services (например, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Имя используемого проекта.
trainedModelLabel	path	True	string	Метка обученной модели.
api-version	query	True	string	Версия API клиента.
stringIndexType	query	True	StringIndexType	Указывает метод, используемый для интерпретации смещения строк. Дополнительные сведения см. в разделе https://aka.ms/text-analytics-offsets.
maxpagesize	query		integer int32	Максимальное количество ресурсов, включаемых в один ответ.
skip	query		integer int32	Смещение в коллекции первого возвращаемого ресурса.
top	query		integer int32	Максимальное количество ресурсов, возвращаемых из коллекции.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Ocp-Apim-Subscription-Key	True	string	Ключ подписки для ресурса языковой службы.

Ответы

Имя	Тип	Описание
200 OK	ConversationalAnalysisAuthoringEvaluationResults	Список прогнозов оценки.
Other Status Codes	ErrorResponse	Ответ об ошибке.

Безопасность

Ocp-Apim-Subscription-Key

Ключ подписки для ресурса языковой службы.

Тип: apiKey
В: header

Примеры

Successful Get Model Evaluation

Образец запроса

HTTP

GET {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/models/model1/evaluation/result?stringIndexType=Utf16CodeUnit&maxpagesize=10&api-version=2022-05-01

Пример ответа

Код состояния:

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

Определения

Имя	Описание
ConversationalAnalysisAuthoringEvaluationResults	Представляет список результатов оценки речевых фрагментов.
ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult	Представляет сравнение ожидаемых и прогнозируемых сущностей для речевого фрагмента.
ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult	Представляет выходные данные оценки метки сущности или прогноза.
ConversationalAnalysisAuthoringUtteranceEvaluationResult	Представляет результат оценки для речевого фрагмента.
ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult	Представляет сравнение ожидаемого и прогнозируемого намерения для речевого фрагмента.
Error	Объект ошибки.
ErrorCode	Код ошибки, доступный для чтения человеком.
ErrorResponse	Ответ об ошибке.
InnerErrorCode	Код ошибки, доступный для чтения человеком.
InnerErrorModel	Объект , содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
StringIndexType	Указывает метод, используемый для интерпретации смещения строк. Дополнительные сведения см. в разделе https://aka.ms/text-analytics-offsets.

ConversationalAnalysisAuthoringEvaluationResults

Представляет список результатов оценки речевых фрагментов.

Имя	Тип	Описание
nextLink	string	Ссылка на следующую страницу.
value	ConversationalAnalysisAuthoringUtteranceEvaluationResult[]	Результаты оценки речевых фрагментов.

ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult

Представляет сравнение ожидаемых и прогнозируемых сущностей для речевого фрагмента.

Имя	Тип	Описание
expectedEntities	ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult[]	Представляет ожидаемые метки сущностей.
predictedEntities	ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult[]	Представляет прогнозируемые метки сущностей.

ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult

Представляет выходные данные оценки метки сущности или прогноза.

Имя	Тип	Описание
category	string	Представляет категорию сущностей.
length	integer	Представляет длину сущности.
offset	integer	Представляет индекс смещения сущности относительно исходного текста.

ConversationalAnalysisAuthoringUtteranceEvaluationResult

Представляет результат оценки для речевого фрагмента.

Имя	Тип	Описание
entitiesResult	ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult	Представляет результаты сущностей для речевого фрагмента.
intentsResult	ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult	Представляет результаты намерений для речевого фрагмента.
language	string	Представляет язык речевого фрагмента. Это представление языка BCP-47. Например, используйте "en" для английского языка, "en-gb" для английского языка (Великобритания), "es" для испанского языка и т. д.
text	string	Представляет текст речевого фрагмента.

ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult

Представляет сравнение ожидаемого и прогнозируемого намерения для речевого фрагмента.

Имя	Тип	Описание
expectedIntent	string	Представляет ожидаемое намерение речевого фрагмента.
predictedIntent	string	Представляет прогнозируемое намерение речевого фрагмента.

Error

Объект ошибки.

Имя	Тип	Описание
code	ErrorCode	Один из серверных наборов кодов ошибок.
details	Error[]	Массив сведений о конкретных ошибках, которые привели к этой сообщаемой ошибке.
innererror	InnerErrorModel	Объект , содержащий более конкретные сведения об ошибке, чем текущий объект.
message	string	Понятное представление ошибки.
target	string	Целевой объект ошибки.

ErrorCode

Код ошибки, доступный для чтения человеком.

Имя	Тип	Описание
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

Ответ об ошибке.

Имя	Тип	Описание
error	Error	Объект ошибки.

InnerErrorCode

Код ошибки, доступный для чтения человеком.

Имя	Тип	Описание
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

Объект , содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Имя	Тип	Описание
code	InnerErrorCode	Один из серверных наборов кодов ошибок.
details	object	Сведения об ошибке.
innererror	InnerErrorModel	Объект , содержащий более конкретные сведения об ошибке, чем текущий объект.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

StringIndexType

Указывает метод, используемый для интерпретации смещения строк. Дополнительные сведения см. в разделе https://aka.ms/text-analytics-offsets.

Имя	Тип	Описание
Utf16CodeUnit	string	Значения смещения и длины будут соответствовать единицам кода UTF-16. Используйте этот параметр, если приложение написано на языке, поддерживающем Юникод, например Java, JavaScript.