Nicholai/jan
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: syntax highlighting

Browse Source
This commit is contained in:
0xSage 2023-11-24 16:35:25 +08:00
parent 02ceb0b0f8
commit 50fc20858d
5 changed files with 45 additions and 403 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
docs/docs/specs/data-structures.md
View File

@ -8,66 +8,36 @@ This page is still under construction, and should be read as a scratchpad
::: :::
```sh
janroot/
assistants/
assistant-a/
assistant.json
src/
index.ts
threads/
thread-a/
thread-b
models/
model-a/
model.json
```
Jan use the local filesystem for data persistence, similar to VSCode. This allows for composability and tinkerability. Jan use the local filesystem for data persistence, similar to VSCode. This allows for composability and tinkerability.
```sh= ```yaml
/janroot # Jan's root folder (e.g. ~/jan) janroot/ # Jan's root folder (e.g. ~/jan)
/models # For raw AI models models/ # For raw AI models
/threads # For conversation history threads/ # For conversation history
/assistants # For AI assistants' configs, knowledge, etc. assistants/ # For AI assistants' configs, knowledge, etc.
``` ```
```sh= ```yaml
/models /models
/modelA /modelA
model.json # Default model settings model.json # Default model settings
llama-7b-q4.gguf # Model binaries llama-7b-q4.gguf # Model binaries
llama-7b-q5.gguf # Include different quantizations
/threads /threads
/jan-unixstamp-salt /jan-unixstamp
model.json # Overrides assistant/model-level model settings
thread.json # thread metadata (e.g. subject) thread.json # thread metadata (e.g. subject)
messages.json # messages messages.jsonl # messages
content.json # What is this? files/ # RAG
files/ # Future for RAG
/assistants /assistants
/jan /jan # A default assistant that can use all models
assistant.json # Assistant configs (see below) assistant.json # Assistant configs (see below)
package.json # Import npm modules, e.g. Langchain, Llamaindex
# For any custom code /src # For custom code
package.json # Import npm modules
# e.g. Langchain, Llamaindex
/src # Supporting files (needs better name)
index.js # Entrypoint index.js # Entrypoint
process.js # For electron IPC processes (needs better name) # `/threads` at root level
# `/models` at root level
# `/threads` at root level /shakespeare # Example of a custom assistant
# `/models` at root level
/shakespeare
assistant.json assistant.json
model.json # Creator chooses model and settings
package.json package.json
/src
index.js
process.js
/threads # Assistants remember conversations in the future /threads # Assistants remember conversations in the future
/models # Users can upload custom models /models # Users can upload custom models
/finetuned-model
``` ```

8
docs/docs/specs/files.md
View File

@ -18,7 +18,7 @@ Files can be used by `threads`, `assistants` and `fine-tuning`
- Note: OAI's struct doesn't seem very well designed - Note: OAI's struct doesn't seem very well designed
- `files.json` - `files.json`
```json ```js
{ {
// Public properties (OpenAI Compatible: https://platform.openai.com/docs/api-reference/files/object) // Public properties (OpenAI Compatible: https://platform.openai.com/docs/api-reference/files/object)
"id": "file-BK7bzQj3FfZFXr7DbL6xJwfo", "id": "file-BK7bzQj3FfZFXr7DbL6xJwfo",
@ -31,19 +31,25 @@ Files can be used by `threads`, `assistants` and `fine-tuning`
``` ```
## File API ## File API
### List Files ### List Files
> OpenAI Equivalent: https://platform.openai.com/docs/api-reference/files/list > OpenAI Equivalent: https://platform.openai.com/docs/api-reference/files/list
### Upload file ### Upload file
> OpenAI Equivalent: https://platform.openai.com/docs/api-reference/files/create > OpenAI Equivalent: https://platform.openai.com/docs/api-reference/files/create
### Delete file ### Delete file
> OpenAI Equivalent: https://platform.openai.com/docs/api-reference/files/delete > OpenAI Equivalent: https://platform.openai.com/docs/api-reference/files/delete
### Retrieve file ### Retrieve file
> OpenAI Equivalent: https://platform.openai.com/docs/api-reference/files/retrieve > OpenAI Equivalent: https://platform.openai.com/docs/api-reference/files/retrieve
### Retrieve file content ### Retrieve file content
> OpenAI Equivalent: https://platform.openai.com/docs/api-reference/files/retrieve-contents > OpenAI Equivalent: https://platform.openai.com/docs/api-reference/files/retrieve-contents
## Files Filesystem ## Files Filesystem

185
docs/docs/specs/messages.md
View File

@ -19,22 +19,19 @@ This is currently under development.
Messages are saved in the `/threads/{thread_id}` folder in `messages.jsonl` files Messages are saved in the `/threads/{thread_id}` folder in `messages.jsonl` files
```sh ```yaml
jan/ jan/
threads/ threads/
assistant_name_unix_timestamp/ assistant_name_unix_timestamp/
... thread.json # Thread metadata
messages.jsonl messages.jsonl # Messages are stored in jsonl format
jan_2341243134/
...
messages.jsonl
``` ```
## `message.jsonl` ## `message.jsonl`
Individual messages are saved in `jsonl` format for indexing purposes. Individual messages are saved in `jsonl` format for indexing purposes.
```json ```js
{...message_2} {...message_2}
{...message_1} {...message_1}
{...message_0} {...message_0}
@ -44,13 +41,13 @@ Individual messages are saved in `jsonl` format for indexing purposes.
Here's a standard example `message` sent from a user. Here's a standard example `message` sent from a user.
```json ```js
"id": "0", // Sequential or UUID "id": "0", // Sequential or UUID
"object": "thread.message", // Defaults to "thread.message" "object": "thread.message", // Defaults to "thread.message"
"created_at": 1698983503, "created_at": 1698983503,
"thread_id": "thread_asdf", // Defaults to parent thread "thread_id": "thread_asdf", // Defaults to parent thread
"assistant_id": "jan", // Defaults to parent thread "assistant_id": "jan", // Defaults to parent thread
"role": "user", // From either "user" or "assistant" "role": "user", // From either "user" or "assistant"
"content": [ "content": [
{ {
"type": "text", "type": "text",
@ -61,13 +58,11 @@ Here's a standard example `message` sent from a user.
} }
], ],
"metadata": {}, // Defaults to {} "metadata": {}, // Defaults to {}
// "run_id": "...", // Rather than `run` id abstraction
// "file_ids": [],
``` ```
Here's an example `message` response from an assistant. Here's an example `message` response from an assistant.
```json ```js
"id": "0", // Sequential or UUID "id": "0", // Sequential or UUID
"object": "thread.message", // Defaults to "thread.message" "object": "thread.message", // Defaults to "thread.message"
"created_at": 1698983503, "created_at": 1698983503,
@ -84,9 +79,7 @@ Here's an example `message` response from an assistant.
} }
], ],
"metadata": {}, // Defaults to {} "metadata": {}, // Defaults to {}
// "run_id": "...", // KIV "usage": {} // Save chat completion properties https://platform.openai.com/docs/api-reference/chat/object
// "file_ids": [], // KIV
// "usage": {} // KIV: saving chat completion properties https://platform.openai.com/docs/api-reference/chat/object
``` ```
## API Reference ## API Reference
@ -94,165 +87,3 @@ Here's an example `message` response from an assistant.
Jan's `messages` API is compatible with [OpenAI's Messages API](https://platform.openai.com/docs/api-reference/messages), with additional methods for managing messages locally. Jan's `messages` API is compatible with [OpenAI's Messages API](https://platform.openai.com/docs/api-reference/messages), with additional methods for managing messages locally.
See [Jan Messages API](https://jan.ai/api-reference#tag/Messages) See [Jan Messages API](https://jan.ai/api-reference#tag/Messages)
<!-- TODO clean this part up into API -->
<!--
### Get list message
> OpenAI Equivalent: https://platform.openai.com/docs/api-reference/messages/getMessage
- Example request
```shell
curl {JAN_URL}/v1/threads/{thread_id}/messages/{message_id} \
-H "Content-Type: application/json"
```
- Example response
```json
{
"id": "msg_abc123",
"object": "thread.message",
"created_at": 1699017614,
"thread_id": "thread_abc123",
"role": "user",
"content": [
{
"type": "text",
"text": {
"value": "How does AI work? Explain it in simple terms.",
"annotations": []
}
}
],
"file_ids": [],
"assistant_id": null,
"run_id": null,
"metadata": {}
}
```
### Create message
> OpenAI Equivalent: https://platform.openai.com/docs/api-reference/messages/createMessage
- Example request
```shell
curl -X POST {JAN_URL}/v1/threads/{thread_id}/messages \
-H "Content-Type: application/json" \
-d '{
"role": "user",
"content": "How does AI work? Explain it in simple terms."
}'
```
- Example response
```json
{
"id": "msg_abc123",
"object": "thread.message",
"created_at": 1699017614,
"thread_id": "thread_abc123",
"role": "user",
"content": [
{
"type": "text",
"text": {
"value": "How does AI work? Explain it in simple terms.",
"annotations": []
}
}
],
"file_ids": [],
"assistant_id": null,
"run_id": null,
"metadata": {}
}
```
### Get message
> OpenAI Equivalent: https://platform.openai.com/docs/api-reference/assistants/listAssistants
- Example request
```shell
curl {JAN_URL}/v1/threads/{thread_id}/messages/{message_id} \
-H "Content-Type: application/json"
```
- Example response
```json
{
"id": "msg_abc123",
"object": "thread.message",
"created_at": 1699017614,
"thread_id": "thread_abc123",
"role": "user",
"content": [
{
"type": "text",
"text": {
"value": "How does AI work? Explain it in simple terms.",
"annotations": []
}
}
],
"file_ids": [],
"assistant_id": null,
"run_id": null,
"metadata": {}
}
```
### Modify message
> Jan: TODO: Do we need to modify message? Or let user create new message?
# Get message file
> OpenAI Equivalent: https://api.openai.com/v1/threads/{thread_id}/messages/{message_id}/files/{file_id}
- Example request
```shell
curl {JAN_URL}/v1/threads/{thread_id}/messages/{message_id}/files/{file_id} \
-H "Content-Type: application/json"
```
- Example response
```json
{
"id": "file-abc123",
"object": "thread.message.file",
"created_at": 1699061776,
"message_id": "msg_abc123"
}
```
# List message files
> OpenAI Equivalent: https://api.openai.com/v1/threads/{thread_id}/messages/{message_id}/files
````
- Example request
```shell
curl {JAN_URL}/v1/threads/{thread_id}/messages/{message_id}/files/{file_id} \
-H "Content-Type: application/json"
````
- Example response
```json
{
"id": "file-abc123",
"object": "thread.message.file",
"created_at": 1699061776,
"message_id": "msg_abc123"
}
``` -->

17
docs/docs/specs/models.md
View File

@ -22,7 +22,7 @@ In Jan, models are primary entities with the following capabilities:
- Models are organized by individual folders, each containing the binaries and configurations needed to run the model. This makes for easy packaging and sharing. - Models are organized by individual folders, each containing the binaries and configurations needed to run the model. This makes for easy packaging and sharing.
- Model folder names are unique and used as `model_id` default values. - Model folder names are unique and used as `model_id` default values.
```bash ```yaml
jan/ # Jan root folder jan/ # Jan root folder
models/ models/
llama2-70b-q4_k_m/ # Example: standard GGUF model llama2-70b-q4_k_m/ # Example: standard GGUF model
@ -52,9 +52,9 @@ Here's a standard example `model.json` for a GGUF model.
- `source_url`: https://huggingface.co/TheBloke/zephyr-7B-beta-GGUF/. - `source_url`: https://huggingface.co/TheBloke/zephyr-7B-beta-GGUF/.
```json ```js
"id": "zephyr-7b" // Defaults to foldername "id": "zephyr-7b" // Defaults to foldername
"object": "model", // Defaults to "model" "object": "model", // Defaults to "model"
"source_url": "https://huggingface.co/TheBloke/zephyr-7B-beta-GGUF/blob/main/zephyr-7b-beta.Q4_K_M.gguf", "source_url": "https://huggingface.co/TheBloke/zephyr-7B-beta-GGUF/blob/main/zephyr-7b-beta.Q4_K_M.gguf",
"name": "Zephyr 7B" // Defaults to foldername "name": "Zephyr 7B" // Defaults to foldername
"owned_by": "you" // Defaults to you "owned_by": "you" // Defaults to you
@ -63,24 +63,21 @@ Here's a standard example `model.json` for a GGUF model.
"description": "" "description": ""
"state": enum[null, "downloading", "ready", "starting", "stopping", ...] "state": enum[null, "downloading", "ready", "starting", "stopping", ...]
"format": "ggufv3", // Defaults to "ggufv3" "format": "ggufv3", // Defaults to "ggufv3"
"settings": { // Models are initialized with these settings "settings": { // Models are initialized with settings
"ctx_len": "2048", "ctx_len": "2048",
"ngl": "100", "ngl": "100",
"embedding": "true", "embedding": "true",
"n_parallel": "4", "n_parallel": "4",
// KIV: "pre_prompt": "A chat between a curious user and an artificial intelligence",
// KIV:"user_prompt": "USER: ",
// KIV: "ai_prompt": "ASSISTANT: "
} }
"parameters": { // Models are called with these parameters "parameters": { // Models are called parameters
"temperature": "0.7", "temperature": "0.7",
"token_limit": "2048", "token_limit": "2048",
"top_k": "0", "top_k": "0",
"top_p": "1", "top_p": "1",
"stream": "true" "stream": "true"
}, },
"metadata": {} // Defaults to {} "metadata": {} // Defaults to {}
"assets": [ // Filepaths to model binaries; Defaults to current dir "assets": [ // Defaults to current dir
"file://.../zephyr-7b-q4_k_m.bin", "file://.../zephyr-7b-q4_k_m.bin",
] ]
``` ```

174
docs/docs/specs/threads.md
View File

@ -23,13 +23,10 @@ This is currently under development.
- Thread folders follow the naming: `assistant_id` + `thread_created_at`. - Thread folders follow the naming: `assistant_id` + `thread_created_at`.
- Thread folders also contain `messages.jsonl` files. See [messages](/specs/messages). - Thread folders also contain `messages.jsonl` files. See [messages](/specs/messages).
```sh ```yaml
jan/ janroot/
threads/ threads/
assistant_name_unix_timestamp/ assistant_name_unix_timestamp/ # Thread `ID`
thread.json
messages.jsonl
jan_2341243134/
thread.json thread.json
``` ```
@ -43,14 +40,15 @@ jan/
Here's a standard example `thread.json` for a conversation between the user and the default Jan assistant. Here's a standard example `thread.json` for a conversation between the user and the default Jan assistant.
```json ```js
"id": "thread_....", // Defaults to foldername "id": "thread_....", // Defaults to foldername
"object": "thread", // Defaults to "thread" "object": "thread", // Defaults to "thread"
"title": "funny physics joke", // Defaults to "" "title": "funny physics joke", // Defaults to ""
"assistants": [ "assistants": [
{ {
"assistant_id": "jan", // Defaults to "jan" "assistant_id": "jan", // Defaults to "jan"
"model": { // Defaults to 1 currently active model (can be changed before thread is begun) "model": { // Defaults to the currently active model (can be changed before thread is begun)
"id": "...",
"settings": {}, // Defaults to and overrides assistant.json's "settings" (and if none, then model.json "settings") "settings": {}, // Defaults to and overrides assistant.json's "settings" (and if none, then model.json "settings")
"parameters": {}, // Defaults to and overrides assistant.json's "parameters" (and if none, then model.json "parameters") "parameters": {}, // Defaults to and overrides assistant.json's "parameters" (and if none, then model.json "parameters")
} }
@ -65,163 +63,3 @@ Here's a standard example `thread.json` for a conversation between the user and
Jan's Threads API is compatible with [OpenAI's Threads API](https://platform.openai.com/docs/api-reference/threads), with additional methods for managing threads locally. Jan's Threads API is compatible with [OpenAI's Threads API](https://platform.openai.com/docs/api-reference/threads), with additional methods for managing threads locally.
See [Jan Threads API](https://jan.ai/api-reference#tag/Threads) See [Jan Threads API](https://jan.ai/api-reference#tag/Threads)
<!-- TODO clean this part up into API -->
<!--
### Get thread
> OpenAI Equivalent: https://platform.openai.com/docs/api-reference/threads/getThread
- Example request
```shell
curl {JAN_URL}/v1/threads/{thread_id}
```
- Example response
```json
{
"id": "thread_abc123",
"object": "thread",
"created_at": 1699014083,
"assistants": ["assistant-001"],
"metadata": {},
"messages": []
}
```
### Create Thread
> OpenAI Equivalent: https://platform.openai.com/docs/api-reference/threads/createThread
- Example request
```shell
curl -X POST {JAN_URL}/v1/threads \
-H "Content-Type: application/json" \
-d '{
"messages": [{
"role": "user",
"content": "Hello, what is AI?",
"file_ids": ["file-abc123"]
}, {
"role": "user",
"content": "How does AI work? Explain it in simple terms."
}]
}'
```
- Example response
```json
{
"id": "thread_abc123",
"object": "thread",
"created_at": 1699014083,
"metadata": {}
}
```
### Modify Thread
> OpenAI Equivalent: https://platform.openai.com/docs/api-reference/threads/modifyThread
- Example request
```shell
curl -X POST {JAN_URL}/v1/threads/{thread_id} \
-H "Content-Type: application/json" \
-d '{
"messages": [{
"role": "user",
"content": "Hello, what is AI?",
"file_ids": ["file-abc123"]
}, {
"role": "user",
"content": "How does AI work? Explain it in simple terms."
}]
}'
```
- Example response
```json
{
"id": "thread_abc123",
"object": "thread",
"created_at": 1699014083,
"metadata": {}
}
```
- https://platform.openai.com/docs/api-reference/threads/modifyThread
### Delete Thread
> OpenAI Equivalent: https://platform.openai.com/docs/api-reference/threads/deleteThread
- Example request
```shell
curl -X DELETE {JAN_URL}/v1/threads/{thread_id}
```
- Example response
```json
{
"id": "thread_abc123",
"object": "thread.deleted",
"deleted": true
}
```
### List Threads
> This is a Jan-only endpoint, not supported by OAI yet.
- Example request
```shell
curl {JAN_URL}/v1/threads \
-H "Content-Type: application/json" \
```
- Example response
```json
[
{
"id": "thread_abc123",
"object": "thread",
"created_at": 1699014083,
"assistants": ["assistant-001"],
"metadata": {},
"messages": []
},
{
"id": "thread_abc456",
"object": "thread",
"created_at": 1699014083,
"assistants": ["assistant-002", "assistant-002"],
"metadata": {}
}
]
```
### Get & Modify `Thread.Assistants`
-> Can achieve this goal by calling `Modify Thread` API
#### `GET v1/threads/{thread_id}/assistants`
-> Can achieve this goal by calling `Get Thread` API
#### `POST v1/threads/{thread_id}/assistants/{assistant_id}`
-> Can achieve this goal by calling `Modify Assistant` API with `thread.assistant[]`
### List `Thread.Messages`
-> Can achieve this goal by calling `Get Thread` API -->