Welcome to the Semantic Workbench Codespace

October 1, 2024 · View on GitHub

The steps below will help you get started with the Semantic Workbench app and service.

How to use

Launch VS Code and open the command palette with the F1 key or Ctrl/Cmd+Shift+P
Type Codespaces: Connect to Codespace... and select it
After the Codespace is ready, you will be prompted to open the workspace; click Open Workspace

See OPTIMIZING_FOR_CODESPACES.md for tips on optimizing your Codespaces experience.

Use VS Code > Run and Debug (Ctrl/Cmd+Shift+D) > semantic-workbench to start the project
Open your browser and navigate to https://127.0.0.1:4000
- You may receive a warning about the app not being secure; click Advanced and Proceed to localhost to continue
You can now interact with the app and service in the browser

See the README for more details on how to use the Semantic Workbench app and service.

Launch an example assistant service:
- Using the canonical assistant
  - Use VS Code > Run and Debug (Ctrl/Cmd+Shift+D) > canonical-assistant to start the canonical assistant
- Using an example assistant
  - Use VS Code > Run and Debug (Ctrl/Cmd+Shift+D) > launch assistant (examples/python/python-01-echo-bot) to start the example assistant
- Or create your own assistant service by following the Assistant Development Guide
Add the assistant to the workbench app by clicking the Add Assistant button in the app and selecting the assistant from the list
Configure the assistant and interact with it in the app by clicking on the assistant in the list
From the assistant configuration screen, click New Conversation to start a new conversation with the assistant

We have included an example Python assistant service that echos the user's input and can serve as a starting point for your own assistant service.

See the python-01-echo-bot/README for more details.

When you are done with a Codespace, you can delete it to free up resources.