|
1 | 1 | ---
|
2 | 2 | title: Azure OpenAI client library for .NET
|
3 | 3 | keywords: Azure, dotnet, SDK, API, Azure.AI.OpenAI, openai
|
4 |
| -ms.date: 07/14/2025 |
| 4 | +ms.date: 08/07/2025 |
5 | 5 | ms.topic: reference
|
6 | 6 | ms.devlang: dotnet
|
7 | 7 | ms.service: openai
|
8 | 8 | ---
|
9 |
| -# Azure OpenAI client library for .NET - version 2.2.0-beta.5 |
| 9 | +# Azure OpenAI client library for .NET - version 2.3.0-beta.1 |
10 | 10 |
|
11 | 11 |
|
12 | 12 | The Azure OpenAI client library for .NET is a companion to the official [OpenAI client library for .NET](https://github.com/openai/openai-dotnet). The Azure OpenAI library configures a client for use with Azure OpenAI and provides additional strongly typed extension support for request and response models specific to Azure OpenAI scenarios.
|
13 | 13 |
|
14 | 14 | Azure OpenAI is a managed service that allows developers to deploy, tune, and generate content from OpenAI models on Azure resources.
|
15 | 15 |
|
16 |
| - [Source code](https://github.com/Azure/azure-sdk-for-net/blob/Azure.AI.OpenAI_2.2.0-beta.5/sdk/openai/Azure.AI.OpenAI/src) | [Package (NuGet)](https://www.nuget.org/packages/Azure.AI.OpenAI) | [API reference documentation](https://learn.microsoft.com/azure/cognitive-services/openai/reference) | [Product documentation](https://learn.microsoft.com/azure/cognitive-services/openai/) | [Samples](https://github.com/Azure/azure-sdk-for-net/blob/Azure.AI.OpenAI_2.2.0-beta.5/sdk/openai/Azure.AI.OpenAI/tests/Samples) |
| 16 | + [Source code](https://github.com/Azure/azure-sdk-for-net/blob/Azure.AI.OpenAI_2.3.0-beta.1/sdk/openai/Azure.AI.OpenAI/src) | [Package (NuGet)](https://www.nuget.org/packages/Azure.AI.OpenAI) | [API reference documentation](https://learn.microsoft.com/azure/cognitive-services/openai/reference) | [Product documentation](https://learn.microsoft.com/azure/cognitive-services/openai/) | [Samples](https://github.com/Azure/azure-sdk-for-net/blob/Azure.AI.OpenAI_2.3.0-beta.1/sdk/openai/Azure.AI.OpenAI/tests/Samples) |
17 | 17 |
|
18 | 18 | ## Getting started
|
19 | 19 |
|
@@ -142,18 +142,18 @@ We guarantee that all client instance methods are thread-safe and independent of
|
142 | 142 | ### Additional concepts
|
143 | 143 |
|
144 | 144 | <!-- CLIENT COMMON BAR -->
|
145 |
| -[Client options](https://github.com/Azure/azure-sdk-for-net/blob/Azure.AI.OpenAI_2.2.0-beta.5/sdk/core/Azure.Core/README.md#configuring-service-clients-using-clientoptions) | |
146 |
| -[Accessing the response](https://github.com/Azure/azure-sdk-for-net/blob/Azure.AI.OpenAI_2.2.0-beta.5/sdk/core/Azure.Core/README.md#accessing-http-response-details-using-responset) | |
147 |
| -[Long-running operations](https://github.com/Azure/azure-sdk-for-net/blob/Azure.AI.OpenAI_2.2.0-beta.5/sdk/core/Azure.Core/README.md#consuming-long-running-operations-using-operationt) | |
148 |
| -[Handling failures](https://github.com/Azure/azure-sdk-for-net/blob/Azure.AI.OpenAI_2.2.0-beta.5/sdk/core/Azure.Core/README.md#reporting-errors-requestfailedexception) | |
149 |
| -[Diagnostics](https://github.com/Azure/azure-sdk-for-net/blob/Azure.AI.OpenAI_2.2.0-beta.5/sdk/core/Azure.Core/samples/Diagnostics.md) | |
| 145 | +[Client options](https://github.com/Azure/azure-sdk-for-net/blob/Azure.AI.OpenAI_2.3.0-beta.1/sdk/core/Azure.Core/README.md#configuring-service-clients-using-clientoptions) | |
| 146 | +[Accessing the response](https://github.com/Azure/azure-sdk-for-net/blob/Azure.AI.OpenAI_2.3.0-beta.1/sdk/core/Azure.Core/README.md#accessing-http-response-details-using-responset) | |
| 147 | +[Long-running operations](https://github.com/Azure/azure-sdk-for-net/blob/Azure.AI.OpenAI_2.3.0-beta.1/sdk/core/Azure.Core/README.md#consuming-long-running-operations-using-operationt) | |
| 148 | +[Handling failures](https://github.com/Azure/azure-sdk-for-net/blob/Azure.AI.OpenAI_2.3.0-beta.1/sdk/core/Azure.Core/README.md#reporting-errors-requestfailedexception) | |
| 149 | +[Diagnostics](https://github.com/Azure/azure-sdk-for-net/blob/Azure.AI.OpenAI_2.3.0-beta.1/sdk/core/Azure.Core/samples/Diagnostics.md) | |
150 | 150 | [Mocking](https://learn.microsoft.com/dotnet/azure/sdk/unit-testing-mocking) |
|
151 | 151 | [Client lifetime](https://devblogs.microsoft.com/azure-sdk/lifetime-management-and-thread-safety-guarantees-of-azure-sdk-net-clients/)
|
152 | 152 | <!-- CLIENT COMMON BAR -->
|
153 | 153 |
|
154 | 154 | ## Examples
|
155 | 155 |
|
156 |
| -You can familiarize yourself with different APIs using [Samples from OpenAI's .NET library](https://github.com/openai/openai-dotnet/tree/main/examples) or [Azure.AI.OpenAI-specific samples](https://github.com/Azure/azure-sdk-for-net/tree/Azure.AI.OpenAI_2.2.0-beta.5/sdk/openai/Azure.AI.OpenAI/tests/Samples). Most OpenAI capabilities are available on both Azure OpenAI and OpenAI using the same scenario clients and methods, so not all scenarios are redundantly covered here. |
| 156 | +You can familiarize yourself with different APIs using [Samples from OpenAI's .NET library](https://github.com/openai/openai-dotnet/tree/main/examples) or [Azure.AI.OpenAI-specific samples](https://github.com/Azure/azure-sdk-for-net/tree/Azure.AI.OpenAI_2.3.0-beta.1/sdk/openai/Azure.AI.OpenAI/tests/Samples). Most OpenAI capabilities are available on both Azure OpenAI and OpenAI using the same scenario clients and methods, so not all scenarios are redundantly covered here. |
157 | 157 |
|
158 | 158 | ### Get a chat completion
|
159 | 159 |
|
@@ -515,11 +515,11 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con
|
515 | 515 | [msdocs_openai_embedding]: https://learn.microsoft.com/azure/cognitive-services/openai/concepts/understand-embeddings
|
516 | 516 | [style-guide-msft]: /style-guide/capitalization
|
517 | 517 | [style-guide-cloud]: https://aka.ms/azsdk/cloud-style-guide
|
518 |
| -[azure_openai_client_class]: https://github.com/Azure/azure-sdk-for-net/blob/Azure.AI.OpenAI_2.2.0-beta.5/sdk/openai/Azure.AI.OpenAI/src/Custom/AzureOpenAIClient.cs |
| 518 | +[azure_openai_client_class]: https://github.com/Azure/azure-sdk-for-net/blob/Azure.AI.OpenAI_2.3.0-beta.1/sdk/openai/Azure.AI.OpenAI/src/Custom/AzureOpenAIClient.cs |
519 | 519 | [openai_rest]: https://learn.microsoft.com/azure/cognitive-services/openai/reference
|
520 | 520 | [azure_openai_completions_docs]: https://learn.microsoft.com/azure/cognitive-services/openai/how-to/completions
|
521 | 521 | [azure_openai_embeddings_docs]: https://learn.microsoft.com/azure/cognitive-services/openai/concepts/understand-embeddings
|
522 |
| -[openai_contrib]: https://github.com/Azure/azure-sdk-for-net/blob/Azure.AI.OpenAI_2.2.0-beta.5/CONTRIBUTING.md |
| 522 | +[openai_contrib]: https://github.com/Azure/azure-sdk-for-net/blob/Azure.AI.OpenAI_2.3.0-beta.1/CONTRIBUTING.md |
523 | 523 | [cla]: https://cla.microsoft.com
|
524 | 524 | [code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
|
525 | 525 | [code_of_conduct_faq]: https://opensource.microsoft.com/codeofconduct/faq/
|
|
0 commit comments