microsoft / microsoft/markitdown
Update Readme to include how to initialize Azure Document Intelligence correctly?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 186k
- Forks
- 13.7k
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 49
Description
Could someone provide an updated readme or how to, on how to initialize the markitdown package to use Azure Document Intelligence via api key, esp with python?
the only thing I'm seeing on the readme is pointing to an endpoint, but there doesn't seem to be any documentation on what it expects for the API key if you aren't using Azure AD to auth to Doc Intel service.
The only semblence of information I found from browsing through the issues tab is this (from https://github.com/microsoft/markitdown/issues/1168):
Initialize MarkItDown
md = MarkItDown(docintel_endpoint = AZURE_DOC_INT_ENDPOINT,
docintel_file_types = ['pdf'],
docintel_credential = AzureKeyCredential(AZURE_DOC_INT_KEY))
Thanks!
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the README's existing Azure Document Intelligence setup and compare it with the initialization example using AzureKeyCredential shown in the issue. Document the Python API-key configuration, including the endpoint, credential, and relevant file types; done means a newcomer can follow the README without relying on Azure AD authentication.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure, python
- Domain
- cloud, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100