Skip to content

Commit 56bb3d9

Browse files
committed
Update docs
1 parent c79f4af commit 56bb3d9

File tree

6 files changed

+21
-3
lines changed

6 files changed

+21
-3
lines changed

web/docs/apis/intro.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ You will need to parse the output in your client code and stitch the chunks toge
2727

2828
### Endpoints
2929

30+
:::warning
31+
Endpoints are going to be deprecated in the future releases. Please use [Apps](/docs/apps/introduction) instead.
32+
:::
33+
3034
Run an endpoint.
3135

3236
```bash

web/docs/apps/builder.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,10 @@ In sessions view, you can see the pairs of requests and responses in each sessio
5353

5454
Tests tab allows you to write tests for your app. You can create test sets by clicking on the `Create Test Set` button, provide a name, add input and expected output. You can add more test cases to the test set once it is created. To run the test suite, simply click on the `play` icon in the actions tab of the test suite. You can also run individual test cases by clicking on the `play` icon in the actions tab of the test case.
5555

56+
## Versions
57+
58+
Versions tab allows you to manage versions of your app. You can create a new version of your app by clicking on the `Save App` button and providing a change description. You can use `Save Draft` button and preview changes while you are working on your changes before publishing them to your live app. You can also view the history of your app versions by clicking on the `Versions` tab in the app menu. You can also view the history of individual versions by clicking on the version number in the versions page.
59+
5660
## Integrations
5761

5862
Integrations tab allows you to connect your app to other platforms. You can connect your app to Slack, Discord and more. You can also embed your app in your website using the embed code. You can integrate your app in existing products to provide AI capabilities to your users using the app API.

web/docs/apps/sharing.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,20 @@ id: sharing
33
title: App Sharing
44
---
55

6-
Published apps can be shared with other users. This allows you to share your apps with your team or with the world. You can also use this feature to share apps with your other accounts. There are three different visibility levels for a published app:
6+
Published apps can be shared with other users. This allows you to share your apps with your team or with the world. There are three different visibility levels for a published app:
77

88
![App Sharing](/img/ui/llmstack-sharing.png)
99

10-
- **Private**: Only you or the people you shared the app with can see and run the app. Shared apps will show up in the `Apps Shared With You` section in LLMStack home page of the users you shared the app with.
10+
- **Private**: Only you or the people you shared the app with can see and run the app.
1111

1212
- **Unlisted**: Anyone with the link can see the app. App will not show up in the `Discover` page.
1313

1414
- **Organization**: Only members of the organization you are part of can see the app.
1515

1616
- **Public**: Anyone can see the app. App may show up in the `Discover` page.
17+
18+
You can also share apps with others and collaborate on building apps together using the the `Publish` button in the app builder. For published apps, you can click on the icon next to the app url to change the visibility or sharing settings. There are two kinds of roles you can assign to people you share your app with:
19+
20+
- **Viewer**: Viewers can view the app and run the app. They cannot make any changes to the app.
21+
22+
- **Collaborator**: Collaborators can view the app, run the app and make changes to the app.

web/docs/endpoints/intro.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ id: introduction
33
title: Endpoints
44
---
55

6+
:::warning
7+
Endpoints are going to be deprecated in the future releases. Please use [Apps](/docs/apps/introduction) instead.
8+
:::
9+
610
Endpoints are instances of processors with predefined configuration parameters and can optionally include variables to be filled during runtime. They are available as HTTP APIs that can be invoked using the API key and the endpoint UUID. Endpoints are useful for creating multiple versions of the same processor with different configuration parameters. They can be versioned and form building blocks for apps.
711

812
To illustrate how endpoints are used, imagine you have perfected a prompt for GPT-4 that allows you to extract structured information from a given text. You can create an endpoint with `ChatGPT` processor and the prompt as configuration on LLMStack. You can now use this endpoint in your application to extract structured information from text. If you need to make changes to the prompt, you can create a new version of the endpoint in LLMStack without changing the application code.

web/docs/getting-started/ui.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The Apps page is the first page you see when you log in to LLMStack. It gives yo
2323

2424
## App Builder
2525

26-
The App Builder page allows you to build powerful AI applications using LLMStack. You can connect multiple processors, add data sources, share apps, integrate apps with external services and deploy your apps to production.
26+
The App Builder page allows you to build powerful AI applications using LLMStack. You can connect multiple processors, add data sources, share apps, integrate apps with external services and deploy your apps to production. You can also version your apps, test them and share them with your team.
2727

2828
![App Builder Page](/img/ui/llmstack-app-builder.png)
2929

-110 KB
Loading

0 commit comments

Comments
 (0)