Skip to content

README.md

Latest commit

 

History

History
148 lines (79 loc) · 3.94 KB

README.md

File metadata and controls

148 lines (79 loc) · 3.94 KB

Speech Recognition with Hugging Face

This function uses the Hugging Face API to perform speech recognition. It takes an audio file from Appwrite storage and sends it to the Hugging Face API for speech recognition. The API returns the text and records it in the database. This function also supports receiving document events from the Appwrite Database.

🧰 Usage

POST /

Parameters

Name Description Location Type Sample Value
fileId Appwrite File ID of audio file Body String 65c6319c5f34dc9638ec

This function also accepts body of a file event from Appwrite Storage.

Response

Sample 200 Response:

Text from the audio file is recognized and stored in the database.

{
 "text": " going along slushy country roads and speaking to damp audiences in draughty schoolrooms day after day for a fortnight he'll have to put in an appearance at some place of worship on sunday morning and he can come to us immediately afterwards"
}

Sample 404 Response:

{
 "error": "File not found"
}

⚙️ Configuration

Setting Value
Runtime Python (3.12)
Entrypoint src/main.py
Build Commands npm install && npm run setup
Permissions any
Timeout (Seconds) 15
Events buckets.*.files.*.create

Prerequisites

🔒 Environment Variables

APPWRITE_BUCKET_ID

The ID of the bucket where audio is stored.

Question Answer
Required No
Sample Value speech_recogition

APPWRITE_DATABASE_ID

The ID of the database where the responses are stored.

Question Answer
Required No
Sample Value ai

APPWRITE_COLLECTION_ID

The ID of the collection where the responses are stored.

Question Answer
Required No
Sample Value speech_recogition

HUGGINGFACE_ACCESS_TOKEN

Secret for sending requests to the Hugging Face API.

Question Answer
Required Yes
Sample Value hf_x2a...
Documentation Hugging Face: API tokens

Create a .env file in the src directory and add the following environment variables:

APPWRITE_ENDPOINT=http://localhost/v1 <---- set to this if you selected all default values when running appwrite locally through docker
APPWRITE_API_KEY=your_appwrite_api_key
APPWRITE_PROJECT_ID=your_appwrite_project_id
HUGGINGFACE_ACCESS_TOKEN=your_huggingface_access_token
APPWRITE_DATABASE_ID=ai
APPWRITE_COLLECTION_ID=speech_recognition
APPWRITE_BUCKET_ID=speech_recognition

Running the Application

To process an audio file for speech recognition, you can use the main.py script. Ensure your Appwrite function is set up to handle HTTP requests and call the process_audio function.

Dependencies

  • pip install appwrite
  • pip install huggingface_hub
  • pip install python-dotenv

License

This project is licensed under the MIT License.