Azure-Samples / azure-ai-vision-sdk

SDK for Microsoft's Azure AI Vision
MIT License
75 stars 46 forks source link

Some Vision Studio links reference old docs or "404" pages. If Azure-Samples/azure-vision-sdk is the wrong samples place, then remove. #100

Open jimbarrett33 opened 2 weeks ago

jimbarrett33 commented 2 weeks ago

Please provide us with the following information:

This issue is for a: (mark with an x)

- [ ] bug report -> please search issues before submitting
- [ ] feature request
- [X] documentation issue or request
- [ ] regression (a behavior that used to work and stopped in a new release)

Minimal steps to reproduce

I'm logging this because the documentation and samples for for Vision SDK a Vision REST API is very confusing and just trying to help eliminate some confusion.

1. If this repo "Azure-Samples/azure-vision-sdk" is the wrong location for samples then please remove or provide a big warning or a redirect to the correct samples.

This Github issue seems to indicate this is the wrong place for samples: https://github.com/Azure-Samples/azure-ai-vision-sdk/issues/76#issuecomment-1935176736

2. For all features, in the "Try it out" view the "Use REST API" link goes to a 404 not found page (returned in JSON)

(NOTE: In Vision Studio, the links depend on which vision "feature" is selected on the start page. This is also slightly confusing, but I get it.)

the link currently goes to: https://centraluseuap.dev.cognitive.microsoft.com/docs/services/unified-vision-apis-public-preview-2023-02-01-preview/operations/61d65934cd35050c20f73ab6

if change "centraluseuap" to "eastus" in the domain then the link will work (not sure if that actually is the intended location):

https://eastus.dev.cognitive.microsoft.com/docs/services/unified-vision-apis-public-preview-2023-02-01-preview/operations/61d65934cd35050c20f73ab6

image

3. The "Extract common tags from images" feature, in the "Try it out" view, the "View Samples on Github" link goes to obsolete documentation according to this Github issue: https://github.com/Azure-Samples/azure-ai-vision-sdk/issues/76#issuecomment-1935176736

According to that issue the link should probably go to: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/vision/Azure.AI.Vision.ImageAnalysis/samples

image

Expected/desired behavior

Links should work and point to current samples.