umbot
    Preparing search index...

    Interface ISberSmartAppRequestPayload

    Полезная нагрузка запроса. Содержит все данные, необходимые для обработки запроса

    interface ISberSmartAppRequestPayload {
        annotations: ISberSmartAppAnnotations;
        app_info: ISberSmartAppAppInfo;
        character: ISberSmartAppCharacterInfo;
        device: ISberSmartAppDeviceInfo;
        intent: string;
        intent_meta: object;
        message: ISberSmartAppMessageInfo;
        meta: ISberSmartAppMetaInfo;
        new_session?: boolean;
        original_intent: string;
        projectName: string;
        rating?: ISberRating;
        selected_item?: ISberSmartAppSelectedItem;
        server_action?: ISberSmartAppServerAction;
        status_code?: ISberRatingStatusCode;
        strategies: {
            happy_birthday: boolean;
            is_alice?: boolean;
            last_call: number;
        };
    }
    Index

    Properties

    annotations app_info character device intent intent_meta message meta new_session? original_intent projectName rating? selected_item? server_action? status_code? strategies

    Properties

    annotations: ISberSmartAppAnnotations

    Общие характеристики сообщения пользователя.

    app_info: ISberSmartAppAppInfo

    Информация о смартапе.

    character: ISberSmartAppCharacterInfo

    Информация о текущем персонаже ассистента, который установлен у пользователя.

    device: ISberSmartAppDeviceInfo

    Информация об устройстве пользователя.

    intent: string

    Интент, полученный из предыдущего ответа смартапа.

    intent_meta: object

    Мета данные, полученные от сервиса распознавания интентов. Поле будет использовано в будущем. В текущей реализации содержит пустой объект. Определяйте интенты в SmartApp Code и передавайте их в запросах к своему серверу.

    message: ISberSmartAppMessageInfo

    Результат предобработки.

    meta: ISberSmartAppMetaInfo

    Данные о содержимом экрана пользователя.

    new_session?: boolean

    Указывает на характер запуска смартапа. Если поле содержит true, сессии присваивается новый идентификатор (поле sessionId). Возможные значения: true — приложение запущено впервые или после закрытия приложения, а также при запуске приложения по истечении тайм-аута (10 минут) или после прерывания работы приложения, например, по запросу "текущее время" false — во всех остальных случаях.

    false
    original_intent: string

    Исходный интент. Значение поля отличается от значения intent только при монопольном захвате контекста.

    projectName: string

    Имя смартапа, которое задается при создании проекта и отображается в каталоге приложений.

    rating?: ISberRating

    Результат оценки пользователя

    selected_item?: ISberSmartAppSelectedItem

    Описание элемента экрана, который пользователь назвал при запросе ("включи второй" / "включи второго терминатора"). Для работы этой функциональности нужна отправка во входящем сообщении с фронтенда item_selector со списком элементов. Поле опционально (selected_item?): отсутствует, если пользователь не выбирал элемент.

    server_action?: ISberSmartAppServerAction

    Информация о запускаемом смартапе и параметрах его запуска. Формируется бэкендом приложения. По умолчанию: пустой объект.

    {}
    status_code?: ISberRatingStatusCode

    Статус оценки

    strategies: { happy_birthday: boolean; is_alice?: boolean; last_call: number }

    Возможные стратегии смартапа.

    Type Declaration

    • happy_birthday: boolean

      Стратегия «поздравление с днём рождения» активна

    • Optionalis_alice?: boolean

      Признак, что собеседник — Алиса

    • last_call: number

      Признак последнего вызова

    Settings

    Member Visibility

    On This Page

    Properties