Choice Recognitions

Performing a choice recognition is broken up into various calls.

To perform a choice recognition a number of steps have to be made:

Initialising a choice recognition
Initialise choice challenge
Register audio procedure
Perform the recognition

Initialising a choice recognition

This is the starting point for a choice recognition. A unique recognition id is generated, which serves a leading role in the recognition. Each other call requires the recognition id as a parameter.

If other RPCs are called without this RPC being called first, the error nl.itslanguage.session_not_initialised will be returned.

URI

nl.itslanguage.choice.init_recognition

Response

The unique recognition id is returned as a string. The id is used in other calls to identify the current recognition.

Before performing the recognition, a WFST needs to be prepared for the challenge. When the RPC is called, the challenge is initialised asynchronously. When the challenge is to be used, the server automatically waits for the challenge initialisation to finish. If the initialisation results in an error, the error is relayed to the client.

URI

nl.itslanguage.choice.init_challenge

Parameters

Name	Type	Description
recognition_id	`string`	Required The id of the recognition to prepare the challenge for.
organisation_id	`string`	Required The id of the organisation in which to find the challenge.
challenge_id	`string`	Required The id of the challenge to prepare.

Perform the recognition

The recognition can be performed when all preparations are done.

URI

nl.itslanguage.choice.recognise

Parameters

Name	Type	Description
recognition_id	`string`	Required The id of the recognition to perform.
rpc	`string`	Required The URI of a registered audio rpc.

Response

A JSON object with the recognition results and metadata is returned.

Example:

{"id": "g93h844",
 "audioUrl": "https://api-dot-itslanguage.nl:80/organisations/1/challenges/choice/4/recognitions/g93h844/audio",
 "recognised": "Unicorns"}

The RPC can return various errors:

nl.itslanguage.recognition_failed If the recognition of the audio failed.
nl.itslanguage.no_such_organisation If the organisation doesn't exist.
nl.itslanguage.no_such_challenge If the challenge doesn't exist.