Skip to content

Commit 2ab67bc

Browse files
Add preview disclaimer for to_llm_input in README (#46676)
1 parent 81a96af commit 2ab67bc

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

  • sdk/contentunderstanding/azure-ai-contentunderstanding

sdk/contentunderstanding/azure-ai-contentunderstanding/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ Use the client library for Azure AI Content Understanding to:
1111
* **Create custom analyzers** - Build domain-specific analyzers for specialized content extraction needs across all four modalities (documents, video, audio, and images)
1212
* **Classify documents and video** - Automatically categorize and extract information from documents and video by type
1313

14+
If you have encountered issues or want to suggest features, please [file an issue][file_issue].
15+
1416
[Source code][python_cu_src] | [Package (PyPI)][python_cu_pypi] | [Product documentation][python_cu_product_docs] | [Samples][python_cu_samples]
1517

1618
## Table of Contents
@@ -520,6 +522,9 @@ asyncio.run(analyze_invoice())
520522
521523
#### Convert results to LLM-ready text
522524
525+
> **Note:** `to_llm_input()` is currently in preview and may change in future
526+
> releases. We welcome feedback — please [file an issue][file_issue].
527+
523528
Use the `to_llm_input()` helper to convert any analysis result into a text format that LLMs
524529
can consume directly — YAML front matter with extracted fields followed by the markdown body.
525530
This works with all content types (documents, images, audio, video) and handles multi-segment
@@ -695,6 +700,7 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con
695700
[pip]: https://pypi.org/project/pip/
696701
[cla]: https://cla.microsoft.com
697702
[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
703+
[file_issue]: https://github.com/Azure/azure-sdk-for-python/issues/new?labels=Cognitive%20-%20Content%20Understanding&title=[ContentUnderstanding]%20&body=%23%23%20Library%20Version%0A%0A%23%23%20Repro%20Steps%0A%0A%23%23%20Expected%20Result%0A%0A%23%23%20Actual%20Result
698704
[code_of_conduct_faq]: https://opensource.microsoft.com/codeofconduct/faq/
699705
[opencode_email]: mailto:opencode@microsoft.com
700706
[aiohttp]: https://pypi.org/project/aiohttp/

0 commit comments

Comments
 (0)