Skip to content

Clarify update_analyzer sample docs #47137

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.

Sign up for GitHub

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

Open
anhtnt90dev wants to merge 3 commits into
base: main
Choose a base branch
from
+29 −8
Open

Clarify update_analyzer sample docs #47137

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5ccfd9b
Clarify update analyzer sample docs
anhtnt90dev May 26, 2026
0dc8bb3
Stabilize content understanding playback URLs
anhtnt90dev May 28, 2026
ef1541a
Clarify update analyzer base analyzer guidance
anhtnt90dev May 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions sdk/contentunderstanding/azure-ai-contentunderstanding/samples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,13 +119,13 @@ Lists all available analyzers in your Microsoft Foundry resource. Shows how to d
### Sample 08: Update Analyzer

#### `sample_update_analyzer.py` / `sample_update_analyzer_async.py`
Updates an existing custom analyzer's description and tags. Shows how to modify analyzer properties.
Updates an existing custom analyzer's description and tags. Only `description` and `tags` can be updated with `update_analyzer`; use `begin_create_analyzer` with `allow_replace=True` to change create-only properties such as `models`, `field_schema`, `config`, `base_analyzer_id`, `dynamic_field_schema`, `processing_location`, or `knowledge_sources`.

**Key concepts:**
- Updating analyzer description
- Adding, updating, and removing tags
- Verifying analyzer updates
- Modifying analyzer properties
- Replacing create-only analyzer properties with `begin_create_analyzer(..., allow_replace=True)`

### Sample 09: Delete Analyzer

Expand Down
10 changes: 7 additions & 3 deletions ...nding/azure-ai-contentunderstanding/samples/async_samples/sample_update_analyzer_async.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,14 @@
This sample demonstrates how to update an existing custom analyzer, including updating
its description and tags.

The update_analyzer method allows you to modify certain properties of an existing analyzer.
The following properties can be updated:
The update_analyzer method allows you to modify only these properties of an existing analyzer:
- Description: Update the analyzer's description
- Tags: Add or update tags

To change create-only properties such as models, field_schema, config, base_analyzer_id,
dynamic_field_schema, processing_location, or knowledge_sources, use begin_create_analyzer
with allow_replace=True.

USAGE:
python sample_update_analyzer_async.py

Expand Down Expand Up @@ -94,7 +97,8 @@ async def main() -> None:
tags_str = ", ".join(f"{k}={v}" for k, v in current_analyzer.tags.items())
print(f" Tags: {tags_str}")

# Create an updated analyzer with new description and tags
# Create an updated analyzer with the properties supported by update_analyzer.
# Other analyzer properties are create-only and require begin_create_analyzer(..., allow_replace=True).
updated_analyzer = ContentAnalyzer(
base_analyzer_id=current_analyzer.base_analyzer_id,
description="Updated description",
Expand Down
10 changes: 7 additions & 3 deletions sdk/contentunderstanding/azure-ai-contentunderstanding/samples/sample_update_analyzer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,14 @@
This sample demonstrates how to update an existing custom analyzer, including updating
its description and tags.

The update_analyzer method allows you to modify certain properties of an existing analyzer.
The following properties can be updated:
The update_analyzer method allows you to modify only these properties of an existing analyzer:
- Description: Update the analyzer's description
- Tags: Add or update tags

To change create-only properties such as models, field_schema, config, base_analyzer_id,
dynamic_field_schema, processing_location, or knowledge_sources, use begin_create_analyzer
with allow_replace=True.

USAGE:
python sample_update_analyzer.py

Expand Down Expand Up @@ -92,7 +95,8 @@ def main() -> None:
tags_str = ", ".join(f"{k}={v}" for k, v in current_analyzer.tags.items())
print(f" Tags: {tags_str}")

# Create an updated analyzer with new description and tags
# Create an updated analyzer with the properties supported by update_analyzer.
# Other analyzer properties are create-only and require begin_create_analyzer(..., allow_replace=True).
updated_analyzer = ContentAnalyzer(
base_analyzer_id=current_analyzer.base_analyzer_id,
description="Updated description",
Expand Down
Loading