Azure / azure-sdk-for-net

This repository is for active development of the Azure SDK for .NET. For consumers of the SDK we recommend visiting our public developer docs at https://learn.microsoft.com/dotnet/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-net.
MIT License
5.46k stars 4.8k forks source link

Add important note at the top of the page #45728

Open AngelosP opened 2 months ago

AngelosP commented 2 months ago

Type of issue

Outdated article

Description

Add the following notice at the top of the page (this is the same notice that is on the GitHub repo as well):

IMPORTANT NOTE: Assistants is converging! With the June 2024 preview release of the official OpenAI .NET library , Azure OpenAI has converged with OpenAI's language support by converting the previously standalone Azure.AI.OpenAI library , which going forward will now be an extension library for Azure OpenAI Service support with OpenAI's library. The new 2.* solution includes full, converged support for Assistants, including the latest v2 and streaming features. Migration guides are not yet available at initial release but will come soon. Please see the Azure.AI.OpenAI project for more details.

Page URL

https://learn.microsoft.com/en-us/dotnet/api/azure.ai.openai.assistants?view=azure-dotnet-preview

Content source URL

https://github.com/Azure/azure-docs-sdk-dotnet/blob/master/xml/ns-Azure.AI.OpenAI.Assistants.xml

Document Version Independent Id

13d804c6-9aa0-98fc-8009-3e6f9fe2cda4

Article author

@azure-sdk

Metadata

github-actions[bot] commented 2 months ago

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @jpalvarezl @ralph-msft @trrwilson.

AngelosP commented 2 months ago

Also consider adding a deep link to https://github.com/openai/openai-dotnet?tab=readme-ov-file#how-to-use-assistants-with-retrieval-augmented-generation-rag

AngelosP commented 2 months ago

Updated message after feedback from the extended team:

IMPORTANT NOTE: Assistants is converging!

With the June 2024 preview release of the official OpenAI .NET library , Azure OpenAI has converged with OpenAI's language support by converting the previously standalone Azure.AI.OpenAI library , which going forward will now be an extension library for Azure OpenAI Service support with OpenAI's library.

The new 2.* solution includes full, converged support for Assistants, including the latest v2 and streaming features. You can see Assistant examples using the new OpenAI library for .NET here. You can also see how to use Assistants with the new Azure.AI.OpenAI companion library here.