tree: c7b449e44326d34b00f7388c875516a3a1981aa7 [path history] [tgz]
  1. HelloWorldModel.java
  2. README.md
nlpcraft/src/main/scala/org/apache/nlpcraft/examples/helloworld/README.md

License build Documentation Status Gitter

HelloWorld Example

This trivial example simply responds with ‘Hello World!’ on any user input. This is the simplest and shortest user model that can be defined.

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
    • 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.helloworld.HelloWorldModel

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.helloworld.HelloWorldModel"
    • Program arguments: -probe

Documentation

See Getting Started guide for more instructions on how to run these examples.

For any questions, feedback or suggestions:

Copyright

Copyright (C) 2020 Apache Software Foundation