Exemplos de uso da API

Requisições com Script​

Abaixo estão alguns exemplos de uso das APIs com script.

Endpoint Score_audio​

Esta demonstração será feita na linha de comando usando um sistema compatível com Linux por meio do comando cURL.

Comando cURL usando o parâmetro audio_path​

Neste exemplo, usaremos a frase "When the sunlight strikes raindrops in the air, they act like a prism and form a rainbow." com o áudio disponível nesta URL pública [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>"

Comando cURL usando o parâmetro 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>"

Você pode alterar o parâmetro "api_plan" para obter resultados mais ou menos detalhados.

Exemplo de suporte a múltipla escolha​

Usando o mesmo endpoint e os mesmos parâmetros acima, também é possível avaliar exercícios de múltipla escolha, onde o mecanismo ELSA irá: 1) selecionar a palavra/frase que melhor corresponde à entrada do usuário; b) avaliar essa frase como no caso de frase única. Para realizar a múltipla escolha, enviaremos uma lista de frases possíveis no campo sentence:

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

Não há limite para o número de frases que você pode enviar.

Veja a seguir uma forma de enviar a lista em um comando curl:

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

Requisições sem Script​

Aqui estão alguns exemplos de uso das APIs sem script.

Endpoint Score_audio_plus​

Para implementar as chamadas à API ELSA, podemos usar o comando "curl" em qualquer linha de comando compatível com Linux.

Comando cURL usando o parâmetro audio_file​

O exemplo a seguir retornará o link para baixar o json de resultado quando chamado usando um arquivo de áudio local (não se esqueça do "@" antes do caminho).

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

Se preferir receber o próprio json como resposta à chamada, faça:

 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​

Exemplo de uso da transcrição ASR e alinhamento temporal no nível de palavra:

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

Recuperação assíncrona de funcionalidade​

Exemplo de uso assíncrono. Começamos chamando a API com um arquivo de áudio e recuperamos dela o 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" 

Veja um exemplo do resultado:

{"stream_id":"<unique_stream_id>"}

Endpoint de resultado​

Para recuperar o arquivo de resultado (seja como link de download ou como estrutura json), chame o endpoint de resultado.

Recuperar um resultado, obtendo um link de download:​

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

Recuperar um resultado no formato json​

Recuperar um resultado:

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

Recuperar vários resultados juntos (nesta opção, não é permitido retornar json na chamada)

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

Endpoint de áudio​

Para recuperar o arquivo de áudio:

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