tree: 864b50c06ffcd67c76d7bfbdf8f7b658d1c264cb [path history] [tgz]
  1. phone_model.json
  2. PhoneModel.java
  3. README.md
nlpcraft/src/main/scala/org/apache/nlpcraft/examples/phone/README.md

License build Documentation Status Gitter

Phone Service Example

This example simulates voice phone dialing a-la Siri or Google Assistant. It doesn't actually do a phone dialing, but it recognizes the recipient and returns it back. You can easily add access to the contact database and issue the call via many existing REST services.

Running

You can run necessary JVMs for this example the same way from either the command line or IDE. Note that you don't need to start Data Probe standalone if you are only running the unit test as it uses the embedded probe and starts it automatically:

  • Run REST server:
    • Main class: org.apache.nlpcraft.NCStart
    • VM arguments: -Dconfig.override_with_env_vars=true
    • Environment variables:
      • CONFIG_FORCE_nlpcraft_server_tokenProviders="nlpcraft, google"
    • Program arguments: -server
  • Test using built-in model auto-validator:
    • Main class: org.apache.nlpcraft.model.tools.test.NCTestAutoModelValidator
    • VM arguments: -DNLPCRAFT_TEST_MODELS=org.apache.nlpcraft.examples.phone.PhoneModel

If not using built-in test framework (i.e. not using embedded probe) you need to start data probe manually:

  • Run probe standalone and use your own REST client:
    • Main class: org.apache.nlpcraft.NCStart
    • VM arguments: -Dconfig.override_with_env_vars=true
    • Environment variables: CONFIG_FORCE_nlpcraft_probe_models="org.apache.nlpcraft.examples.phone.PhoneModel"
    • Program arguments: -probe

Documentation

See Getting Started guide for more instructions on how to run these examples. See also Integrations section on how to configure 3rd party token providers.

For any questions, feedback or suggestions:

Copyright

Copyright (C) 2020 Apache Software Foundation