speechsuper / SpeechSuper-API-Samples

Deep learning based speech and pronunciation assessment API for 8 languages.
MIT License
28 stars 2 forks source link
assessment chinese english eval french german japanese korean learning recognition russian spanish speech speech-assessment speech-recognition speechassessment study

SpeechSuper API

Enhance your language learning with our Pronunciation Assessment API. Tailored to support language learners, our API evaluates pronunciation by analyzing audio files and text strings, providing comprehensive metrics for speech quality and fluency.

Pronunciation Assessment API (Scripted)

🌟 Basic Features

The Pronunciation Assessment API (scripted) provided by SpeechSuper offers a comprehensive analysis of learners' audio recordings, providing valuable insights in the following areas:

Basic Features:

πŸͺ Highlight Features

Explore advanced capabilities with SpeechSuper's Pronunciation Assessment API, complementing its fundamental features. Unleash the power of:

With SpeechSuper's Pronunciation Assessment API, you access robust tools to evaluate and refine your pronunciation skills within structured contexts. Elevate your language proficiency with precise analysis and instant feedback mechanisms.

Spoken languages covered * English * Chinese * German * French * Russian * Korean * Japanese * Spanish * more to come
Coding languages covered * Java * C/C++ * Swift * golang * php * C# * Unity * Javascript * Objective-C * Python * Node * Rust * etc
Platforms supported * iOS * Android * Web * Windows * MacOS * Linux * etc

πŸš€ Getting Started

  1. Get the appKey and secretKey.

If you don't have the keys, please go to SpeechSuper, and click "Contact us" to fill in the sheet. We will get in touch with you very soon!

  1. Git clone this project to your local.
git clone https://github.com/speechsuper/speechsuper-api-samples.git
  1. Choose the example of your interest.

We have http / websocket examples in multiple coding languages. Fill in your appKey and secretKey:

appKey = "Insert your appKey here"
secretKey = "Insert your secretKey here"
  1. Change the inputs according to your needs.
    coreType = "sent.eval.promax" // sentence evaluation
    refText = "The successful warrior is the average man with laser-like focus." // reference text
    audioPath = "The audio path of the spoken sentence." 
    audioType = "wav"

Notes on Audio: SpeechSuper supports most audio formats, such as wav, mp3, opus, ogg, and amr.

To optimize file size and enhance performance, we strongly recommend recording your audio at the following settings: Audio Attribute Suggestion
Sample size 16-bit
Sample rate 16Khz
Channels 1 (mono)
Bitrate β‰₯ 96kbps
  1. Launch πŸš€ your code and get the result.

English Spontaneous Speech Assessment API (Unscripted)

🌟 Overview

The English Spontaneous Speech Assessment API (Unscripted) offered by SpeechSuper provides a comprehensive analysis of learners' audio recordings, delivering valuable insights in the following areas:

πŸͺ Pro Features

In addition to the basics, the Pro features enhance the analysis by offering detailed information such as:

With SpeechSuper's API, you can unlock a wealth of information to assess and improve your English spontaneous speech skills.

πŸš€ Getting Started

  1. Get the appKey and secretKey. If you don't have the keys, please go to SpeechSuper, and click "Contact us" to fill in the sheet. We will get in touch with you very soon!

  2. Git clone this project to your local.

    git clone https://github.com/speechsuper/speechsuper-api-samples.git
  3. Choose the example of your interest.

We have http / websocket examples in multiple coding languages. Fill in your appKey and secretKey:

appKey = "Insert your appKey here"
secretKey = "Insert your secretKey here"
  1. Change the inputs according to your needs.
# CoreType for English spontaneous speech assessment
coreType = "speak.eval.pro"

# Test type, currently supporting only IELTS speaking assessment
test_type = "ielts"

# Question prompt used to score relevance of the response and penalize irrelevant responses
question_prompt = "What's your favorite food?"

# Model for transcription accuracy; use "non_native" for non-native speakers, "native" otherwise
model = "non_native"

# Penalize scores for off-topic responses (1 to penalize, 0 otherwise)
penalize_offtopic = 1

# Path to the audio file of the speech
audioPath = "The audio path of the speech."

# Type of the audio file (e.g., "wav")
audioType = "wav"

Notes on Audio: SpeechSuper supports most audio formats, such as wav, mp3, opus, ogg, and amr.

To optimize file size and enhance performance, we strongly recommend recording your audio at the following settings: Audio Attribute Suggestion
Sample size 16-bit
Sample rate 16Khz
Channels 1 (mono)
Bitrate β‰₯ 96kbps
  1. Launch πŸš€ your code and get the result.