Skip to content

Commit 342f99d

Browse files
committed
final updates
1 parent 616c4c2 commit 342f99d

File tree

1 file changed

+67
-40
lines changed

1 file changed

+67
-40
lines changed

README.md

Lines changed: 67 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Official Python SDK for [Deepgram](https://www.deepgram.com/). Power your apps w
5050
- [Get All Balances](#get-all-balances)
5151
- [Get Balance](#get-balance)
5252
- [Models](#models)
53-
- [Get All Models](#get-all-models)
53+
- [Get All Project Models](#get-all-project-models)
5454
- [Get Model](#get-model)
5555
- [On-Prem APIs](#on-prem-apis)
5656
- [List On-Prem credentials](#list-on-prem-credentials)
@@ -100,8 +100,11 @@ deepgram = DeepgramClient("YOUR_API_KEY") # Replace with your API key
100100
Transcribe audio from a URL.
101101

102102
```python
103+
104+
from deepgram import PrerecordedOptions
105+
103106
response = deepgram.listen.rest.v("1").transcribe_url(
104-
source={"url": "https://dpgr.am/spacewalk.wav"}
107+
source={"url": "https://dpgr.am/spacewalk.wav"},
105108
options=PrerecordedOptions(model="nova-3") # Apply other options
106109
)
107110
```
@@ -115,8 +118,10 @@ response = deepgram.listen.rest.v("1").transcribe_url(
115118
Transcribe audio from a file.
116119

117120
```python
121+
from deepgram import PrerecordedOptions
122+
118123
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"),
120125
options=PrerecordedOptions(model="nova-3") # Apply other options
121126
)
122127
```
@@ -132,9 +137,11 @@ response = deepgram.listen.rest.v("1").transcribe_file(
132137
Transcribe audio from a URL.
133138

134139
```python
140+
from deepgram import PrerecordedOptions
141+
135142
response = deepgram.listen.rest.v("1").transcribe_url_async(
136143
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",
138145
options=PrerecordedOptions(model="nova-3") # Apply other options
139146
)
140147
```
@@ -148,9 +155,11 @@ response = deepgram.listen.rest.v("1").transcribe_url_async(
148155
Transcribe audio from a file.
149156

150157
```python
158+
from deepgram import PrerecordedOptions
159+
151160
response = deepgram.listen.rest.v("1").transcribe_file_async(
152161
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",
154163
options=PrerecordedOptions(model="nova-3") # Apply other options
155164
)
156165
```
@@ -527,142 +536,160 @@ response = deepgram.manage.v("1").update_member_scope(myProjectId, memberId, opt
527536
Retrieves all invitations associated with the provided project_id.
528537

529538
```python
530-
@TODO
539+
response = deepgram.manage.v("1").get_invites(myProjectId)
531540
```
532541

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).
534543

535544
### Send Invite
536545

537546
Sends an invitation to the provided email address.
538547

539548
```python
540-
@TODO
549+
response = deepgram.manage.v("1").send_invite(myProjectId, options)
541550
```
542551

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).
544553

545554
### Delete Invite
546555

547556
Removes the specified invitation from the project.
548557

549558
```python
550-
@TODO
559+
response = deepgram.manage.v("1").delete_invite(myProjectId, email)
551560
```
552561

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).
554563

555564
### Leave Project
556565

557566
```python
558-
@TODO
567+
response = deepgram.manage.v("1").leave_project(myProjectId)
559568
```
560569

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).
562571

563572
## Usage
564573

565574
### Get All Requests
566575

576+
Retrieves all requests associated with the provided project_id based on the provided options.
577+
567578
```python
568-
@TODO
579+
response = deepgram.manage.v("1").get_usage_requests(myProjectId)
569580
```
570581

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).
572583

573584
### Get Request
574585

586+
Retrieves a specific request associated with the provided project_id
587+
575588
```python
576-
@TODO
589+
response = deepgram.manage.v("1").get_usage_request(myProjectId, RequestId)
577590
```
578591

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).
580593

581-
### Summarize Usage
594+
### Get Fields
595+
596+
Lists the features, models, tags, languages, and processing method used for requests in the specified project.
582597

583598
```python
584-
@TODO
599+
response = deepgram.manage.v("1").get_usage_fields(myProjectId)
585600
```
586601

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).
588603

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.
590607

591608
```python
592-
@TODO
609+
response = deepgram.manage.v("1").get_usage_summary(myProjectId)
593610
```
594611

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).
596613

597614
## Billing
598615

599616
### Get All Balances
600617

618+
Retrieves the list of balance info for the specified project.
619+
601620
```python
602-
@TODO
621+
response = deepgram.manage.v("1").get_balances(myProjectId)
603622
```
604623

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).
606625

607626
### Get Balance
608627

628+
Retrieves the balance info for the specified project and balance_id.
629+
609630
```python
610-
@TODO
631+
response = deepgram.manage.v("1").get_balance(myProjectId)
611632
```
612633

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).
614635

615636
## Models
616637

617-
### Get All Models
638+
### Get All Project Models
639+
640+
Retrieves all models available for a given project.
618641

619642
```python
620-
@TODO
643+
response = deepgram.manage.v("1").get_project_models(myProjectId)
621644
```
622645

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).
624647

625648
### Get Model
626649

650+
Retrieves details of a specific model.
651+
627652
```python
628-
@TODO
653+
response = deepgram.manage.v("1").get_project_model(myProjectId, ModelId)
629654
```
630655

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).
632657

633658
## On-Prem APIs
634659

635660
### List On-Prem credentials
636661

662+
Lists sets of distribution credentials for the specified project.
663+
637664
```python
638-
@TODO
665+
response = deepgram.selfhosted.v("1").list_selfhosted_credentials(projectId)
639666
```
640667

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).
642669

643670
### Get On-Prem credentials
644671

645672
```python
646-
@TODO
673+
response = deepgram.selfhosted.v("1").get_selfhosted_credentials(projectId, distributionCredentialsId)
647674
```
648675

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).
650677

651678
### Create On-Prem credentials
652679

653680
```python
654-
@TODO
681+
response = deepgram.selfhosted.v("1").create_selfhosted_credentials(project_id, options)
655682
```
656683

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).
658685

659686
### Delete On-Prem credentials
660687

661688
```python
662-
@TODO
689+
response = deepgram.selfhosted.v("1").delete_selfhosted_credentials(projectId, distributionCredentialId)
663690
```
664691

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).
666693

667694
## Pinning Versions
668695

0 commit comments

Comments
 (0)