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.35k stars 4.71k forks source link

Frustratingly incomplete docs #44311

Open JimGaleForce opened 4 months ago

JimGaleForce commented 4 months ago

Type of issue

Missing information

Description

(This applies to ALL DOCUMENTATION)

You likely can't provide samples/examples in docs due to legal reasons, perhaps.

however, when a 'type' is expected, as a string, for list what the hell you mean. is "string" vs "int" a type, or is it an unknown, unlisted enum that isn't anywhere, or should it be an official type "String" or "System.String", or is it something completely different?

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

Page URL

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

Content source URL

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

Document Version Independent Id

0f6da810-80bb-89d4-6b5a-59c04bcfd39d

Article author

@azure-sdk

Metadata

github-actions[bot] commented 4 months ago

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

trrwilson commented 3 months ago

Thank you @JimGaleForce -- we'll follow up with the AOAI service team to clarify what, if anything, this Azure-only parameter is for and either clarify or remove it. It's long been present in the Azure OpenAI API specification and, other than a listed example of "query," there's no additional information.

The parameter is not expected or required, however, so please don't worry about finding a suitable value for it if one isn't already known.