search

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.26k stars 4.6k forks source link

Specify clearly what parameters OpenAIClient accepts #41423

Open Alerinos opened 8 months ago

Alerinos commented 8 months ago

Library name

Azure.AI.OpenAI

Please describe the feature.

according to the "documentation" to use open AI api we need to use TOKEN.DOMAIN, this is misleading because the token itself is enough.

https://github.com/Azure/azure-sdk-for-net/tree/Azure.AI.OpenAI_1.0.0-beta.9/sdk/openai/Azure.AI.OpenAI#key-concepts

In my opinion there should be two separate classes that define what they are, open AI only accepts the token and Azure URI.

I lost two hours before I realized that the documentation is misleading. Below is the thread where I struggled with the problem. Unfortunately, it is very poorly described and I had to arrive at the problem by trial and error methods.

https://github.com/microsoft/semantic-kernel/issues/4656 https://github.com/microsoft/semantic-kernel/issues/4594

github-actions[bot] commented 8 months ago

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

github-actions[bot] commented 8 months ago

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