EC530_Project4

Intro

This RESTful API is designed and powered uing google cloud sever. When posting http request with speech file, please encode the speech file as '.wav' with sample rate = 16000Hz and single track

Github Structure

Setting up Back-end Sever

Functions of RESTful API & Request Formates

----Post Speech File

----Get Task State

----Get Task Result

Session Examples

Github Structure

Top Level

- .github
- Code (*The Main Body of the Project)
- Flake8_Styles
- requirements.txt
- README.md

Code

- main.py
      main.py contains the main function of the API. This file is used to launch the back-end server
- app.yaml
      Config info for google cloud sever
- requirements.txt
      Config info for google cloud sever
- This_is_a_test.wav
      A test speech file
- API_test.py
      A test session

Setting up Back-end Sever

This project is designed for google cloud. To set up the sever, just run the following line in the Code folder: gcloud app deploy

The google cloud sever should have the following APIs enabled:

    google cloud speech to text API
    google-api-python-client
    google-cloud-tasks==2.7.1

Functions of RESTful API and Request Formates

The following parts contain formates and functions that can be called from the front-end side using http requests. Users need to import the following python modules:

    import requests
    import json

Post Speech File

The address to post the file is [http://'sever_address'/s2t/]. Posting a speech file can be done using the following request:

    BASE = "http://ec530pj4.uk.r.appspot.com/"
    # speech file should have sample rate = 16000 and single track
    with open([Speech File Location], 'rb') as s_file: 
      response = requests.post(BASE + "s2t/" + '[any digit]', files={'file': s_file})

[response] containse a dictionary with key = {'task_id'}. task_id is the sever-side queued task id created for this post request, user can use task_id to track the completion states of the task and request for the task result.

Get Task State

The address to get task state is [http://'sever_address'/task_state/].

    BASE = "http://ec530pj4.uk.r.appspot.com/"
    response = requests.get(BASE + "task_state/" + str([task_id]))

[response] containse a dictionary with key = {'task_id', 'task_state'}. task_state can have the following value, representing different states of the task: 0: Free to start 1: Working 2: Completed

Get Task Result

The address to get task result is [http://'sever_address'/s2t/[task_id]]. [task_id] is the queued task id of the previous post request:

    BASE = "http://ec530pj4.uk.r.appspot.com/"
    response = requests.get(BASE + "s2t/" + str([task_id]))

[response] containse a dictionary with key = {'result'}. [result] is converted text message.

Session Examples

A request example is in EC530_Project_4/Code/API_test.py. The example use the sample speech file in EC530_Project_4/Code/This_is_a_test.wav. A sample google cloud sever is set.