docs: more specs and docs

This commit is contained in:
0xSage 2023-11-13 13:27:24 +08:00
parent f1afbb81fd
commit bb2c60d7bb
5 changed files with 8 additions and 8 deletions

View File

@ -16,7 +16,7 @@ See [/chat](/api/chat)
- Equivalent to: https://platform.openai.com/docs/api-reference/chat
```sh=
```sh
POST https://localhost:1337/v1/chat/completions
TODO:

View File

@ -12,7 +12,7 @@ Models are AI models like Llama and Mistral
> Equivalent to: https://platform.openai.com/docs/api-reference/models/object
```json=
```json
{
// OpenAI model compatibility
// https://platform.openai.com/docs/api-reference/models)
@ -48,7 +48,7 @@ See [/model](/api/model)
- Equivalent to: https://platform.openai.com/docs/api-reference/models
```sh=
```sh
GET https://localhost:1337/v1/models # List models
GET https://localhost:1337/v1/models/{model} # Get model object
DELETE https://localhost:1337/v1/models/{model} # Delete model

View File

@ -13,7 +13,7 @@ Assistants can use models and tools.
- `assistant.json`
- Equivalent to: https://platform.openai.com/docs/api-reference/assistants/object
```json=
```json
{
// Jan specific properties
"avatar": "https://lala.png"
@ -42,7 +42,7 @@ Assistants can use models and tools.
- _TODO_: What would modifying Assistant do? (doesn't mutate `index.js`?)
```sh=
```sh
GET https://api.openai.com/v1/assistants # List
POST https://api.openai.com/v1/assistants # C
GET https://api.openai.com/v1/assistants/{assistant_id} # R
@ -52,7 +52,7 @@ DELETE https://api.openai.com/v1/assistants/{assistant_id} # D
## Assistants Filesystem
```sh=
```sh
/assistants
/jan
assistant.json # Assistant configs (see below)

View File

@ -41,7 +41,7 @@ Messages are within `threads` and capture additional metadata.
- Equivalent to: https://platform.openai.com/docs/api-reference/messages
```sh=
```sh
POST https://api.openai.com/v1/threads/{thread_id}/messages # create msg
GET https://api.openai.com/v1/threads/{thread_id}/messages # list messages
GET https://api.openai.com/v1/threads/{thread_id}/messages/{message_id}

View File

@ -31,7 +31,7 @@ Files can be used by `threads`, `assistants` and `fine-tuning`
- Files can exist in several parts of Jan's filesystem
- TODO: are files hard copied into these folders? Or do we define a `files.json` and only record the relative filepath?
```sh=
```sh
/files # root `/files` for finetuning, etc
/assistants
/jan