.NET SDK V3 to V4 Migration Guide
Migrating from Deepgram .NET SDK v3 to the Deepgram .NET SDK v4
This guide is for users with experience using the Deepgram .NET SDK v3 who want to migrate to the Deepgram .NET SDK v4. This is not an end-to-end guide, but a reference for people using our existing .NET SDK to migrate to our newest version.
Notable Changes
- Significant Restructure of the .NET SDK
- Improved Implementation for Live, PreRecorded, and Manage Clients
- Implements Text-to-Speech API
- Implements Intelligence APIs for PreRecorded and Text (Summary, Intent, Topic, Sentiment)
- Support for self-hosted/on-prem (previously not supported)
- Improved and Independent Timeout Capabilities per API Call
- Verbosity Logging Levels for Troubleshooting
- Custom Header and Query Parameters for API calls
- Better Error Handling
- Support for future products (APIs)
Migration Guide
This section of the migration guide focuses on the SDK’s PreRecorded and Live Clients. It will allow you to transition to the latest version of the SDK.
Installation
Transcription: Pre-Recorded
There are two methods for transcribing Pre-Recorded audio:
- Using a local file on the file system
- Providing a URL pointing to an supported audio file
Local File Transcription
Transcribe a local file on the same filesystem as the app is running.
URL File Transcription
Transcribe a remote file by sending a publicly accessible URL.
Transcription: Live
The Live Client abstracts the underlying WebSocket implementation from the user for greater usability. This in turn only requires that you deal with higher-level functions like Connect()
, Send()
, Stop()
methods.
Management API
Below is a transition guide for using the Manage APIs.
Get all projects for a user
See our API reference for more info.
Get a project
See our API reference for more info.
Update a project
See our API reference for more info.
Delete a project
See our API reference for more info.
Get all project key details
See our API reference for more info.
Get a project key
See our API reference for more info.
Create a project key
See our API reference for more info.
Delete a project key
See our API reference for more info.
Get all project members
See our API reference for more info.
Remove a project member
See our API reference for more info.
Get all scopes for a project member
See our API reference for more info.
Update a scope for a project member
See our API reference for more info.
Get all usage requests for a project
See our API reference for more info.
Get a usage request for a project
See our API reference for more info.
Get the project usage summary
See our API reference for more info.
Get project usage fields
See our API reference for more info.
New to v4
[NOTICE] There were several APIs that were previously unavailable in v3
of the .NET SDK but that are now available in the v4
release. These included:
- Self-hosted (on-prem) APIs
- Manage APIs for Balances and Invitations
- Intelligence APIs (SITS) for Text and Audio
- Text-to-Speech
Please refer to the examples in the examples
folder at the root of the .NET SDK repository for implementation details.