Skip to content

Commit 6ce28f0

Browse files
improve description for analyzer training
1 parent 39b99bf commit 6ce28f0

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

notebooks/analyzer_training.ipynb

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@
6060
"metadata": {},
6161
"source": [
6262
"## Create Azure content understanding client\n",
63-
"> The [AzureContentUnderstandingClient](../python/content_understanding_client.py) is utility Class which contain the functions to interact with the Content Understanding server. Before Content Understanding SDK release, we can regard it as a lightweight SDK. Fill the constant **AZURE_AI_ENDPOINT**, **AZURE_AI_API_VERSION**, **AZURE_AI_API_KEY** with the information from your Azure AI Service.\n",
63+
"> The [AzureContentUnderstandingClient](../python/content_understanding_client.py) is utility class that contains the functions, Before the release of the Content Understanding SDK, please consider it a lightweight SDK., Fill in values for the constants **AZURE_AI_ENDPOINT**, **AZURE_AI_API_VERSION**, **AZURE_AI_API_KEY** with the information from your Azure AI Service.\n",
6464
"\n",
6565
"> ⚠️ Important:\n",
6666
"You must update the code below to match your Azure authentication method.\n",
@@ -111,9 +111,9 @@
111111
"metadata": {},
112112
"source": [
113113
"## Create analyzer with defined schema\n",
114-
"Before creating the custom fields analyzer, you should fill the constant ANALYZER_ID with a business-related name. Here we randomly generate a name for demo purpose.\n",
114+
"Before creating the analyzer, you should fill in the constant ANALYZER_ID with a relevant name to your task. Here, we generate a unique suffix so this cell can be run multiple times to create different analyzers.\n",
115115
"\n",
116-
"We use **TRAINING_DATA_SAS_URL** and **TRAINING_DATA_PATH** that's set in the prerequisite step."
116+
"We use **TRAINING_DATA_SAS_URL** and **TRAINING_DATA_PATH** that's set in the Prerequisites step."
117117
]
118118
},
119119
{
@@ -133,11 +133,12 @@
133133
")\n",
134134
"result = client.poll_result(response)\n",
135135
"if result is not None and \"status\" in result and result[\"status\"] == \"Succeeded\":\n",
136-
" logging.info(f\"Here is the analyzer detail for {result['result']['analyzerId']}\")\n",
136+
" logging.info(f\"Analyzer details for {result['result']['analyzerId']}\")\n",
137137
" logging.info(json.dumps(result, indent=2))\n",
138138
"else:\n",
139-
" logging.info(\n",
140-
" \"Check your service please, may be some issues in configuration and deployment\"\n",
139+
" logging.warning(\n",
140+
" \"An issue was encountered when trying to create the analyzer. \"\n",
141+
" \"Please double-check your deployment and configurations for potential problems.\"\n",
141142
" )"
142143
]
143144
},
@@ -166,7 +167,7 @@
166167
"metadata": {},
167168
"source": [
168169
"## Delete exist analyzer in Content Understanding Service\n",
169-
"This snippet is not required, but it's only used to prevent the testing analyzer from residing in your service. The custom fields analyzer could be stored in your service for reusing by subsequent business in real usage scenarios."
170+
"This snippet is not required, but it's only used to prevent the testing analyzer from residing in your service. Without deletion, the analyzer will remain in your service for subsequent reuse."
170171
]
171172
},
172173
{

0 commit comments

Comments
 (0)