# Neon Iris
Neon Iris (Interactive Relay for Intelligence Systems) provides tools for
interacting with Neon systems remotely, via [MQ](https://github.com/NeonGeckoCom/chat_api_mq_proxy).
Install the Iris Python package with: `pip install neon-iris`
The `iris` entrypoint is available to interact with a bus via CLI. Help is available via `iris --help`.
## Configuration
Configuration files can be specified via environment variables. By default,
`Iris` will read configuration from `~/.config/neon/diana.yaml` where
`XDG_CONFIG_HOME` is set to the default `~/.config`.
More information about configuration handling can be found
[in the docs](https://neongeckocom.github.io/neon-docs/quick_reference/configuration/).
> *Note:* The neon-iris Docker image uses `neon.yaml` by default because the
> `iris` web UI is often deployed with neon-core.
A default configuration might look like:
```yaml
MQ:
server: neonaialpha.com
port: 25672
users:
mq_handler:
user: neon_api_utils
password: Klatchat2021
iris:
default_lang: en-us
languages:
- en-us
- uk-ua
webui_chatbot_label: "Neon AI"
webui_mic_label: "Speak with Neon"
webui_input_placeholder: "Chat with Neon"
```
### Language Support
For Neon Core deployments that support language support queries via MQ, `languages`
may be removed and `enable_lang_api: True` added to configuration. This will use
the reported STT/TTS supported languages in place of any `iris` configuration.
## Interfacing with a Diana installation
The `iris` CLI includes utilities for interacting with a `Diana` backend. Use
`iris --help` to get a current list of available commands.
### `iris start-listener`
This will start a local wake word recognizer and use a remote Neon
instance connected to MQ for processing audio and providing responses.
### `iris start-gradio`
This will start a local webserver and serve a Gradio UI to interact with a Neon
instance connected to MQ.
### `iris start-client`
This starts a CLI client for typing inputs and receiving responses from a Neon
instance connected via MQ.
Raw data
{
"_id": null,
"home_page": "https://github.com/neongeckocom/neon-iris",
"name": "neon-iris",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Neongecko",
"author_email": "developers@neon.ai",
"download_url": "https://files.pythonhosted.org/packages/68/41/50bd31caaf7df1fe0cac875223972888ce54e56060ae82245773501f5927/neon-iris-0.1.0.tar.gz",
"platform": null,
"description": "# Neon Iris\nNeon Iris (Interactive Relay for Intelligence Systems) provides tools for\ninteracting with Neon systems remotely, via [MQ](https://github.com/NeonGeckoCom/chat_api_mq_proxy).\n\nInstall the Iris Python package with: `pip install neon-iris`\nThe `iris` entrypoint is available to interact with a bus via CLI. Help is available via `iris --help`.\n\n## Configuration\nConfiguration files can be specified via environment variables. By default, \n`Iris` will read configuration from `~/.config/neon/diana.yaml` where \n`XDG_CONFIG_HOME` is set to the default `~/.config`.\nMore information about configuration handling can be found \n[in the docs](https://neongeckocom.github.io/neon-docs/quick_reference/configuration/).\n> *Note:* The neon-iris Docker image uses `neon.yaml` by default because the\n> `iris` web UI is often deployed with neon-core.\n\nA default configuration might look like:\n```yaml\nMQ:\n server: neonaialpha.com\n port: 25672\n users:\n mq_handler:\n user: neon_api_utils\n password: Klatchat2021\niris:\n default_lang: en-us\n languages:\n - en-us\n - uk-ua\n webui_chatbot_label: \"Neon AI\"\n webui_mic_label: \"Speak with Neon\"\n webui_input_placeholder: \"Chat with Neon\"\n```\n\n### Language Support\nFor Neon Core deployments that support language support queries via MQ, `languages`\nmay be removed and `enable_lang_api: True` added to configuration. This will use\nthe reported STT/TTS supported languages in place of any `iris` configuration.\n\n## Interfacing with a Diana installation\nThe `iris` CLI includes utilities for interacting with a `Diana` backend. Use\n`iris --help` to get a current list of available commands.\n\n### `iris start-listener`\nThis will start a local wake word recognizer and use a remote Neon \ninstance connected to MQ for processing audio and providing responses.\n\n### `iris start-gradio`\nThis will start a local webserver and serve a Gradio UI to interact with a Neon\ninstance connected to MQ.\n\n### `iris start-client`\nThis starts a CLI client for typing inputs and receiving responses from a Neon \ninstance connected via MQ.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Interactive Relay for Intelligence Systems",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/neongeckocom/neon-iris"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f39a8305fa231022c2ed7128702f4ad9500aab79f2ca47cc046b0d3c55c9fca1",
"md5": "e6872fb317a41c1dca2a3d05e29b04bb",
"sha256": "a469ee07e858e11ff294b01463b7b7d3f81c2e8f7d7354511b623f82e243deec"
},
"downloads": -1,
"filename": "neon_iris-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e6872fb317a41c1dca2a3d05e29b04bb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 25110,
"upload_time": "2023-12-20T17:37:32",
"upload_time_iso_8601": "2023-12-20T17:37:32.626344Z",
"url": "https://files.pythonhosted.org/packages/f3/9a/8305fa231022c2ed7128702f4ad9500aab79f2ca47cc046b0d3c55c9fca1/neon_iris-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "684150bd31caaf7df1fe0cac875223972888ce54e56060ae82245773501f5927",
"md5": "f9ad9b89661866dbccc2f411bd74a6f4",
"sha256": "522930a6114958d1304b4b87d0114f365d7124d9b7b4dd3cd6e7660a9eeb090f"
},
"downloads": -1,
"filename": "neon-iris-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "f9ad9b89661866dbccc2f411bd74a6f4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 17966,
"upload_time": "2023-12-20T17:37:34",
"upload_time_iso_8601": "2023-12-20T17:37:34.515137Z",
"url": "https://files.pythonhosted.org/packages/68/41/50bd31caaf7df1fe0cac875223972888ce54e56060ae82245773501f5927/neon-iris-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-20 17:37:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "neongeckocom",
"github_project": "neon-iris",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "neon-iris"
}
JSON
