Sign up Log in


Topic guides

How-to guides

Reference guides

Getting started - Part 2

6 min read.

On this page

    This tutorial begins where Getting started - Part 1 left off. You’ll create your first interpretation, some entities and use the console.

    First basic interpretation

    Create an interpretation

    In the “Interpretations” tab, click on the “New Interpretation” button.

    New interpretation screenshot

    A modal box with the form “Create a new interpretation” opens.

    1. Fill the ID with “address”.
    2. Set your interpretation visibility to Public.
    3. Fill a description: “Identifies the French postal addresses.”
    4. Click on the “Create” button.

    Interpretation form screenshot

    Create your first formulation

    Your first interpretation is created. Now click on it and select the “fr” tab. Type “12 avenue de Flandres 75019 Paris” in the text field, then click on “Add” button.

    Keep the default options (keep order, close, auto solution) as is. We will come back to them later.

    Formulation form screenshot

    Testing the agent

    A console panel is on the right to test in live your agent. Type “12 avenue de Flandres 75019 Paris” in the text field and click on the arrow to send the request. This console calls your agent by REST API.

    You can see the returned solution in the “Explain” tab (opened by default). The solution is also available in JSON format; click on the “JSON” tab to see it.

    Console screenshot

    The returned value is the interpretation you just created and the score is the match confidence level: 0 means no match, and 1 means an exact match. Here the score is 1 because the sentence typed in the console exactly matches the formulation you just created.

    Route types

    You want to be able to identify any French postal address with other street number, route types and names, and localities.

    We will start with the route types detection by using an entities list.

    Create a route type entities list

    Click on the “Entities” tab and click on the “New entities list” button.

    Entities lists UI screenshot

    A modal box with the form “Create a new entities list” opens.

    1. Type “route_types” in the ID text field.
    2. Select Private and Glued options.
    3. Click on the “Create” button.

    create entities list screenshot

    Click on the entities list you just created to open it and enter route types names:

    1. Type “rue” in the Terms text area ; then click on “Add” button.
    2. Type “avenue” in the Terms text area; then click on “Add” button.
    3. Type “impasse” in the Terms text area; then click on “Add” button.
    4. Type “passage” in the Terms text area; then click on “Add” button.

    filling the entities list screenshot

    Go back to the “Interpretations” tab, click on the “address” public interpretation.

    Step 1 Edit the current formulation in address interpretation

    Click on the formulation “12 avenue de Flandres 75019 Paris” in order to edit it.

    UI screenshot

    Step 2 Link avenue with route_types entities list

    1. Highlight “avenue” in “12 avenue de Flandres 75019 Paris”.
    2. A drop-down list appears displaying the different interpretations and entities lists available.
    3. Choose the “route_types” entities list (it should be labeled like yourname/youragent/entities_lists/route_types).
    4. Click on “Update” button.

    Interpretation form screenshot

    updating interpretation screenshot

    Step 3 Validate

    Test in console the interpretation with the following sentences:

    • 12 impasse de Flandres 75019 Paris
    • 12 avenue de Flandres 75019 Paris
    • 12 rue de Flandres 75019 Paris

    All sentences are successful, the interpretation “address” is found on each route type variant.

    Console screenshots

    On this page

      Home Pricing Open Source Blog Documentation