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

Add HackMDs to public docs for feedback

Browse Source
This commit is contained in:
Daniel 2023-11-17 18:02:06 +08:00
parent b701e8a8fe
commit 68273f16f6
6 changed files with 52 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/docs/docs/specs/assistants.md
View File

@ -2,6 +2,15 @@
title: "Assistants" title: "Assistants"
--- ---
:::warning
Draft Specification: functionality has not been implemented yet.
Feedback: [HackMD: Assistants Spec](https://hackmd.io/KKAznzZvS668R6Vmyf8fCg)
:::
## User Stories ## User Stories
_Users can chat with an assistant_ _Users can chat with an assistant_
@ -17,7 +26,7 @@ _Users can use Jan - the default assistant_
_Users can create an assistant from scratch_ _Users can create an assistant from scratch_
- [Wireframes here - show create asst flow] - [Wireframes here - show create asst flow]
- Users can select any model for an assistant. See [Model Spec]() - Users can select any model for an assistant. See Model Spec
_Users can create an assistant from an existing assistant_ _Users can create an assistant from an existing assistant_

6
docs/docs/docs/specs/chats.md
View File

@ -2,6 +2,12 @@
title: "Chats" title: "Chats"
--- ---
:::warning
Draft Specification: functionality has not been implemented yet.
:::
Chats are essentially inference requests to a model Chats are essentially inference requests to a model
> OpenAI Equivalent: https://platform.openai.com/docs/api-reference/chat > OpenAI Equivalent: https://platform.openai.com/docs/api-reference/chat

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

@ -2,6 +2,12 @@
title: "Files" title: "Files"
--- ---
:::warning
Draft Specification: functionality has not been implemented yet.
:::
Files can be used by `threads`, `assistants` and `fine-tuning` Files can be used by `threads`, `assistants` and `fine-tuning`
> Equivalent to: https://platform.openai.com/docs/api-reference/files > Equivalent to: https://platform.openai.com/docs/api-reference/files

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

@ -2,6 +2,14 @@
title: "Messages" title: "Messages"
--- ---
:::warning
Draft Specification: functionality has not been implemented yet.
Feedback: [HackMD: Threads Spec](https://hackmd.io/BM_8o_OCQ-iLCYhunn2Aug)
:::
Messages are within `threads` and capture additional metadata. Messages are within `threads` and capture additional metadata.
- Equivalent to: https://platform.openai.com/docs/api-reference/messages - Equivalent to: https://platform.openai.com/docs/api-reference/messages

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

@ -2,6 +2,14 @@
title: "Models" title: "Models"
--- ---
:::warning
Draft Specification: functionality has not been implemented yet.
Feedback: [HackMD: Models Spec](https://hackmd.io/ulO3uB1AQCqLa5SAAMFOQw)
:::
Models are AI models like Llama and Mistral Models are AI models like Llama and Mistral
> OpenAI Equivalent: https://platform.openai.com/docs/api-reference/models > OpenAI Equivalent: https://platform.openai.com/docs/api-reference/models

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

@ -2,6 +2,14 @@
title: "Threads" title: "Threads"
--- ---
:::warning
Draft Specification: functionality has not been implemented yet.
Feedback: [HackMD: Threads Spec](https://hackmd.io/BM_8o_OCQ-iLCYhunn2Aug)
:::
## User Stories ## User Stories
_Users can chat with an assistant in a thread_ _Users can chat with an assistant in a thread_
@ -28,10 +36,10 @@ _Users can delete all thread history_
- Objects contain a `models` field, to track when the user overrides the assistant's default model parameters. - Objects contain a `models` field, to track when the user overrides the assistant's default model parameters.
| Property | Type | Description | Validation | | Property | Type | Description | Validation |
| ---------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | ---------- | ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ |
| `object` | enum: `model`, `assistant`, `thread`, `message` | The Jan Object type | Defaults to `thread` | | `object` | enum: `model`, `assistant`, `thread`, `message` | The Jan Object type | Defaults to `thread` |
| `models` | array | An array of Jan Model Objects. Threads can "override" an assistant's model run parameters. Thread-level model parameters are directly saved in the `thread.models` property! [See `model` spec]() | Defaults to `assistant.models` | | `models` | array | An array of Jan Model Objects. Threads can "override" an assistant's model run parameters. Thread-level model parameters are directly saved in the `thread.models` property! (see Models spec) | Defaults to `assistant.models` |
| `messages` | array | An array of Jan Message Objects. [See `message` spec](https://hackmd.io/7a4Tcaa6QDurEzMY9g8HNg) | Defaults to `[]` | | `messages` | array | An array of Jan Message Objects. (see Messages spec) | Defaults to `[]` |
| `metadata` | map | Useful for storing additional information about the object in a structured format. | Defaults to `{}` | | `metadata` | map | Useful for storing additional information about the object in a structured format. | Defaults to `{}` |
### Generic Example ### Generic Example