Skip to content

Commit

Permalink
Add my node
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Yuan <michael@secondstate.io>
  • Loading branch information
juntao committed May 20, 2024
1 parent ea86e56 commit ad9db6a
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/user-guide/apps/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Agent frameworks and apps",
"position": 2,
"position": 3,
"link": {
"type": "generated-index",
"description": "How to use a GaiaNet node as the backend service for an agent framework or app, replacing the OpenAI API."
Expand Down
29 changes: 29 additions & 0 deletions docs/user-guide/mynode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
sidebar_position: 2
---

# Use my GaiaNet node

When you [start a GaiaNet node](../node-guide/quick-start), or you find a node on the web, you could use it as a
web-based chatbot UI and an OpenAI compatible web service. Just load the node's public URL in the browser to open its dashboard.
Let's say the URL is as follows.

```
https://0x1234...xyz.gaianet.network/
```

> Please refer to the [agent apps](apps/intro) section to see how to use the GaiaNet node API in your favorite agent frameworks or apps.
## Web-based chatbot

On the GaiaNet node dashboard, you will see a "Chat with this node" button.

![](chat_button.png)

## OpenAI API replacement

The GaiaNet node is a drop-in replacement for OpenAI API in [agent and LLM apps](apps/intro).
On the GaiaNet node dashboard, you will see a table that shows how to replace OpenAI parameters in those apps.

![](openai_api_options.png)

2 changes: 1 addition & 1 deletion docs/user-guide/nodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 1
---

# Available GaiaNet nodes
# Public GaiaNet nodes

Each GaiaNet node provides a web-based chatbot UI and an OpenAI compatible web service.
Here are some popular nodes. Please refer to the [agent apps](apps/intro) section to see how
Expand Down

0 comments on commit ad9db6a

Please sign in to comment.