-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
25 changed files
with
1,894 additions
and
218 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# Instructions | ||
|
||
In Prompt Studio, an instruction is a command to a Language Model. It is a prompt formatted in a specific way before being provided to an LLM. | ||
|
||
::: warning Under Construction | ||
|
||
The documentation for Prompt Studio is currently under construction. If you have any questions about how Prompt Studio | ||
works you can reach us in our [discord](https://discord.gg/3RxwUEk8fW), or you can send us an email at `[email protected]`. | ||
|
||
::: | ||
|
||
## Prompts | ||
|
||
A good prompt should be structured to provide context and guidance to the model to generate a meaningful response. It is constrained by the context length of the language model used. | ||
|
||
## Instruction types | ||
|
||
There are different ways you can run a prompt, |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Tools | ||
|
||
A tool is a series of [instructions](instructions.md) that can be combined to create more complex features. Once created, your tool can be deployed and becomes available through an API. You can use our SDK or our Rest API to integrate the workflow into your codebase. You can also share a preview of the tool using our [shareable ui]() feature. | ||
|
||
::: warning Under Construction | ||
|
||
The documentation for Prompt Studio is currently under construction. If you have any questions about how Prompt Studio | ||
works you can reach us in our [discord](https://discord.gg/3RxwUEk8fW), or you can send us an email at `[email protected]`. | ||
|
||
::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,51 @@ | ||
# Welcome to the Prompt Studio docs! | ||
|
||
Prompt Studio is a collaborative prompt engineering platform for teams that work with LLMs. With Prompt Studio you can bridge the gap between domain experts and engineers building LLM-powered features. | ||
Prompt Studio is a collaborative no-code platform for teams building LLM-powered apps, tools and assistants. | ||
|
||
Software engineers are crucial for the integration of LLM powered features into a software product but domain experts are just as important. You need the entire team involved in prompt engineering and QA. | ||
It's a fully managed backend were you can quickly build and deploy [AI tools](concepts/tools.md) as [shareable prototypes](tools/preview.md) or integrate them via our [API](tools/deploy.md) into existing software. Prompt Studio makes it easy to integrate LLMs into your application by fully decoupling app development and prompt engineering. | ||
|
||
::: warning Under Construction | ||
|
||
The documentation for Prompt Studio is currently under construction. If you have any questions about how Prompt Studio | ||
works you can reach us in our [discord](https://discord.gg/3RxwUEk8fW), or you can send us an email at `[email protected]`. | ||
|
||
::: | ||
|
||
## Concepts | ||
|
||
- [**Assistants**]() _coming soon_ AI that finds out how to solve a problem using tools and context. | ||
- [**Tools**](concepts/tools.md): Tools are automation for specific tasks, e.g. running a checklist on a document. | ||
- [**Instructions**](concepts/instructions.md): Instructions tell the AI what to do, several instructions can be assembled into a tool. | ||
- [**Files**](concepts/file.md): A file is a piece of text that you can pass to instructions, e.g. a legal contract to analyze. | ||
- [**Knowledge Bases**](concepts/knowledge-base.md): A collection of files that can be provided as context to an assistant or tool. The assistant / tool will pick the most relevant parts of the knowledge base to solve specific queries. | ||
|
||
## Features | ||
|
||
### **Provider Agnostic** | ||
|
||
Connect to LLMs from `Mistral`, `Meta`, `Anthropic` and `OpenAI`, switch between language models at any time. | ||
|
||
### **Instructions with Batteries Included** | ||
|
||
Don't worry about context length, we can run instructions optimized for different use cases, from document analysis to summarization, we provide you with the tools you need out of the box. If you want total control, you can still build your own custom instructions. | ||
|
||
### **No Code Editor** | ||
|
||
Our no-code editor and tailored instructions let you use LLMs without the need to code. | ||
|
||
### **Shareable Previews** | ||
|
||
Turn your AI tools and assistants into shareable previews for your colleagues | ||
|
||
### **API Deployments** | ||
|
||
Prompt Studio is a fully-managed LLM backend that allows you to deploy your AI tools in an instant. We'll take care of infrastructure, scaling and maintenance for you. | ||
|
||
## Use Cases | ||
|
||
LLMs excel in tasks such as personalized customer service, efficient data analysis and synthesis, automating complex workflows, and providing intuitive interfaces for human-machine interaction. Below are some of the things you can build with Prompt Studio: | ||
|
||
- Document Processing (unstructured text to structured data) | ||
- Retrieval + Q&A | ||
- Quick prototyping of AI workflows | ||
- Conversational Systems |
4 changes: 1 addition & 3 deletions
4
websites/docs/pages/concepts/secrets.md → ...es/docs/pages/instructions/instruction.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 1 addition & 3 deletions
4
websites/docs/pages/concepts/chat.md → websites/docs/pages/instructions/table.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 1 addition & 5 deletions
6
websites/docs/pages/concepts/prompt.md → websites/docs/pages/tools/deploy.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Build a Tool | ||
|
||
This guide provides step-by-step instructions on how to build a tool. | ||
|
||
## Step 1: Build your Tool | ||
|
||
To start building your tool, follow these steps: | ||
|
||
- Open the **Tool** tab in the left sidebar. | ||
- Click on the **Create Tool** button. This action will create a new tool that you can edit in the tool editor. | ||
- To add instructions to the tool, click on the **+ Add node** button. | ||
|
||
![Tool Editor Interface](./images/tool-editor-interface.png) | ||
|
||
- Select the **Instruction node**. This node allows you to provide instructions to a language model. | ||
|
||
![Tool Editor Interface](./images/node-select-instruction.png) | ||
|
||
## Step 2: Connecting the Nodes | ||
|
||
After adding an instruction node, you need to connect it properly: | ||
|
||
- You will see a warning on the instruction node. To resolve this, connect its control input to the **Start** node. | ||
- Add a prompt in the input field of the instruction node. For example, use the prompt: `what is the fastest car in the world?`. | ||
- Connect the result output of the instruction node to the **Output** node. | ||
|
||
![Image Placeholder](./images/connect-nodes.png) | ||
|
||
## Step 3: Running the Tool | ||
|
||
To see your tool in action, follow these steps: | ||
|
||
- Click on the **Run Tool tab**. | ||
- Press the **Run Tool** button. | ||
- The result will be displayed in the **output** section of the **Run Tool tab**. | ||
|
||
![Image Placeholder: Running the Tool](./images/run-tool.png) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# Preview Your Tool | ||
|
||
Previewing your tool in Prompt Studio is a straightforward process that allows you to test and interact with your creation in real-time. Follow these simple steps to see your tool in action: | ||
|
||
## Step 1: Locate the Preview Button | ||
|
||
To begin the preview, look for the **Preview** button situated on the top right side of the Tool Editor panel. | ||
|
||
![Preview Button Location](./images/preview-button-location.png) | ||
|
||
## Step 2: Open the Preview Page | ||
|
||
Click the **Preview** button. This action will open a new browser tab, taking you to the preview page where you can interact with your tool. | ||
|
||
![Preview Page](./images/preview-page.png) | ||
|
||
## Step 3: Interact with Your Tool | ||
|
||
On the preview page, you will find the input fields to the left. These fields are dynamic and will reflect the values and parameters you have connected to the `User Input` node in the tool editor. | ||
|
||
![Preview Inputs](./images/preview-inputs.png) | ||
|
||
To the right, the results of your tool will be displayed. These results are based on the values you have connected to the `Ouput` node. | ||
|
||
![Results Section Placeholder](./images/preview-outputs.png) | ||
|
||
### Real-Time Updates | ||
|
||
Any modifications you make to your tool will be instantly reflected in the preview. This allows you to test and iterate quickly. | ||
|
||
## Step 4: Running the Preview | ||
|
||
To execute your tool within the preview, simply click on the `Run` button located in the preview tab. | ||
|
||
![Run Button Placeholder](./images/run-button-placeholder.png) |
4 changes: 1 addition & 3 deletions
4
websites/docs/pages/concepts/workflow.md → websites/docs/pages/tools/run.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters