From 68273f16f6007804d0ed29184b6440b788bf7dcc Mon Sep 17 00:00:00 2001 From: Daniel <101145494+dan-jan@users.noreply.github.com> Date: Fri, 17 Nov 2023 18:02:06 +0800 Subject: [PATCH] Add HackMDs to public docs for feedback --- docs/docs/docs/specs/assistants.md | 11 ++++++++++- docs/docs/docs/specs/chats.md | 6 ++++++ docs/docs/docs/specs/files.md | 6 ++++++ docs/docs/docs/specs/messages.md | 8 ++++++++ docs/docs/docs/specs/models.md | 8 ++++++++ docs/docs/docs/specs/threads.md | 20 ++++++++++++++------ 6 files changed, 52 insertions(+), 7 deletions(-) diff --git a/docs/docs/docs/specs/assistants.md b/docs/docs/docs/specs/assistants.md index 701e0cc67..eb93265fe 100644 --- a/docs/docs/docs/specs/assistants.md +++ b/docs/docs/docs/specs/assistants.md @@ -2,6 +2,15 @@ title: "Assistants" --- +:::warning + +Draft Specification: functionality has not been implemented yet. + +Feedback: [HackMD: Assistants Spec](https://hackmd.io/KKAznzZvS668R6Vmyf8fCg) + +::: + + ## User Stories _Users can chat with an assistant_ @@ -17,7 +26,7 @@ _Users can use Jan - the default assistant_ _Users can create an assistant from scratch_ - [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_ diff --git a/docs/docs/docs/specs/chats.md b/docs/docs/docs/specs/chats.md index 58047c4c8..fedd6a9c8 100644 --- a/docs/docs/docs/specs/chats.md +++ b/docs/docs/docs/specs/chats.md @@ -2,6 +2,12 @@ title: "Chats" --- +:::warning + +Draft Specification: functionality has not been implemented yet. + +::: + Chats are essentially inference requests to a model > OpenAI Equivalent: https://platform.openai.com/docs/api-reference/chat diff --git a/docs/docs/docs/specs/files.md b/docs/docs/docs/specs/files.md index 70c3e345f..4d62e33d5 100644 --- a/docs/docs/docs/specs/files.md +++ b/docs/docs/docs/specs/files.md @@ -2,6 +2,12 @@ title: "Files" --- +:::warning + +Draft Specification: functionality has not been implemented yet. + +::: + Files can be used by `threads`, `assistants` and `fine-tuning` > Equivalent to: https://platform.openai.com/docs/api-reference/files diff --git a/docs/docs/docs/specs/messages.md b/docs/docs/docs/specs/messages.md index 8bc79d1ae..ed5c5d95b 100644 --- a/docs/docs/docs/specs/messages.md +++ b/docs/docs/docs/specs/messages.md @@ -2,6 +2,14 @@ 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. - Equivalent to: https://platform.openai.com/docs/api-reference/messages diff --git a/docs/docs/docs/specs/models.md b/docs/docs/docs/specs/models.md index 29b45f6a0..467a96d0c 100644 --- a/docs/docs/docs/specs/models.md +++ b/docs/docs/docs/specs/models.md @@ -2,6 +2,14 @@ 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 > OpenAI Equivalent: https://platform.openai.com/docs/api-reference/models diff --git a/docs/docs/docs/specs/threads.md b/docs/docs/docs/specs/threads.md index 29cae6a7c..e7d0fe978 100644 --- a/docs/docs/docs/specs/threads.md +++ b/docs/docs/docs/specs/threads.md @@ -2,6 +2,14 @@ title: "Threads" --- +:::warning + +Draft Specification: functionality has not been implemented yet. + +Feedback: [HackMD: Threads Spec](https://hackmd.io/BM_8o_OCQ-iLCYhunn2Aug) + +::: + ## User Stories _Users can chat with an assistant in a thread_ @@ -27,12 +35,12 @@ _Users can delete all thread history_ - Objects are designed to be compatible with `OpenAI Thread Objects` with additional properties needed to run on our infrastructure. - Objects contain a `models` field, to track when the user overrides the assistant's default model parameters. -| Property | Type | Description | Validation | -| ---------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | -| `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` | -| `messages` | array | An array of Jan Message Objects. [See `message` spec](https://hackmd.io/7a4Tcaa6QDurEzMY9g8HNg) | Defaults to `[]` | -| `metadata` | map | Useful for storing additional information about the object in a structured format. | Defaults to `{}` | +| Property | Type | Description | Validation | +| ---------- | ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | +| `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 Models spec) | Defaults to `assistant.models` | +| `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 `{}` | ### Generic Example