We invite you to shape the future of IBM, including product roadmaps, by submitting ideas that matter to you the most. Here's how it works:
Post your ideas
Post ideas and requests to enhance a product or service. Take a look at ideas others have posted and upvote them if they matter to you,
Post an idea
Upvote ideas that matter most to you
Get feedback from the IBM team to refine your idea
Help IBM prioritize your ideas and requests
The IBM team may need your help to refine the ideas so they may ask for more information or feedback. The product management team will then decide if they can begin working on your idea. If they can start during the next development cycle, they will put the idea on the priority list. Each team at IBM works on a different schedule, where some ideas can be implemented right away, others may be placed on a different schedule.
Receive notification on the decision
Some ideas can be implemented at IBM, while others may not fit within the development plans for the product. In either case, the team will let you know as soon as possible. In some cases, we may be able to find alternatives for ideas which cannot be implemented in a reasonable time.
Improve API response structure for timestamps and word_confidence within STT SpeechRecognitionAlternative model
As part of the response from making a POST to the v1/recognize endpoint in the Speech to Text service, the user receives an array of "alternatives". Within these "alternatives" objects, there are two arrays called "word_confidence" and "transcript". Below is an example of this piece of the response:
The problem with this response is that both "word_confidence" and "timestamps" are arrays of arrays, even though the internal arrays have specific attributes at particular indices. As is, this response lends itself more to "word_confidence" and "timestamps" being arrays of objects like so:
Added motivation for the change is that this is currently causing a problem with the API specification and, in turn, efforts to automatically generate code/documentation based on the API.
Currently, we are specifying the various Watson APIs based on the OpenAPI version 2.0 specification. These can be found here. The way the response is actually structured, with a nested array of mixed types, cannot be properly specified according to the specification, resulting in manual work to tweak code that may be generated from the Speech to Text API spec.
Overall, making the proposed change to the v1/recognize response in the Speech to Text service would both make more sense based on the structure, but would also make it easier to document and help further the effort to streamline API changes across all relevant tools.
Do not place IBM confidential, company confidential, or personal information into any field.