Kagi FastGPT Fallback Skill for OVOS

Install or Upgrade

pip install --upgrade git+https://code.sitosis.com/rudism/skill-ovos-fallback-kagi.git

Then restart OVOS (systemctl --user restart ovos, or reboot).

Configure

To use the Kagi FastGPT API, add your Kagi API key to the settings.json (usually found in ~/.config/mycroft/skills/skill-ovos-fallback-kagi.rudism). Each search that isn't cached will use up your Kagi API credits.

{
  "__mycroft_skill_firstrun": false,
  "kagiApiKey": "your-api-key-here"
}

If you are a Kagi Professional or Kagi Ultimate subscriber, you can use the session-based API instead without the need for API credits. This uses the same unofficial API that the FastGPT web interface uses. Keep in mind that since this is not an official API it is more prone to break without notice. To use it, get your session token from Kagi by going to Settings -> Account and looking at your "Session Link." The token is the string of random characters at the end of the url, which should look like https://kagi.com/search?token=abc123xyz. In that example, the token is abc123xyz and your settings.json should look like this:

{
  "__mycroft_skill_firstrun": false,
  "kagiSession": "abc123xyz"
}

By default the session-based API will wait up to 10 seconds for a complete response, but this may not be long enough for longer answers that trigger searches, so you can increase that by setting a timeout value to a different number of seconds. The catch is that if the session API fails to send a [DONE] event then the skill will hang for the full duration before passing the utterance to the next fallback skill.

You can add "verbose": true to your settings to print raw responses from Kagi to the skills log.

Usage

The skill should catch all unrecognized utterances and pass those directly to FastGPT, then read the answer. Best attempt has been made to strip the response of formatting and references. If it doesn't respond you can check the skill logs for possible clues as to why (usually at ~/.local/state/mycroft/skills.log).