docs: update port no
This commit is contained in:
parent
23c7586f15
commit
0258a836a3
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: "Assistants"
|
||||
slug: /specs/assistants
|
||||
---
|
||||
|
||||
:::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`.
|
||||
- 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.
|
||||
|
||||
## Folder Structure
|
||||
@ -49,6 +50,7 @@ In Jan, assistants are `primary` entities with the following capabilities:
|
||||
"models": [ // Defaults to "*" all models
|
||||
{ ...model_0 }
|
||||
],
|
||||
"instructions": "Be concise", // A system prompt for the assistant
|
||||
"events": [], // Defaults to "*"
|
||||
"metadata": {}, // Defaults to {}
|
||||
// "tools": [], // Coming soon
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Chats
|
||||
slug: /specs/chats
|
||||
---
|
||||
|
||||
:::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`.
|
||||
|
||||
- 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
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: "Files"
|
||||
slug: /specs/files
|
||||
---
|
||||
|
||||
:::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
|
||||
slug: /specs/messages
|
||||
---
|
||||
|
||||
:::caution
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Models
|
||||
slug: /specs/models
|
||||
---
|
||||
|
||||
:::caution
|
||||
@ -13,7 +14,7 @@ This is currently under development.
|
||||
In Jan, models are primary entities with the following capabilities:
|
||||
|
||||
- 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.
|
||||
|
||||
## Folder Structure
|
||||
@ -1,7 +1,8 @@
|
||||
---
|
||||
title: Prompts
|
||||
slug: /specs/prompts
|
||||
---
|
||||
|
||||
- [ ] /prompts folder
|
||||
- [ ] How to add to prompts
|
||||
- [ ] Assistants can have suggested Prompts
|
||||
- [ ] Assistants can have suggested Prompts
|
||||
@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Threads
|
||||
slug: /specs/threads
|
||||
---
|
||||
|
||||
:::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,
|
||||
collapsed: false,
|
||||
items: [
|
||||
"specs/home",
|
||||
"specs/hub",
|
||||
"specs/system-monitor",
|
||||
"specs/settings",
|
||||
"specs/product/chat",
|
||||
"specs/product/hub",
|
||||
"specs/product/system-monitor",
|
||||
"specs/product/settings",
|
||||
],
|
||||
},
|
||||
|
||||
@ -79,16 +79,16 @@ const sidebars = {
|
||||
collapsible: true,
|
||||
collapsed: false,
|
||||
items: [
|
||||
"specs/chats",
|
||||
"specs/models",
|
||||
"specs/threads",
|
||||
"specs/messages",
|
||||
"specs/assistants",
|
||||
// "specs/files",
|
||||
// "specs/jan",
|
||||
// "specs/fine-tuning",
|
||||
// "specs/settings",
|
||||
// "specs/prompts",
|
||||
"specs/engineering/chats",
|
||||
"specs/engineering/models",
|
||||
"specs/engineering/threads",
|
||||
"specs/engineering/messages",
|
||||
"specs/engineering/assistants",
|
||||
// "specs/engineering/files",
|
||||
// "specs/engineering/jan",
|
||||
// "specs/engineering/fine-tuning",
|
||||
// "specs/engineering/settings",
|
||||
// "specs/engineering/prompts",
|
||||
],
|
||||
},
|
||||
],
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user