Skip to content

Commit 035295a

Browse files
committed
Update docs
1 parent b8ac0f0 commit 035295a

File tree

5 files changed

+5
-40
lines changed

5 files changed

+5
-40
lines changed

web/docs/apis/intro.md

Lines changed: 2 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ id: introduction
33
title: APIs
44
---
55

6-
LLMStack provides a set of APIs that you can use to access the functionality of LLMStack. You can use these APIs to run apps, endpoints and jobs, manage your data sources etc.,
6+
LLMStack provides a set of APIs that you can use to access the functionality of LLMStack. You can use these APIs to run apps, manage your data sources etc.,
77

88
## Authentication
99

1010
All LLMStack APIs require authentication. You can authenticate using your API Token. You can find your API Token in your [LLMStack Settings](https://localhost:3000/settings). You can pass your API Token in the `Authorization` header with `Token` prefix.
1111

1212
## Streaming Output
1313

14-
For endpoint and app runs, if `stream` parameter is used, output is received in chunks of values for JSON keys. For example, if the output is a JSON object with keys `a`, `b` and `c`, you will receive the output in the following format:
14+
For app runs, if `stream` parameter is used, output is received in chunks of values for JSON keys. For example, if the output is a JSON object with keys `a`, `b` and `c`, you will receive the output in the following format:
1515

1616
```json
1717
{
@@ -25,29 +25,6 @@ You will need to parse the output in your client code and stitch the chunks toge
2525

2626
## API Reference
2727

28-
### Endpoints
29-
30-
:::warning
31-
Endpoints are going to be deprecated in the future releases. Please use [Apps](/docs/apps/introduction) instead.
32-
:::
33-
34-
Run an endpoint.
35-
36-
```bash
37-
POST /api/endpoints/<endpoint_uuid>
38-
```
39-
40-
#### Request
41-
42-
If the endpoint includes variables, you can pass the values for the variables in the request body. You can also pass `stream` parameter to stream the response.
43-
44-
```json
45-
{
46-
"template_values": <KEY_VALUE_JSON>,
47-
"stream": <BOOLEAN>
48-
}
49-
```
50-
5128
### Apps
5229

5330
Run an app.

web/docs/endpoints/intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Endpoints
44
---
55

66
:::warning
7-
Endpoints are going to be deprecated in the future releases. Please use [Apps](/docs/apps/introduction) instead.
7+
Endpoints are deprecated. Please use [Apps](/docs/apps/introduction) instead. This page is only available for users who have already created endpoints. To access the page, go to [http://localhost:3000/endpoint](http://localhost:3000/endpoint).
88
:::
99

1010
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.

web/docs/getting-started/intro.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,6 @@ Processors are the basic building blocks in LLMStack. These provide the function
7979

8080
Providers are the entities that provide the functionality to the processors. For example, OpenAI's ChatGPT processor uses OpenAI's API to generate text. LLMStack comes with a few built-in providers like OpenAI, Cohere, Stability etc. Providers act as namespaces for the processors. You can also create your own providers and add them to LLMStack.
8181

82-
### Endpoints
83-
84-
Endpoints are instances of processors. You can create multiple endpoints based on a single processor. For example, you can create multiple endpoints for OpenAI's ChatGPT processor with different parameters and prompts. These endpoints can be invoked using APIs. Endpoints also form the basis of apps in LLMStack. When an app is created by chaining multiple processors, LLMStack creates an endpoint each of those processors and connects them together.
85-
8682
### Apps
8783

8884
Apps are the final product of LLMStack. Apps are created by chaining multiple processors together. LLMStack provides a visual editor to create apps. Apps can be shared with other users of LLMStack installation. Apps can be invoked using APIs, from the UI or triggered from Slack, Discord etc.

web/docs/getting-started/ui.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,13 @@ The App Builder page allows you to build powerful AI applications using LLMStack
2929

3030
## Playground
3131

32-
The Playground page allows you to test all the available processors in LLMStack. You can test the processors with your own input and configuration before using them in your apps or building an endpoint.
33-
34-
You can create and manage your [endpoints](/docs/endpoints/introduction) from the Playground page.
32+
The Playground page allows you to test all the available processors in LLMStack. You can test the processors with your own input and configuration before using them in your apps.
3533

3634
![Playground Page](/img/ui/llmstack-playground.png)
3735

3836
## History
3937

40-
The History page allows you to view the history of all the apps and endpoints that you have run. You can view the input, output and other information of each run.
38+
The History page allows you to view the history of all the apps and playground tests that you have run. You can view the input, output and other information of each run.
4139

4240
![History Page](/img/ui/llmstack-history.png)
4341

web/sidebars.js

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,6 @@ const sidebars = {
4343
"processors/localai",
4444
],
4545
},
46-
{
47-
type: "category",
48-
label: "Endpoints",
49-
link: { type: "doc", id: "endpoints/introduction" },
50-
items: [],
51-
},
5246
{
5347
type: "category",
5448
label: "Apps",

0 commit comments

Comments
 (0)