Echo Example

This is a Scala example.

For any user input this example model returns JSON representation of the query context corresponding to that input. This is a simple demonstration of the JSON output and of most of the NLPCraft-provided data that a user defined model can operate on. This example can be useful during the development to see what object properties are available.

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.echo.EchoModel

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.echo.EchoModel"
  • Program arguments: -probe

Documentation

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

For any questions, feedback or suggestions:

• View & run other examples
• Read documentation, latest Javadoc and REST APIs * Download & Maven/Grape/Gradle/SBT instructions
• File a bug or improvement in JIRA
• Post a question at Stack Overflow using nlpcraft tag
• Access GitHub mirror repository.
• Join project developers on dev@nlpcraft.apache.org

Copyright

Copyright (C) 2020 Apache Software Foundation