Merge branch 'docs/add-guides' of https://github.com/janhq/jan into docs/add-guides

This commit is contained in:
0xSage 2023-12-26 08:23:38 +08:00
commit 9ebc73fbf4
9 changed files with 124 additions and 9 deletions

View File

@ -1,12 +1,40 @@
--- ---
title: Starting a Thread title: Starting a Thread
slug: /guides/chatting/start-thread/
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
keywords:
[
Jan AI,
Jan,
ChatGPT alternative,
local AI,
private AI,
conversational AI,
no-subscription fee,
large language model,
chatting,
starting-thread,
]
--- ---
Rough outline: A thread is the conversations between an assistant and a user. This tutorial will walk you through the process of starting a thread on Jan.
Choosing an assistant
Setting assistant instructions ### Setting Thread Title
At thread level
Globally, as default A thread title acts as a name for your thread. It appears on the left side of the chat window, helping you easily navigate through your interactions. If you do not set a thread title, Jan will set it to "New Thread" as default.
Choosing a model
Customizing model params (thread level) ### Setting Assistant Instructions
Customizing engine params
On Jan, you can set assistant instructions that guide the responses of your assistant. These instructions are set at the conversation level. Globally, as default, assistant instructions will apply to all conversations in this thread unless you change it at the conversation level. In one thread, you can change the assistant instructions for each conversation. If you do not set assistant instructions, Jan will set it to empty as default.
### Choosing a Model
Jan offers a variety of models to suit your conversational needs. Each model has its unique characteristics and capabilities. You can choose a model that best fits your needs via the hub and download your preferred model. Then, you can set the model for your thread.
### Customizing Model Params
You can customize the model params for your thread e.g. setting a customized value of max_tokens value for your thread, etc.
<br></br>
![start-thread-gif](./assets/start-thread.gif)

View File

@ -1,3 +1,16 @@
--- ---
title: Uploading docs title: Uploading Docs
slug: /guides/chatting/upload-docs/
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
keywords:
[
Jan AI,
Jan,
ChatGPT alternative,
local AI,
private AI,
conversational AI,
no-subscription fee,
large language model,
]
--- ---

View File

@ -1,3 +1,16 @@
--- ---
title: Uploading Images title: Uploading Images
slug: /guides/chatting/upload-images/
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
keywords:
[
Jan AI,
Jan,
ChatGPT alternative,
local AI,
private AI,
conversational AI,
no-subscription fee,
large language model,
]
--- ---

View File

@ -1,3 +1,43 @@
--- ---
title: Manage Chat History title: Manage Chat History
slug: /guides/chatting/manage-history/
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
keywords:
[
Jan AI,
Jan,
ChatGPT alternative,
local AI,
private AI,
conversational AI,
no-subscription fee,
large language model,
manage-chat-history,
]
--- ---
Jan offers a convenient and private way to interact with a conversational AI locally on your computer. This guide will walk you through how to manage your chat history with Jan, ensuring your interactions remain private and organized.
## Viewing Chat History
1. Navigate to the main dashboard.
2. Locate the list of threads on the left side of the screen. This list shows all your conversations.
3. Select a thread to view the conversation in the main chat window.
4. Scroll up and down to view the entire chat history in the selected thread.
<br></br>
![viewing-chat-history](./assets/manage-history-1.gif)
## Clean Thread
To streamline your conservation view, click on the three dots (⋮) on the thread you want to clean, then select `Clean Thread`. It will remove all messages from the thread. It is useful if you want to keep the thread settings, but want to remove the messages from the chat window.
<br></br>
![clean-thread](./assets/manage-history-2.gif)
## Delete Thread
To delete a thread, click on the three dots (⋮) on the thread you want to delete, then select `Delete Thread`. It will remove the thread from the list of threads.
<br></br>
![delete-thread](./assets/manage-history-3.gif)

View File

@ -1,3 +1,24 @@
--- ---
title: Chatting title: Chatting
slug: /guides/chatting/
description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server.
keywords:
[
Jan AI,
Jan,
ChatGPT alternative,
local AI,
private AI,
conversational AI,
no-subscription fee,
large language model,
chatting,
]
--- ---
This guide is designed to help you maximize your experience with Jan, covering everything from starting engaging threads to managing your chat history effectively.
- [Start a thread](start-thread)
- [Upload docs](upload-docs)
- [Upload images](upload-images)
- [Manage chat history](manage-chat-history)

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 MiB