skill-ovos-fallback-chatgpt


Nameskill-ovos-fallback-chatgpt JSON
Version 0.0.2a17 PyPI version JSON
download
home_pagehttps://github.com/OpenVoiceOS/skill-ovos-fallback-chatgpt
Summaryovos chatGPT skill
upload_time2024-04-03 15:52:28
maintainerNone
docs_urlNone
authorJarbasAi
requires_pythonNone
licenseApache-2.0
keywords ovos skill plugin
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # ChatGPT Fallback Skill

When in doubt, ask ChatGPT, powered by [OpenAI Solver](https://github.com/OpenVoiceOS/ovos-solver-plugin-openai-persona).

You need to configure a `key`, get it at https://platform.openai.com/api-keys

Or use a LocalAI (see example below)

## About

Capabilities:

- Remembers what user said earlier in the conversation
- Trained to decline inappropriate requests

Limitations:

- May occasionally generate incorrect information
- May occasionally produce harmful instructions or biased content
- Limited knowledge of world and events after 2021

## Configuration

Under skill settings (`.config/mycroft/skills/skill-ovos-fallback-chatgpt.openvoiceos/settings.json`) you can tweak some parameters for chatGPT.

| Option          | Value                                                                   | Description                                                                           |
| --------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `key`           | `sk-XXXYYYZZZAAABBB123`                                                 | Your `api_key` to access OpenAI API                                                   |
| `persona`       | `You are a helpful assistant who gives very short but factual answers.` | Give a personality to chatGPT                                                         |
| `model`         | `gpt-3.5-turbo`                                                         | LLM model to use, see all the options [here](https://platform.openai.com/docs/models) |
| `api_url`       | `https://llama.smartgic.io/v1`                                          | Optional and **only** required with a local AI server                                 |
| `enable_memory` | `true`                                                                  | Remember the last generated outputs                                                   |
| `memory_size`   | `15`                                                                    | How many memories to keep                                                             |
| `name`          | `Chat G.P.T.`                                                           | Name to give to the AI assistant                                                      |
| `confirmation`  | `true`                                                                  | Spoken confirmation will be triggered when a request is sent to the AI                |

When using a local AI server instead of OpenAI, the `api_url`has to redirect to an alternative/local server compatible with OpenAI API. When using local AI, the `key` can be anything, but it has to exist. Read more about it in the OVOS technical manual, page [persona server](https://openvoiceos.github.io/ovos-technical-manual/persona_server/#compatible-projects)

The default persona is `You are a helpful voice assistant with a friendly tone and fun sense of humor. You respond in 40 words or fewer.`

## Configurations

The skill utilizes the `~/.config/mycroft/skills/skill-ovos-fallback-chatgpt.openvoiceos/settings.json` file which allows you to configure it.

### Configuration for use with OpenAI **(ChatGPT)**

```json
{
  "key": "sk-XXXYYYZZZAAABBB123",
  "model": "gpt-3.5-turbo",
  "persona": "You are a helpful voice assistant with a friendly tone and fun sense of humor",
  "enable_memory": true,
  "memory_size": 15,
  "__mycroft_skill_firstrun": false
}
```

### Configuration for use with Local AI

```json
{
  "api_url": "https://llama.smartgic.io/v1",
  "key": "sk-xxx",
  "persona": "You are a helpful voice assistant with a friendly tone and fun sense of humor",
  "enable_memory": true,
  "memory_size": 15,
  "name": "A.I.",
  "confirmation": false,
  "__mycroft_skill_firstrun": false
}
```

## Examples

- "Explain quantum computing in simple terms"
- "Got any creative ideas for a 10 year old’s birthday?"



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/OpenVoiceOS/skill-ovos-fallback-chatgpt",
    "name": "skill-ovos-fallback-chatgpt",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "ovos skill plugin",
    "author": "JarbasAi",
    "author_email": "jarbasai@mailfence.com",
    "download_url": null,
    "platform": null,
    "description": "# ChatGPT Fallback Skill\n\nWhen in doubt, ask ChatGPT, powered by [OpenAI Solver](https://github.com/OpenVoiceOS/ovos-solver-plugin-openai-persona).\n\nYou need to configure a `key`, get it at https://platform.openai.com/api-keys\n\nOr use a LocalAI (see example below)\n\n## About\n\nCapabilities:\n\n- Remembers what user said earlier in the conversation\n- Trained to decline inappropriate requests\n\nLimitations:\n\n- May occasionally generate incorrect information\n- May occasionally produce harmful instructions or biased content\n- Limited knowledge of world and events after 2021\n\n## Configuration\n\nUnder skill settings (`.config/mycroft/skills/skill-ovos-fallback-chatgpt.openvoiceos/settings.json`) you can tweak some parameters for chatGPT.\n\n| Option          | Value                                                                   | Description                                                                           |\n| --------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |\n| `key`           | `sk-XXXYYYZZZAAABBB123`                                                 | Your `api_key` to access OpenAI API                                                   |\n| `persona`       | `You are a helpful assistant who gives very short but factual answers.` | Give a personality to chatGPT                                                         |\n| `model`         | `gpt-3.5-turbo`                                                         | LLM model to use, see all the options [here](https://platform.openai.com/docs/models) |\n| `api_url`       | `https://llama.smartgic.io/v1`                                          | Optional and **only** required with a local AI server                                 |\n| `enable_memory` | `true`                                                                  | Remember the last generated outputs                                                   |\n| `memory_size`   | `15`                                                                    | How many memories to keep                                                             |\n| `name`          | `Chat G.P.T.`                                                           | Name to give to the AI assistant                                                      |\n| `confirmation`  | `true`                                                                  | Spoken confirmation will be triggered when a request is sent to the AI                |\n\nWhen using a local AI server instead of OpenAI, the `api_url`has to redirect to an alternative/local server compatible with OpenAI API. When using local AI, the `key` can be anything, but it has to exist. Read more about it in the OVOS technical manual, page [persona server](https://openvoiceos.github.io/ovos-technical-manual/persona_server/#compatible-projects)\n\nThe default persona is `You are a helpful voice assistant with a friendly tone and fun sense of humor. You respond in 40 words or fewer.`\n\n## Configurations\n\nThe skill utilizes the `~/.config/mycroft/skills/skill-ovos-fallback-chatgpt.openvoiceos/settings.json` file which allows you to configure it.\n\n### Configuration for use with OpenAI **(ChatGPT)**\n\n```json\n{\n  \"key\": \"sk-XXXYYYZZZAAABBB123\",\n  \"model\": \"gpt-3.5-turbo\",\n  \"persona\": \"You are a helpful voice assistant with a friendly tone and fun sense of humor\",\n  \"enable_memory\": true,\n  \"memory_size\": 15,\n  \"__mycroft_skill_firstrun\": false\n}\n```\n\n### Configuration for use with Local AI\n\n```json\n{\n  \"api_url\": \"https://llama.smartgic.io/v1\",\n  \"key\": \"sk-xxx\",\n  \"persona\": \"You are a helpful voice assistant with a friendly tone and fun sense of humor\",\n  \"enable_memory\": true,\n  \"memory_size\": 15,\n  \"name\": \"A.I.\",\n  \"confirmation\": false,\n  \"__mycroft_skill_firstrun\": false\n}\n```\n\n## Examples\n\n- \"Explain quantum computing in simple terms\"\n- \"Got any creative ideas for a 10 year old\u2019s birthday?\"\n\n\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "ovos chatGPT skill",
    "version": "0.0.2a17",
    "project_urls": {
        "Homepage": "https://github.com/OpenVoiceOS/skill-ovos-fallback-chatgpt"
    },
    "split_keywords": [
        "ovos",
        "skill",
        "plugin"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "634a11aad3c140d657267eb022e07d8e986df8bb6207eab3b0eee2109f059012",
                "md5": "1353edc5366c120afc01eedc4bc55550",
                "sha256": "0346f2a3b1aee3e85dc4ba0fe42a24f5889f2871799092002c4d5837c046ea50"
            },
            "downloads": -1,
            "filename": "skill_ovos_fallback_chatgpt-0.0.2a17-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1353edc5366c120afc01eedc4bc55550",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 20508,
            "upload_time": "2024-04-03T15:52:28",
            "upload_time_iso_8601": "2024-04-03T15:52:28.820820Z",
            "url": "https://files.pythonhosted.org/packages/63/4a/11aad3c140d657267eb022e07d8e986df8bb6207eab3b0eee2109f059012/skill_ovos_fallback_chatgpt-0.0.2a17-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-03 15:52:28",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "OpenVoiceOS",
    "github_project": "skill-ovos-fallback-chatgpt",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "skill-ovos-fallback-chatgpt"
}
        
Elapsed time: 0.21707s