About this Task

When you have a pipeline created, it's useful to let others try it out and gather their feedback. You can quickly generate a shareable link to let others try out your pipeline prototype and provide input.

You can make your prototype accessible to anyone with the link, without needing to set up deepset AI Platform accounts, or you can restrict access to people in your deepset organization.

What Am I Sharing?

Users with access to your prototype can:

• View a read-only prototype page.
• Run searches on your pipeline and add feedback to search results.
• Share the prototype link.

They cannot edit or change anything in deepset AI Platform. They gain read-only access to the Search page that uses your pipeline and to the following assets:

• File metadata from the search if you enable metadata filters.
• Documents returned from the search.
• Document metadata from the search.
• The name of the pipeline you shared.
• Any metadata for your pipeline in the document store if you enable the metadata filters for the prototype.

If a user without a deepset account or not logged in to deepset AI Platform opens a shared pipeline link, they only see that specific pipeline. If a logged-in deepset user opens the same link, they see all the deployed pipelines in the workspace they have access to.

Prototypes With Login Required

If you configure the prototype to require login, only logged in users who belong to your deepset organization will be able to view the prototype. They'll be requested to log in when they paste the link into the browser window.

Prototype Lifespan

When sharing a pipeline prototype, you can specify when the link to your prototype should expire. If you want to stop sharing the prototype, you can do so at any time by simply deleting the generated link.

Prototype Style

Use the Style tab in the Share prototype window to customize your prototype look and feel. Add a brand logo and colors.

Here's what a customized prototype where users can view source documents may look like:

Do the Users Need a deepset AI Platform Account?

If the prototype is not set to require login, anyone with the prototype link can use the pipeline right away. They don't need to create or have a deepset account.

Collecting Feedback

When testing your pipeline, users can provide feedback on the answers the pipeline returns. You can then view this feedback on the pipeline details page or export it to a file. Feedback can show you how to optimize your pipeline for better performance.

Updating a Shared Pipeline

If you find you want to change the pipeline you already shared, you can edit it at any time. You'll need to undeploy the pipeline, change it, and then deploy it again. The sharing link stays the same, so all you need to do is let your users know the pipeline may not work until it's deployed again.

Prerequisites

• Your pipeline must be deployed and active so that users can run queries with it and test it out.
• Set the right expectations for your users. For tips on doing this, see Guidelines for Onboarding Your Users.

Share Your Prototype

1. In deepset AI Platform, click Pipelines.
2. Find the pipeline you want to share, and click Share next to it. A window with prototype settings opens.

3. On the Settings tab:
   1. Set the link expiration time.
   2. Add any notes to your users.
      These can be guidelines on how to use the prototype, things they should pay attention to, and so on. These notes are shown on the prototype page the users open with your link.
   3. Decide if the prototype requires login. If you enable this option, only users from your deepset organization will be able to use the prototype after they log in.
   4. Decide if you want to enable metadata filters.
      These are the metadata in your documents. They act as search filters.
   5. Choose if you want the users to be able to see the source documents.
4. Optionally, on the Style tab, upload your logo and choose your brand colors. Your logo shows in the bottom left corner of the shared prototype, and your color is used to highlight the generated answer.
5. Generate and copy the link. You can now send it to anyone you like.

Stop Sharing a Prototype

You can revoke access to your prototype by simply deleting the link. To do this:

1. In deepset AI Platform, click Pipelines.
2. Find the pipeline you want to stop sharing, click the more actions menu next to it, and choose Share.
3. Click Delete link.

When you delete the link, nobody can access the prototype anymore. You need to generate a new link to share the prototype again.