Skip to main content
https://travis-ci.org/snipsco/snips-nlu.svg?branch=develop https://img.shields.io/pypi/v/snips-nlu.svg?branch=develop https://img.shields.io/pypi/pyversions/snips-nlu.svg?branch=develop https://codecov.io/gh/snipsco/snips-nlu/branch/develop/graph/badge.svg

Snips NLU (Natural Language Understanding) is a Python library that allows to parse sentences written in natural language and extracts structured information.

Check out our blog post to get more details about why we built Snips NLU and how it works under the hood.

Installation

pip install snips-nlu

We currently have pre-built binaries (wheels) for snips-nlu and its dependencies for MacOS and Linux x86_64. If you use a different architecture/os you will need to build these dependencies from sources which means you will need to install setuptools_rust and Rust before running the pip install snips-nlu command.

A simple example

Let’s take an example to illustrate the main purpose of this lib, and consider the following sentence:

"What will be the weather in paris at 9pm?"

Properly trained, the Snips NLU engine will be able to extract structured data such as:

{
   "intent": {
      "intentName": "searchWeatherForecast",
      "probability": 0.95
   },
   "slots": [
      {
         "value": "paris",
         "entity": "locality",
         "slotName": "forecast_locality"
      },
      {
         "value": {
            "kind": "InstantTime",
            "value": "2018-02-08 20:00:00 +00:00"
         },
         "entity": "snips/datetime",
         "slotName": "forecast_start_datetime"
      }
   ]
}

Sample code

Here is a sample code that you can run on your machine after having installed snips-nlu and downloaded this sample dataset:

from __future__ import unicode_literals, print_function

import io
import json

from snips_nlu import SnipsNLUEngine, load_resources
from snips_nlu.default_configs import CONFIG_EN

with io.open("sample_dataset.json") as f:
    sample_dataset = json.load(f)

load_resources("en")
nlu_engine = SnipsNLUEngine(config=CONFIG_EN)
nlu_engine.fit(sample_dataset)

text = "What will be the weather in San Francisco next week?"
parsing = nlu_engine.parse(text)
print(json.dumps(parsing, indent=2))

What it does is training an NLU engine on a sample weather dataset and parsing a weather query.

Documentation

To find out how to use Snips NLU please refer to our documentation, it will provide you with a step-by-step guide on how to use and setup our library.

FAQ

Please join our Discord channel to ask your questions and get feedback from the community.

How do I contribute ?

Please see the Contribution Guidelines.

Licence

This library is provided by Snips as Open Source software. See LICENSE for more information.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

snips_nlu-0.13.5.tar.gz (8.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

snips_nlu-0.13.5-py2.py3-none-any.whl (8.3 MB view details)

Uploaded Python 2Python 3

File details

Details for the file snips_nlu-0.13.5.tar.gz.

File metadata

  • Download URL: snips_nlu-0.13.5.tar.gz
  • Upload date:
  • Size: 8.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for snips_nlu-0.13.5.tar.gz
Algorithm Hash digest
SHA256 41dcb363474342ae9b8e3a505cb950b18be7d5717249e88ec8c9166591a58ff4
MD5 183ab3849f5abe549a307f2ba06f4511
BLAKE2b-256 ae5903ddca3d1b68189335187f819bd17a889373ac42bbf1cbfcea813bfcda6f

See more details on using hashes here.

File details

Details for the file snips_nlu-0.13.5-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for snips_nlu-0.13.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7b3ec0f509794769fb6c3d59b49cb9651666c8d5d625e71786ea76d45ff85e21
MD5 cf554585d4efba052e9c0a027bb27644
BLAKE2b-256 64a73bb2b9386d02f691b8b5e1d9e2cb134f14d60e8e5fc326a689ad09593e0f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page