API使用例

スクリプト済みリクエスト​

以下に、スクリプト済みAPIの使用例をいくつか示します。

Score_audioエンドポイント​

このデモは、cURLコマンドを使用してLinux互換システムのコマンドラインで実行します。

audio_pathパラメータを使用したcURLコマンド​

この例では、「When the sunlight strikes raindrops in the air, they act like a prism and form a rainbow.」という文を使用します。音声はこの公開URL https://elsa-api-docs.s3-eu-west-1.amazonaws.com/api_samples/rainbow.wav から入手できます。

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>"

audio_fileパラメータを使用したcURLコマンド​

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>"

「api_plan」パラメータを変更することで、結果の詳細度を調整できます。

多肢選択式サポートの例​

上記と同じエンドポイントおよびパラメータを使用して、多肢選択式の演習にも点数を付けることができます。ELSAエンジンは、1) ユーザーの入力に最も適した単語/文を選択し、b) 単一文の場合と同様にその文を採点します。多肢選択式を実行するには、sentenceフィールドに候補文のリストを送信します：

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

送信できる文の数に制限はありません。

curlコマンドでリストを送信する方法の例を以下に示します：

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

スクリプトなしリクエスト​

以下に、スクリプトなしAPIの使用例をいくつか示します。

Score_audio_plusエンドポイント​

ELSA APIへの呼び出しを実装するには、Linux互換のコマンドラインで「curl」コマンドを使用できます。

audio_fileパラメータを使用したcURLコマンド​

以下のサンプルは、ローカルの音声ファイルを使用して呼び出した場合に、結果のJSONをダウンロードするためのリンクを返します（パスの前に「@」を忘れずに付けてください）。

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>"

呼び出しへの応答としてJSON自体を受け取りたい場合は、次のようにします：

 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エンドポイント​

ASRトランスクリプトおよび単語レベルの時間アライメントの使用例：

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

機能の非同期取得​

非同期使用の例です。まず、音声ファイルを使用してAPIを呼び出し、そこからstream_idを取得します。

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" 

結果の例を以下に示します：

{"stream_id":"<unique_stream_id>"}

結果エンドポイント​

結果ファイル（ダウンロードリンクまたはJSON構造として）を取得するには、結果エンドポイントを呼び出します。

1件の結果をダウンロードリンクとして取得する：​

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

1件の結果をJSON形式で取得する​

1件の結果を取得する：

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

複数の結果をまとめて取得する（このオプションでは、呼び出し時にJSONの返却は許可されていません）

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

音声エンドポイント​

音声ファイルを取得するには：

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