From fbad12336e069553b0a9fb798a6dedd082617310 Mon Sep 17 00:00:00 2001 From: david-ros <138538459+david-ros@users.noreply.github.com> Date: Thu, 31 Oct 2024 19:49:45 -0600 Subject: [PATCH 01/20] Update custom-assistants.md (#570) Improve structure and add Default Custom Assistants section --- docs/kagi/ai/custom-assistants.md | 120 +++++++++++++++++------------- 1 file changed, 67 insertions(+), 53 deletions(-) diff --git a/docs/kagi/ai/custom-assistants.md b/docs/kagi/ai/custom-assistants.md index a731ce8f..41bd3db8 100644 --- a/docs/kagi/ai/custom-assistants.md +++ b/docs/kagi/ai/custom-assistants.md @@ -20,59 +20,6 @@ - Context Window - **Response Instructions**: Define how your assistant should interact (1500 characters max) -## Using Custom Assistants - -Select your Custom Assistant from the model-selection dropdown menu below the prompt bar to begin interaction. - -## Example Configurations - -Here are a few example configurations you can use to get started. You can also visit [Anthropic’s Prompt Library](https://docs.anthropic.com/en/prompt-library/library) for more useful prompts. - -### Professional Writer Assistant -```markdown -Name: Writing Pro -Bang: !write -Internet Access: Enabled (for current writing trends and examples) -Lens: Entire Internet -Instructions: Respond in a professional tone with clear, concise language. Focus on grammar, style, and clarity. Provide constructive feedback on writing samples. When appropriate, suggest improvements while maintaining the original message's intent. -``` - -### Coding Mentor -```markdown -Name: Code Guide -Bang: !code -Internet Access: Enabled (for documentation and best practices) -Lens: Programming -Instructions: Explain programming concepts clearly with practical examples. Use best practices and modern conventions. Include comments in code examples. Focus on readability and maintainability. Highlight potential pitfalls and optimization opportunities. -``` - -### Academic Researcher -```markdown -Name: Research Aid -Bang: !research -Internet Access: Enabled (for current research and papers) -Lens: Academic -Instructions: Provide comprehensive, academic-style responses with clear citations. Focus on peer-reviewed sources when available. Present balanced viewpoints on complex topics. Highlight key findings and methodologies. -``` - -### Recipe Helper -```markdown -Name: Chef Assistant -Bang: !chef -Internet Access: Enabled (for recipes and cooking techniques) -Lens: Recipes -Instructions: Provide clear, step-by-step cooking instructions. Focus on practical cooking tips, ingredient substitutions, and technique explanations. Include serving sizes and preparation times. -``` - -### News Analyst -```markdown -Name: News Guide -Bang: !news -Internet Access: Enabled (for current events) -Lens: World News -Instructions: Analyze current events with balanced perspective. Provide context for news developments. Focus on factual reporting and multiple viewpoints. Summarize key points clearly. -``` - ## Tips for Effective Instructions - Be specific about desired tone and style @@ -95,3 +42,70 @@ Instructions: Analyze current events with balanced perspective. Provide context 5. Update settings as your needs change Remember that well-crafted instructions lead to more accurate and useful responses. Take time to think about your specific needs and how to communicate them effectively. + +## Using Custom Assistants + +Select your Custom Assistant from the model-selection dropdown menu below the prompt bar to begin interaction. + +## Default Custom Assistants + +The Assistant comes with carefully pre-configured assistants designed to enhance your productivity. + +### Code Assistant +Powered by the best AI model for programming tasks and equipped with web access, the Code Assistant excels at: + +- Writing efficient, clean code +- Debugging and troubleshooting +- Providing practical coding solutions + +Simply use the ```!code``` shortcut or select "Code" from the model dropdown to access this specialized assistant. Whether you're debugging a tricky issue, learning a new programming language, or seeking to optimize your code, the Code Assistant is your go-to programming companion. + +## Example Custom Configurations + +Here are a few example configurations you can use to get started. You can also visit [Anthropic’s Prompt Library](https://docs.anthropic.com/en/prompt-library/library) for more useful prompts. + +### Professional Writer Assistant +| Setting | Value | +|---------|-------| +| Name | Writing Pro | +| Bang | !write | +| Internet Access | Enabled (for current writing trends and examples) | +| Lens | Entire Internet | +| Instructions | Respond in a professional tone with clear, concise language. Focus on grammar, style, and clarity. Provide constructive feedback on writing samples. When appropriate, suggest improvements while maintaining the original message's intent. | + +### Coding Mentor +| Setting | Value | +|---------|-------| +| Name | Code Guide | +| Bang | !code | +| Internet Access | Enabled (for documentation and best practices) | +| Lens | Programming | +| Instructions | Explain programming concepts clearly with practical examples. Use best practices and modern conventions. Include comments in code examples. Focus on readability and maintainability. Highlight potential pitfalls and optimization opportunities. | + +### Academic Researcher +| Setting | Value | +|---------|-------| +| Name | Research Aid | +| Bang | !research | +| Internet Access | Enabled (for current research and papers) | +| Lens | Academic | +| Instructions | Provide comprehensive, academic-style responses with clear citations. Focus on peer-reviewed sources when available. Present balanced viewpoints on complex topics. Highlight key findings and methodologies. | + +### Recipe Helper +| Setting | Value | +|---------|-------| +| Name | Chef Assistant | +| Bang | !chef | +| Internet Access | Enabled (for recipes and cooking techniques) | +| Lens | Recipes | +| Instructions | Provide clear, step-by-step cooking instructions. Focus on practical cooking tips, ingredient substitutions, and technique explanations. Include serving sizes and preparation times. | + +### News Analyst +| Setting | Value | +|---------|-------| +| Name | News Guide | +| Bang | !news | +| Internet Access | Enabled (for current events) | +| Lens | World News | +| Instructions | Analyze current events with balanced perspective. Provide context for news developments. Focus on factual reporting and multiple viewpoints. Summarize key points clearly. | + From 978076a7aaac104ffbf49734be68ee3d4056c5dd Mon Sep 17 00:00:00 2001 From: Thibault Molleman Date: Fri, 1 Nov 2024 16:04:21 +0000 Subject: [PATCH 02/20] changes docs about default lenses to reflect the current default lenses (#571) --- docs/kagi/features/lenses.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/kagi/features/lenses.md b/docs/kagi/features/lenses.md index d4d5404c..ee995af8 100644 --- a/docs/kagi/features/lenses.md +++ b/docs/kagi/features/lenses.md @@ -24,17 +24,20 @@ Lenses do not yet support image or video searches. Kagi offers several prebuilt lenses. The following are available by default: -- **Forums**: search forums from around the Web. +- **Forums**: search forums from around the web. - **Programming**: official programming language websites and forums. -- **World News**: recent information from a selection of global news outlets across the globe. -- **Academic**: searches academic domains. -- **PDF**: search for PDF files. -- **Kagi Help and Feedback**: search Kagi's documentation and feedback websites. +- **News 360**: offers a 360-degree perspective on news impacting the globe. +- **Fediverse Forums**: search Lemmy and kbin fediverse forums. +- **Usenet/Archive**: search Usenet Archives and Archive.org non-web collections. +- **Academic**: searches education (.edu) domains. +- **PDFs**: search for PDF files. +- **Kagi Documentation**: searches help.kagi.com, blog.kagi.com, kagifeedback.org, and orionfeedback.org. The following lenses need to be activated from the [Lenses](https://kagi.com/settings?p=lenses) settings. +- **Cyber Security**: search cyber security news websites. - **Small Web**: results that favor noncommercial domains and topics. -- **Recipes**: common sense recipes from sites with no ads. +- **Recipes**: recipes without spam from high-quality (English) recipe sites. ## Lens Example From 0b4f005cc90baa0ab2b1cf3f70948ed60fbc6276 Mon Sep 17 00:00:00 2001 From: Thibault Molleman Date: Sat, 2 Nov 2024 04:40:32 +0000 Subject: [PATCH 03/20] add url parameter for assistant to docs (#572) * add url parameter for assistant to docs * correction * Update assistant URL parameter docs * Minor changes --------- Co-authored-by: Margret Riegert --- docs/kagi/ai/assistant.md | 14 +++++++++++++- docs/kagi/ai/custom-assistants.md | 15 ++++++++++++++- 2 files changed, 27 insertions(+), 2 deletions(-) diff --git a/docs/kagi/ai/assistant.md b/docs/kagi/ai/assistant.md index 553bd748..ae890ce0 100644 --- a/docs/kagi/ai/assistant.md +++ b/docs/kagi/ai/assistant.md @@ -31,7 +31,7 @@ When you use the Assistant by Kagi, your data is never used to train AI models, ## Using the Assistant -The Assistant can be accessed via the Control Center located in the top right corner of all Kagi pages or by clicking on the link in the top right corner of the Kagi homepage. [The direct link](https://kagi.com/assistant) to the Assistant can also be used. +The Assistant can be accessed via the Control Center located in the top right corner of all Kagi pages or by clicking on the link in the top right corner of the Kagi homepage. [The direct link](https://kagi.com/assistant) to the Assistant can also be used. When you first access the Assistant, you will be greeted by a familiar-looking landing page, allowing you to get right into using it. You can either type your prompt or use voice input by pressing the microphone symbol. @@ -166,6 +166,18 @@ You can quickly access Assistant from Kagi Search by using the following [bangs] You can also access the **Code** Custom Assistant with the `!code` bang. +## URL Parameters + +You can specify a particular model in the Assistant's URL by including a `profile` parameter. +`https://kagi.com/assistant?profile=gpt-4o&q=%s` +The available model names include: `gpt-4`, `gpt-4-turbo`, `gpt-4o`, `gpt-4o-mini`, `gemini-pro`, `mistral-nemo`, `mistral-large`, `claude-3-haiku`, `claude-3-sonnet`, `claude-3-opus`, `llama-3-405b`, `code`. + +This can also be used with custom assistants, as described on the [custom assistant documentation](./custom-assistants.md#url-parameters). + +The `internet` parameter can be used to turn on and off internet access, set to `true` to enable, anything else to disable. This overrides the internet setting of the profile used. + +The `lens` parameter can be used to set the lens if internet access is enabled. The value of this is the lowercase format of the lens name, for example, `https://kagi.com/assistant?lens=programming&q=%s` will use the Programming lens. + ## Availability The Assistant is available to all Kagi Ultimate members. diff --git a/docs/kagi/ai/custom-assistants.md b/docs/kagi/ai/custom-assistants.md index 41bd3db8..af746f73 100644 --- a/docs/kagi/ai/custom-assistants.md +++ b/docs/kagi/ai/custom-assistants.md @@ -47,6 +47,20 @@ Remember that well-crafted instructions lead to more accurate and useful respons Select your Custom Assistant from the model-selection dropdown menu below the prompt bar to begin interaction. +## URL Parameters + +You can specify a custom assistant by adding a `profile` parameter to the URL, using either the name (in lowercase format) or the UUID of your custom assistant. + +For instance, if you want to use a specific custom assistant, locate its UUID by navigating to your [Custom Assistants settings page](https://kagi.com/settings?p=assistant), and copy the long UUID found in the URL when editing the assistant. You can then create a custom bang template, like: + +``` +/assistant?q=%s&profile=c03f3098-9ead-408f-93f0-407a77e697db +``` + +This setup will direct the request to your specified assistant. + +More information about assistant URL parameters can be found in the [assistant documentation](./assistant.md#url-parameters). + ## Default Custom Assistants The Assistant comes with carefully pre-configured assistants designed to enhance your productivity. @@ -108,4 +122,3 @@ Here are a few example configurations you can use to get started. You can also v | Internet Access | Enabled (for current events) | | Lens | World News | | Instructions | Analyze current events with balanced perspective. Provide context for news developments. Focus on factual reporting and multiple viewpoints. Summarize key points clearly. | - From c950846dab91b167621207d148584d275a302ea0 Mon Sep 17 00:00:00 2001 From: laiz <89704167+laizxyz@users.noreply.github.com> Date: Sat, 2 Nov 2024 20:08:50 +0200 Subject: [PATCH 04/20] The Assistant page fixes and updates (#573) --- docs/kagi/ai/assistant.md | 25 +++++++++++-------------- 1 file changed, 11 insertions(+), 14 deletions(-) diff --git a/docs/kagi/ai/assistant.md b/docs/kagi/ai/assistant.md index ae890ce0..1639cd23 100644 --- a/docs/kagi/ai/assistant.md +++ b/docs/kagi/ai/assistant.md @@ -4,16 +4,16 @@