Skip to content

Commit 4cb3bc1

Browse files
authored
Merge pull request #5068 from HeidiSteen/heidist-work
knowledge agent terminology
2 parents b0a0cc9 + 8759580 commit 4cb3bc1

7 files changed

+55
-55
lines changed

articles/search/includes/quickstarts/agentic-retrieval-python.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -227,9 +227,9 @@ with SearchIndexingBufferedSender(endpoint=endpoint, index_name=index_name, cred
227227
print(f"Documents uploaded to index '{index_name}'")
228228
```
229229

230-
## Create a search agent
230+
## Create a knowledge agent
231231

232-
To connect Azure AI Search to your `gpt-4o-mini` deployment and target the `earth_at_night` index at query time, you need a search agent. The following code defines an agent named `earth-search-agent`, which you specified using the `agent_name` variable in a previous section.
232+
To connect Azure AI Search to your `gpt-4o-mini` deployment and target the `earth_at_night` index at query time, you need a knowledge agent. The following code defines a knowledge agent named `earth-search-agent`, which you specified using the `agent_name` variable in a previous section.
233233

234234
To ensure relevant and semantically meaningful responses, `default_reranker_threshold` is set to exclude responses with a reranker score of `2.5` or lower.
235235

@@ -261,7 +261,7 @@ print(f"Knowledge agent '{agent_name}' created or updated successfully")
261261

262262
## Set up messages
263263

264-
The next step is to define the agent instructions and conversation context using the `messages` array. Each message includes a `role`, such as `user` or `assistant`, and `content` in natural language. A user message represents the query to be processed, while an assistant message guides the agent on how to respond. During the retrieval process, these messages are sent to an LLM to extract relevant responses from indexed documents.
264+
The next step is to define the knowledge agent instructions and conversation context using the `messages` array. Each message includes a `role`, such as `user` or `assistant`, and `content` in natural language. A user message represents the query to be processed, while an assistant message guides the knowledge agent on how to respond. During the retrieval process, these messages are sent to an LLM to extract relevant responses from indexed documents.
265265

266266
For now, create the following assistant message, which instructs `earth-search-agent` to answer questions about the Earth at night, cite sources using their `ref_id`, and respond with "I don't know" when answers are unavailable.
267267

articles/search/search-agentic-retrieval-concept.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ ms.date: 05/19/2025
1616

1717
[!INCLUDE [Feature preview](./includes/previews/preview-generic.md)]
1818

19-
In Azure AI Search, *agentic retrieval* is a new parallel query processing architecture that incorporates user conversation history and Azure OpenAI models to plan, retrieve and synthesize queries for improved results. It produces high-quality grounding data for custom chat and generative AI solutions that include agents.
19+
In Azure AI Search, *agentic retrieval* is a new parallel query processing architecture that incorporates user conversation history and Azure OpenAI models to plan, retrieve and synthesize queries for improved results. It produces high-quality grounding data for custom chat and generative AI solutions that include knowledge agents.
2020

21-
Programmatically, agentic retrieval is supported through a new Knowledge Agents object (also known as a search agent) in the 2025-05-01-preview data plane REST API and in Azure SDK prerelease packages that provide the feature. An agent's retrieval response is designed for downstream consumption by other agents and chat apps.
21+
Programmatically, agentic retrieval is supported through a new Knowledge Agents object in the 2025-05-01-preview data plane REST API and in Azure SDK prerelease packages that provide the feature. A knowledge agent's retrieval response is designed for downstream consumption by other agents and chat apps.
2222

2323
## Why use agentic retrieval
2424

@@ -54,9 +54,9 @@ Agentic retrieval has these components:
5454

5555
| Component | Resource | Usage |
5656
|-----------|----------|-------|
57-
| LLM (gpt-4o and gpt-4.1 series) | Azure OpenAI | An LLM has two functions. First, it formulates subqueries for the query plan and sends it back to the search agent. Second, after the query executes, the LLM receives grounding data from the query response and uses it for answer formulation. |
57+
| LLM (gpt-4o and gpt-4.1 series) | Azure OpenAI | An LLM has two functions. First, it formulates subqueries for the query plan and sends it back to the knowledge agent. Second, after the query executes, the LLM receives grounding data from the query response and uses it for answer formulation. |
5858
| Search index | Azure AI Search | Contains plain text and vector content, a semantic configuration, and other elements as needed. |
59-
| Search agent | Azure AI Search | Connects to your LLM, providing parameters and inputs to build a query plan. |
59+
| Knowledge agent | Azure AI Search | Connects to your LLM, providing parameters and inputs to build a query plan. |
6060
| Retrieval engine | Azure AI Search | Executes on the LLM-generated query plan and other parameters, returning a rich response that includes content and query plan metadata. Queries are keyword, vector, and hybrid. Results are merged and ranked. |
6161
| Semantic ranker | Azure AI Search | Provides L2 reranking, promoting the most relevant matches. Semantic ranker is required for agentic retrieval. |
6262

@@ -65,12 +65,12 @@ Your solution should include a tool or app that drives the pipeline. An agentic
6565
<!-- Insert multiquery pipeline diagram here -->
6666
Agentic retrieval has these processes:
6767

68-
+ Requests for agentic retrieval are initiated by calls to an agent on Azure AI Search.
69-
+ Agents connect to an LLM and provide conversation history as input. How much history is configurable by the number of messages you provide.
68+
+ Requests for agentic retrieval are initiated by calls to a knowledge agent on Azure AI Search.
69+
+ Knowledge agents connect to an LLM and provide conversation history as input. How much history is configurable by the number of messages you provide.
7070
+ LLMs look at the conversation and determine whether to break it up into subqueries. The number of subqueries depends on what the LLM decides and whether the `maxDocsForReranker` parameter is higher than 50. A new subquery is defined for each 50-document batch sent to semantic ranker.
7171
+ Subqueries execute simultaneously on Azure AI Search and generate structured results and extracted references.
7272
+ Results are ranked and merged.
73-
+ Agent responses are formulated and returned as a three-part response consisting of a unified result (a long string), a reference array, and an activities array that enumerates all operations.
73+
+ Knowledge agent responses are formulated and returned as a three-part response consisting of a unified result (a long string), a reference array, and an activities array that enumerates all operations.
7474

7575
Your search index determines query execution and any optimizations that occur during query execution. This includes your semantic configuration, as well as optional scoring profiles, synonym maps, analyzers, and normalizers (if you add filters).
7676

@@ -80,7 +80,7 @@ Agentic retrieval is available in [all regions that provide semantic ranker](sea
8080

8181
Billing for agentic retrieval has two parts:
8282

83-
+ Billing for query planning is pay-as-you-go in Azure OpenAI. It's token based for both input and output tokens. The model you assign to the agent is the one charged for token usage. For example, if you use gpt-4o, the token charge appears in the bill for gpt-4o.
83+
+ Billing for query planning is pay-as-you-go in Azure OpenAI. It's token based for both input and output tokens. The model you assign to the knowledge agent is the one charged for token usage. For example, if you use gpt-4o, the token charge appears in the bill for gpt-4o.
8484

8585
+ Billing for semantic ranking during query execution. Billing is suspended during the initial roll-out phase but then transitions to pay-as-you-go on the Azure AI Search side through the semantic ranker. Semantic ranker, which is a premium billable feature, is an integral part of agentic retrieval. You're charged on the Azure AI Search side for token inputs to the semantic ranking models.
8686

@@ -154,11 +154,11 @@ Choose any of these options for your next step.
154154

155155
+ How-to guides for a focused look at development tasks:
156156

157-
+ [Create an agent](search-agentic-retrieval-how-to-create.md)
158-
+ [Use an agent to retrieve data](search-agentic-retrieval-how-to-retrieve.md)
157+
+ [Create a knowledge agent](search-agentic-retrieval-how-to-create.md)
158+
+ [Use a knowledge agent to retrieve data](search-agentic-retrieval-how-to-retrieve.md)
159159
+ [Build an agent-to-agent retrieval solution](search-agentic-retrieval-how-to-pipeline.md).
160160

161-
+ REST API reference, [Agents](/rest/api/searchservice/knowledge-agents?view=rest-searchservice-2025-05-01-preview&preserve-view=true) and [retrieve](/rest/api/searchservice/knowledge-retrieval/retrieve?view=rest-searchservice-2025-05-01-preview&preserve-view=true).
161+
+ REST API reference, [Knowledge Agents](/rest/api/searchservice/knowledge-agents?view=rest-searchservice-2025-05-01-preview&preserve-view=true) and [Knowledge Retrieval](/rest/api/searchservice/knowledge-retrieval/retrieve?view=rest-searchservice-2025-05-01-preview&preserve-view=true).
162162

163163
+ [Azure OpenAI Demo](https://github.com/Azure-Samples/azure-search-openai-demo), updated to use agentic retrieval.
164164

articles/search/search-agentic-retrieval-how-to-create.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Create an agent
2+
title: Create a knowledge agent
33
titleSuffix: Azure AI Search
4-
description: Learn how to create an agent for agentic retrieval workloads in Azure AI Search.
4+
description: Learn how to create a knowledge agent for agentic retrieval workloads in Azure AI Search.
55

66
manager: nitinme
77
author: HeidiSteen
@@ -11,13 +11,13 @@ ms.topic: how-to
1111
ms.date: 05/05/2025
1212
---
1313

14-
# Create an agent in Azure AI Search
14+
# Create a knowledge agent in Azure AI Search
1515

1616
[!INCLUDE [Feature preview](./includes/previews/preview-generic.md)]
1717

18-
In Azure AI Search, an *agent* is a top-level resource representing a connection to a conversational language model for use in agentic retrieval workloads. It specifies a model that provides reasoning capabilities, and it identifies the search index used at query time.
18+
In Azure AI Search, a *knowledge agent* is a top-level resource representing a connection to a conversational language model for use in agentic retrieval workloads. It specifies a model that provides reasoning capabilities, and it identifies the search index used at query time.
1919

20-
After you can create an agent, you can update its properties at any time. If the agent is in use, updates take effect on the next job.
20+
After you can create a knowledge agent, you can update its properties at any time. If the knowledge agent is in use, updates take effect on the next job.
2121

2222
## Prerequisites
2323

@@ -27,11 +27,11 @@ After you can create an agent, you can update its properties at any time. If the
2727

2828
+ Azure AI Search, in any [region that provides semantic ranker](search-region-support.md), on basic tier and above. Your search service must have a [managed identity](search-howto-managed-identities-data-sources.md) for role-based access to a chat model.
2929

30-
+ Permission requirements on Azure AI Search. An **Owner/Contributor** or **Search Service Contributor** can create and manage an agent. **Search Index Data Contributor** uploads and indexes document. **Search Index Data Reader** runs queries. Instructions are provided in this article.
30+
+ Permission requirements on Azure AI Search. An **Owner/Contributor** or **Search Service Contributor** can create and manage a knowledge agent. **Search Index Data Contributor** uploads and indexes document. **Search Index Data Reader** runs queries. Instructions are provided in this article.
3131

3232
+ A search index containing plain text or vectors. The index must [meet requirements for agentic retrieval](search-agentic-retrieval-how-to-index.md), including a [semantic configuration](semantic-how-to-configure.md) with the `defaultConfiguration` specified.
3333

34-
+ API requirements. To create or use an agent, use 2025-05-01-preview data plane REST API or a prerelease package of an Azure SDK that provides Agent APIs.
34+
+ API requirements. To create or use a knowledge agent, use 2025-05-01-preview data plane REST API or a prerelease package of an Azure SDK that provides knowledge agent APIs.
3535

3636
To follow the steps in this guide, we recommend [Visual Studio Code](https://code.visualstudio.com/download) with a [REST client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) for sending REST API calls to Azure AI Search. There's no portal support at this time.
3737

@@ -100,31 +100,31 @@ You can use API keys if you don't have permission to create role assignments.
100100
api-key: {{search-api-key}}
101101
```
102102

103-
## Check for existing agents
103+
## Check for existing knowledge agents
104104

105-
The following request lists agents by name. Within the agents collection, all agents must be uniquely named. It's helpful for knowing about existing agents for reuse or naming purposes.
105+
The following request lists knowledge agents by name. Within the knowledge agents collection, all knowledge agents must be uniquely named. It's helpful for knowing about existing knowledge agents for reuse or naming purposes.
106106

107107
<!-- ### [**REST APIs**](#tab/rest-get) -->
108108

109109
```http
110-
# List Agents
110+
# List knowledge agents
111111
GET https://{{search-url}}/agents?api-version=2025-05-01-preview
112112
api-key: {{search-api-key}}
113113
```
114114

115115
You can also return a single agent by name.
116116

117117
```http
118-
# Get Agent
118+
# Get knowledge agent
119119
GET https://{{search-url}}/agents/{{agent-name}}?api-version=2025-05-01-preview
120120
api-key: {{search-api-key}}
121121
```
122122

123123
<!-- --- -->
124124

125-
## Create an agent
125+
## Create a knowledge agent
126126

127-
An agent represents a connection to a model that you've deployed. Parameters on the model establish the connection.
127+
A knowledge agent represents a connection to a model that you've deployed. Parameters on the model establish the connection.
128128

129129
<!-- ### [**REST APIs**](#tab/rest-create) -->
130130

@@ -138,7 +138,7 @@ To create an agent, use the 2025-05-01-preview data plane REST API or an Azure S
138138
@model-provider-url=<YOUR AZURE OPENAI RESOURCE URI>
139139
@model-api-key=<YOUR AZURE OPENAI API KEY>
140140
141-
# Create Agent
141+
# Create knowledge agent
142142
PUT https://{{search-url}}/agents/{{agent-name}}?api-version=2025-05-01-preview
143143
api-key: {{search-api-key}}
144144
Content-Type: application/json
@@ -174,9 +174,9 @@ Content-Type: application/json
174174

175175
**Key points**:
176176

177-
+ `name` must be unique within the agents collection it must adhere to [naming rules](/rest/api/searchservice/naming-rules) for objects on Azure AI Search.
177+
+ `name` must be unique within the knowledge agents collection it must adhere to [naming rules](/rest/api/searchservice/naming-rules) for objects on Azure AI Search.
178178

179-
+ `targetIndexes` is required for agent creation. It lists the search indexes that can use the agent. Currently in this preview release, the `targetIndexes` array can contain only one index. *It must have a default semantic configuration* (`defaultConfiguration`). For more information, see [Design an index for agentic retrieval](search-agentic-retrieval-how-to-index.md).
179+
+ `targetIndexes` is required for knowledge agent creation. It lists the search indexes that can use the knowledge agent. Currently in this preview release, the `targetIndexes` array can contain only one index. *It must have a default semantic configuration* (`defaultConfiguration`). For more information, see [Design an index for agentic retrieval](search-agentic-retrieval-how-to-index.md).
180180

181181
```json
182182
"semantic": {
@@ -204,9 +204,9 @@ Content-Type: application/json
204204

205205
<!-- --- -->
206206

207-
## Confirm agent operations
207+
## Confirm knowledge agent operations
208208

209-
Call the **retrieve** action on the agent object to confirm the model connection and return a response. Use the [2025-05-01-preview](/rest/api/searchservice/operation-groups?view=rest-searchservice-2025-05-01-preview&preserve-view=true) data plane REST API or an Azure SDK prerelease package that provides equivalent functionality for this task.
209+
Call the **retrieve** action on the knowledge agent object to confirm the model connection and return a response. Use the [2025-05-01-preview](/rest/api/searchservice/operation-groups?view=rest-searchservice-2025-05-01-preview&preserve-view=true) data plane REST API or an Azure SDK prerelease package that provides equivalent functionality for this task.
210210

211211
Replace "What are my vision benefits?" with a query string that's valid for your search index.
212212

@@ -243,7 +243,7 @@ Content-Type: application/json
243243
}
244244
```
245245

246-
For more information about the **retrieve** API and the shape of the response, see [Retrieve data using an agent in Azure AI Search](search-agentic-retrieval-how-to-retrieve.md).
246+
For more information about the **retrieve** API and the shape of the response, see [Retrieve data using a knowledge agent in Azure AI Search](search-agentic-retrieval-how-to-retrieve.md).
247247

248248
## Delete an agent
249249

0 commit comments

Comments
 (0)