Skill - Site Search

Skill Type

Fallback

Overview

The Site Search skill uses Google to search your website and return the top result. The top results are displayed as an internal link or external link card so the user can navigate to that content.

Note: Default UI (a.k.a Auckland Theme) does not support internal link cards.

This skill is:

Limitations

Skill Demo

Site Search Skill Demo

Configurations

Provide the following information in the Site Search Skill configuration screen in Digital DNA Studio. See Adding Skills to your Digital Person for detailed instructions:

Site Search Skill Configuration

Field

Type

Description

GOOGLE API KEY USED TO CONDUCT SEARCH

(required)

TEXT

Enter the API Key generated from Custom Search JSON API page.

CUSTOM SEARCH ENGINE GENERATED ID

(required)

TEXT

Enter the search engine ID generated from google Programmable Search. For detailed instruction see section Creating a Programmable Search Engine for your Site.

RESPONSE WHEN SHOWING RESULTS

TEXT

Output phrase when showing results. The default is 'Ok. Here you go.'

RESPONSE WHEN NO RESULTS FOUND

TEXT

Output phrase when no results are found. The default is 'Sorry, I've had a problem looking up an answer for that.'

INTERNAL LINK OR EXTERNAL LINK
(required)

DROPDOWN

Internal link opens the links in the same tab (used with a widget).

External link opens links in a separate tab, can be used on widget and default UI.

IF INTERNAL LINK, NUMBER OF RESULTS THE DIGITAL PERSON SHOULD RETURN

TEXT

The number of internal links that can be displayed can be configured to up to four, whereas the number of external links is restricted to one.

Creating a Programmable Search Engine for your Site

To create a Programmable Search Engine:

  1. Sign into Control Panel using your Google Account (get an account if you don't have one).

  2. In the Create a new search engine page, add the pages you want to include in your search engine. You can include any sites you wish to, not just the sites you own. You can include whole site URLs or individual page URLs. You can also use URL patterns.

  3. Click Create.

  4. Select the search engine name from the Control Panel.

  5. Copy the Search engine ID.

     

IMPORTANT
The Google Custom Search API key allows only a certain number of searches a day, as determined by your administrator. For more information, see https://support.google.com/googleapi/answer/7035610.