Installation - DrHazemAli/AzureSoraSDK GitHub Wiki
Installation
This guide covers how to install and set up the AzureSoraSDK in your .NET project.
Prerequisites
Before installing the SDK, ensure you have:
- .NET 6.0 or higher installed (Download .NET)
- Azure OpenAI resource with Sora model deployment
- Valid API key with appropriate permissions
Installation Methods
1. Package Manager Console
Install-Package AzureSoraSDK
2. .NET CLI
dotnet add package AzureSoraSDK
3. PackageReference
Add the following to your .csproj
file:
<PackageReference Include="AzureSoraSDK" Version="1.0.2" />
4. Package Manager UI
- Right-click on your project in Visual Studio
- Select "Manage NuGet Packages"
- Search for "AzureSoraSDK"
- Click "Install"
Verify Installation
After installation, you can verify by adding the using statement:
using AzureSoraSDK;
Dependencies
The SDK automatically includes the following dependencies:
- Microsoft.Extensions.DependencyInjection (>= 6.0.0)
- Microsoft.Extensions.Http (>= 6.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 6.0.0)
- Microsoft.Extensions.Options (>= 6.0.0)
- Microsoft.Extensions.Options.DataAnnotations (>= 6.0.0)
- Polly.Extensions.Http (>= 3.0.0)
- System.Text.Json (>= 6.0.0)
Next Steps
- Getting Started - Learn how to use the SDK
- Configuration - Set up your Azure OpenAI credentials
- Examples - See code examples
Troubleshooting Installation
Common Issues
-
Package not found
- Ensure you have a stable internet connection
- Check if NuGet.org is accessible
- Try clearing NuGet cache:
dotnet nuget locals all --clear
-
Version conflicts
- Check for conflicting package versions in your project
- Consider updating to the latest versions of dependencies
-
Build errors after installation
- Ensure your project targets .NET 6.0 or higher
- Rebuild the solution:
dotnet clean && dotnet build
For more help, see the Troubleshooting guide.