Documentation for data output from AWS Amplify Predictions

[michaelmccrae]

Is this related to a new or existing framework?

No response

Is this related to a new or existing API?

No response

Is this related to another service?

No response

Describe the feature you'd like to request

I am looking for documentation regarding the return data outputs from running AWS Amplify Prediction. In the Amplify docs, you can run the code and get textToSpeech or a transcription back.

`function convertFromBuffer(bytes) {
setResponse('Converting text...');

Predictions.convert({
  transcription: {
    source: {
      bytes
    },
    // language: "en-US", // other options are "en-GB", "fr-FR", "fr-CA", "es-US"
  },
}).then(({ transcription: { fullText } }) => {
  setResponse(fullText); 
  console.log('fulltext result', fullText); `

Describe the solution you'd like

Can you return more information, such as the error rate or length of recording similar to data input and outputs: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html

Describe alternatives you've considered

I don't know what other alternatives are possible.

Additional context

No response

Is this something that you'd be interested in working on?

• 👋 I may be able to implement this feature request
• ⚠️ This feature might incur a breaking change

[nadetastic]

Hi @michaelmccrae, thank you for opening this issue. Currently, our docs do not fully documented what is returned, however you can get an idea from the defined types.

For example SpeechToText OutPut:

amplify-js/packages/predictions/src/types/Predictions.ts

Lines 139 to 143 in 56c093c

	export interface SpeechToTextOutput {
	transcription: {
	fullText: string;
	};
	}

In the meantime, I will mark this as a feature request to add additional data on the return.

[nadetastic]

With the release of the latest major version of Amplify (aws-amplify@>6), this issue should now be resolved, with increased support for types! Please refer to our release announcement, migration guide, and documentation for more information.