Repository navigation
Add asyntai-ai-assistant package #246
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
Open
asyntai
wants to merge
2
commits into
espanso:main
Choose a base branch
from
asyntai:add-asyntai-ai-assistant
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2026 Asyntai | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # Asyntai AI Assistant | ||
|
|
||
| [Asyntai](https://asyntai.com) is an AI chatbot for your website. It answers your visitors from your own pages, docs and FAQ. This package brings those answers into every text field on your computer: your email, your help desk, Slack, Word, a browser form. | ||
|
|
||
| Type `:ask`, write a question, and Espanso types the answer your chatbot gives, with the same facts, prices and links your visitors get. | ||
|
|
||
| ## Triggers | ||
|
|
||
| - `:ask` opens a small form. Write a question, press Enter, and the answer is typed where your cursor is. | ||
| - `:clipask` answers the text on your clipboard. Copy a customer's question from an email or a ticket, type `:clipask` in your reply, and the answer is typed in. | ||
| - `:asyntaikey` saves your Asyntai API key. You do this one time. | ||
|
|
||
| Links in an answer are typed as `text (https://...)`, so they work in plain text fields too. | ||
|
|
||
| ## Setup | ||
|
|
||
| 1. Install the package: | ||
|
|
||
| ``` | ||
| espanso install asyntai-ai-assistant | ||
| ``` | ||
|
|
||
| 2. Sign in to [Asyntai](https://asyntai.com), open **Settings**, then **API**, and copy your API key. | ||
| 3. Open an empty text field, for example a new note, and type `:asyntaikey`. Paste the key and press Enter. Asyntai checks the key, and the package saves it in your user folder (`%APPDATA%\asyntai` on Windows, `~/.config/asyntai` on macOS and Linux). | ||
| 4. Type `:ask` anywhere and ask your first question. | ||
|
|
||
| The package is free. It uses the Asyntai API, which needs an Asyntai account on the Starter plan or higher. | ||
|
|
||
| ## Requirements | ||
|
|
||
| - Espanso 2 | ||
| - Windows: nothing else. The package uses Windows PowerShell, which every Windows 10 and 11 has. | ||
| - macOS and Linux: Python 3 (`python3`). The package uses only the Python standard library, so there is nothing to `pip install`. Your default shell must be sh, bash or zsh. | ||
|
|
||
| ## Support | ||
|
|
||
| Documentation: https://asyntai.com/documentation/integrations/espanso/ | ||
|
|
||
| Questions: hello@asyntai.com |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| name: "asyntai-ai-assistant" | ||
| title: "Asyntai AI Assistant" | ||
| description: "Type :ask anywhere and get the answer your Asyntai AI chatbot gives from your own website, docs and FAQ. Great for support replies." | ||
| version: "0.1.0" | ||
| author: "Asyntai" | ||
| homepage: "https://asyntai.com/documentation/integrations/espanso/" | ||
| tags: ["AI", "chatbot", "assistant", "customer support", "support", "LLM", "knowledge base", "Asyntai"] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,207 @@ | ||
| # Copyright (c) Asyntai. Licensed under the MIT license. | ||
| # | ||
| # Asyntai AI Assistant for Espanso, Windows side. | ||
| # | ||
| # Espanso runs this script through the shell extension (see package.yml) and | ||
| # types whatever it prints. macOS and Linux run asyntai.py, which does the | ||
| # same work. | ||
| # | ||
| # ask question from the :ask form (ESPANSO_FORM1_QUESTION) | ||
| # clip question from the clipboard (ESPANSO_CLIP) | ||
| # key save the API key from the :asyntaikey form (ESPANSO_FORM1_KEY) | ||
| # | ||
| # The script only talks to asyntai.com, only sends the API key in the | ||
| # Authorization header, and only writes one file: the saved API key. | ||
| # It needs nothing but Windows PowerShell 5.1, which every Windows 10 and 11 | ||
| # has. | ||
|
|
||
| param([string]$Mode) | ||
|
|
||
| $ErrorActionPreference = 'Stop' | ||
|
|
||
| $LiveBase = 'https://asyntai.com' | ||
| $UserAgent = 'AsyntaiEspanso/0.1' | ||
| $TimeoutMs = 90000 | ||
| # The other Asyntai launchers mark their own questions the same way, so the | ||
| # owner's test questions are easy to tell apart from visitor chats. | ||
| $AskMarker = 'espanso_ask_' | ||
|
|
||
| $NoKey = 'Asyntai: add your API key first. Type :asyntaikey in an empty text field.' | ||
| $BadKey = 'Asyntai: this API key no longer works. Type :asyntaikey and paste a new key.' | ||
|
|
||
| function New-AsyntaiError([string]$Message, [int]$Status = 0) { | ||
| $e = New-Object System.Exception $Message | ||
| $e.Data['asyntai'] = $true | ||
| $e.Data['status'] = $Status | ||
| return $e | ||
| } | ||
|
|
||
| function Get-KeyPath { | ||
| $root = $env:APPDATA | ||
| if (-not $root) { $root = $env:USERPROFILE } | ||
| return [IO.Path]::Combine($root, 'asyntai', 'espanso-api-key') | ||
| } | ||
|
|
||
| function Read-Key { | ||
| if ($env:ASYNTAI_API_KEY -and $env:ASYNTAI_API_KEY.Trim()) { return $env:ASYNTAI_API_KEY.Trim() } | ||
| $path = Get-KeyPath | ||
| if (Test-Path -LiteralPath $path) { | ||
| return ([IO.File]::ReadAllText($path, [Text.Encoding]::UTF8)).Trim() | ||
| } | ||
| return '' | ||
| } | ||
|
|
||
| function Save-Key([string]$Key) { | ||
| $path = Get-KeyPath | ||
| [void][IO.Directory]::CreateDirectory([IO.Path]::GetDirectoryName($path)) | ||
| [IO.File]::WriteAllText($path, $Key, (New-Object Text.UTF8Encoding $false)) | ||
| } | ||
|
|
||
| function Get-BaseUrl { | ||
| # A local Asyntai server can be used for development, nothing else, so | ||
| # the key can never be sent to a third-party host. | ||
| $base = "$env:ASYNTAI_BASE_URL".Trim().TrimEnd('/') | ||
| if ($base) { | ||
| try { | ||
| $uri = New-Object Uri $base | ||
| if ($uri.Host -eq '127.0.0.1' -or $uri.Host -eq 'localhost') { return $base } | ||
| } catch { } | ||
| } | ||
| return $LiveBase | ||
| } | ||
|
|
||
| function Invoke-Asyntai([string]$Method, [string]$Path, [string]$Key, $Body) { | ||
| [Net.ServicePointManager]::SecurityProtocol = [Net.ServicePointManager]::SecurityProtocol -bor [Net.SecurityProtocolType]::Tls12 | ||
| $request = [Net.HttpWebRequest]::Create((Get-BaseUrl) + $Path) | ||
| $request.Method = $Method | ||
| # Never follow a redirect: it could send the question or the API key to | ||
| # another host. A 3xx answer becomes an error instead. | ||
| $request.AllowAutoRedirect = $false | ||
| $request.Timeout = $TimeoutMs | ||
| $request.ReadWriteTimeout = $TimeoutMs | ||
| $request.UserAgent = $UserAgent | ||
| $request.Accept = 'application/json' | ||
| $request.Headers['Authorization'] = 'Bearer ' + $Key | ||
|
|
||
| $response = $null | ||
| try { | ||
| if ($null -ne $Body) { | ||
| $bytes = [Text.Encoding]::UTF8.GetBytes(($Body | ConvertTo-Json -Compress)) | ||
| $request.ContentType = 'application/json; charset=utf-8' | ||
| $request.ContentLength = $bytes.Length | ||
| $stream = $request.GetRequestStream() | ||
| $stream.Write($bytes, 0, $bytes.Length) | ||
| $stream.Close() | ||
| } | ||
| $response = $request.GetResponse() | ||
| } catch { | ||
| $inner = $_.Exception | ||
| while ($inner -and -not ($inner -is [Net.WebException])) { $inner = $inner.InnerException } | ||
| if ($inner -and $inner.Response) { $response = $inner.Response } | ||
| } | ||
| if ($null -eq $response) { | ||
| throw (New-AsyntaiError 'Asyntai: no answer from asyntai.com. Check your internet connection and try again.') | ||
| } | ||
|
|
||
| $status = [int]$response.StatusCode | ||
| $reader = New-Object IO.StreamReader($response.GetResponseStream(), [Text.Encoding]::UTF8) | ||
| $text = $reader.ReadToEnd() | ||
| $reader.Close() | ||
| $response.Close() | ||
|
|
||
| $root = $null | ||
| if ($text.Trim()) { | ||
| try { $root = $text | ConvertFrom-Json } catch { $root = $null } | ||
| } else { | ||
| $root = New-Object PSObject | ||
| } | ||
| $message = '' | ||
| if ($root -and ($root.error -is [string])) { $message = $root.error } | ||
|
|
||
| if ($status -eq 401) { throw (New-AsyntaiError $BadKey $status) } | ||
| if ($status -eq 403) { | ||
| if (-not $message) { $message = 'the Asyntai API needs the Starter plan or higher.' } | ||
| throw (New-AsyntaiError ('Asyntai: ' + $message) $status) | ||
| } | ||
| if ($status -eq 429) { | ||
| if (-not $message) { $message = 'your chatbot reached its message limit.' } | ||
| throw (New-AsyntaiError ('Asyntai: ' + $message) $status) | ||
| } | ||
| if ($status -lt 200 -or $status -ge 300 -or $null -eq $root -or $root.success -eq $false) { | ||
| if (-not $message) { $message = "the server answered with status $status." } | ||
| throw (New-AsyntaiError ('Asyntai: ' + $message) $status) | ||
| } | ||
| return $root | ||
| } | ||
|
|
||
| function ConvertTo-Plain([string]$Text) { | ||
| # Make a chat answer fit a plain text field: links as "text (url)", no bold. | ||
| $Text = [regex]::Replace($Text, '\[([^\]]*)\]\((\S+?)\)', { | ||
| param($m) | ||
| $label = $m.Groups[1].Value.Trim() | ||
| $url = $m.Groups[2].Value.Trim() | ||
| if (-not $label -or $label -eq $url -or $url.StartsWith('mailto:') -or $url.StartsWith('tel:')) { | ||
| if ($label) { return $label } else { return $url } | ||
| } | ||
| return "$label ($url)" | ||
| }) | ||
| $Text = [regex]::Replace($Text, '(?s)\*\*(.+?)\*\*', '$1') | ||
| $Text = [regex]::Replace($Text, '(?s)__(.+?)__', '$1') | ||
| $Text = [regex]::Replace($Text, '(?m)^#{1,6}[ \t]+', '') | ||
| $Text = $Text -replace "`r`n", "`n" | ||
| $Text = [regex]::Replace($Text, '\n{3,}', "`n`n") | ||
| return $Text.Trim() | ||
| } | ||
|
|
||
| function Invoke-Ask([string]$Question) { | ||
| $Question = "$Question".Trim() | ||
| if (-not $Question) { return 'Asyntai: the question is empty. Type :ask and write a question.' } | ||
| $key = Read-Key | ||
| if (-not $key) { return $NoKey } | ||
| $session = $AskMarker + [DateTimeOffset]::UtcNow.ToUnixTimeMilliseconds() + '_' + [guid]::NewGuid().ToString('N').Substring(0, 6) | ||
| $root = Invoke-Asyntai 'POST' '/api/v1/chat/' $key @{ message = $Question; session_id = $session } | ||
| $answer = '' | ||
| if ($root.response -is [string]) { $answer = ConvertTo-Plain $root.response } | ||
| if (-not $answer) { return 'Asyntai: your chatbot gave an empty answer.' } | ||
| return $answer | ||
| } | ||
|
|
||
| function Set-AsyntaiKey([string]$Key) { | ||
| $Key = "$Key".Trim() | ||
| if (-not $Key) { return 'Asyntai: the API key is empty. Type :asyntaikey and paste your key.' } | ||
| try { | ||
| $root = Invoke-Asyntai 'GET' '/api/v1/websites/' $Key $null | ||
| } catch { | ||
| if ($_.Exception.Data['status'] -eq 401) { | ||
| return 'Asyntai: this is not a valid API key. In Asyntai, open Settings, then API, and copy the key again.' | ||
| } | ||
| throw | ||
| } | ||
| # Save only a key that Asyntai accepts. | ||
| Save-Key $Key | ||
| $sites = @($root.websites | Where-Object { $_ -ne $null }) | ||
| $primary = @($sites | Where-Object { $_.is_primary -eq $true }) + $sites | Select-Object -First 1 | ||
| if ($primary -and ($primary.domain -is [string]) -and $primary.domain) { | ||
| return "Asyntai API key saved. Your chatbot for $($primary.domain) is ready: type :ask to ask it." | ||
| } | ||
| return 'Asyntai API key saved. Type :ask to ask your chatbot.' | ||
| } | ||
|
|
||
| try { | ||
| switch ($Mode) { | ||
| 'ask' { $out = Invoke-Ask $env:ESPANSO_FORM1_QUESTION } | ||
| 'clip' { $out = Invoke-Ask $env:ESPANSO_CLIP } | ||
| 'key' { $out = Set-AsyntaiKey $env:ESPANSO_FORM1_KEY } | ||
| default { $out = 'Asyntai: unknown command.' } | ||
| } | ||
| } catch { | ||
| if ($_.Exception.Data['asyntai']) { $out = $_.Exception.Message } | ||
| else { $out = 'Asyntai: something went wrong. Please try again.' } | ||
| } | ||
|
|
||
| # Espanso reads stdout as UTF-8. Write the bytes directly, so the console | ||
| # code page cannot change the text. | ||
| $bytes = [Text.Encoding]::UTF8.GetBytes($out) | ||
| $stdout = [Console]::OpenStandardOutput() | ||
| $stdout.Write($bytes, 0, $bytes.Length) | ||
| $stdout.Flush() | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.