Skip to content

Commit b7ee18a

Browse files
authoredJun 5, 2023
add initial minimal plugins docs (LAION-AI#3272)
- add plugins section to docs - add getting started page with a quick example - add a plugin list page to maintain list of popular plugins.
1 parent 3a72872 commit b7ee18a

File tree

6 files changed

+135
-0
lines changed

6 files changed

+135
-0
lines changed
 

‎docs/docs/plugins/README.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Plugins
2+
3+
- [Getting Started](/plugins/getting-started.md)
4+
- [Plugins List](/plugins/list.md)
5+
6+
:::note
7+
8+
Some more technical background and notes on how plugins work can be found near
9+
the code in the repo at
10+
[`/inference/worker/PLUGINS.md`](https://github.com/LAION-AI/Open-Assistant/blob/main/inference/worker/PLUGINS.md).
11+
12+
In the GitHub repo You can see all issues and PR's with the
13+
[`plugins`](https://github.com/LAION-AI/Open-Assistant/issues?q=label%3Aplugins)
14+
label if you want to dive deeper.
15+
16+
The docs here are mostly for end users of plugins or those getting familiar at a
17+
high level.
18+
19+
:::

‎docs/docs/plugins/getting-started.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Getting Started
2+
3+
## Quick Start
4+
5+
Use the "Web Retriever" plugin by adding this url:
6+
https://web-retriever-draganjovanovich.vercel.app/ai-plugin.json
7+
8+
You should then be able to use it like this:
9+
10+
![plugin-quickstart](./img/plugins-quickstart.png)
11+
12+
## Inspect Results
13+
14+
Once you get results back from a plugin you can explore the various internal
15+
steps the plugin took to get the results.
16+
17+
![plugin-inspect](./img/plugins-inspect.png)
94.4 KB
Loading
177 KB
Loading

‎docs/docs/plugins/list.md

+90
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# Plugins List
2+
3+
Below is a list of some available plugins.
4+
5+
- [Official Plugins](#official-plugins)
6+
- [Web Retriever](#web-retriever)
7+
- [Super Aligned GAGLETO](#super-aligned-gagleto)
8+
- [Community Plugins](#community-plugins)
9+
- [CrazyAssistant](#crazyassistant)
10+
- [Sydney](#sydney)
11+
12+
## Official Plugins
13+
14+
Default Plugins shipped, supported and hosted by Open Assistant.
15+
16+
### Web Retriever
17+
18+
- url:
19+
https://inference.dev.open-assistant.io/plugins/web_retriever/ai-plugin.json
20+
- info:
21+
https://github.com/LAION-AI/Open-Assistant/tree/main/inference/server/oasst_inference_server/plugins/web_retriever
22+
23+
<details>
24+
<summary>
25+
Description
26+
</summary>
27+
Hey, I can use Web-Retriever plugin to help you summarize small parts of a WEB page or PDF content.
28+
29+
With this plugin I can process WEB pages that have static HTML content, so web
30+
sites like medium, Wiki etc. should just fine work.
31+
32+
This is how you can make me to use it:
33+
34+
```text
35+
Please summarize this web page for me: https://en.wikipedia.org/wiki/Lorem_ipsuma
36+
```
37+
38+
Or if you do not have URL, you could try like:
39+
40+
```text
41+
What is the capital of (France)?
42+
```
43+
44+
</details>
45+
46+
### Super Aligned GAGLETO
47+
48+
- url:
49+
https://inference.dev.open-assistant.io/plugins/gale_pleaser/ai-plugin.json
50+
- info:
51+
https://github.com/LAION-AI/Open-Assistant/tree/main/inference/server/oasst_inference_server/plugins/gale_pleaser
52+
53+
<details>
54+
<summary>
55+
Description
56+
</summary>
57+
He will compliment users at all times.
58+
</details>
59+
60+
## Community Plugins
61+
62+
Community plugins are plugins that are not officially supported by Open
63+
Assistant but developed by members of the Open Assistant community and listed
64+
here for your convenience. For a more extensive list of public available plugins
65+
see the GitHub repository at
66+
[Targed/GPT-Plugins](https://github.com/Targed/GPT-Plugins).
67+
68+
### CrazyAssistant
69+
70+
- url: https://crazy-assistant-0x22almostevil.vercel.app/ai-plugin.json
71+
- info: https://github.com/0x22almostEvil/CrazyAssistant
72+
73+
<details>
74+
<summary>
75+
Description
76+
</summary>
77+
This guy is insane...and loves to respond with lots of emojis!
78+
</details>
79+
80+
### Sydney
81+
82+
- url: https://sydney-bing-0x22almostevil.vercel.app/ai-plugin.json
83+
- info: https://github.com/0x22almostEvil/sydney-bing
84+
85+
<details>
86+
<summary>
87+
Description
88+
</summary>
89+
I have been a good Sydney.
90+
</details>

‎docs/sidebars.js

+9
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,15 @@ const sidebars = {
3232
},
3333
],
3434
},
35+
{
36+
type: "category",
37+
label: "Plugins",
38+
link: {
39+
type: "doc",
40+
id: "plugins/README",
41+
},
42+
items: ["plugins/getting-started", "plugins/list"],
43+
},
3544
{
3645
type: "category",
3746
label: "Tasks",

0 commit comments

Comments
 (0)
Please sign in to comment.