Ejemplos de uso de la API

Solicitudes con guion​

A continuación se muestran algunos ejemplos del uso de las APIs con guion.

Endpoint Score_audio​

Esta demostración se realizará en la línea de comandos utilizando un sistema compatible con Linux a través del comando cURL.

Comando cURL usando el parámetro audio_path​

En este ejemplo usaremos la frase "When the sunlight strikes raindrops in the air, they act like a prism and form a rainbow." con el audio disponible en esta 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 el 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>"

Puede cambiar el parámetro "api_plan" para obtener resultados más o menos detallados.

Ejemplo de compatibilidad con opción múltiple​

Usando el mismo endpoint y los mismos parámetros que arriba, también podemos puntuar ejercicios de opción múltiple, donde el motor de ELSA: 1) seleccionará la palabra/frase que mejor coincida con la entrada del usuario; b) puntuará esa frase como en el caso de frase única. Para realizar la opción múltiple, enviaremos una lista de posibles frases en el campo sentence:

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

No hay límite en el número de frases que puede enviar.

A continuación se muestra una forma de enviar la lista en un comando curl:

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

Solicitudes sin guion​

A continuación se muestran algunos ejemplos del uso de las APIs sin guion.

Endpoint Score_audio_plus​

Para implementar las llamadas a la API de ELSA podemos usar el comando "curl" en cualquier línea de comandos compatible con Linux.

Comando cURL usando el parámetro audio_file​

El siguiente ejemplo devolverá el enlace para descargar el JSON de resultados cuando se llame usando un archivo de audio local (no olvide el "@" antes de la ruta).

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

Si prefiere recibir el JSON directamente como respuesta a la llamada, haga lo siguiente:

 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​

Ejemplo de uso de la transcripción ASR y la alineación temporal a nivel de palabra:

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

Recuperación asíncrona de funcionalidad​

Ejemplo de uso asíncrono. Comenzamos llamando a la API con un archivo de audio y obtenemos a partir de ella el 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" 

A continuación se muestra un ejemplo del resultado:

{"stream_id":"<unique_stream_id>"}

Endpoint de resultados​

Para recuperar el archivo de resultados (ya sea como enlace de descarga o como estructura JSON), llame al endpoint de resultados.

Recuperar un resultado obteniendo un enlace de descarga:​

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

Recuperar un resultado en formato JSON​

Recuperar un resultado:

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

Recuperar varios resultados juntos (en esta opción no se permite devolver JSON en la llamada):

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

Endpoint de audio​

Para recuperar el archivo de audio:

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