fix:save utterances

[JarbasAl]

backwards compat check wasnt quite right in #140

Oct 19 08:04:47 x270.home.lan ovos-dinkum-listener[152114]: 2024-10-19 08:04:47.463 - voice - ovos_dinkum_listener.service:_stt_audio:747 - ERROR - Error while saving STT audio
Oct 19 08:04:47 x270.home.lan ovos-dinkum-listener[152114]: Traceback (most recent call last):
Oct 19 08:04:47 x270.home.lan ovos-dinkum-listener[152114]:   File "/home/goldyfruit/.venvs/ovos/lib64/python3.11/site-packages/ovos_dinkum_listener/service.py", line 742, in _stt_audio
Oct 19 08:04:47 x270.home.lan ovos-dinkum-listener[152114]:     stt_context["filename"] = self._save_stt(audio_bytes, stt_context)
Oct 19 08:04:47 x270.home.lan ovos-dinkum-listener[152114]:                               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Oct 19 08:04:47 x270.home.lan ovos-dinkum-listener[152114]:   File "/home/goldyfruit/.venvs/ovos/lib64/python3.11/site-packages/ovos_dinkum_listener/service.py", line 707, in _save_stt
Oct 19 08:04:47 x270.home.lan ovos-dinkum-listener[152114]:     filename = formatter.format(utterance_filename)
Oct 19 08:04:47 x270.home.lan ovos-dinkum-listener[152114]:                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Oct 19 08:04:47 x270.home.lan ovos-dinkum-listener[152114]:   File "/home/goldyfruit/.venvs/ovos/lib64/python3.11/site-packages/ovos_dinkum_listener/_util.py", line 107, in format
Oct 19 08:04:47 x270.home.lan ovos-dinkum-listener[152114]:     fmtkw = self._build_fmtkw(template, **kwargs)
Oct 19 08:04:47 x270.home.lan ovos-dinkum-listener[152114]:             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Oct 19 08:04:47 x270.home.lan ovos-dinkum-listener[152114]:   File "/home/goldyfruit/.venvs/ovos/lib64/python3.11/site-packages/ovos_dinkum_listener/_util.py", line 91, in _build_fmtkw
Oct 19 08:04:47 x270.home.lan ovos-dinkum-listener[152114]:     fmtkw[key] = builder()
Oct 19 08:04:47 x270.home.lan ovos-dinkum-listener[152114]:                  ^^^^^^^^^
Oct 19 08:04:47 x270.home.lan ovos-dinkum-listener[152114]:   File "/home/goldyfruit/.venvs/ovos/lib64/python3.11/site-packages/ovos_dinkum_listener/service.py", line 705, in transcription_md5
Oct 19 08:04:47 x270.home.lan ovos-dinkum-listener[152114]:     return hash_sentence(text)
Oct 19 08:04:47 x270.home.lan ovos-dinkum-listener[152114]:            ^^^^^^^^^^^^^^^^^^^
Oct 19 08:04:47 x270.home.lan ovos-dinkum-listener[152114]:   File "/home/goldyfruit/.venvs/ovos/lib64/python3.11/site-packages/ovos_plugin_manager/utils/tts_cache.py", line 20, in hash_sentence
Oct 19 08:04:47 x270.home.lan ovos-dinkum-listener[152114]:     encoded_sentence = sentence.encode("utf-8", "ignore")
Oct 19 08:04:47 x270.home.lan ovos-dinkum-listener[152114]:                        ^^^^^^^^^^^^^^^
Oct 19 08:04:47 x270.home.lan ovos-dinkum-listener[152114]: AttributeError: 'NoneType' object has no attribute 'encode'

also needs OpenVoiceOS/ovos-config#171

Summary by CodeRabbit

• New Features

  • Enhanced speech-to-text functionality for improved transcription accuracy.
  • Improved handling of audio recordings and hotword detection.

• Bug Fixes

  • Refined error handling for audio saving operations to ensure proper logging.

• Chores

  • Updated ovos-config dependency version for better compatibility.

[coderabbitai]

Walkthrough

The pull request introduces several modifications to the OVOSDinkumVoiceService class in ovos_dinkum_listener/service.py, focusing on enhancing speech-to-text (STT) functionality and audio recording management. Key updates include improved handling of transcription metadata, refined error handling, volume management during recordings, and configuration reloading mechanisms. Additionally, the requirements.txt file has been updated to specify a newer version of the ovos-config dependency.

Changes

File Path	Change Summary
ovos_dinkum_listener/service.py	- Updated _stt_text method for streamlined reporting of utterances. - Modified _save_stt for improved transcription metadata handling and error logging. - Enhanced _handle_volume_change for better volume tracking during recordings. - Improved reload_configuration to check for relevant configuration changes. - Adjusted _hotword_audio for better handling of hotword audio data.
requirements/requirements.txt	- Updated ovos-config dependency version from >=0.2.1,<1.0.0 to >=0.4.3,<1.0.0.

Possibly related PRs

• Fix error when saving utterances #140: The changes in this PR directly modify the _save_stt method in ovos_dinkum_listener/service.py, enhancing the filename generation process for saved audio files, which is closely related to the modifications made in the main PR regarding audio saving logic and transcription handling.

Poem

In a burrow deep, where echoes play,
The voice service hops, brightening the day.
With clearer words and volume so fine,
It captures each utterance, a true design.
From hotwords to whispers, it dances with glee,
Oh, what a joy, this change brings to me! 🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[goldyfruit]

All good

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 9398f1d and 249a24e.

📒 Files selected for processing (2)

• ovos_dinkum_listener/service.py (1 hunks)
• requirements/requirements.txt (1 hunks)

🧰 Additional context used

🔇 Additional comments (1)

requirements/requirements.txt (1)

3-3: LGTM! Version update for ovos-config looks good.

The update to ovos-config>=0.4.3,<1.0.0 aligns with the PR objectives and likely includes necessary features or fixes for this project.

Please ensure the following:

1. Update the changelog to reflect this dependency change if not already done.
2. Verify that this version of ovos-config is compatible with other dependencies in the project.

To check for potential compatibility issues, you can run:

✅ Verification successful

Verification Successful: ovos-config version update is compatible.

• No additional requirements.txt files found.
• All dependencies referencing ovos-config are updated to >=0.4.3,<1.0.0.

Please ensure the changelog is updated to reflect this dependency change.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for potential compatibility issues with the updated ovos-config version

# Test: Look for other files that might reference ovos-config version
echo "Files referencing ovos-config version:"
rg --type yaml --type toml --type python "ovos-config.*?[0-9]+\.[0-9]+\.[0-9]+"

# Test: Check if there are any other requirements files
echo "Other requirements files:"
fd requirements.txt

# If other requirements files exist, you may want to check them manually for consistency

Length of output: 312

---

Script:

#!/bin/bash
# Description: Comprehensive search for ovos-config version references across all files

# Test: Look for ovos-config version references in all files
echo "Files referencing ovos-config version:"
rg "ovos-config>=[0-9]+\.[0-9]+\.[0-9]+,<[0-9]+\.[0-9]+\.[0-9]+" --context 2

# Test: List all requirements files to ensure consistency
echo "Listing all requirements files:"
fd -e txt "requirements.txt"

Length of output: 587