Skip to content

Latest commit

 

History

History
97 lines (60 loc) · 4.87 KB

deploy-web-link.md

File metadata and controls

97 lines (60 loc) · 4.87 KB
Raw
copyright lastupdated subcollection
years
2015, 2021
2021-03-01
assistant

{:shortdesc: .shortdesc} {:new_window: target="_blank"} {:deprecated: .deprecated} {:important: .important} {:note: .note} {:tip: .tip} {:pre: .pre} {:codeblock: .codeblock} {:screen: .screen} {:javascript: .ph data-hd-programlang='javascript'} {:java: .ph data-hd-programlang='java'} {:python: .ph data-hd-programlang='python'} {:swift: .ph data-hd-programlang='swift'}

Testing your assistant

{: #deploy-web-link}

Use the Preview integration to test your assistant. {: shortdesc}

The preview renders your assistant as a web chat and embeds it in a preview web page. You can test the skills that you added to the assistant by entering text into the chat window. The Preview integration also embeds the chat window in a simple IBM-branded web page. You can copy and paste the web page URL into a web browser and share the page with others to enlist help in testing and getting feedback about the assistant.

Unlike when you test using the "Try it out" pane, any API calls that result from your interactions with the assistant hosted by the preview integration do incur charges.

The name of the integration changed in February 2021. If you created a service instance earlier than that, your integration might be named Preview link. {: note}

Using the Preview integration to test your assistant

{: #deploy-web-link-try}

To test the assistant from a web-hosted chat widget, complete the following steps:

  1. From the Assistants page, click to open the assistant tile that you want to test.

  2. From the Integrations section, click Add integration, and then choose the Preview tile.

    The preview integration is added to your first assistant automatically. If you're using the My first assistant, click the Preview tile to open the integration that was added for you.

    Plus or higher plans only For environments where private endpoints are in use, keep in mind that the preview integration sends traffic over the internet. For more information, see Private network endpoints. {: note}

  3. In the Assistant preview window, submit test utterances to see how the assistant responds.

    If the Connect to agent response is displayed, it means you do not have a conversational skill added to your assistant. You must add one before you can chat with the assistant. {: important}

  4. You can click the Restart conversation button to start a conversation over.

    This action is useful if you want to test different routes through a single conversational flow. Or if you set or change context variable values in a dialog skill and want to see how specifying different values affects the conversation.

    The conversation is restarted after the assistant's inactivity period elapses. The inactivity period can range from 5 minutes to 7 days depending on what you configure for your service plan type. After the intactivity time frame passes, any context variable values that were set during the conversation are set to null or back to their default values. For more information, see Changing the inactivity timeout setting.

  5. To test the assistant from a separate web page, copy and paste the Share this link URL into a web browser.

    An IBM-branded web page is displayed that contains a chat window where you can interact with your assistant. You can share the page with others by sending them the Share this link URL.

  6. After testing, you can close the browser tab to exit the public web page.

  7. Click X to close the Preview integration setup page.

Dialog considerations

{: #deploy-web-link-dialog}

The rich responses that you add to a dialog are displayed in the web-hosted chat widget as expected, with the following exceptions:

  • Connect to human agent: This response type is ignored.

  • Pause: This response type pauses the assistant's activity in the chat widget. However, activity does not resume after the pause until another response is triggered. Whenever you include a pause response type, add another, different response type, such as text, after it.

See Rich responses for more information about response types.

Adding a preview integration

{: #deploy-web-link-add-more}

If you want to create another, separate public web page, you can add another preview integration.

  1. From the Assistant tab, click to open the tile for the assistant that you want to deploy.

  2. Click Add integration.

  3. Click the Preview integration tile.

    A preview page is displayed and a new preview web page is created for you.

  4. Click x to close the preview page.

The integration is named Preview. You cannot change the name.