Skip to content
This repository has been archived by the owner on Sep 8, 2024. It is now read-only.

Issues-2516 - Resolved IBM Cloud integration issue #2548

Merged
merged 4 commits into from
Apr 27, 2020

Conversation

codyreinold
Copy link
Contributor

@codyreinold codyreinold commented Apr 26, 2020

Description

This is a rewrite of the IBM Cloud Text to Speech connector. Resolves #2516. Previously, we were using the speech_recognition package to interface with IBM Cloud. However, recently IBM moved from user / pass-based auth to api key-based auth. This fix moves all functionality for IBM Cloud into the mycroft-core codebase (using the requests package).

How to test

Create an IBM Cloud account, if you do not already have one. Enable "Speech to Text" to receive an API Key and URL. Setup Mycroft config file according to documented format (see codebase).

Once configured, start Mycroft in debug mode. Test different scenarios (wakeword + phrase, wakeword + silence) to ensure acceptance of functionality. Error message on silence is specific to this integration, so can be used to validate IBM plugin is being used. Usage can also be confirmed in IBM Cloud usage dashboard (https://cloud.ibm.com/billing/usage) and digging into the service usage report.

Unit test covers basic functionality (generation of request) and mocks the response. Additional tests could be added to test malformed responses, but I wanted to adhere to current test pattern.

Contributor license agreement signed?

CLA [ Yes ]

@codyreinold codyreinold changed the title Issues-2516 - Resolved IBM Cloud integration issue, switching from user / pass to api key Issues-2516 - Resolved IBM Cloud integration issue Apr 26, 2020
@devs-mycroft devs-mycroft added the CLA: Needed Need signed CLA from https://mycroft.ai/cla label Apr 26, 2020
@devs-mycroft
Copy link
Collaborator

Hello, @codyreinold, thank you for helping with the Mycroft project! We welcome everyone
into the community and greatly appreciate your help as we work to build an AI
for Everyone.

To protect yourself, the project, and users of Mycroft technologies we require
a Contributor Licensing Agreement (CLA) before accepting any code
contribution. This agreement makes it crystal clear that along with your
code you are offering a license to use it within the confines of this project.
You retain ownership of the code, this is just a license.

Please visit https://mycroft.ai/cla to initiate this one-time signing. Thank
you!

@forslund
Copy link
Collaborator

Hi @codyreinold looks really good! gonna give it a test run tomorrow morning!

@codyreinold
Copy link
Contributor Author

Hi @devs-mycroft. Not sure if you're a bot or a human, but this has already been completed prior to my submitting the PR!

@MycroftAI MycroftAI deleted a comment from devops-mycroft Apr 26, 2020
@devops-mycroft
Copy link

Voight Kampff Integration Test Succeeded (Results)

1 similar comment
@devops-mycroft
Copy link

Voight Kampff Integration Test Succeeded (Results)

Copy link
Collaborator

@forslund forslund left a comment

Choose a reason for hiding this comment

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

I think it looks very good and can be merged as soon as the CLA process is completed.

I do wonder why params are explicitly added to the url instead of using the requests.post() params argument?

mycroft/stt/__init__.py Outdated Show resolved Hide resolved
@devops-mycroft
Copy link

Voight Kampff Integration Test Succeeded (Results)

@devops-mycroft
Copy link

Voight Kampff Integration Test Failed (Results)

@devops-mycroft
Copy link

Voight Kampff Integration Test Succeeded (Results)

@krisgesling krisgesling added CLA: Yes Contributor License Agreement exists (see https://github.com/MycroftAI/contributors) and removed CLA: Needed Need signed CLA from https://mycroft.ai/cla labels Apr 27, 2020
@krisgesling
Copy link
Contributor

Thanks so much Cody, this is great!

Merging now

@krisgesling krisgesling merged commit 6640861 into MycroftAI:dev Apr 27, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
CLA: Yes Contributor License Agreement exists (see https://github.com/MycroftAI/contributors)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

IBM Watson STT not working
5 participants