Conversational Analysis Authoring - Get Model Evaluation Results

Serviço:

Azure AI Services

Versão da API:

2023-04-01

Obtém os resultados detalhados da avaliação de um modelo treinado. Isso inclui os resultados brutos de inferência para os dados incluídos no processo de avaliação.

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
Endpoint	path	True	string
projectName	path	True	string	O novo nome do projeto.
trainedModelLabel	path	True	string	O rótulo de modelo treinado.
api-version	query	True	string	A versão da API a ser usada para esta operação.
stringIndexType	query	True	StringIndexType	Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets.
maxpagesize	query		integer int32	O número máximo de itens de resultado por página.
skip	query		integer int32	O número de itens de resultado a serem ignoradas.
top	query		integer int32	O número de itens de resultado a serem retornados.

Respostas

Nome	Tipo	Description
200 OK	PagedConversationalAnalysisAuthoringUtteranceEvaluationResult	A solicitação foi bem-sucedida.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
URL do Token: https://login.microsoftonline.com/common/oauth2/token

Escopos

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

Exemplos

Successful Get Model Evaluation

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:

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": "https://api.example.com/language/authoring/analyze-conversations/projects/EmailApp/models/model1/evaluation/result/?api-version=2023-04-01&top=2147483637&skip=100&maxpagesize=100"
}

Definições

Nome	Description
ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult	Representa a comparação entre as entidades esperadas e previstas para um enunciado.
ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult	Representa a saída de avaliação de um rótulo ou previsão de entidade.
ConversationalAnalysisAuthoringUtteranceEvaluationResult	Representa o resultado da avaliação de um enunciado.
ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult	Representa a comparação entre o esperado e a intenção prevista para um enunciado.
Error	O objeto de erro.
ErrorCode	Código de erro legível por humanos.
ErrorResponse	Resposta de erro.
InnerErrorCode	Código de erro legível por humanos.
InnerErrorModel	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
PagedConversationalAnalysisAuthoringUtteranceEvaluationResult	Coleção paged de itens ConversationalAnalysisAuthoringUtteranceEvaluationResult
StringIndexType

ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult

Representa a comparação entre as entidades esperadas e previstas para um enunciado.

Nome	Tipo	Description
expectedEntities	ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult[]	Representa os rótulos de entidade esperados.
predictedEntities	ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult[]	Representa os rótulos de entidade previstos.

ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult

Representa a saída de avaliação de um rótulo ou previsão de entidade.

Nome	Tipo	Description
category	string	Representa a categoria de entidade.
length	integer	Representa o comprimento da entidade.
offset	integer	Representa o índice de deslocamento de entidade em relação ao texto original.

ConversationalAnalysisAuthoringUtteranceEvaluationResult

Representa o resultado da avaliação de um enunciado.

Nome	Tipo	Description
entitiesResult	ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult	Representa os resultados das entidades para o enunciado.
intentsResult	ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult	Representa os resultados das intenções para o enunciado.
language	string	Representa a linguagem de enunciado. Esta é a representação BCP-47 de um idioma. Por exemplo, use "en" para inglês, "en-gb" para inglês (Reino Unido), "es" para espanhol etc.
text	string	Representa o texto do enunciado.

ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult

Representa a comparação entre o esperado e a intenção prevista para um enunciado.

Nome	Tipo	Description
expectedIntent	string	Representa a intenção esperada do enunciado.
predictedIntent	string	Representa a intenção prevista do enunciado.

Error

O objeto de erro.

Nome	Tipo	Description
code	ErrorCode	Um de um conjunto definido pelo servidor de códigos de erro.
details	Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	InnerErrorModel	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível pelo ser humano do erro.
target	string	O destino do erro.

ErrorCode

Código de erro legível por humanos.

Nome	Tipo	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

Resposta de erro.

Nome	Tipo	Description
error	Error	O objeto de erro.

InnerErrorCode

Código de erro legível por humanos.

Nome	Tipo	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

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Description
code	InnerErrorCode	Um de um conjunto definido pelo servidor de códigos de erro.
details	object	Detalhes do erro.
innererror	InnerErrorModel	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Mensagem de erro.
target	string	Destino de erro.

PagedConversationalAnalysisAuthoringUtteranceEvaluationResult

Coleção paged de itens ConversationalAnalysisAuthoringUtteranceEvaluationResult

Nome	Tipo	Description
nextLink	string	O link para a próxima página de itens
value	ConversationalAnalysisAuthoringUtteranceEvaluationResult[]	Os itens ConversationalAnalysisAuthoringUtteranceEvaluationResult nesta página

StringIndexType

Nome	Tipo	Description
Utf16CodeUnit	string	Os valores de deslocamento e comprimento corresponderão às unidades de código UTF-16. Use essa opção se o aplicativo for escrito em um idioma que dê suporte ao Unicode, por exemplo Java, JavaScript.