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

docs: update the content for thread and best practices

Browse Source
This commit is contained in:
Arista Indrajaya 2024-03-06 13:58:12 +07:00
parent dd1f20f8ec
commit 7e2f1d9ada
2 changed files with 14 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/docs/guides/best-practices.mdx
View File

@ -23,21 +23,21 @@ Jan is a versatile platform offering solutions for integrating AI locally across
The [quickstart guide](quickstart.mdx) is designed to facilitate a quick setup process. It provides a clear instruction and simple steps to get you up and running with Jan.ai quickly. Even, if you are inexperienced in AI, the quickstart can offer valuable insights and tips to help you get started quickly.
## Setting up the Right Models
Jan offers a range of pre-configured AI models that is tailored to different tasks and industries. You should indentify which on that aligns with your objectives. There are model's factors to be considered:
Jan offers a range of pre-configured AI models that are tailored to different tasks and industries. You should identify which on that aligns with your objectives. There are factors to be considered:
- Capabilities
- Accuracy
- Processing Speed
:::note
Some of these factors also depends on your hardware, please see [Hardware Requirement](hardware-requiement.mdx).
- Some of these factors also depend on your hardware, please see Hardware Requirement.
- Choosing the right model is important to achieve the best performance.
:::
Choosing the right model is important to achieve the best performance.
## Setting up Jan
Ensure that you familiarize yourself with the Jan application. Jan offers advanced settings that you can adjust. These settings may influence how your AI behaves locally. Please see the [Advanced Settings](./advanced-settings/advanced-settings.mdx) article for a complete list of Jan's configurations and instructions on how to configure them.
## Integrations
One of Jan.ai key features is its ability to integrate with many FileSystemWritableFileStream. Whether you are incorporating Jan.ai with any open-source LLM provider or other WebTransportBidirectionalStream, it is important to understand the integration capabilities and limitations.
One of Jan's key features is its ability to integrate with many systems. Whether you are incorporating Jan.ai with any open-source LLM provider or other tools, it is important to understand the integration capabilities and limitations.
## Mastering the Prompt Engineering
Prompt engineering is an important aspect when dealing with AI models to generate the desired outputs. Mastering this skill can significantly enhance the performance and the responses of the AI. Below are some tips that you can do for prompt engineering:
@ -45,4 +45,4 @@ Prompt engineering is an important aspect when dealing with AI models to generat
- Be specific and details get a more specific answers
- Provide examples or preference text or context at the beginning
- Use a clear and concise language
- Use a certain keywords and phrases
- Use certain keywords and phrases

29
docs/docs/guides/thread.mdx
View File

@ -5,58 +5,45 @@ hide_table_of_contents: true
description: Manage your interaction with AI locally.
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Jan provides a straightforward and private solution for managing your threads with AI on your own device. As you interact with AI using Jan, you'll accumulate a history of threads.
Jan offers easy tools to organize, delete, or review your past threads with AI. This guide will show you how to keep your threads private and well-organized.
<Tabs>
<TabItem value="view" label = "View Thread History" default>
### View Thread History
To view your threads history, follow the steps below:
To view your thread history, follow the steps below:
1. Navigate to the main dashboard.
2. Locate the list of threads screen on the left side.
3. To view a specific thread, simply choose the one you're interested in and then scroll up or down to explore the entire conversation.
</TabItem>
<TabItem value = "manage" label = "Managing Threads">
### Manage the Threads via Folder
To manage your threads history and configurations, follow the steps below:
### Manage Thread via Jan Data Folder
To manage your thread history and configurations, follow the steps below:
1. Navigate to the Thread that you want to manage via the list of threads on the left side of the dashboard.
2. Click on the **three dots (⋮)** on the Thread section.
2. Click on the **three dots (⋮)** in the Thread section.
3. There are two available options to select:
- **Reveal in Finder**: Opens the folder containing the thread history and configurations.
- **View as JSON**: Opens the thread.json file in your default browser.
</TabItem>
<TabItem value = "clean" label = "Clean Threads">
### Clean Threads History
To clean all the messages from a thread, follow the steps below:
1. Navigate to the Thread that you want to clean.
2. Click on the **three dots (⋮)** on the Thread section.
2. Click on the **three dots (⋮)** in the Thread section.
3. Sleect the **Clean Thread** button.
:::note
This will delete all messages in the thread, while keeping the thread settings.
This will delete all messages in the thread while keeping the thread settings.
:::
</TabItem>
<TabItem value="delete" label = "Delete Thread" default>
### Delete Threads History
To delete a thread, follow the steps below:
1. Navigate to the Thread that you want to delete.
2. Click on the **three dots (⋮)** on the Thread section.
2. Click on the **three dots (⋮)** in the Thread section.
3. Sleect the **Delete Thread** button.
:::note
This will delete all messages and the thread settings.
:::
</TabItem>
</Tabs>