actions-on-google/dist/service/dialogflow/conv.d.ts

/**
 * Copyright 2018 Google Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import * as Api from './api/v2';
import * as ApiV1 from './api/v1';
import * as ActionsApi from '../actionssdk/api/v2';
import { Conversation, ConversationBaseOptions, ConversationOptionsInit } from '../actionssdk';
import { ProtoAny, JsonObject } from '../../common';
import { Contexts, ContextValues, Parameters } from './context';
import { Incoming } from './incoming';
/** @hidden */
export interface SystemIntent {
    intent: string;
    data: ProtoAny<string, JsonObject>;
}
/** @hidden */
export interface GoogleAssistantResponse {
    expectUserResponse?: boolean;
    noInputPrompts?: ActionsApi.GoogleActionsV2SimpleResponse[];
    isSsml?: boolean;
    richResponse?: ActionsApi.GoogleActionsV2RichResponse;
    systemIntent?: SystemIntent;
    userStorage?: string;
    speechBiasingHints?: string[];
}
/** @hidden */
export interface PayloadGoogle {
    google: GoogleAssistantResponse;
}
/** @public */
export interface DialogflowConversationOptions<TConvData, TUserStorage> extends ConversationBaseOptions<TConvData, TUserStorage> {
    /** @public */
    body?: Api.GoogleCloudDialogflowV2WebhookRequest | ApiV1.DialogflowV1WebhookRequest;
}
/** @public */
export declare class DialogflowConversation<TConvData = JsonObject, TUserStorage = JsonObject, TContexts extends Contexts = Contexts> extends Conversation<TUserStorage> {
    /** @public */
    body: Api.GoogleCloudDialogflowV2WebhookRequest | ApiV1.DialogflowV1WebhookRequest;
    /**
     * Get the current Dialogflow action name.
     *
     * @example
     * ```javascript
     *
     * app.intent('Default Welcome Intent', conv => {
     *   const action = conv.action
     * })
     * ```
     *
     * @public
     */
    action: string;
    /**
     * Get the current Dialogflow intent name.
     *
     * @example
     * ```javascript
     *
     * app.intent('Default Welcome Intent', conv => {
     *   const intent = conv.intent // will be 'Default Welcome Intent'
     * })
     * ```
     *
     * @public
     */
    intent: string;
    /**
     * The Dialogflow parameters from the current intent.
     * Values will only be a string, an Object, or undefined if not included.
     *
     * Will also be sent via intent handler 3rd argument which is the encouraged method to retrieve.
     *
     * @example
     * ```javascript
     *
     * // Encouraged method through intent handler
     * app.intent('Tell Greeting', (conv, params) => {
     *   const color = params.color
     *   const num = params.num
     * })
     *
     * // Encouraged method through destructuring in intent handler
     * app.intent('Tell Greeting', (conv, { color, num }) => {
     *   // now use color and num as variables
     * }))
     *
     * // Using conv.parameters
     * app.intent('Tell Greeting', conv => {
     *   const parameters = conv.parameters
     *   // or destructed
     *   const { color, num } = conv.parameters
     * })
     * ```
     *
     * @public
     */
    parameters: Parameters;
    /** @public */
    contexts: ContextValues<TContexts>;
    /** @public */
    incoming: Incoming;
    /**
     * The user's raw input query.
     *
     * @example
     * ```javascript
     *
     * app.intent('User Input', conv => {
     *   conv.close(`You said ${conv.query}`)
     * })
     * ```
     *
     * @public
     */
    query: string;
    /**
     * The session data in JSON format.
     * Stored using contexts.
     *
     * @example
     * ```javascript
     *
     * app.intent('Default Welcome Intent', conv => {
     *   conv.data.someProperty = 'someValue'
     * })
     * ```
     *
     * @public
     */
    data: TConvData;
    /** @public */
    version: number;
    /** @hidden */
    _followup?: Api.GoogleCloudDialogflowV2EventInput | ApiV1.DialogflowV1FollowupEvent;
    /** @hidden */
    _init: ConversationOptionsInit<TConvData, TUserStorage>;
    /** @public */
    constructor(options?: DialogflowConversationOptions<TConvData, TUserStorage>);
    /**
     * Triggers an intent of your choosing by sending a followup event from the webhook.
     * Final response can theoretically include responses but these will not be handled
     * by Dialogflow. Dialogflow will not pass anything back to Google Assistant, therefore
     * Google Assistant specific information, most notably conv.user.storage, is ignored.
     *
     * @example
     * ```javascript
     *
     * const app = dialogflow()
     *
     * // Create a Dialogflow intent with event 'apply-for-license-event'
     *
     * app.intent('Default Welcome Intent', conv => {
     *   conv.followup('apply-for-license-event', {
     *     date: new Date().toISOString(),
     *   })
     *   // The dialogflow intent with the 'apply-for-license-event' event
     *   // will be triggered with the given parameters `date`
     * })
     * ```
     *
     * @param event Name of the event
     * @param parameters Parameters to send with the event
     * @param lang The language of this query.
     *     See {@link https://dialogflow.com/docs/languages|Language Support}
     *     for a list of the currently supported language codes.
     *     Note that queries in the same session do not necessarily need to specify the same language.
     *     By default, it is the languageCode sent with Dialogflow's queryResult.languageCode
     * @public
     */
    followup(event: string, parameters?: Parameters, lang?: string): this;
    /** @public */
    serialize(): Api.GoogleCloudDialogflowV2WebhookResponse | ApiV1.DialogflowV1WebhookResponse;
}