Constructor

ActionsSdkApp

new ActionsSdkApp(options)

Constructor for ActionsSdkApp object. To be used in the Actions SDK HTTP endpoint logic.

Parameter

options

Object

JSON configuration.

Methods

ask

ask(inputPrompt, dialogState) returns (Object or null)

Asks to collect user's input; all user's queries need to be sent to the app. The guidelines when prompting the user for a response must be followed at all times.

Parameter

inputPrompt

(Object, SimpleResponse, or RichResponse)

Holding initial and no-input prompts.

dialogState

Optional

Object

JSON object the app uses to hold dialog state that will be circulated back by App.

Returns

(Object or null) The response that is sent to Assistant to ask user to provide input.

Example

const app = new ActionsSdkApp({request: request, response: response});

const noInputs = [
  `I didn't hear a number`,
  `If you're still there, what's the number?`,
  'What is the number?'
];

function mainIntent (app) {
  const ssml = '<speak>Hi! <break time="1"/> ' +
    'I can read out an ordinal like ' +
    '<say-as interpret-as="ordinal">123</say-as>. Say a number.</speak>';
  const inputPrompt = app.buildInputPrompt(true, ssml, noInputs);
  app.ask(inputPrompt);
}

function rawInput (app) {
  if (app.getRawInput() === 'bye') {
    app.tell('Goodbye!');
  } else {
    const ssml = '<speak>You said, <say-as interpret-as="ordinal">' +
      app.getRawInput() + '</say-as></speak>';
    const inputPrompt = app.buildInputPrompt(true, ssml, noInputs);
    app.ask(inputPrompt);
  }
}

const actionMap = new Map();
actionMap.set(app.StandardIntents.MAIN, mainIntent);
actionMap.set(app.StandardIntents.TEXT, rawInput);

app.handleRequest(actionMap);

askWithCarousel

askWithCarousel(inputPrompt, carousel, dialogState) returns (Object or null)

Asks to collect user's input with a carousel.

Parameter

inputPrompt

(Object, SimpleResponse, or RichResponse)

Holding initial and no-input prompts. Cannot contain basic card.

carousel

Carousel

Carousel built with buildCarousel.

dialogState

Optional

Object

JSON object the app uses to hold dialog state that will be circulated back by Assistant.

Returns

(Object or null) The response that is sent to Assistant to ask user to provide input.

Example

const app = new ActionsSdkApp({request, response});

function welcomeIntent (app) {
  app.askWithCarousel('Which of these looks good?',
    app.buildCarousel()
     .addItems([
       app.buildOptionItem(SELECTION_KEY_ONE,
         ['synonym of KEY_ONE 1', 'synonym of KEY_ONE 2'])
         .setTitle('Number one'),
       app.buildOptionItem(SELECTION_KEY_TWO,
         ['synonym of KEY_TWO 1', 'synonym of KEY_TWO 2'])
         .setTitle('Number two'),
     ]));
}

function optionIntent (app) {
  if (app.getSelectedOption() === SELECTION_KEY_ONE) {
    app.tell('Number one is a great choice!');
  } else {
    app.tell('Number two is a great choice!');
  }
}

const actionMap = new Map();
actionMap.set(app.StandardIntents.TEXT, welcomeIntent);
actionMap.set(app.StandardIntents.OPTION, optionIntent);
app.handleRequest(actionMap);

askWithList

askWithList(inputPrompt, list, dialogState) returns (Object or null)

Asks to collect user's input with a list.

Parameter

inputPrompt

(Object, SimpleResponse, or RichResponse)

Holding initial and no-input prompts. Cannot contain basic card.

list

List

List built with buildList.

dialogState

Optional

Object

JSON object the app uses to hold dialog state that will be circulated back by Assistant.

Returns

(Object or null) The response that is sent to Assistant to ask user to provide input.

Example

const app = new ActionsSdkApp({request, response});

function welcomeIntent (app) {
  app.askWithList('Which of these looks good?',
    app.buildList('List title')
     .addItems([
       app.buildOptionItem(SELECTION_KEY_ONE,
         ['synonym of KEY_ONE 1', 'synonym of KEY_ONE 2'])
         .setTitle('Number one'),
       app.buildOptionItem(SELECTION_KEY_TWO,
         ['synonym of KEY_TWO 1', 'synonym of KEY_TWO 2'])
         .setTitle('Number two'),
     ]));
}

function optionIntent (app) {
  if (app.getSelectedOption() === SELECTION_KEY_ONE) {
    app.tell('Number one is a great choice!');
  } else {
    app.tell('Number two is a great choice!');
  }
}

const actionMap = new Map();
actionMap.set(app.StandardIntents.TEXT, welcomeIntent);
actionMap.set(app.StandardIntents.OPTION, optionIntent);
app.handleRequest(actionMap);

buildInputPrompt

buildInputPrompt(isSsml, initialPrompt, noInputs) returns Object

Builds the InputPrompt object from initial prompt and no-input prompts.

The App needs one initial prompt to start the conversation. If there is no user response, the App re-opens the mic and renders the no-input prompts three times (one for each no-input prompt that was configured) to help the user provide the right response.

Note: we highly recommend app to provide all the prompts required here in order to ensure a good user experience.

Parameter

isSsml

boolean

Indicates whether the text to speech is SSML or not.

initialPrompt

string

The initial prompt the App asks the user.

noInputs

Optional

Array of string

Array of re-prompts when the user does not respond (max 3).

Returns

Object An InputPrompt object.

Example

const inputPrompt = app.buildInputPrompt(false, 'Welcome to action snippets! Say a number.',
    ['Say any number', 'Pick a number', 'What is the number?']);
app.ask(inputPrompt);

getActionVersionLabel

getActionVersionLabel() returns string

Gets the "versionLabel" specified inside the Action Package. Used by app to do version control.

Returns

string The specified version label or null if unspecified.

Example

const app = new ActionsSdkApp({request: request, response: response});
const actionVersionLabel = app.getActionVersionLabel();

getApiVersion

getApiVersion() returns string

Gets the request Conversation API version.

Returns

string Version value or null if no value.

Example

const app = new ActionsSdkApp({request: request, response: response});
const apiVersion = app.getApiVersion();

getArgument

getArgument(argName) returns string

Get the argument value by name from the current intent. If the argument is not a text argument, the entire argument object is returned.

Note: If incoming request is using an API version under 2 (e.g. 'v1'), the argument object will be in Proto2 format (snake_case, etc).

Parameter

argName

string

Name of the argument.

Returns

string Argument value matching argName or null if no matching argument.

getConversationId

getConversationId() returns string

Gets the unique conversation ID. It's a new ID for the initial query, and stays the same until the end of the conversation.

Returns

string Conversation ID or null if no value.

Example

const app = new ActionsSdkApp({request: request, response: response});
const conversationId = app.getConversationId();

getDialogState

getDialogState() returns Object

Gets previous JSON dialog state that the app sent to Assistant. Alternatively, use the app.data field to store JSON values between requests.

Returns

Object JSON object provided to the Assistant in the previous user turn or {} if no value.

Example

const app = new ActionsSdkApp({request: request, response: response});
const dialogState = app.getDialogState();

getIntent

getIntent() returns string

Get the current intent. Alternatively, using a handler Map with handleRequest, the client library will automatically handle the incoming intents.

Returns

string Intent id or null if no value.

Example

const app = new ActionsSdkApp({request: request, response: response});

function responseHandler (app) {
  const intent = app.getIntent();
  switch (intent) {
    case app.StandardIntents.MAIN:
      const welcome = 'Welcome to action snippets! Say anything.';
      const inputPrompt = app.buildInputPrompt(false, welcome);
      app.ask(inputPrompt);
      break;

    case app.StandardIntents.TEXT:
      app.tell('You said ' + app.getRawInput());
      break;
  }
}

app.handleRequest(responseHandler);

getRawInput

getRawInput() returns string

Gets the user's raw input query.

Returns

string User's raw query or null if no value.

Example

const app = new ActionsSdkApp({request: request, response: response});
app.tell('You said ' + app.getRawInput());

getSelectedOption

getSelectedOption() returns string

Returns the option key user chose from options response.

Returns

string Option key of selected item. Null if no option selected or if current intent is not OPTION intent.

Example

const app = new App({request: req, response: res});

function pickOption (app) {
  if (app.hasSurfaceCapability(app.SurfaceCapabilities.SCREEN_OUTPUT)) {
    app.askWithCarousel('Which of these looks good?',
      app.buildCarousel().addItems(
        app.buildOptionItem('another_choice', ['Another choice']).
        setTitle('Another choice').setDescription('Choose me!')));
  } else {
    app.ask('What would you like?');
  }
}

function optionPicked (app) {
  app.ask('You picked ' + app.getSelectedOption());
}

const actionMap = new Map();
actionMap.set(app.StandardIntents.TEXT, pickOption);
actionMap.set(app.StandardIntents.OPTION, optionPicked);

app.handleRequest(actionMap);

isRequestFromAssistant

isRequestFromAssistant(projectId) returns Promise containing LoginTicket

Parameter

projectId

string

Google Cloud Project ID for the Assistant app.

Deprecated
Validates whether request is from Assistant through signature verification. Uses Google-Auth-Library to verify authorization token against given Google Cloud Project ID. Auth token is given in request header with key, "Authorization".
Returns

Promise containing LoginTicket Promise resolving with google-auth-library LoginTicket if request is from a valid source, otherwise rejects with the error reason for an invalid token.

Example

const app = new ActionsSdkApp({request, response});
app.isRequestFromAssistant('nodejs-cloud-test-project-1234')
  .then(() => {
    app.ask('Hey there, thanks for stopping by!');
  })
  .catch(err => {
    response.status(400).send();
  });

isRequestFromGoogle

isRequestFromGoogle(projectId) returns Promise containing LoginTicket

Validates whether request is from Google through signature verification. Uses Google-Auth-Library to verify authorization token against given Google Cloud Project ID. Auth token is given in request header with key, "Authorization".

Parameter

projectId

string

Google Cloud Project ID for the Assistant app.

Returns

Promise containing LoginTicket Promise resolving with google-auth-library LoginTicket if request is from a valid source, otherwise rejects with the error reason for an invalid token.

Example

const app = new ActionsSdkApp({request, response});
app.isRequestFromGoogle('nodejs-cloud-test-project-1234')
  .then(() => {
    app.ask('Hey there, thanks for stopping by!');
  })
  .catch(err => {
    response.status(400).send();
  });

tell

tell(textToSpeech) returns (Object or null)

Tells Assistant to render the speech response and close the mic.

Parameter

textToSpeech

(string, SimpleResponse, or RichResponse)

Final response. Spoken response can be SSML.

Returns

(Object or null) The HTTP response that is sent back to Assistant.

Example

const app = new ActionsSdkApp({request: request, response: response});

const noInputs = [
  `I didn't hear a number`,
  `If you're still there, what's the number?`,
  'What is the number?'
];

function mainIntent (app) {
  const ssml = '<speak>Hi! <break time="1"/> ' +
    'I can read out an ordinal like ' +
    '<say-as interpret-as="ordinal">123</say-as>. Say a number.</speak>';
  const inputPrompt = app.buildInputPrompt(true, ssml, noInputs);
  app.ask(inputPrompt);
}

function rawInput (app) {
  if (app.getRawInput() === 'bye') {
    app.tell('Goodbye!');
  } else {
    const ssml = '<speak>You said, <say-as interpret-as="ordinal">' +
      app.getRawInput() + '</say-as></speak>';
    const inputPrompt = app.buildInputPrompt(true, ssml, noInputs);
    app.ask(inputPrompt);
  }
}

const actionMap = new Map();
actionMap.set(app.StandardIntents.MAIN, mainIntent);
actionMap.set(app.StandardIntents.TEXT, rawInput);

app.handleRequest(actionMap);