{"id":26359100,"url":"https://github.com/assemblyai/assemblyai-algolia-voice-widget","last_synced_at":"2025-03-16T15:58:43.246Z","repository":{"id":39143121,"uuid":"243694550","full_name":"AssemblyAI/assemblyai-algolia-voice-widget","owner":"AssemblyAI","description":null,"archived":false,"fork":false,"pushed_at":"2023-01-05T11:13:19.000Z","size":957,"stargazers_count":24,"open_issues_count":26,"forks_count":2,"subscribers_count":6,"default_branch":"master","last_synced_at":"2023-03-28T21:07:53.914Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AssemblyAI.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-02-28T06:31:40.000Z","updated_at":"2022-05-14T16:50:36.000Z","dependencies_parsed_at":"2023-02-04T02:45:44.664Z","dependency_job_id":null,"html_url":"https://github.com/AssemblyAI/assemblyai-algolia-voice-widget","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AssemblyAI%2Fassemblyai-algolia-voice-widget","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AssemblyAI%2Fassemblyai-algolia-voice-widget/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AssemblyAI%2Fassemblyai-algolia-voice-widget/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AssemblyAI%2Fassemblyai-algolia-voice-widget/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AssemblyAI","download_url":"https://codeload.github.com/AssemblyAI/assemblyai-algolia-voice-widget/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243893856,"owners_count":20364916,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-16T15:58:43.184Z","updated_at":"2025-03-16T15:58:43.240Z","avatar_url":"https://github.com/AssemblyAI.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AssemblyAI Voice Search Widget\n\nUsing this widget, you can effortlessly add voice search to your website and/or app. \n\n- [Getting Started](#getting-started)\n- [Supported Platforms/Browsers](#supported-platforms-browsers)\n- [Supported Languages](#supported-languages)\n- [Getting an AssemblyAI API Token](#getting-an-assemblyai-api-token)\n- [Feedback/Support](#feedback-and-support)\n\n# Getting Started\n\n### 1: Include AssemblyAI\n\n```html\n\u003cscript src=\"https://cdn.jsdelivr.net/gh/assemblyai/assemblyai-algolia-voice-widget/public/assemblyai-voice-helper.js\"\u003e\u003c/script\u003e\n```\n\n### 2. Configure Algolia InstantSearch\n\n\u003e The below Voice Search Widget requires you have an AssemblyAI Token, which you can get [here](#getting-an-assemblyai-api-token)\n\n```js\nconst search = instantsearch({\n    indexName: '...',\n    searchClient: algoliasearch('...', '...'),\n});\n\nsearch.addWidgets([\n    instantsearch.widgets.hits({\n      container: '#hits',\n    }),\n    instantsearch.widgets.searchBox({\n      container: '#searchbox'\n    }),\n    instantsearch.widgets.voiceSearch({\n      container: '#voicesearch',\n      createVoiceSearchHelper: window.assemblyAIHelper(\n        'xxxxxxxxxxxxxxx', // Your AssemblyAI API Token\n        {\n          word_boost: ['AssemblyAI', 'Google', 'Facebook'], // AssemblyAI word_boost parameter. See: https://docs.assemblyai.com/all-guides/synchronous-transcription-for-short-audio-files#boost\n          format_text: true // AssemblyAI format_text parameter. See: https://docs.assemblyai.com/all-guides/synchronous-transcription-for-short-audio-files#format\n        }\n      ),\n      cssClasses: {\n        root: ['AssemblyAIHelper'] // Add AssemblyAI stylings or use your own\n      },\n      templates: {\n        status: ({errorCode}) =\u003e Boolean(errorCode) ? `\u003cdiv\u003e${errorCode}\u003c/div\u003e` : '' // AssemblyAI error handling\n      }\n    }),\n    // ... other configurations\n]);\n\nsearch.start();\n\n```\n\n# Supported Platforms Browsers\n\n\n| Browser  | Supported |\n| ------------- | ------------- |\n| Dekstop Safari  | Yes  |\n| Desktop Chrome  | Yes  |\n| Desktop Firefox | Yes |\n| iOS Safari | Yes |\n| iOS Chrome | No |\n| iOS Firefox | No |\n| Android Chrome | Yes |\n| Android Firefox | Yes |\n\n# Supported Languages\n\nAt this time, only **English** (all accents) is supported.\n\n# Getting an AssemblyAI API Token\n\nAssemblyAI is a [Speech-to-Text API](https://www.assemblyai.com/) that can convert voice into text. You must have an AssemblyAI API Token to use this voice search widget. \n\n1. Register for an AssemblyAI API token [here](https://app.assemblyai.com/login/)\n1. Add a credit card to your AssemblyAI account [here](https://app.assemblyai.com/dashboard/account/)\n1. Pricing is billed at **$0.008 per request to AssemblyAI**. \n\n# Feedback and Support\n\nFor questions about AssemblyAI, please email support@assemblyai.com. For questions about Algolia, please visit Algolia's support center [here](https://www.algolia.com/support/).\n\n# Dev\n\n## Build\n\n```js\nhttps://github.com/AssemblyAI/assemblyai-algolia-voice-widget\ncd assemblyai-voice-widget\nnpm install\nnpm run build\n```\n\n## Development\n```js\nhttps://github.com/AssemblyAI/assemblyai-algolia-voice-widget\ncd assemblyai-voice-widget\nnpm install\nnpm run dev // Server is running with webpack-dev-server (http://localhost:3000)\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fassemblyai%2Fassemblyai-algolia-voice-widget","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fassemblyai%2Fassemblyai-algolia-voice-widget","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fassemblyai%2Fassemblyai-algolia-voice-widget/lists"}