Prediction - Get Slot Prediction

Ссылка

Service:: Cognitive Services - LUIS

API Version:: 3.0

Возвращает прогнозы для слота приложения.

POST {Endpoint}/luis/prediction/v3.0/apps/{appId}/slots/{slotName}/predict

With optional parameters:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
appId	path	True	string uuid	Код приложения.
Endpoint	path	True	string	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например : https://westus.api.cognitive.microsoft.com).
slotName	path	True	string	Имя слота приложения.
log	query		boolean	Указывает, следует ли регистрировать запрос конечной точки.
show-all-intents	query		boolean	Указывает, следует ли возвращать все намерения в ответе или только основное намерение.
verbose	query		boolean	Указывает, следует ли получать дополнительные метаданные для прогнозов сущностей.

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

Имя	Обязательно	Тип	Описание
Ocp-Apim-Subscription-Key	True	string

Текст запроса

Имя	Обязательно	Тип	Описание
query	True	string	Прогнозируемый запрос.
dynamicLists		DynamicList[]	Динамически создаваемые сущности списка для этого запроса.
externalEntities		ExternalEntity[]	Внешние прогнозируемые сущности для этого запроса.
options		PredictionRequestOptions	Пользовательские параметры, определенные для этого запроса.

Ответы

Имя	Тип	Описание
200 OK	PredictionResponse	Прогноз для предоставленного запроса.
Other Status Codes	Error	Непредвиденная ошибка.

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

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Примеры

Successful Get Slot Predictions From Endpoint Via Post request

Sample Request

HTTP

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": []
        }
      ]
    }
  ]
}

Sample Response

Status code:: 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
    }
  }
}

Определения

Имя	Описание
DynamicList	Определяет расширение для сущности списка.
Error	Представляет возникщую ошибку.
ErrorBody	Представляет определение возникщей ошибки.
ExternalEntity	Определяет прогнозируемую пользователем сущность, которая расширяет уже существующую.
Intent	Представляет прогноз намерения.
Prediction	Представляет прогноз запроса.
PredictionRequest	Представляет параметры прогнозирующего запроса.
PredictionRequestOptions	Пользовательские параметры для прогнозирующего запроса.
PredictionResponse	Представляет прогнозирующий ответ.
RequestList	Определяет вложенный список для добавления к существующей сущности списка.
Sentiment	Результат анализа тональности.

DynamicList

Определяет расширение для сущности списка.

Имя	Тип	Описание
listEntityName	string	Имя расширяемой сущности списка.
requestLists	RequestList[]	Списки, добавляемые в сущность расширенного списка.

Error

Представляет возникщую ошибку.

Имя	Тип	Описание
error	ErrorBody	Представляет определение возникщей ошибки.

ErrorBody

Представляет определение возникщей ошибки.

Имя	Тип	Описание
code	string	Код ошибки.
message	string	Сообщение об ошибке.

ExternalEntity

Определяет прогнозируемую пользователем сущность, которая расширяет уже существующую.

Имя	Тип	Описание
entityLength	integer	Длина прогнозируемой сущности.
entityName	string	Имя расширяемой сущности.
resolution		Пользователь предоставил пользовательское разрешение для возврата в качестве прогноза сущности.
score	number	Предоставленная пользователем оценка, возвращаемая в качестве оценки прогнозирования сущности.
startIndex	integer	Индекс начального символа прогнозируемой сущности.

Intent

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

Имя	Тип	Описание
childApp	Prediction	Прогноз отправленного приложения.
score	number	Оценка активированного намерения.

Prediction

Представляет прогноз запроса.

Имя	Тип	Описание
alteredQuery	string	Запрос после проверки орфографии. Задается только в том случае, если проверка орфографии была включена и обнаружена орфографическая ошибка.
entities		Словарь, представляющий активированные сущности.
intents	<string, Intent>	Словарь, представляющий намерения, которые были запущены.
sentiment	Sentiment	Результат анализа тональности.
topIntent	string	Имя намерения с верхней оценкой.

PredictionRequest

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

Имя	Тип	Описание
dynamicLists	DynamicList[]	Динамически создаваемые сущности списка для этого запроса.
externalEntities	ExternalEntity[]	Внешние прогнозируемые сущности для этого запроса.
options	PredictionRequestOptions	Пользовательские параметры, определенные для этого запроса.
query	string	Прогнозируемый запрос.

PredictionRequestOptions

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

Имя	Тип	Описание
datetimeReference	string	Эталонное значение DateTime, используемое для прогнозирования сущностей даты и времени.
preferExternalEntities	boolean	Следует ли сделать разрешение внешних сущностей переопределять прогнозы в случае перекрытия.

PredictionResponse

Представляет прогнозирующий ответ.

Имя	Тип	Описание
prediction	Prediction	Прогноз запрошенного запроса.
query	string	Запрос, используемый в прогнозе.

RequestList

Определяет вложенный список для добавления к существующей сущности списка.

Имя	Тип	Описание
canonicalForm	string	Каноническая форма вложенного списка.
name	string	Имя вложенного списка.
synonyms	string[]	Синонимы канонической формы.

Sentiment

Результат анализа тональности.

Имя	Тип	Описание
label	string	Метка результата анализа тональности.
score	number	Оценка тональности запроса.

Share via