Skip to content

Python tool for converting files and office documents to Markdown.

Kennyzhang/docintel docs (#312)

KennyZhang1bf6a15e9b5eb
diff --git a/README.md b/README.md
index 6bc91e6c..76a4d3f1 100644
--- a/README.md
+++ b/README.md
@@ -33,12 +33,20 @@ Or use `-o` to specify the output file:
markitdown path-to-file.pdf -o document.md
```
+To use Document Intelligence conversion:
+
+```bash
+markitdown path-to-file.pdf -o document.md -d -e "<document_intelligence_endpoint>"
+```
+
You can also pipe content:
```bash
cat path-to-file.pdf | markitdown
```
+More information about how to set up an Azure Document Intelligence Resource can be found [here](https://learn.microsoft.com/en-us/azure/ai-services/document-intelligence/how-to-guides/create-document-intelligence-resource?view=doc-intel-4.0.0)
+
### Python API
Basic usage in Python:
@@ -51,6 +59,16 @@ result = md.convert("test.xlsx")
print(result.text_content)
```
+Document Intelligence conversion in Python:
+
+```python
+from markitdown import MarkItDown
+
+md = MarkItDown(docintel_endpoint="<document_intelligence_endpoint>")
+result = md.convert("test.pdf")
+print(result.text_content)
+```
+
To use Large Language Models for image descriptions, provide `llm_client` and `llm_model`:
```python