@@ -50,7 +50,7 @@ Official Python SDK for [Deepgram](https://www.deepgram.com/). Power your apps w
50
50
- [ Get All Balances] ( #get-all-balances )
51
51
- [ Get Balance] ( #get-balance )
52
52
- [ Models] ( #models )
53
- - [ Get All Models] ( #get-all-models )
53
+ - [ Get All Project Models] ( #get-all-project -models )
54
54
- [ Get Model] ( #get-model )
55
55
- [ On-Prem APIs] ( #on-prem-apis )
56
56
- [ List On-Prem credentials] ( #list-on-prem-credentials )
@@ -100,8 +100,11 @@ deepgram = DeepgramClient("YOUR_API_KEY") # Replace with your API key
100
100
Transcribe audio from a URL.
101
101
102
102
``` python
103
+
104
+ from deepgram import PrerecordedOptions
105
+
103
106
response = deepgram.listen.rest.v(" 1" ).transcribe_url(
104
- source = {" url" : " https://dpgr.am/spacewalk.wav" }
107
+ source = {" url" : " https://dpgr.am/spacewalk.wav" },
105
108
options = PrerecordedOptions(model = " nova-3" ) # Apply other options
106
109
)
107
110
```
@@ -115,8 +118,10 @@ response = deepgram.listen.rest.v("1").transcribe_url(
115
118
Transcribe audio from a file.
116
119
117
120
``` python
121
+ from deepgram import PrerecordedOptions
122
+
118
123
response = deepgram.listen.rest.v(" 1" ).transcribe_file(
119
- source = open (" path/to/your/audio.wav" , " rb" )
124
+ source = open (" path/to/your/audio.wav" , " rb" ),
120
125
options = PrerecordedOptions(model = " nova-3" ) # Apply other options
121
126
)
122
127
```
@@ -132,9 +137,11 @@ response = deepgram.listen.rest.v("1").transcribe_file(
132
137
Transcribe audio from a URL.
133
138
134
139
``` python
140
+ from deepgram import PrerecordedOptions
141
+
135
142
response = deepgram.listen.rest.v(" 1" ).transcribe_url_async(
136
143
source = {" url" : " https://dpgr.am/spacewalk.wav" },
137
- callback_url = " https://your-callback-url.com/webhook"
144
+ callback_url = " https://your-callback-url.com/webhook" ,
138
145
options = PrerecordedOptions(model = " nova-3" ) # Apply other options
139
146
)
140
147
```
@@ -148,9 +155,11 @@ response = deepgram.listen.rest.v("1").transcribe_url_async(
148
155
Transcribe audio from a file.
149
156
150
157
``` python
158
+ from deepgram import PrerecordedOptions
159
+
151
160
response = deepgram.listen.rest.v(" 1" ).transcribe_file_async(
152
161
source = open (" path/to/your/audio.wav" , " rb" ),
153
- callback_url = " https://your-callback-url.com/webhook"
162
+ callback_url = " https://your-callback-url.com/webhook" ,
154
163
options = PrerecordedOptions(model = " nova-3" ) # Apply other options
155
164
)
156
165
```
@@ -527,142 +536,160 @@ response = deepgram.manage.v("1").update_member_scope(myProjectId, memberId, opt
527
536
Retrieves all invitations associated with the provided project_id.
528
537
529
538
``` python
530
- @TODO
539
+ response = deepgram.manage.v( " 1 " ).get_invites(myProjectId)
531
540
```
532
541
533
- [ See our API reference for more info] ( https://developers.deepgram.com/reference/invites -api ) .
542
+ [ See our API reference for more info] ( https://developers.deepgram.com/reference/management -api/invitations/list ) .
534
543
535
544
### Send Invite
536
545
537
546
Sends an invitation to the provided email address.
538
547
539
548
``` python
540
- @TODO
549
+ response = deepgram.manage.v( " 1 " ).send_invite(myProjectId, options)
541
550
```
542
551
543
- [ See our API reference for more info] ( https://developers.deepgram.com/reference/invites -api ) .
552
+ [ See our API reference for more info] ( https://developers.deepgram.com/reference/management -api/invitations/create ) .
544
553
545
554
### Delete Invite
546
555
547
556
Removes the specified invitation from the project.
548
557
549
558
``` python
550
- @TODO
559
+ response = deepgram.manage.v( " 1 " ).delete_invite(myProjectId, email)
551
560
```
552
561
553
- [ See our API reference for more info] ( https://developers.deepgram.com/reference/invites -api ) .
562
+ [ See our API reference for more info] ( https://developers.deepgram.com/reference/management -api/invitations/delete ) .
554
563
555
564
### Leave Project
556
565
557
566
``` python
558
- @TODO
567
+ response = deepgram.manage.v( " 1 " ).leave_project(myProjectId)
559
568
```
560
569
561
- [ See our API reference for more info] ( https://developers.deepgram.com/reference/projects -api ) .
570
+ [ See our API reference for more info] ( https://developers.deepgram.com/reference/management -api/invitations/leave ) .
562
571
563
572
## Usage
564
573
565
574
### Get All Requests
566
575
576
+ Retrieves all requests associated with the provided project_id based on the provided options.
577
+
567
578
``` python
568
- @TODO
579
+ response = deepgram.manage.v( " 1 " ).get_usage_requests(myProjectId)
569
580
```
570
581
571
- [ See our API reference for more info] ( https://developers.deepgram.com/reference/requests -api ) .
582
+ [ See our API reference for more info] ( https://developers.deepgram.com/reference/management -api/usage/list-requests ) .
572
583
573
584
### Get Request
574
585
586
+ Retrieves a specific request associated with the provided project_id
587
+
575
588
``` python
576
- @TODO
589
+ response = deepgram.manage.v( " 1 " ).get_usage_request(myProjectId, RequestId)
577
590
```
578
591
579
- [ See our API reference for more info] ( https://developers.deepgram.com/reference/requests -api ) .
592
+ [ See our API reference for more info] ( https://developers.deepgram.com/reference/management -api/usage/get-request ) .
580
593
581
- ### Summarize Usage
594
+ ### Get Fields
595
+
596
+ Lists the features, models, tags, languages, and processing method used for requests in the specified project.
582
597
583
598
``` python
584
- @TODO
599
+ response = deepgram.manage.v( " 1 " ).get_usage_fields(myProjectId)
585
600
```
586
601
587
- [ See our API reference for more info] ( https://developers.deepgram.com/reference/usage -api ) .
602
+ [ See our API reference for more info] ( https://developers.deepgram.com/reference/management -api/usage/list-fields ) .
588
603
589
- ### Get Fields
604
+ ### Summarize Usage
605
+
606
+ ` Deprecated ` Retrieves the usage for a specific project. Use Get Project Usage Breakdown for a more comprehensive usage summary.
590
607
591
608
``` python
592
- @TODO
609
+ response = deepgram.manage.v( " 1 " ).get_usage_summary(myProjectId)
593
610
```
594
611
595
- [ See our API reference for more info] ( https://developers.deepgram.com/reference/usage -api ) .
612
+ [ See our API reference for more info] ( https://developers.deepgram.com/reference/management -api/usage/get ) .
596
613
597
614
## Billing
598
615
599
616
### Get All Balances
600
617
618
+ Retrieves the list of balance info for the specified project.
619
+
601
620
``` python
602
- @TODO
621
+ response = deepgram.manage.v( " 1 " ).get_balances(myProjectId)
603
622
```
604
623
605
- [ See our API reference for more info] ( https://developers.deepgram.com/reference/balances -api ) .
624
+ [ See our API reference for more info] ( https://developers.deepgram.com/reference/management -api/balances/list ) .
606
625
607
626
### Get Balance
608
627
628
+ Retrieves the balance info for the specified project and balance_id.
629
+
609
630
``` python
610
- @TODO
631
+ response = deepgram.manage.v( " 1 " ).get_balance(myProjectId)
611
632
```
612
633
613
- [ See our API reference for more info] ( https://developers.deepgram.com/reference/balances -api ) .
634
+ [ See our API reference for more info] ( https://developers.deepgram.com/reference/management -api/balances/get ) .
614
635
615
636
## Models
616
637
617
- ### Get All Models
638
+ ### Get All Project Models
639
+
640
+ Retrieves all models available for a given project.
618
641
619
642
``` python
620
- @TODO
643
+ response = deepgram.manage.v( " 1 " ).get_project_models(myProjectId)
621
644
```
622
645
623
- [ See our API reference for more info] ( https://developers.deepgram.com/reference/models -api ) .
646
+ [ See our API reference for more info] ( https://developers.deepgram.com/reference/management -api/projects/list-models ) .
624
647
625
648
### Get Model
626
649
650
+ Retrieves details of a specific model.
651
+
627
652
``` python
628
- @TODO
653
+ response = deepgram.manage.v( " 1 " ).get_project_model(myProjectId, ModelId)
629
654
```
630
655
631
- [ See our API reference for more info] ( https://developers.deepgram.com/reference/models -api ) .
656
+ [ See our API reference for more info] ( https://developers.deepgram.com/reference/management -api/projects/get-model ) .
632
657
633
658
## On-Prem APIs
634
659
635
660
### List On-Prem credentials
636
661
662
+ Lists sets of distribution credentials for the specified project.
663
+
637
664
``` python
638
- @TODO
665
+ response = deepgram.selfhosted.v( " 1 " ).list_selfhosted_credentials(projectId)
639
666
```
640
667
641
- [ See our API reference for more info] ( https://developers.deepgram.com/reference/on-prem -api ) .
668
+ [ See our API reference for more info] ( https://developers.deepgram.com/reference/self-hosted -api/list-credentials ) .
642
669
643
670
### Get On-Prem credentials
644
671
645
672
``` python
646
- @TODO
673
+ response = deepgram.selfhosted.v( " 1 " ).get_selfhosted_credentials(projectId, distributionCredentialsId)
647
674
```
648
675
649
- [ See our API reference for more info] ( https://developers.deepgram.com/reference/on-prem -api ) .
676
+ [ See our API reference for more info] ( https://developers.deepgram.com/reference/self-hosted -api/get-credentials ) .
650
677
651
678
### Create On-Prem credentials
652
679
653
680
``` python
654
- @TODO
681
+ response = deepgram.selfhosted.v( " 1 " ).create_selfhosted_credentials(project_id, options)
655
682
```
656
683
657
- [ See our API reference for more info] ( https://developers.deepgram.com/reference/on-prem -api ) .
684
+ [ See our API reference for more info] ( https://developers.deepgram.com/reference/self-hosted -api/create-credentials ) .
658
685
659
686
### Delete On-Prem credentials
660
687
661
688
``` python
662
- @TODO
689
+ response = deepgram.selfhosted.v( " 1 " ).delete_selfhosted_credentials(projectId, distributionCredentialId)
663
690
```
664
691
665
- [ See our API reference for more info] ( https://developers.deepgram.com/reference/on-prem -api ) .
692
+ [ See our API reference for more info] ( https://developers.deepgram.com/reference/self-hosted -api/delete-credentials ) .
666
693
667
694
## Pinning Versions
668
695
0 commit comments