Beispiele zur API-Nutzung

Geskriptete Anfragen​

Nachfolgend finden Sie einige Beispiele zur Verwendung der geskripteten APIs.

Score_audio-Endpunkt​

Diese Demo wird über die Befehlszeile auf einem Linux-kompatiblen System mithilfe des cURL-Befehls durchgeführt.

cURL-Befehl mit dem Parameter audio_path​

In diesem Beispiel verwenden wir den Satz „When the sunlight strikes raindrops in the air, they act like a prism and form a rainbow." mit der Audiodatei, die unter dieser öffentlichen URL verfügbar ist: [https://elsa-api-docs.s3-eu-west-1.amazonaws.com/api\_samples/rainbow.wav]{{LINK0}}

curl -XPOST -s https://api.elsanow.io/api/v2/score_audio -F "api_plan=premium" -F "audio_path=https://elsa-api-docs.s3-eu-west-1.amazonaws.com/api_samples/rainbow.wav" -F sentence="When the sunlight strikes raindrops in the air, they act like a prism and form a rainbow" --header "Authorization: ELSA <API_token>"

cURL-Befehl mit dem Parameter audio_file​

curl -XPOST -s https://api.elsanow.io/api/v2/score_audio -F "api_plan=premium" -F "audio_file=@<path_to_the_file>/rainbow.wav" -F sentence="When the sunlight strikes raindrops in the air, they act like a prism and form a rainbow" --header "Authorization: ELSA <API_token>"

Sie können den Parameter „api_plan" ändern, um mehr oder weniger detaillierte Ergebnisse zu erhalten.

Beispiel für Multiple-Choice-Unterstützung​

Mithilfe desselben Endpunkts und derselben Parameter wie oben können wir auch Multiple-Choice-Übungen bewerten, bei denen die ELSA-Engine: 1) das Wort/den Satz auswählt, das/der am besten zur Eingabe des Nutzers passt; b) diesen Satz wie im Einzelsatz-Fall bewertet. Für Multiple-Choice senden wir eine Liste möglicher Sätze im Feld „sentence":

sentence: ["sentence 0", "sentence 1"]

Die Anzahl der Sätze, die Sie senden können, ist nicht begrenzt.

Hier ist eine Möglichkeit, die Liste in einem curl-Befehl zu senden:

sentence="[\"sentence 0\",\"sentence 1\"]"

Ungeskriptete Anfragen​

Hier sind einige Beispiele zur Verwendung der ungeskripteten APIs.

Score_audio_plus-Endpunkt​

Um die Aufrufe an die ELSA API zu implementieren, können wir den „curl"-Befehl in jeder Linux-kompatiblen Befehlszeile verwenden.

cURL-Befehl mit dem Parameter audio_file​

Das folgende Beispiel gibt den Link zum Herunterladen der JSON-Ergebnisdatei zurück, wenn es mit einer lokalen Audiodatei aufgerufen wird (vergessen Sie nicht das „@" vor dem Pfad).

curl -XPOST -s https://api.elsanow.io/api/v1/score_audio_plus -F "api_plan=premium" -F "audio_file=@<path_to_your_file.wav>" --header "Authorization: ELSA <API_token>"

Wenn Sie das JSON selbst als Antwort auf den Aufruf erhalten möchten, verwenden Sie:

 curl -XPOST -s https://api.elsanow.io/api/v1/score_audio_plus -F "api_plan=premium" -F "return_json=true" -F "audio_file=@<path_to_your_file.wav>" --header "Authorization: ELSA <API_token>"

ASR-Endpunkt​

Beispiel zur Verwendung des ASR-Transkripts und der zeitlichen Ausrichtung auf Wortebene:

curl -XPOST -s https://api.elsanow.io/api/v1/asr -F "audio=@<path_to_your_file.wav>" --header "Authorization: ELSA <API_token>"

Asynchrones Abrufen der Funktionalität​

Beispiel zur asynchronen Verwendung. Wir beginnen damit, die API mit einer Audiodatei aufzurufen und die stream_id daraus abzurufen.

curl -XPOST -s https://api.elsanow.io/api/v1/score_audio_plus -F "api_plan=premium" -F "audio_file=@<path_to_your_file.wav>" --header "Authorization: ELSA <API_token>" -F "sync=false" 

Hier ist ein Beispiel für das Ergebnis:

{"stream_id":"<unique_stream_id>"}

Ergebnis-Endpunkt​

Um die Ergebnisdatei abzurufen (entweder als Download-Link oder als JSON-Struktur), rufen Sie den Ergebnis-Endpunkt auf.

Ein Ergebnis abrufen und einen Download-Link erhalten:​

curl -XGET "https://api.elsanow.io/result?stream_id=<unique_stream_id>" --header "Authorization: ELSA <API_token>"

Ein Ergebnis im JSON-Format abrufen​

Ein Ergebnis abrufen:

curl -XGET "https://api.elsanow.io/result?stream_id=<unique_stream_id>&return_json=true" --header "Authorization: ELSA <API_token>"

Mehrere Ergebnisse gleichzeitig abrufen (bei dieser Option ist die Rückgabe von JSON im Aufruf nicht möglich)

curl -XGET "https://api.elsanow.io/result?stream_id=<unique_stream_id>&stream_id=<unique_stream_id>" --header "Authorization: ELSA <API_token>"

Audio-Endpunkt​

Um die Audiodatei abzurufen:

curl -XGET "https://api.elsanow.io/audio?stream_id=<unique_stream_id>" --header "Authorization: ELSA <API_token>"