Skip to content

Commit

Permalink
Update assistant URL parameter docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nobodywasishere committed Nov 2, 2024
1 parent ada3478 commit 081cf2c
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
14 changes: 10 additions & 4 deletions docs/kagi/ai/assistant.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -166,11 +166,17 @@ 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 Parameter for Model Selection
## 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_4o` `gpt_4o_mini` `gpt_4` `gpt_4_turbo` `claude_3_haiku` `claude_3_opus` `claude_3_sonnet` `code` `gemini_pro` `llama-3-405b` `mistral_pixtral` `mistral_large`
`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`.

## Availability

Expand Down
7 changes: 4 additions & 3 deletions docs/kagi/ai/custom-assistants.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@ 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 Parameter for Custom Assistants
## URL Parameters

You can specify a custom assistant by adding a `profile` parameter to the URL, using either the name (in lowercase, hyphenated format) or the UUID of your custom assistant.
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:

Expand All @@ -59,6 +59,8 @@ For instance, if you want to use a specific custom assistant, locate its UUID by

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.
Expand Down Expand Up @@ -120,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. |

0 comments on commit 081cf2c

Please sign in to comment.