Prediction - Get Slot Prediction

Ссылка

Служба:: Azure AI Services

Версия API:: 3.0

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

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

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

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

Тип: apiKey
В: header

Примеры

Successful Get Slot Predictions From Endpoint Via Post 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": []
        }
      ]
    }
  ]
}

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

Код состояния:: 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

Object

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

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

Error

Object

Представляет ошибку, которая произошла.

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

ErrorBody

Object

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

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

ExternalEntity

Object

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

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

Intent

Object

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

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

Prediction

Object

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

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

PredictionRequest

Object

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

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

PredictionRequestOptions

Object

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

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

PredictionResponse

Object

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

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

RequestList

Object

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

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

Sentiment

Object

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

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

Поделиться через

Prediction - Get Slot Prediction

Параметры URI

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

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

Ответы

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

Ocp-Apim-Subscription-Key

Примеры

Successful Get Slot Predictions From Endpoint Via Post request

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

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

Определения

DynamicList

Error

ErrorBody

ExternalEntity

Intent

Prediction

PredictionRequest

PredictionRequestOptions

PredictionResponse

RequestList

Sentiment

Дополнительные ресурсы