diff --git a/docs/src/pages/docs/_assets/assistant-01.png b/docs/src/pages/docs/_assets/assistant-01.png new file mode 100644 index 000000000..5b3546032 Binary files /dev/null and b/docs/src/pages/docs/_assets/assistant-01.png differ diff --git a/docs/src/pages/docs/_assets/quick-start-02.png b/docs/src/pages/docs/_assets/quick-start-02.png index 7fa43fe38..f1ecd7ee5 100644 Binary files a/docs/src/pages/docs/_assets/quick-start-02.png and b/docs/src/pages/docs/_assets/quick-start-02.png differ diff --git a/docs/src/pages/docs/assistants.mdx b/docs/src/pages/docs/assistants.mdx index 7f2af63e0..6932dc051 100644 --- a/docs/src/pages/docs/assistants.mdx +++ b/docs/src/pages/docs/assistants.mdx @@ -20,15 +20,49 @@ keywords: import { Callout, Steps } from 'nextra/components' # Assistants -This guide explains how to set the Assistant instructions in the Jan application. +Assistant is a configuration profile that determines how the AI should behave and respond to your inputs. It consists of: +- A set of instructions that guide the AI's behavior +- Model settings for AI responses +- Tool configurations (like [knowlegde retrieval](/docs/tools/retrieval) settings) + +Currently, Jan comes with a single default Assistant named **Jan**, which is used across all your threads. We're working on the ability to create and switch between multiple assistants. + +## Set Assistant Instructions +By modifying assistant instructions, you can customize how Jan understands and responds to your queries, what context it should consider, and how it should format its responses. + +1. In any **Thread**, click the **Assistant** tab in the **right sidebar** +2. Enter your custom instructions in **Instructions** input field +3. Your instructions will be applied to the current thread right after you click out of the instruction field . + +![Set Instructions](./_assets/quick-start-02.png) + +**Best Practices for Instructions:** +- Be clear and specific about the desired behavior +- Include any consistent preferences for formatting, tone, or style + +**Examples:** + +Here are some example instructions you might set: +``` +Act as a software development mentor focused on Python and JavaScript. +Provide detailed explanations with code examples when relevant. +Use markdown formatting for code blocks. +``` +``` +Respond in a casual, friendly tone. Keep explanations brief and use simple language. +Provide examples when explaining complex topics. +``` + + +## Apply Instructions to New Threads +You can save Assistant instructions to be automatically applied to all new threads: + +1. In any **Thread**, click the **Assistant** tab in the **right sidebar** +2. Toggle the **Save instructions for new threads** slider +3. When enabled, all **new threads** will use these instructions as their default, old threads are not affected -## Applied the Instructions to All Threads -To apply the instructions to all the new threads, follow these steps: -1. Select a **Thread**. -2. Click the **Assistant** tab. -3. Toggle the **slider** to ensure these instructions are applied to all new threads. (Activate the **Experimental Mode** feature to enable this option.)
-![Assistant Slider](./_assets/assistant-slider.png) +![Assistant Slider](./_assets/assistant-01.png)
\ No newline at end of file