Skip to content

Commit 97dfb41

Browse files
authored
Refine docs (#12)
1 parent 9cf84f2 commit 97dfb41

File tree

4 files changed

+14
-7
lines changed

4 files changed

+14
-7
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ Azure AI Content Understanding is a new Generative AI-based [Azure AI service](h
1212

1313
| File | Description |
1414
| --- | --- |
15-
| [field_extraction.ipynb](notebooks/field_extraction.ipynb) | Extract custom fields with sample analyzer templates |
16-
| [content_extraction.ipynb](notebooks/content_extraction.ipynb) | Extract structured content from your input files |
17-
| [analyzer_training.ipynb](notebooks/analyzer_training.ipynb) | Provide training data to improve the quality of your analyzer |
15+
| [content_extraction.ipynb](notebooks/content_extraction.ipynb) | In this sample we will show content understanding API can help you get semantic information from your file. For example OCR with table in document, audio transcription, and face analysis in video. |
16+
| [field_extraction.ipynb](notebooks/field_extraction.ipynb) | In this sample we will show how to create an analyzer to extract fields in your file. For example invoice amount in the document, how many people in an image, names mentioned in an audio, or summary of a video. You can customize the fields by creating your own analyzer template. |
17+
| [analyzer_training.ipynb](notebooks/analyzer_training.ipynb) | If you want to futher boost the performance for field extraction, we can do training when you provide few labeled samples to the API. Note: This feature is available to document scenario now. |
1818

1919

2020
## Getting started

notebooks/analyzer_training.ipynb

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,19 @@
66
"source": [
77
"# Enhance your analyzer with labeled data\n",
88
"\n",
9+
"\n",
10+
"> #################################################################################\n",
11+
">\n",
12+
"> Note: Currently this feature is only available for analyzer scenario is `document`\n",
13+
">\n",
14+
"> #################################################################################\n",
15+
"\n",
916
"Labeled data is a group of samples that have been tagged with one or more labels to add context or meaning, which is used to improve analyzer's performance.\n",
1017
"\n",
1118
"Please go to [Azure AI Foundry]() to use the labling tool to annotate your data.\n",
1219
"\n",
1320
"In this notebook we will demonstrate after you have the labeled data, how to create analyzer with them and analyze your files.\n",
1421
"\n",
15-
"> Note: Currently this feature is only available for analyzer scenario is `document`\n",
1622
"\n",
1723
"\n",
1824
"## Prerequisites\n",
@@ -354,7 +360,7 @@
354360
"name": "python",
355361
"nbconvert_exporter": "python",
356362
"pygments_lexer": "ipython3",
357-
"version": "3.8.10"
363+
"version": "3.11.11"
358364
}
359365
},
360366
"nbformat": 4,

notebooks/content_extraction.ipynb

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,8 @@
237237
"cell_type": "markdown",
238238
"metadata": {},
239239
"source": [
240-
"## Video Content with Face"
240+
"## Video Content with Face\n",
241+
"This is a gated feature, please go through process [Azure AI Resource Face Gating](https://learn.microsoft.com/en-us/legal/cognitive-services/computer-vision/limited-access-identity?context=%2Fazure%2Fai-services%2Fcomputer-vision%2Fcontext%2Fcontext#registration-process) Select `[Video Indexer] Facial Identification (1:N or 1:1 matching) to search for a face in a media or entertainment video archive to find a face within a video and generate metadata for media or entertainment use cases only` in the registration form."
241242
]
242243
},
243244
{

notebooks/field_extraction.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -440,7 +440,7 @@
440440
"name": "python",
441441
"nbconvert_exporter": "python",
442442
"pygments_lexer": "ipython3",
443-
"version": "3.8.10"
443+
"version": "3.11.11"
444444
}
445445
},
446446
"nbformat": 4,

0 commit comments

Comments
 (0)