readme.md

ALERTUS Transciption System

Guidelines

ALERTUS Transciption System uses Google-Speech-to-Text to transcribe audio file to readable text

HOW TO SETUP:

• Create An Account With Google Cloud check https://cloud.google.com/speech-to-text/
• Create a /google-credential/key.json File
• Store the API key Json in file created above the check https://cloud.google.com/speech-to-text/docs/ quickstart-gcloud for quickstart
• Create account on Cloudconvert to generate an API key check https://cloudconvert.com/ for more info
• Please Note the CloudConvert Platform is useful for converting the audio file to FLAC before transcription for more efficiency. check https://cloud.google.com/speech-to-text/docs/encoding for more info
• clone this repo
• composer install
• php artisan migrate, to migrate table
• cp .env.example .env fill the Keys in the .env accordingly with the API keys generated above

RESTful URLs

* To register a user:
    * POST /api/user/create

  Authorization Bearer Token is needed to access the next endpoints,  register first !!

 * To update a user info:
    * PUT /api/user/update

* To update or refresh a user auth Token:
    * PUT /api/user/update

* To get all Transcription:
    * GET /api/transcribeResponses

* To get all Transcription for a Session:
    * GET /api/transcribe/Session/{SessionId}
       
* To get all Transcription for a Recording:
    * GET /api/transcribe/Recording/{RecordingId}

* To get One Transcription By Id:
    * GET /api/transcribe/{id}

* To transcribe audio from url:
    * POST /api/transcribeFromUrl

HTTP Verbs

HTTP METHOD	POST	GET	PUT	DELETE
CRUD OP	CREATE	READ	UPDATE	DELETE

Thank You ❤️ 🙏