Add the AI Assistant to Reverb 2.0 help

By the end, the Reverb 2.0 help you publish with ePublisher carries a Reverb Assistant that answers readers from the help itself, with citations that open the passage they come from. You need an ePublisher project with a WebWorks Reverb 2.0 target whose Target Settings include the AI Features group, and a web server that serves the output over https: or http:.

Create your account

1. Go to https://platform.webworks.com. On the Sign In page, click Sign up here.

2. Fill in the form, agree to the Terms of Service and Privacy Policy, and click Sign Up.

3. Confirm your email address from the message you receive, then sign in.

4. The first time you sign in, a short welcome asks you to name your organization and choose a plan. You can continue on Pay-As-You-Go and change plans later.

See Create an account and sign in for details.

Create the Assistant

1. In AI Assistants, click Create Assistant. The new Assistant opens on its Configure tab.

2. In Name, enter a name that identifies the help it serves, such as the product or help title.

3. In Instructions, say what the Assistant is and how it should answer. See Write an Assistant's Instructions.

4. Under Origin Domains, enter the domain that serves your published help, such as docs.example.com. See Set an Assistant's Origin Domains.

5. Click Save Changes.

6. On the Install tab, under Reverb 2.0, click Copy to copy the Assistant ID.

Set up the Reverb 2.0 target

1. In ePublisher, open Target Settings for the WebWorks Reverb 2.0 target.

2. In the AI Features group, set Generate Assistant to enable, paste the ID into Assistant ID, and set Generate Knowledge Base to enable.

3. Generate the target. Next to index.html in the output, ePublisher writes the Knowledge Files as a knowledge-*.zip archive.

ePublisher's help describes every AI Features setting: see AI Features.

Upload the Knowledge Files

1. Back on the Assistant's Configure tab, drag the knowledge-*.zip archive onto Knowledge Base, or click Click to browse and choose it.

2. Click Save Changes. The Knowledge Base indexes the archive; wait for indexing to finish before you test.

Upload the new archive each time you publish. See Upload Knowledge Files from ePublisher.

Test it in Preview

Open the Preview tab, or use the Preview pane beside Configure in a wide window, and ask questions your help answers. Each answer shows its citations and what it would cost in deployment; testing within the daily preview allowance is free. See Test an Assistant in Preview.

Put it in deployment

1. On the Configure tab, go to In Deployment. Any requirement still missing is listed there.

2. Turn the In Deployment switch on. The header shows In Deployment.

See Put an Assistant in deployment.

Publish and check

1. Publish the generated output to the server behind your Origin Domain.

2. Open the published help in a browser and open the AI Assistant from the help's menu.

3. Ask a question your help answers, and follow a citation to the passage it opens.

Opened from a file rather than a web server, the help can't reach the Assistant. If the Assistant doesn't answer, see The Assistant doesn't appear or doesn't answer.

Next steps