NAV Navbar
 
shell
  • Membership and plans
  • Create a project
  • Instruct
  • API
  • Membership and plans

    Registering is easy:
    
    1. Just go to register page.
    2. Type your name, surname, email, password and repeat the same password.
    3. Click to register button and you're done.

    You must be a member to start using Talkwai.

    After the membership process, you can choose the plan that best suits your business. Talkwai offers 4 different plan options. If you have a small business, you can use Talkwai for free for a lifetime by choosing our free plan. Large businesses and companies can choose the appropriate package based on their minute message capacity, considering that Talkwai works with the API. If our packages are not enough for your minute message capacity depending on your business, you can contact for the 4th package. This package does not appear on the plans page, there is no limit to the features and the pricing is 'pay to go'.

    Create a project

    To create a project:
    
    1. Go to Talkwai panel. If it is necessary, log in. 
    2. If it is your first using experience; click the
       Create new project button that in the middle of the scene,
       for making your fist project. You can't pass the page if you didn't create any project.
    3. Type your project name and your website. Your project will be immediately active but,
       we'll have a circumstance anlysis on your website.
       If you have a not active or against our service rules website, our quality team maybe
       deactivate your project.
    4. Click the Create now button.

    You should create your project with the steps in this guide. This step is imperative for training your artificial intelligence and for many configurations.

    Instruct

    Create a new instruction and then educate it:
    You define several training phrases for each instruction. The education
    phrase is an example of what it can write or say to your end user,
    also known as the end user phrase. For example, an end user might say
    "what's your name?", "Do you have a name?" or just "name?" He/she may ask.
    Each of these end-user statements is unique but has the same purpose: getting your name.
        
    Create a new instruction:
    1. In the middle of the instruct page, click that 'Create new Instructions' button.
    2. In the Name field, enter the name you want to give to the group of instructions.
       This name is for you to easily identify your instructions.
    3. Choose your instructions type: Regular or Uncertainty.
    4. In the Training phrase section, click the blank text field. Enter the following
       training phrases and press enter after typing every instruction:
    
        What is your name?
        Do you have a name?
        name
        
       P.S.: in many cases, it is recommended to enter at least 10 training statements for
       reliable instruction matching.
    
    5. In the Responses section, click the blank text field and enter this text:
    
        My name is Talkwai!
    
    6. Click the 'Save' button and wait for the notification drop-down window to say that
       the instructions has been successfully created.

    This is where we can add logic to your ai. Every instruction is responsible for a job. Some to detect user inputs and response, some to create more complex logic to improve user engagement. These instructions, reset the end user's speech transformation. For each project, you define many instructions where your combined instructions can make a full conversation.

    Default instructions:
    When you create a project, two default instructions will be create for you.

    Default Welcome Instructions: These instructions, it matches when the end user starts talking with your representative. This training should return a response that allows the end user to know what your project is doing or what they can say to start talking.

    Default Uncertainty Instructions: These instructions, it matches when the end user cannot match the expression to another target.

    To look at these instructions, go to your project's instruct section:

    1. Go to Talkwai panel. If it is necessary, log in.
    2. Choose that project you just create.
    3. Click instruct on the left sidebar.
    4. And then, in the middle of the page, the instruction list shows up.

    API

    Query Parameters:
    Parameter	  Required  Description
    __________________________________________________________________________________________________
    client_key        True	    Your client API key that is used to authorize your requests.
    developer_secret  True	    Your secret developer API key that is used to authorize your requests.
    query	          True	    The training phrase you received from the end user.
    
    API Endpoints:
    https://api.talkwai.com/v1/query

    If you are not using one of the integration options, you need to write code that interacts directly with the end user. You also need to interact directly with Talkwai's API for each conversation queue to send end-user statements and receive instruction matches.

    The bottom schema shows the process flow when you interact with the API.

    1. The end user writes or says a phrase.
    2. Your service sends this end user expression to Talkwai in a detection request message (API).
    3. Talkwai sends an appropriate response message to your API query. This message contains information about the matching instruction, action, parameters and response defined for the instruction.
    4. Your service takes action when needed, such as database queries or external API calls.
    5. Your service sends the response received from the API to the end user.
    6. The end user sees or hears the answer.

    Talkwai uses API keys to allow access to the API. You can find your Talkwai API key in your project home page.

    Before you can interact with the Talkwai API, you must provide the necessary authentication credentials in each POST request that you make to Talkwai.

    Authenticate your account by including your secret key in API requests. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such GitHub, client-side code, and so forth.