https://github.com/mdrokz/llama_internet_chatbot
https://github.com/mdrokz/llama_internet_chatbot
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mdrokz/llama_internet_chatbot
- Owner: mdrokz
- Created: 2023-07-26T10:40:46.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-01-22T21:45:41.000Z (over 1 year ago)
- Last Synced: 2025-01-11T03:27:06.957Z (9 months ago)
- Language: Rust
- Size: 138 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Usage
## Chat API Documentation
This API provides a set of endpoints to manage chats and conversations.
## Models
### Chat
A chat is represented by the following fields:
- `id`: A unique identifier for the chat (UUID).
- `name`: The name of the chat.
- `created_at`: The date and time when the chat was created.
- `updated_at`: The date and time when the chat was last updated.
### Conversation
A conversation is represented by the following fields:
- `id`: A unique identifier for the conversation (UUID).
- `role`: The role of the user in the conversation. It can be either "Human" or "Assistant".
- `chat_id`: The identifier of the chat to which the conversation belongs.
- `message`: The content of the conversation.
- `created_at`: The date and time when the conversation was created.
- `updated_at`: The date and time when the conversation was last updated.
## API Endpoints
### List Chats
- **URL**: `/chats/`
- **Method**: `GET`
- **Response Content-Type**: `application/json`
- **Description**: Returns a list of all chats.
- **Response Example**:
```json
[
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Chat 1",
"created_at": "2023-08-05T14:48:00.000Z",
"updated_at": "2023-08-05T14:48:00.000Z"
},
...
]
```
### Get Chat
- **URL**: `/chats/`
- **Method**: `GET`
- **Response Content-Type**: `application/json`
- **Description**: Returns a specific chat identified by `id`.
- **Response Example**:
```json
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Chat 1",
"created_at": "2023-08-05T14:48:00.000Z",
"updated_at": "2023-08-05T14:48:00.000Z"
}
```
### Create Chat
- **URL**: `/chats/create`
- **Method**: `POST`
- **Response Content-Type**: `application/json`
- **Request Body**:
```json
{
"name": "string"
}
```
- **Description**: Creates a new chat with the provided name.
### Delete Chat
- **URL**: `/chats/delete/`
- **Method**: `DELETE`
- **Response Content-Type**: `application/json`
- **Description**: Deletes the chat identified by `id`.
### Update Chat
- **URL**: `/chats/update/`
- **Method**: `PUT`
- **Response Content-Type**: `application/json`
- **Request Body**:
```json
{
"name": "string",
"updated_at": "datetime"
}
```
- **Description**: Updates the chat identified by `id` with the provided name and updated_at time.
### Create Conversation
- **URL**: `/conversations/create`
- **Method**: `POST`
- **Response Content-Type**: `application/json`
- **Request Body**:
```json
{
"chat_id": "uuid",
"role": "string",
"message": "string"
}
```
- **Description**: Creates a new conversation in the chat identified by `chat_id`, with the provided role and message. The `role` should be either "Human" or "Assistant".
### Inference
- **URL**: `/conversations/inference/`
- **Method**: `GET`
- **Description**: This is a Server-Sent Events (SSE) endpoint that provides real-time updates for the conversation identified by `id`.
### Inference Internet
- **URL**: `/conversations/inference_internet/`
- **Method**: `GET`
- **Description**: This is a Server-Sent Events (SSE) endpoint that provides real-time updates for the conversation identified by `id`, including internet-based inference.