Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Form Recognizer endpoint documentation #38283

Open
catalinaperalta opened this issue Nov 2, 2024 · 0 comments
Open

Improve Form Recognizer endpoint documentation #38283

catalinaperalta opened this issue Nov 2, 2024 · 0 comments

Comments

@catalinaperalta
Copy link
Member

catalinaperalta commented Nov 2, 2024

There are two action items for this issue:

1. Fix client documentation:
Check the azure-ai-formrecognizer client documentation to make sure the description for the endpoint parameter is clear. Current documentation is using the regional form recognizer endpoint as an example for users which is not correct, we should instead be specifying the resource endpoint in our documentation and examples.

Current documentation:

:param str endpoint: Supported Cognitive Services endpoints (protocol and hostname,
        for example: https://westus2.api.cognitive.microsoft.com).

Expected documentation:

:param str endpoint: Supported service endpoints (protocol and hostname,
        for example: https://<resource-name>.cognitiveservices.azure.com/).

A regional endpoint looks like: https://.api.cognitive.microsoft.com/
A resource endpoint looks like: https://.cognitiveservices.azure.com/

2. Fix README:
In the authentication section of the readme, we have a link that points to the regional endpoints, but the link isn't clearly listing regional endpoints anymore for Form Recognizer. We should consider removing this information from the readme and just have folks use the resource endpoints for authentication and client initialization. This is where the link is:

Image

Link: https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-region/?products=form-recognizer

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants