Skip to content

Commit

Permalink
endpoints
Browse files Browse the repository at this point in the history
  • Loading branch information
pieroit committed Aug 22, 2024
1 parent c58ca74 commit e18033e
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ nav:
- Rabbit Hole Ingestion: framework/flows/rabbit-hole-ingestion.md

- Production:
- Endpoints: production/endpoints.md
- Clients: production/clients.md
- Administrations:
- Architecture: production/administrators/architecture.md
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@


## 💬 Interacting with the Cat
## Websocket API

While most network communication with LLMs is performed via HTTP, the Cat features full duplex communication:

- two way communication: you send messages to the Cat, and the Cat can send messages to you

## HTTP API

You can play around with the HTTP endpoints directly on your installation, under [`localhost:1865/docs`](http://localhost:1865/docs).
You will find there most of the documentation you need, alongside code snippets in various languages.

## Examples

### Interacting via WebSocket

Example of how to implement a simple chat system using the websocket endpoint at `localhost:1865/ws/`.
!!! info "Request JSON schema"
Expand Down Expand Up @@ -99,7 +112,7 @@ Example of how to implement a simple chat system using the websocket endpoint at
cat_chat();
```

## 🐇 Interacting with Rabbithole
### Upload documents to the Rabbithole

Example of how to send a text file (`.md`,`.pdf.`,`.txt`) to the Cat using the Rabbit Hole at `localhost:1865/rabbithole/`.

Expand Down

0 comments on commit e18033e

Please sign in to comment.