@speechly/js-config-api

Javascript Library for Speechly Config API

This library allows to create and deploy simple Speechly voice-search applications from within a (server-side) Javascript program.

Installation

The gRPC libraries (grpc and google-protobuf) are declared as peer dependencies, meaning that they need to be installed separately in the main package. This is to prevent multiple versions of grpc existing in the module tree, as this is not supported by the module.

npm install --save grpc google-protobuf
npm install --save @speechly/js-config-api

Usage

You must first obtain a Speechly API token by following the instructions at https://docs.speechly.com/dev-tools/command-line-client/#adding-an-api-token.

Then, you can copy-paste the API token to the example script below. Running the script will first create a new application, and then deploy a simple example configuration. The script initiates deployment and returns immediately, please check the Speechly Dashboard to see when deployment is complete. Then, you can try out the application with the Speechly Playground. It supports utterances such as

• show me blue jackets for men
• can i see shirts by adidas in size large

const { setupConnection, createApplication, deployApplication } = require("@speechly/js-config-api");

(async () => {
  try {
    const token = YOUR_API_TOKEN_HERE;

    // Establishes connection to the Speechly Config API.
    // The token must be a valid Speechly API token obtained from the
    // Speechly Dashboard.
    const conn = setupConnection(token);

    // Create a new application. It is enough to call this once.
    // After the application has been set up, all subsequent
    // calls to either createApplication or deployApplication
    // target the same application id.
    //
    // Here conn must be a connection object returned by setupConnection.
    await createApplication(conn);

    // Define a simple example configuration that maps a list of possible
    // values for all supported entity types. Values must be given as a
    // list of Strings. The keys listed below are the ones supported.
    // None of the keys is mandatory, any subset thereof can be used.
    const co = {"category": ["jackets", "shirts"],
                "brand": ["nike", "adidas"],
                "color": ["blue", "red", "green"],
                "size": ["small", "medium", "large"],
                "department": ["men", "women", "kids"]};

    // Deploy the configuration specified above.
    // Note that this only initates deployment. The function returns
    // once deployment has started. To see when deployment is complete,
    // please log on to the Speechly Dashboard.
    //
    // Here conn must be a connection object returned by setupConnectionm
    // and co a dictionary object as defined above.
    await deployApplication(conn, co);
  } catch (err) {
    console.error(err);
  }
})();

Specifying the configuration

The configuration is a simple Javascript object that maps a list of possible values (must be strings) to each entity name as shown in the code example above. There is no upper limit to the number of possible values for each entity type.

The configuration supports five entity types:

• category: the type of the product (e.g. jackets, shirts, shoes, etc)
• department: useful if products from the same category should still be divided further (e.g. for fashion stores where one might have separate mens and womens departments)
• brand: product brand
• color: product color
• size: product size These are all optional, meaning it is possible to use a configuration that only uses a subset of the entity types.