python-docs-samples icon indicating copy to clipboard operation
python-docs-samples copied to clipboard

Update samples for `google-cloud-speech` to improve usability

Open parthea opened this issue 1 year ago • 3 comments

An issue was filed in google-cloud-python related to usability issues with the google-cloud-speech sample located here.

Currently there are 2 imports in speech/snippets/transcribe_streaming_v2.py with similar names. SpeechClient and cloud_speech could be confusing to readers as they appear to be similar.

Right now we have

from google.cloud.speech_v2 import SpeechClient
from google.cloud.speech_v2.types import cloud_speech

Instead we could have

from google.cloud.speech_v2 import SpeechClient
from google.cloud.speech_v2.types import cloud_speech as cloud_speech_types

or this could also work

from google.cloud.speech_v2 import SpeechClient
from google.cloud.speech_v2 import StreamingRecognizeRequest
from google.cloud.speech_v2 import RecognitionConfig
from google.cloud.speech_v2 import StreamingRecognizeResponse

parthea avatar Feb 23 '24 10:02 parthea

I am taking it up

magar51 avatar Mar 05 '24 11:03 magar51

This problem is being fixed. Let me know if there is any more questions. Thank you!

jping0220 avatar Mar 06 '24 18:03 jping0220

hey @magar51, apologies I had asked @jping0220 to take a look at this issue last week and she had started working on this already. Please do take a look at her PR and give feedback if you can. Thank you!

iennae avatar Mar 06 '24 19:03 iennae