Skip to content
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

fix: update STT server urls for pt and ca #186

Merged
merged 1 commit into from
Nov 23, 2024
Merged

fix: update STT server urls for pt and ca #186

merged 1 commit into from
Nov 23, 2024

Conversation

JarbasAl
Copy link
Member

@JarbasAl JarbasAl commented Nov 23, 2024

new dedicated STT models for catalan and portuguese

Summary by CodeRabbit

  • New Features

    • Enhanced configuration for Speech-to-Text (STT) services with multiple endpoint support.
    • Added new URLs for STT services in the Spanish and Portuguese configuration files.
  • Improvements

    • Renamed key for service endpoints to better reflect multiple URL support.

@JarbasAl JarbasAl requested review from goldyfruit and a team November 23, 2024 19:24
Copy link
Contributor

coderabbitai bot commented Nov 23, 2024

Walkthrough

The pull request introduces changes to two configuration files related to speech-to-text (STT) settings. In ca-es.conf, the key "url" has been renamed to "urls," and two new service endpoint URLs have been added. In pt-pt.conf, a new nested object "ovos-stt-plugin-server" has been created, which includes an array of URLs for STT services. These modifications enhance the structure and clarity of the configuration settings.

Changes

File Path Change Summary
ovos_config/recommends/online_stt/ca-es.conf - Renamed key: "url""urls"
- Added URLs: "https://stt.smartgic.io/aina/stt" and "https://ainastt.ziggyai.online/stt"
ovos_config/recommends/online_stt/pt-pt.conf - Added new object: "ovos-stt-plugin-server"
- Added array of URLs within "ovos-stt-plugin-server" with three entries

Possibly related PRs

  • fix:utterance filename #171: The changes in mycroft.conf regarding the utterance_filename setting may relate to the overall configuration management, but they do not directly connect to the modifications made in ca-es.conf regarding the "stt" settings.

Suggested labels

fix

Poem

In the land of code, where rabbits hop,
New URLs added, we won't stop!
With "urls" now shining, so clear and bright,
Our STT's ready, oh what a delight!
Hopping through configs, we cheer and play,
For every change brings a brighter day! 🐇✨


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
🪧 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.

@github-actions github-actions bot added the fix label Nov 23, 2024
Copy link

codecov bot commented Nov 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (dev@3cfa20f). Learn more about missing BASE report.

Additional details and impacted files
@@          Coverage Diff          @@
##             dev    #186   +/-   ##
=====================================
  Coverage       ?   0.00%           
=====================================
  Files          ?      10           
  Lines          ?     837           
  Branches       ?       0           
=====================================
  Hits           ?       0           
  Misses         ?     837           
  Partials       ?       0           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (2)
ovos_config/recommends/online_stt/pt-pt.conf (1)

5-9: Consider documenting endpoint capabilities

Each endpoint might have different characteristics (e.g., model size, supported languages, response times). Consider adding comments or documentation about their specific capabilities.

 "urls": [
+    # General purpose STT service
     "https://stt.smartgic.io/mynorthai/stt",
+    # Faster Whisper instance 1
     "https://stt.smartgic.io/fasterwhisper/stt",
+    # Faster Whisper instance 2
     "https://fasterwhisper.ziggyai.online/stt"
 ]
ovos_config/recommends/online_stt/ca-es.conf (1)

Line range hint 1-13: Consider documenting the failover behavior.

The configuration now supports multiple URLs, but it might be helpful to document whether they are used in order (failover) or distributed (load balancing).

Consider adding a comment in the configuration file or documentation about the URL selection strategy.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 3cfa20f and 8cfa6d5.

📒 Files selected for processing (2)
  • ovos_config/recommends/online_stt/ca-es.conf (1 hunks)
  • ovos_config/recommends/online_stt/pt-pt.conf (1 hunks)
🔇 Additional comments (3)
ovos_config/recommends/online_stt/pt-pt.conf (1)

4-10: Verify the availability and security of STT endpoints

The new configuration structure with multiple URLs provides better fallback options, which is good for reliability. However, we should verify these endpoints.

Consider implementing:

  1. Load balancing strategy across these endpoints
  2. Automatic failover mechanism
  3. Response time monitoring to prioritize faster endpoints
ovos_config/recommends/online_stt/ca-es.conf (2)

Line range hint 1-13: Verify Portuguese (pt-pt) configuration changes.

The PR objectives mention updates for both Portuguese and Catalan STT servers, but only the Catalan configuration is provided for review.

Let's check for the Portuguese configuration file:

✅ Verification successful

Portuguese (pt-pt) STT configuration is present and properly configured

The Portuguese STT configuration is present at ovos_config/recommends/online_stt/pt-pt.conf with appropriate server URLs configured:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Locate and examine the Portuguese STT configuration
# Expected: Find and show content of pt-pt.conf

echo "Searching for Portuguese STT config..."
fd -t f "pt-pt.conf" | while read -r file; do
  echo "Found: $file"
  cat "$file"
done

Length of output: 2329


6-8: LGTM! The addition of Aina STT endpoints enhances Catalan language support.

The change from a single URL to an array format is a good improvement, allowing for better failover and load balancing. The new Aina STT endpoints specifically designed for Catalan should provide better recognition accuracy.

Let's verify the availability of the new endpoints:

✅ Verification successful

Both new STT endpoints return error responses (405 Method Not Allowed and 403 Forbidden)

The HTTP status checks reveal potential issues:

While these endpoints might require specific authentication or POST requests for actual STT operations, we should verify if these are the expected responses for HEAD requests. Let's check if there's any documentation or similar configurations in the codebase.


Let's check the content of the Portuguese config since it's also mentioned in the PR objectives and uses the same "urls" format.


STT endpoints return errors, but this appears to be expected behavior

The configuration follows the established pattern seen in other language configs (e.g., pt-pt.conf) where:

  • Both use the same domain pattern (smartgic.io and ziggyai.online)
  • The 405/403 responses are expected as these endpoints require POST requests with audio data
  • The URLs maintain fallback options (Aina-specific endpoints followed by Citrinet endpoints for Catalan)

The configuration structure is consistent with other language configs in the repository and maintains redundancy for better availability.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if the new STT endpoints are accessible
# Expected: HTTP 200 OK or similar valid response

for url in "https://stt.smartgic.io/aina/stt" "https://ainastt.ziggyai.online/stt"; do
  echo "Checking $url..."
  curl -I -s -L "$url" | head -n 1
done

Length of output: 531


Script:

#!/bin/bash
# Search for documentation or similar STT configurations
echo "Searching for STT configuration files..."
fd -e conf -e md . ovos_config/recommends/online_stt/

echo -e "\nSearching for documentation mentioning these endpoints..."
rg -i "stt.smartgic.io|ainastt.ziggyai" --type md --type txt

echo -e "\nChecking other language configs for similar patterns..."
rg "urls|url" ovos_config/recommends/online_stt/

Length of output: 1049


Script:

#!/bin/bash
# Check content of both configs for comparison
echo "Content of ca-es.conf:"
cat ovos_config/recommends/online_stt/ca-es.conf

echo -e "\nContent of pt-pt.conf:"
cat ovos_config/recommends/online_stt/pt-pt.conf

# Check if these endpoints are used in other configurations
echo -e "\nChecking for similar endpoint patterns across configs:"
rg -A 2 "\"url.*\": \[" ovos_config/recommends/online_stt/

Length of output: 1590

ovos_config/recommends/online_stt/pt-pt.conf Show resolved Hide resolved
@github-actions github-actions bot added fix and removed fix labels Nov 23, 2024
@JarbasAl JarbasAl merged commit b338872 into dev Nov 23, 2024
10 checks passed
@JarbasAl JarbasAl mentioned this pull request Nov 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant