Compartilhar via

Prediction - Get Slot Prediction

  • Referência
Serviço:
Azure AI Services
Versão da API:
3.0

Obtém as previsões de um slot de aplicativo.

POST {Endpoint}/luis/prediction/v3.0/apps/{appId}/slots/{slotName}/predict
Com parâmetros opcionais: 
POST {Endpoint}/luis/prediction/v3.0/apps/{appId}/slots/{slotName}/predict?verbose={verbose}&show-all-intents={show-all-intents}&log={log}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
appId
 path True

string (uuid)

A ID do aplicativo.
Endpoint
 path True

string

Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://westus.api.cognitive.microsoft.com).
slotName
 path True

string

O nome do slot do aplicativo.
log
 query

boolean

Indica se a consulta de ponto de extremidade deve ser registrada ou não.
show-all-intents
 query

boolean

Indica se todas as intenções devem ser retornadas na resposta ou apenas na intenção superior.
verbose
 query

boolean

Indica se os metadados adicionais devem ser obtidos para as previsões de entidades ou não.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
Ocp-Apim-Subscription-Key True

string

Corpo da solicitação

Nome Obrigatório Tipo Description
query True

string

A consulta a ser prevista.
dynamicLists

DynamicList[]

As entidades de lista criadas dinamicamente para essa solicitação.
externalEntities

ExternalEntity[]

As entidades previstas externamente para essa solicitação.
options

PredictionRequestOptions

As opções personalizadas definidas para essa solicitação.

Respostas

Nome Tipo Description
200 OK

PredictionResponse

A previsão da consulta fornecida.
Other Status Codes

Error

Erro inesperado.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

Successful Get Slot Predictions From Endpoint Via Post request

Solicitação de exemplo

POST {Endpoint}/luis/prediction/v3.0/apps/{Application Id}/slots/{Slot Name}/predict


{
  "query": "forward to frank 30 dollars through HSBC",
  "options": {
    "datetimeReference": "2015-02-13T13:15:00.000Z"
  },
  "externalEntities": [
    {
      "entityName": "Bank",
      "startIndex": 36,
      "entityLength": 4,
      "resolution": {
        "text": "International Bank"
      }
    }
  ],
  "dynamicLists": [
    {
      "listEntityName": "Employees",
      "requestLists": [
        {
          "name": "Management",
          "canonicalForm": "Frank",
          "synonyms": []
        }
      ]
    }
  ]
}

Resposta de exemplo

Código de status:
200 
{
  "query": "forward to frank 30 dollars through HSBC",
  "prediction": {
    "topIntent": "give",
    "intents": {
      "give": {
        "score": 0.943442
      }
    },
    "entities": {
      "Employees": [
        [
          "frank"
        ]
      ],
      "number": [
        30
      ],
      "money": [
        {
          "units": "Dollar",
          "value": 30
        }
      ],
      "Bank": [
        {
          "text": "International Bank"
        }
      ]
    },
    "sentiment": {
      "label": "positive",
      "score": 0.9163064
    }
  }
}

Definições

Nome Description
DynamicList

Define uma extensão para uma entidade de lista.
Error

Representa o erro que ocorreu.
ErrorBody

Representa a definição do erro que ocorreu.
ExternalEntity

Define uma entidade prevista pelo usuário que estende uma já existente.
Intent

Representa uma previsão de intenção.
Prediction

Representa a previsão de uma consulta.
PredictionRequest

Representa os parâmetros de solicitação de previsão.
PredictionRequestOptions

As opções personalizadas para a solicitação de previsão.
PredictionResponse

Representa a resposta de previsão.
RequestList

Define uma sub-lista a ser acrescentada a uma entidade de lista existente.
Sentiment

O resultado da análise de sentimento.

DynamicList

Objeto

Define uma extensão para uma entidade de lista.

Nome Tipo Description
listEntityName

string

O nome da entidade de lista a ser estendida.
requestLists

RequestList[]

As listas a serem acrescentadas na entidade de lista estendida.

Error

Objeto

Representa o erro que ocorreu.

Nome Tipo Description
error

ErrorBody

Representa a definição do erro que ocorreu.

ErrorBody

Objeto

Representa a definição do erro que ocorreu.

Nome Tipo Description
code

string

O código de erro.
message

string

A mensagem de erro.

ExternalEntity

Objeto

Define uma entidade prevista pelo usuário que estende uma já existente.

Nome Tipo Description
entityLength

integer (int32)

O comprimento da entidade prevista.
entityName

string

O nome da entidade a ser estendida.
resolution

Um usuário forneceu uma resolução personalizada para retornar como previsão da entidade.
score

number (float)

Uma pontuação fornecida pelo usuário para retornar como a pontuação de previsão da entidade.
startIndex

integer (int32)

O índice de caractere inicial da entidade prevista.

Intent

Objeto

Representa uma previsão de intenção.

Nome Tipo Description
childApp

Prediction

A previsão do aplicativo expedido.
score

number (float)

A pontuação da intenção disparada.

Prediction

Objeto

Representa a previsão de uma consulta.

Nome Tipo Description
alteredQuery

string

A consulta após a verificação ortográfica. Definir somente se a verificação ortográfica foi habilitada e um erro de ortografia foi encontrado.
entities

Um dicionário que representa as entidades que foram acionadas.
intents

<string,  Intent>

Um dicionário que representa as intenções que foram disparadas.
sentiment

Sentiment

O resultado da análise de sentimento.
topIntent

string

O nome da intenção de pontuação superior.

PredictionRequest

Objeto

Representa os parâmetros de solicitação de previsão.

Nome Tipo Description
dynamicLists

DynamicList[]

As entidades de lista criadas dinamicamente para essa solicitação.
externalEntities

ExternalEntity[]

As entidades previstas externamente para essa solicitação.
options

PredictionRequestOptions

As opções personalizadas definidas para essa solicitação.
query

string

A consulta a ser prevista.

PredictionRequestOptions

Objeto

As opções personalizadas para a solicitação de previsão.

Nome Tipo Description
datetimeReference

string (date-time)

O DateTime de referência usado para prever entidades datetime.
preferExternalEntities

boolean

Se a resolução de entidades externas deve substituir as previsões se ocorrer uma sobreposição.

PredictionResponse

Objeto

Representa a resposta de previsão.

Nome Tipo Description
prediction

Prediction

A previsão da consulta solicitada.
query

string

A consulta usada na previsão.

RequestList

Objeto

Define uma sub-lista a ser acrescentada a uma entidade de lista existente.

Nome Tipo Description
canonicalForm

string

A forma canônica da sub-lista.
name

string

O nome da sub-lista.
synonyms

string[]

Os sinônimos da forma canônica.

Sentiment

Objeto

O resultado da análise de sentimento.

Nome Tipo Description
label

string

O rótulo do resultado da análise de sentimento.
score

number (float)

A pontuação de sentimento da consulta.