Ví dụ về cách sử dụng API

Yêu cầu có kịch bản​

Dưới đây là một số ví dụ minh họa cách sử dụng các API có kịch bản.

Endpoint Score_audio​

Bản demo này sẽ được thực hiện trên dòng lệnh sử dụng hệ thống tương thích Linux thông qua lệnh cURL.

Lệnh cURL sử dụng tham số audio_path​

Trong ví dụ này, chúng ta sẽ sử dụng câu "When the sunlight strikes raindrops in the air, they act like a prism and form a rainbow." với tệp âm thanh có tại URL công khai này [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>"

Lệnh cURL sử dụng tham số 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>"

Bạn có thể thay đổi tham số "api_plan" để nhận kết quả chi tiết hơn hoặc ít chi tiết hơn.

Ví dụ về hỗ trợ câu hỏi nhiều lựa chọn​

Sử dụng cùng endpoint và tham số như trên, chúng ta cũng có thể chấm điểm các bài tập nhiều lựa chọn, trong đó công cụ ELSA sẽ: 1) chọn từ/câu phù hợp nhất với đầu vào của người dùng; b) chấm điểm câu đó như trong trường hợp câu đơn. Để thực hiện nhiều lựa chọn, chúng ta sẽ gửi một danh sách các câu có thể trong trường sentence:

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

Không có giới hạn về số lượng câu bạn có thể gửi.

Dưới đây là cách gửi danh sách trong lệnh curl:

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

Yêu cầu không có kịch bản​

Dưới đây là một số ví dụ về cách sử dụng các API không có kịch bản.

Endpoint Score_audio_plus​

Để triển khai các lệnh gọi tới ELSA API, chúng ta có thể sử dụng lệnh "curl" trên bất kỳ dòng lệnh tương thích Linux nào.

Lệnh cURL sử dụng tham số audio_file​

Mẫu sau sẽ trả về đường dẫn tải xuống tệp json kết quả khi được gọi bằng tệp âm thanh cục bộ (đừng quên ký tự "@" trước đường dẫn).

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

Nếu bạn muốn nhận trực tiếp tệp json như một phản hồi cho lệnh gọi, hãy thực hiện:

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

Endpoint ASR​

Ví dụ sử dụng bản ghi ASR và căn chỉnh thời gian theo từng từ:

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

Truy xuất chức năng không đồng bộ​

Ví dụ sử dụng theo chế độ không đồng bộ. Chúng ta bắt đầu bằng cách gọi API với tệp âm thanh và lấy stream_id từ phản hồi.

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" 

Dưới đây là ví dụ về kết quả trả về:

{"stream_id":"<unique_stream_id>"}

Endpoint kết quả​

Để truy xuất tệp kết quả (dưới dạng đường dẫn tải xuống hoặc cấu trúc json), hãy gọi endpoint kết quả.

Truy xuất một kết quả, lấy đường dẫn tải xuống:​

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

Truy xuất một kết quả theo định dạng json​

Truy xuất một kết quả:

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

Truy xuất nhiều kết quả cùng lúc (với tùy chọn này, chúng tôi không cho phép trả về json trong lệnh gọi)

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

Endpoint âm thanh​

Để truy xuất tệp âm thanh:

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