Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
au-re committed Dec 1, 2023
1 parent 0ca4cc3 commit f01b339
Show file tree
Hide file tree
Showing 25 changed files with 1,894 additions and 218 deletions.
1,878 changes: 1,714 additions & 164 deletions package-lock.json

Large diffs are not rendered by default.

37 changes: 21 additions & 16 deletions websites/docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -21,30 +21,35 @@ export default defineConfig({
{ text: "API Reference", link: "/api/getting-started" },
{ text: "Blog", link: "https://blog.prompt.studio" },
],

sidebar: [
{ text: "Introduction", link: "/" },
// {
// text: "Guides",
// items: [
// { text: "Getting Started", link: "/guides/getting-started" },
// { text: "Setting up a Provider", link: "/guides/setting-up-provider" },
// ],
// items: [{ text: "Getting Started", link: "/guides/getting-started" }],
// },
{
text: "Concepts",
items: [
{
text: "Instructions",
items: [
{ text: "Prompt", link: "/concepts/prompt" },
{ text: "Chat", link: "/concepts/chat" },
],
},
{ text: "Workflow", link: "/concepts/workflow" },
{ text: "File", link: "/concepts/file" },
{ text: "Knowledge Base", link: "/concepts/knowledge-base" },
{ text: "Secrets", link: "/concepts/secrets" },
{ text: "Tools", link: "/concepts/tools" },
{ text: "Instructions", link: "/concepts/instructions" },
{ text: "Files", link: "/concepts/file" },
{ text: "Knowledge Bases", link: "/concepts/knowledge-base" },
],
},
{
text: "Instructions",
items: [
{ text: "Instruction", link: "/instructions/instruction" },
{ text: "Table", link: "/instructions/table" },
],
},
{
text: "Building Tools",
items: [
{ text: "Introduction", link: "/tools/introduction" },
{ text: "Run your Tool", link: "/tools/run" },
{ text: "Preview your Tool", link: "/tools/preview" },
{ text: "Deploy your Tool", link: "/tools/deploy" },
],
},
{
Expand Down
2 changes: 1 addition & 1 deletion websites/docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"main": "index.js",
"license": "MIT",
"devDependencies": {
"vitepress": "1.0.0-rc.4"
"vitepress": "1.0.0-rc.31"
},
"scripts": {
"start": "vitepress dev",
Expand Down
Binary file modified websites/docs/pages/assets/favicon.ico
Binary file not shown.
16 changes: 6 additions & 10 deletions websites/docs/pages/assets/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 6 additions & 10 deletions websites/docs/pages/assets/logo_inverted.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion websites/docs/pages/concepts/file.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Files are how you keep track of text you want to pass to a Language Models. It is different from an instruction in that
it only contains data. This could be anything from a user question, a short story, a recipe or a research paper.

You can use your files to test your **instructions** or as part of a **workflow**.
You can use your files to test your [instructions](instructions.md) or as part of a [tool](tools.md).

::: warning Under Construction

Expand Down
18 changes: 18 additions & 0 deletions websites/docs/pages/concepts/instructions.md
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,
10 changes: 10 additions & 0 deletions websites/docs/pages/concepts/tools.md
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]`.

:::
43 changes: 41 additions & 2 deletions websites/docs/pages/index.md
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
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# Secrets

In order to connect safely with LLM Providers like OpenAI, you need to manage your API Keys within Prompt Studio. A secret contains stores your sensitive information.
# Instruction

::: warning Under Construction

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# Chat

In Prompt Studio, a chat is a format for an **instruction** to a Language Model. By providing the history of instructions / answers between a user and a Language Model we can improve the quality of the results provided by the language model.
# Table

::: warning Under Construction

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
# Prompt

In Prompt Studio, a prompt is a format for an **instruction** to a Language Model. It is text that the language model will try to complete.

A good prompt should be structured to provide context and guidance to the model to generate a meaningful response.
# Deploy your Tool

::: warning Under Construction

Expand Down
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.
Binary file added websites/docs/pages/tools/images/preview-page.png
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.
Binary file added websites/docs/pages/tools/images/run-tool.png
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.
37 changes: 37 additions & 0 deletions websites/docs/pages/tools/introduction.md
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)
35 changes: 35 additions & 0 deletions websites/docs/pages/tools/preview.md
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)
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# Workflow

A workflow is a series of instructions that can be combined to create more complex features. Once created, your workflow 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.
# Run your Tool

::: warning Under Construction

Expand Down

0 comments on commit f01b339

Please sign in to comment.