]> git.giacomolli.uk - onechat/blobdiff - README.rst
Describe queued event delivery boundaries
[onechat] / README.rst
index cb47c987a9ebea60e4829c5ef3a6c21638706e80..6b011a872c9ea2d777a7251d5efa0dd5c8617d02 100644 (file)
@@ -77,6 +77,13 @@ or Telegram:
 The session file gives full access to the account. If it leaks, remove
 the device in Linked devices on the phone.
 
+External events
+===============
+
+Use ``onechat notify --source CHECK --id EVENT --text TEXT`` to send
+external data to the root at its next turn. Success means accepted, not
+processed. See ``onechat notify --help`` for the local test limits.
+
 User service
 ============
 
@@ -154,6 +161,9 @@ replies show with Markdown styles and tables. These lines are commands:
 ``/stop NAME``
    Stops the subagent NAME.
 
+``/image PATH [caption]``
+   Sends a JPEG, PNG, or WebP image. Quote a path with spaces.
+
 ``/whatsapp ...``
    The WhatsApp commands above.
 
@@ -191,8 +201,16 @@ WhatsApp
    child of that area, and sets the route after you agree.
 
 Images
-   Send a photo, and the agent sees it. Its memory keeps what the image
-   shows, and it can look at an older image again.
+   Send a photo in Telegram, WhatsApp, or with ``/image`` to the agent.
+   Its memory keeps what the image shows, and it can look at an older
+   image again. Ask it to show an image or send one to a WhatsApp chat.
+
+Voice notes
+   The agent hears Telegram and WhatsApp voice notes through local
+   Whisper. Nix includes the small model. Outside Nix, set
+   ``voice.model`` in ``config.json`` and install ``whisper-cli``.
+   ``voice.transcriber`` selects another executable. No audio goes to a
+   transcription service.
 
 Schedules
    Ask for reminders and timed tasks, such as "every weekday at 8, tell