Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add url parameter for assistant to docs #572

Merged
merged 4 commits into from
Nov 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion 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,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.
Expand Down
15 changes: 14 additions & 1 deletion docs/kagi/ai/custom-assistants.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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. |

Loading