Skip to content

Commit 3a787d9

Browse files
committed
Tweaked wording and syntax
1 parent 22936d0 commit 3a787d9

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

Quickstart-Agentic-Retrieval/quickstart-agentic-retrieval.ipynb

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -77,13 +77,13 @@
7777
"source": [
7878
"## Set up connections\n",
7979
"\n",
80-
"The `sample.env` file contains environment variables for connections to Azure AI Search and Azure OpenAI in Azure AI Foundry. Agentic retrieval requires these connections for document retrieval, query planning, query execution, and answer generation.\n",
80+
"The `sample.env` file contains environment variables for connections to Azure AI Search and Azure OpenAI in Azure AI Foundry. Agentic retrieval requires these connections for document retrieval, query planning, and query execution.\n",
8181
"\n",
82-
"To set up connections:\n",
82+
"To set up the connections:\n",
8383
"\n",
8484
"1. Sign in to the [Azure portal](https://portal.azure.com).\n",
8585
"\n",
86-
"1. Get the endpoints for Azure AI Search (`https://my-service.search.windows.net`) and Azure OpenAI in Azure AI Foundry (`https://my-resource.openai.azure.com`).\n",
86+
"1. Get the endpoints for Azure AI Search (`https://your-search-service.search.windows.net`) and Azure OpenAI in Azure AI Foundry (`https://your-foundry-resource.openai.azure.com`).\n",
8787
"\n",
8888
"1. Save the `sample.env` file as `.env` on your local system.\n",
8989
"\n",
@@ -126,7 +126,7 @@
126126
},
127127
{
128128
"cell_type": "code",
129-
"execution_count": 2,
129+
"execution_count": 23,
130130
"id": "041e5d89",
131131
"metadata": {},
132132
"outputs": [],
@@ -136,7 +136,7 @@
136136
},
137137
{
138138
"cell_type": "code",
139-
"execution_count": 3,
139+
"execution_count": 24,
140140
"id": "2df3a118",
141141
"metadata": {},
142142
"outputs": [],
@@ -175,7 +175,7 @@
175175
},
176176
{
177177
"cell_type": "code",
178-
"execution_count": 6,
178+
"execution_count": 27,
179179
"id": "ee48bec5",
180180
"metadata": {},
181181
"outputs": [
@@ -248,7 +248,7 @@
248248
},
249249
{
250250
"cell_type": "code",
251-
"execution_count": 7,
251+
"execution_count": 28,
252252
"id": "ded5147b",
253253
"metadata": {},
254254
"outputs": [
@@ -285,7 +285,7 @@
285285
},
286286
{
287287
"cell_type": "code",
288-
"execution_count": 8,
288+
"execution_count": 29,
289289
"id": "e3415954",
290290
"metadata": {},
291291
"outputs": [
@@ -329,7 +329,7 @@
329329
},
330330
{
331331
"cell_type": "code",
332-
"execution_count": 9,
332+
"execution_count": 30,
333333
"id": "d3fe4183",
334334
"metadata": {},
335335
"outputs": [
@@ -380,12 +380,12 @@
380380
"source": [
381381
"## Set up messages\n",
382382
"\n",
383-
"Messages are the input for the retrieval route and contain the conversation history. Each message includes a `role` that indicates its origin, such as `assistant` or `user`, and `content` in natural language. The LLM you use determines which roles are valid."
383+
"Messages are the input for the retrieval route and contain the conversation history. Each message includes a `role` that indicates its origin, such as `system` or `user`, and `content` in natural language. The LLM you use determines which roles are valid."
384384
]
385385
},
386386
{
387387
"cell_type": "code",
388-
"execution_count": 5,
388+
"execution_count": 31,
389389
"id": "2ab7b970",
390390
"metadata": {},
391391
"outputs": [],
@@ -425,15 +425,15 @@
425425
},
426426
{
427427
"cell_type": "code",
428-
"execution_count": 6,
428+
"execution_count": 33,
429429
"id": "918ded26",
430430
"metadata": {},
431431
"outputs": [
432432
{
433433
"name": "stdout",
434434
"output_type": "stream",
435435
"text": [
436-
"Retrieved content from 'knowledge_source_name' successfully.\n"
436+
"Retrieved content from 'earth-knowledge-source' successfully.\n"
437437
]
438438
}
439439
],
@@ -468,7 +468,7 @@
468468
")\n",
469469
"\n",
470470
"result = agent_client.retrieve(retrieval_request=req, api_version=search_api_version)\n",
471-
"print(\"Retrieved content from 'knowledge_source_name' successfully.\")"
471+
"print(f\"Retrieved content from '{knowledge_source_name}' successfully.\")"
472472
]
473473
},
474474
{
@@ -480,7 +480,7 @@
480480
"\n",
481481
"Because your knowledge agent is configured for answer synthesis, the retrieval response contains the following values:\n",
482482
"\n",
483-
"+ `response_content`: An LLM-generated answer to the query based on the retrieved documents.\n",
483+
"+ `response_content`: An LLM-generated answer to the query that cites the retrieved documents.\n",
484484
"\n",
485485
"+ `activity_content`: Detailed planning and execution information, including subqueries, reranking decisions, and intermediate steps.\n",
486486
"\n",
@@ -685,7 +685,7 @@
685685
},
686686
{
687687
"cell_type": "code",
688-
"execution_count": 12,
688+
"execution_count": null,
689689
"id": "da260539",
690690
"metadata": {},
691691
"outputs": [
@@ -720,7 +720,7 @@
720720
")\n",
721721
"\n",
722722
"result = agent_client.retrieve(retrieval_request=req, api_version=search_api_version)\n",
723-
"print(\"Retrieved content from 'knowledge_source_name' successfully.\")"
723+
"print(f\"Retrieved content from '{knowledge_source_name}' successfully.\")"
724724
]
725725
},
726726
{

0 commit comments

Comments
 (0)