Skip to content

Commit

Permalink
adding a new section - demo
Browse files Browse the repository at this point in the history
  • Loading branch information
WiolaGreen committed Jul 10, 2024
1 parent 348329f commit 7c2a0d9
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/_data/navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ docs:
url: /docs/quick-start-guide/
- title: "Project Setup"
url: /docs/how-to-setup-llm-proxy-project/
- title: "Demo"
url: /docs/demo/
- title: Advanced Settings
children:
- title: "Input/output capturing"
Expand Down Expand Up @@ -49,7 +51,7 @@ docs:
- title: "Login Page"
url: /docs/login-page
- title: "Organization Dashboard"
url: /docs/organization-dashboard
url: /docs/organization-dashboard/
- title: "Project Dashboard"
url: /docs/project-dashboard
- title: "Transactions View"
Expand Down
37 changes: 37 additions & 0 deletions docs/_docs/03-demo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: "Demo"
permalink: /docs/demo/
excerpt: "What is and how to use a Prompt sail demo"
last_modified_at: 2024-07-10T12:46:35+01:00
redirect_from:
- /theme-setup/
toc: true
toc_sticky: true
---


## Prompt Sail demo


Experience the functionalities of Prompt Sail firsthand by utilizing our demo at https://try-promptsail.azurewebsites.net/.

No installation or account creation is required, making it a straightforward process.
{: .notice--warning}

The demo provides an insight into the user interface of Prompt Sail, and its architecture, and allows to test the capture of the transactions (Gen AI model calls).

To logg your AI API call in the demo:

1. Visit https://try-promptsail.azurewebsites.net/.
2. Access the list of projects by clicking the "Get Started" button. (No account creation or login is required.)
3. Select an existing project or create a new one.
4. Obtain the proxy URL required to initiate the logging of calls to Gen AI models.
1. In the Project Dashboard, navigate to the AI Providers tab. Select an available deployment. or create your own if the required provider is not listed.
2. Copy the auto-generated proxy URL and integrate it into your script/application that communicates with the chosen Gen AI model.
5. Execute your script/application with the proxy URL and return to the Prompt Sail demo.
6. In the Project Dashboard, under the Transactions tab, you will see a table containing transactions, including the one from your AI API call.
7. By clicking on the transaction ID, you will go to its details.
8. Whereas the Overview tab provides a comprehensive view of all transaction statistics for the project.

**Warning**: The Prompt Sail demo is public, so avoid including any sensitive information in your prompts when testing the demo. Each new deployment of https://try-promptsail.azurewebsites.net/ resets the database, causing projects and transactions in the demo to be regularly deleted.
{: .notice--warning}

0 comments on commit 7c2a0d9

Please sign in to comment.