Tutorial: Demoing Your App

Use this tutorial to learn how to demo your pipeline to others. It may seem an easy topic but there are a couple of things to consider here, for example, user expectations, to make your demo successful.

  • Level: Intermediate
  • Time to complete: 10 minutes
  • Prerequisites:
    • This tutorial assumes some basic knowledge of deepset Cloud. It also assumes that you have a pipeline ready. If you don't, you can complete Tutorial: Building Your First Question Answering App or Tutorial: Building Your First Document Retrieval App.
    • You must be an Admin to complete this tutorial.
  • Goal: After completing this tutorial, you will have demonstrated your pipeline to other users and collected their feedback.

Prepare for Inviting Users

Before other users can test your pipeline, you must make them aware of a couple of things:

  • Ensure that your users understand that if they ask for information about documents that don't exist in deepset Cloud, the system won't be able to find an answer.
  • Ensure that the users understand that the information that they're looking for must exist in the text data stored in deepset Cloud. The application cannot make up answers by itself.
  • Explain what queries work well (for example, natural language questions as opposed to simple keywords or copy-pasted error messages).
  • Make your users aware of what data is indexed in their deepset Cloud search application.

Result: The users now know how to use your pipeline and what to expect. They're ready to run a serach with your pipeline and provide feedback.

Add Users to Your Workspace

  1. Log in to deepset Cloud.
  2. Click your name in the top right corner and select Organization.
  3. Click Invite Users.
  4. Enter the user's details and select Search User as the user's role.
    This sends an email to the user asking them to create an account in deepset Cloud.
  5. Continue until you added all users.
  6. Explan to the users that need to create an account in deepset Cloud using the link in the invitation they got via email.

Result: You have invited all users to test your pipeline. They are now ready to log in to deepset Cloud and run a search.

Ask Your Users to Run a Search and Give Feedback

Explain to your users the steps to run a search:

  1. Log in to deepset Cloud.
  2. Click Search.
  3. Select the pipeline that you want to use.
  4. Ask a question and click Search.
  5. Click the thumbs-up or thumbs-down icon below the answers to indicate if they're correct.

Result: You have explained to your users how to run a search and evaluate the answers. They can now start giving you feedback.

Collect User Feedback

🚧

Coming soon!


Related Links