diff --git a/README.md b/README.md index 367524d0..497980f7 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg?style=flat-rounded)](CODE_OF_CONDUCT.md) -> This is a pre-release SDK and is very likely to have breaking changes. Feel free to provide +> This SDK is under active development; feel free to provide > feedback via GitHub issues and suggest new features. Official Python SDK for [Deepgram](https://www.deepgram.com/)'s automated @@ -56,8 +56,6 @@ async def main(): asyncio.run(main()) ``` -As you can tell, query parameters like `punctuate` are added as part of the TranscriptionOptions in the request. Multiple query parameters can be added like so: `response = await dg_client.transcription.prerecorded(source, {'punctuate': True, 'keywords': ['first:5', 'second']})` - #### "Fake" streaming processing: ```python @@ -102,6 +100,18 @@ async def main(): asyncio.run(main()) ``` +### Parameters + +Query parameters like `punctuate` are added as part of the `TranscriptionOptions` `dict` in the `.prerecorded`/`.live` transcription call. +Multiple query parameters can be added similarly, and any dict will do - the types are provided for reference/convenience. +```python +response = await dg_client.transcription.prerecorded(source, {'punctuate': True, 'keywords': ['first:5', 'second']}) +``` +Depending on your preference, you can also add parameters as named arguments, instead. +```python +response = await dg_client.transcription.prerecorded(source, punctuate=True, keywords=['first:5', 'second']) +``` + ## Development and Contributing Interested in contributing? We ❤️ pull requests!