Skip to main content

Speechaceapi TypeScript SDK 1.0.0

Welcome to the Speechaceapi SDK documentation. This guide will help you get started with integrating and using the Speechaceapi SDK in your project.

Versions

  • API version: 1.0.0
  • SDK version: 1.0.0

About the API

Speechace is a Speech Recognition API for fluency and pronunciation assessment. Our patented technology is unique in its ability to score a learner's speech and pinpoint individual syllable and phoneme level mistakes in a user's pronunciation in real time.

Table of Contents

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: TypeScript >= 4.8.4

Installation

To get started with the SDK, we recommend installing using npm:

npm install speechaceapi

Services

The SDK provides various services to interact with the API.

Below is a list of all available services with links to their detailed documentation:

Models

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

Below is a list of all available models with links to their detailed documentation:
NameDescription
ScoreAWordOrSentenceRequest
ScoreAWordOrSentenceOkResponse
ScoreAPhonemeListRequest
ScoreAPhonemeListOkResponse
ValidateTextOkResponse
ScoreTaskRequest
TranscribeScoreRequest
TranscribeScoreOkResponse
ScoreAWordOrSentence1Request
ScoreAWordOrSentence1OkResponse
ScoreAPhonemeList1Request
ScoreAPhonemeList1OkResponse
ValidateText1OkResponse
TranscribeScore1Request
TranscribeScore1OkResponse
ScoreAWordOrSentenceOkResponseTextScore
TextScoreCefrScore
TextScoreFluency1
TextScoreIeltsScore
TextScorePteScore
TextScoreSpeechaceScore
TextScoreToeicScore
TextScoreWordScoreList1
FluencyOverallMetrics1
FluencySegmentMetricsList1
SegmentMetricsListCefrScore1
SegmentMetricsListSpeechaceScore1
WordScoreListPhoneScoreList1
WordScoreListSyllableScoreList1
ScoreAPhonemeListOkResponseWordScore
WordScorePhoneScoreList1
TranscribeScoreOkResponseSpeechScore
SpeechScoreCefrScore
Coherence
SpeechScoreFluency1
Grammar
SpeechScoreIeltsScore
SpeechScorePteScore
SpeechScoreRelevance1
ScoreIssueList
SpeechScoreSpeechaceScore
SpeechScoreToeicScore
Vocab
SpeechScoreWordScoreList1
CoherenceOverallMetrics
AdverbDiversity
BasicConnectives
CausalConnectives
LexicalDensity
NegativeConnectives
PronounDensity
VerbDiversity
FluencyOverallMetrics2
FluencySegmentMetricsList2
SegmentMetricsListCefrScore2
SegmentMetricsListIeltsScore
SegmentMetricsListPteScore
SegmentMetricsListSpeechaceScore2
SegmentMetricsListToeicScore
Errors
GrammarOverallMetrics
GrammaticalAccuracy
GrammaticalRange
Length
OverallMetricsLexicalDiversity1
AdverbModifierVariation
NounPhraseComplexity
NounPhraseVariation
VerbConstructionVariation
VocabOverallMetrics
AcademicLanguageUse
CollocationCommonality
Idiomaticity
OverallMetricsLexicalDiversity2
WordSophistication
WordSpecificity
WordScoreListPhoneScoreList2
WordScoreListSyllableScoreList2
ScoreAWordOrSentence1OkResponseTextScore
TextScoreFluency2
WordIntonationList
TextScoreWordScoreList2
FluencyOverallMetrics3
FluencySegmentMetricsList3
OverallMetricsIeltsSubscore1
WordScoreListPhoneScoreList3
WordScoreListSyllableScoreList3
ScoreAPhonemeList1OkResponseWordScore
WordScorePhoneScoreList2
TranscribeScore1OkResponseSpeechScore
SpeechScoreFluency2
SpeechScoreRelevance2
SpeechScoreWordScoreList2
FluencyOverallMetrics4
FluencySegmentMetricsList4
OverallMetricsIeltsSubscore2
SegmentMetricsListIeltsSubscore
WordScoreListPhoneScoreList4
WordScoreListSyllableScoreList4

License

This SDK is licensed under the MIT License.

See the LICENSE file for more details.

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →