Azure.Data.AI 1.0.0

Prefix Reserved
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package Azure.Data.AI --version 1.0.0
                    
NuGet\Install-Package Azure.Data.AI -Version 1.0.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Azure.Data.AI" Version="1.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Azure.Data.AI" Version="1.0.0" />
                    
Directory.Packages.props
<PackageReference Include="Azure.Data.AI" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Azure.Data.AI --version 1.0.0
                    
#r "nuget: Azure.Data.AI, 1.0.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Azure.Data.AI@1.0.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Azure.Data.AI&version=1.0.0
                    
Install as a Cake Addin
#tool nuget:?package=Azure.Data.AI&version=1.0.0
                    
Install as a Cake Tool

Azure Semantic Reranker client library for .NET

Azure.Data.AI provides semantic reranking operations for .NET applications.

Version 1.0.0 is the first stable release and targets service API version 2026-10-30.

Getting started

Install the package

Install the client library for .NET with NuGet:

dotnet add package Azure.Data.AI

Prerequisites

  • Azure.Core version 1.64.0 or later. This dependency is installed automatically; if your application references Azure.Core directly or pins it through central package management, update that reference to at least 1.64.0.
  • You must have a Microsoft Azure subscription.
  • A Semantic Reranker endpoint.
  • Either an API key or a Microsoft Entra identity assigned the Semantic Reranker User role on the Microsoft.InferenceService/inferenceAccounts resource.

Authenticate the client

Create a client with an API key:

Uri endpoint = new Uri("<semantic-reranker-endpoint>");
AzureKeyCredential credential = new AzureKeyCredential("<api-key>");
InferenceClient client = new InferenceClient(endpoint, credential);

Or authenticate with a TokenCredential, such as DefaultAzureCredential from Azure.Identity:

Uri endpoint = new Uri("<semantic-reranker-endpoint>");
InferenceClient client = new InferenceClient(endpoint, new DefaultAzureCredential());

The generated bearer-token policy requests the https://dbinference.azure.com/.default scope.

Key concepts

Use InferenceClient.SemanticRerank or SemanticRerankAsync to rerank documents directly. Pass a SemanticRerankingContent instance and read the scores and Metadata from the returned SemanticRerankingResult. For JSON documents, set DocumentType to SemanticRerankingDocumentType.Json and add up to 100 property paths to the TargetPaths collection; the client serializes them as a comma-separated string. The API contract specifies a maximum of 100 paths.

Examples

See Semantic reranking.

Troubleshooting

Service operations throw RequestFailedException when the service returns a non-success status code.

Next steps

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (for example, label, comment). Follow the instructions provided by the bot. You'll only need to do this action once across all repositories using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any other questions or comments.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.1.0-beta.1 64 11/14/2026
1.0.0 105 11/11/2026
1.0.0-beta.1 638 9/29/2026