Skip to content

Update parameter documentation #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
phazonoverload merged 2 commits into from
Dec 23, 2021
Merged

Update parameter documentation #5

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
057090b
Update README.md
frumsdotxyz Dec 20, 2021
17dc2b3
Update README.md
frumsdotxyz Dec 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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!
Expand Down