Skip to content

Commit 9baa12d

Browse files
authored
updates missing section of readme (#533)
* updates missing section of readme * a few more updates
1 parent 2bf98aa commit 9baa12d

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@
55

66
Official Python SDK for [Deepgram](https://www.deepgram.com/). Power your apps with world-class speech and Language AI models.
77

8+
- [Documentation](#documentation)
9+
- [Migrating from earlier versions](#migrating-from-earlier-versions)
10+
- [V2 to V3](#v2-to-v3)
11+
- [V3.*\ to V4](#v3-to-v4)
12+
- [Requirements](#requirements)
13+
- [Installation](#installation)
14+
- [Initialization](#initialization)
15+
- [Getting an API Key](#getting-an-api-key)
816
- [Pre-Recorded (Synchronous)](#pre-recorded-synchronous)
917
- [Remote Files (Synchronous)](#remote-files-synchronous)
1018
- [Local Files (Synchronous)](#local-files-synchronous)
@@ -66,9 +74,15 @@ Official Python SDK for [Deepgram](https://www.deepgram.com/). Power your apps w
6674

6775
You can learn more about the Deepgram API at [developers.deepgram.com](https://developers.deepgram.com/docs).
6876

69-
## Getting an API Key
77+
## Migrating from earlier versions
7078

71-
🔑 To access the Deepgram API you will need a [free Deepgram API Key](https://console.deepgram.com/signup?jump=keys).
79+
### V2 to V3
80+
81+
We have published [a migration guide on our docs](https://developers.deepgram.com/sdks/python-sdk/v2-to-v3-migration), showing how to move from v2 to v3.
82+
83+
### V3.\* to V4
84+
85+
The Voice Agent interfaces have been updated to use the new Voice Agent V1 API. Please refer to our [Documentation](https://developers.deepgram.com/docs/voice-agent-v1-migration) on Migration to new V1 Agent API.
7286

7387
## Requirements
7488

@@ -93,6 +107,10 @@ from deepgram import DeepgramClient
93107
deepgram = DeepgramClient("YOUR_API_KEY") # Replace with your API key
94108
```
95109

110+
### Getting an API Key
111+
112+
🔑 To access the Deepgram API you will need a [free Deepgram API Key](https://console.deepgram.com/signup?jump=keys).
113+
96114
## Pre-Recorded (Synchronous)
97115

98116
### Remote Files (Synchronous)
@@ -669,6 +687,8 @@ response = deepgram.selfhosted.v("1").list_selfhosted_credentials(projectId)
669687

670688
### Get On-Prem credentials
671689

690+
Returns a set of distribution credentials for the specified project.
691+
672692
```python
673693
response = deepgram.selfhosted.v("1").get_selfhosted_credentials(projectId, distributionCredentialsId)
674694
```
@@ -677,6 +697,8 @@ response = deepgram.selfhosted.v("1").get_selfhosted_credentials(projectId, dist
677697

678698
### Create On-Prem credentials
679699

700+
Creates a set of distribution credentials for the specified project.
701+
680702
```python
681703
response = deepgram.selfhosted.v("1").create_selfhosted_credentials(project_id, options)
682704
```
@@ -685,6 +707,8 @@ response = deepgram.selfhosted.v("1").create_selfhosted_credentials(project_id,
685707

686708
### Delete On-Prem credentials
687709

710+
Deletes a set of distribution credentials for the specified project.
711+
688712
```python
689713
response = deepgram.selfhosted.v("1").delete_selfhosted_credentials(projectId, distributionCredentialId)
690714
```

0 commit comments

Comments
 (0)