docs: update port no
This commit is contained in:
parent
23c7586f15
commit
0258a836a3
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: "Assistants"
|
title: "Assistants"
|
||||||
|
slug: /specs/assistants
|
||||||
---
|
---
|
||||||
|
|
||||||
:::caution
|
:::caution
|
||||||
@ -14,7 +15,7 @@ In Jan, assistants are `primary` entities with the following capabilities:
|
|||||||
|
|
||||||
- Assistants can use `models`, `tools`, handle and emit `events`, and invoke `custom code`.
|
- Assistants can use `models`, `tools`, handle and emit `events`, and invoke `custom code`.
|
||||||
- Users can create custom assistants with saved `model` settings and parameters.
|
- Users can create custom assistants with saved `model` settings and parameters.
|
||||||
- An [OpenAI Assistants API](https://platform.openai.com/docs/api-reference/assistants) compatible endpoint at `localhost:3000/v1/assistants`.
|
- An [OpenAI Assistants API](https://platform.openai.com/docs/api-reference/assistants) compatible endpoint at `localhost:1337/v1/assistants`.
|
||||||
- Jan ships with a default assistant called "Jan" that lets you use all models.
|
- Jan ships with a default assistant called "Jan" that lets you use all models.
|
||||||
|
|
||||||
## Folder Structure
|
## Folder Structure
|
||||||
@ -49,6 +50,7 @@ In Jan, assistants are `primary` entities with the following capabilities:
|
|||||||
"models": [ // Defaults to "*" all models
|
"models": [ // Defaults to "*" all models
|
||||||
{ ...model_0 }
|
{ ...model_0 }
|
||||||
],
|
],
|
||||||
|
"instructions": "Be concise", // A system prompt for the assistant
|
||||||
"events": [], // Defaults to "*"
|
"events": [], // Defaults to "*"
|
||||||
"metadata": {}, // Defaults to {}
|
"metadata": {}, // Defaults to {}
|
||||||
// "tools": [], // Coming soon
|
// "tools": [], // Coming soon
|
||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Chats
|
title: Chats
|
||||||
|
slug: /specs/chats
|
||||||
---
|
---
|
||||||
|
|
||||||
:::caution
|
:::caution
|
||||||
@ -13,7 +14,7 @@ This is currently under development.
|
|||||||
In Jan, `chats` are LLM responses in the form of OpenAI compatible `chat completion objects`.
|
In Jan, `chats` are LLM responses in the form of OpenAI compatible `chat completion objects`.
|
||||||
|
|
||||||
- Models take a list of messages and return a model-generated response as output.
|
- Models take a list of messages and return a model-generated response as output.
|
||||||
- An [OpenAI Chat API](https://platform.openai.com/docs/api-reference/chat) compatible endpoint at `localhost:3000/v1/chats`.
|
- An [OpenAI Chat API](https://platform.openai.com/docs/api-reference/chat) compatible endpoint at `localhost:1337/v1/chats`.
|
||||||
|
|
||||||
## Folder Structure
|
## Folder Structure
|
||||||
|
|
||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: "Files"
|
title: "Files"
|
||||||
|
slug: /specs/files
|
||||||
---
|
---
|
||||||
|
|
||||||
:::warning
|
:::warning
|
||||||
6
docs/docs/specs/engineering/fine-tuning.md
Normal file
6
docs/docs/specs/engineering/fine-tuning.md
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
---
|
||||||
|
title: "Fine-tuning"
|
||||||
|
slug: /specs/finetuning
|
||||||
|
---
|
||||||
|
|
||||||
|
Todo: @hiro
|
||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Messages
|
title: Messages
|
||||||
|
slug: /specs/messages
|
||||||
---
|
---
|
||||||
|
|
||||||
:::caution
|
:::caution
|
||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Models
|
title: Models
|
||||||
|
slug: /specs/models
|
||||||
---
|
---
|
||||||
|
|
||||||
:::caution
|
:::caution
|
||||||
@ -13,7 +14,7 @@ This is currently under development.
|
|||||||
In Jan, models are primary entities with the following capabilities:
|
In Jan, models are primary entities with the following capabilities:
|
||||||
|
|
||||||
- Users can import, configure, and run models locally.
|
- Users can import, configure, and run models locally.
|
||||||
- An [OpenAI Model API](https://platform.openai.com/docs/api-reference/models) compatible endpoint at `localhost:3000/v1/models`.
|
- An [OpenAI Model API](https://platform.openai.com/docs/api-reference/models) compatible endpoint at `localhost:1337/v1/models`.
|
||||||
- Supported model formats: `ggufv3`, and more.
|
- Supported model formats: `ggufv3`, and more.
|
||||||
|
|
||||||
## Folder Structure
|
## Folder Structure
|
||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Prompts
|
title: Prompts
|
||||||
|
slug: /specs/prompts
|
||||||
---
|
---
|
||||||
|
|
||||||
- [ ] /prompts folder
|
- [ ] /prompts folder
|
||||||
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Threads
|
title: Threads
|
||||||
|
slug: /specs/threads
|
||||||
---
|
---
|
||||||
|
|
||||||
:::caution
|
:::caution
|
||||||
@ -1,4 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Fine-tuning"
|
|
||||||
---
|
|
||||||
Todo: @hiro
|
|
||||||
@ -1,3 +0,0 @@
|
|||||||
---
|
|
||||||
title: Home
|
|
||||||
---
|
|
||||||
@ -1,3 +0,0 @@
|
|||||||
---
|
|
||||||
title: Hub
|
|
||||||
---
|
|
||||||
BIN
docs/docs/specs/img/chat-screen.png
Normal file
BIN
docs/docs/specs/img/chat-screen.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 152 KiB |
17
docs/docs/specs/product/chat.md
Normal file
17
docs/docs/specs/product/chat.md
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
---
|
||||||
|
title: Chat
|
||||||
|
slug: /specs/chat
|
||||||
|
---
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
## Motivation
|
||||||
|
|
||||||
|
## User Stories
|
||||||
|
|
||||||
|
<!-- Can also be used as a QA Checklist -->
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
- I can
|
||||||
|
- I can
|
||||||
14
docs/docs/specs/product/hub.md
Normal file
14
docs/docs/specs/product/hub.md
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
---
|
||||||
|
title: Hub
|
||||||
|
slug: /specs/hub
|
||||||
|
---
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
## Motivation
|
||||||
|
|
||||||
|
## User Stories
|
||||||
|
|
||||||
|
<!-- wireframe here -->
|
||||||
|
|
||||||
|
## <!-- Can also be used as a QA Checklist -->
|
||||||
13
docs/docs/specs/product/settings.md
Normal file
13
docs/docs/specs/product/settings.md
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
---
|
||||||
|
title: Settings
|
||||||
|
slug: /specs/settings
|
||||||
|
---
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
## Motivation
|
||||||
|
|
||||||
|
## User Stories
|
||||||
|
|
||||||
|
<!-- wireframe here -->
|
||||||
|
<!-- Can also be used as a QA Checklist -->
|
||||||
13
docs/docs/specs/product/system-monitor.md
Normal file
13
docs/docs/specs/product/system-monitor.md
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
---
|
||||||
|
title: System Monitor
|
||||||
|
slug: /specs/system-monitor
|
||||||
|
---
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
## Motivation
|
||||||
|
|
||||||
|
## User Stories
|
||||||
|
|
||||||
|
<!-- wireframe here -->
|
||||||
|
<!-- Can also be used as a QA Checklist -->
|
||||||
@ -1,5 +0,0 @@
|
|||||||
---
|
|
||||||
title: Settings
|
|
||||||
---
|
|
||||||
|
|
||||||
- [ ] .jan folder in jan root
|
|
||||||
@ -1,3 +0,0 @@
|
|||||||
---
|
|
||||||
title: System Monitor
|
|
||||||
---
|
|
||||||
@ -66,10 +66,10 @@ const sidebars = {
|
|||||||
collapsible: true,
|
collapsible: true,
|
||||||
collapsed: false,
|
collapsed: false,
|
||||||
items: [
|
items: [
|
||||||
"specs/home",
|
"specs/product/chat",
|
||||||
"specs/hub",
|
"specs/product/hub",
|
||||||
"specs/system-monitor",
|
"specs/product/system-monitor",
|
||||||
"specs/settings",
|
"specs/product/settings",
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
|
||||||
@ -79,16 +79,16 @@ const sidebars = {
|
|||||||
collapsible: true,
|
collapsible: true,
|
||||||
collapsed: false,
|
collapsed: false,
|
||||||
items: [
|
items: [
|
||||||
"specs/chats",
|
"specs/engineering/chats",
|
||||||
"specs/models",
|
"specs/engineering/models",
|
||||||
"specs/threads",
|
"specs/engineering/threads",
|
||||||
"specs/messages",
|
"specs/engineering/messages",
|
||||||
"specs/assistants",
|
"specs/engineering/assistants",
|
||||||
// "specs/files",
|
// "specs/engineering/files",
|
||||||
// "specs/jan",
|
// "specs/engineering/jan",
|
||||||
// "specs/fine-tuning",
|
// "specs/engineering/fine-tuning",
|
||||||
// "specs/settings",
|
// "specs/engineering/settings",
|
||||||
// "specs/prompts",
|
// "specs/engineering/prompts",
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user