Skip to content

Commit 943bdb9

Browse files
Merge pull request #7613 from MicrosoftDocs/main
Auto Publish – main to live - 2025-10-10 22:10 UTC
2 parents 070a4f2 + 936b062 commit 943bdb9

File tree

4 files changed

+95
-57
lines changed

4 files changed

+95
-57
lines changed

articles/search/agentic-knowledge-source-how-to-blob.md

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ author: HeidiSteen
77
ms.author: heidist
88
ms.service: azure-ai-search
99
ms.topic: how-to
10-
ms.date: 08/29/2025
10+
ms.date: 10/10/2025
1111
---
1212

1313
# Create a blob knowledge source
@@ -219,19 +219,7 @@ After the knowledge agent is configured, use the retrieve action to query the kn
219219
220220
## Delete a knowledge source
221221
222-
If you no longer need the knowledge source, or if you need to rebuild it on the search service, use this request to delete the current object.
223-
224-
```http
225-
# Delete agent
226-
DELETE {{search-url}}/knowledgeSources/{{ks-name}}?api-version=2025-08-01-preview
227-
api-key: {{api-key}}
228-
```
229-
230-
> [!IMPORTANT]
231-
> Before you can delete a knowledge source, you must first update the knowledge agent to remove all references to the knowledge source.
232-
>
233-
> Deleting a blob knowledge source also deletes the objects it created. The indexer, data source, skillset, and index are automatically deleted when the blob knowledge source is deleted.
234-
>
222+
[!INCLUDE [Delete knowledge source](includes/how-tos/knowledge-source-delete-rest.md)]
235223
236224
## Learn more
237225

articles/search/agentic-knowledge-source-how-to-search-index.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ author: HeidiSteen
77
ms.author: heidist
88
ms.service: azure-ai-search
99
ms.topic: how-to
10-
ms.date: 08/29/2025
10+
ms.date: 10/10/2025
1111
---
1212

1313
# Create a search index knowledge source
@@ -121,13 +121,7 @@ Within the knowledge agent, there are more properties to set on the knowledge so
121121
122122
## Delete a knowledge source
123123
124-
If you no longer need the knowledge source, or if you need to rebuild it on the search service, use this request to delete the current object.
125-
126-
```http
127-
# Delete agent
128-
DELETE {{search-url}}/knowledgeSources/{{ks-name}}?api-version=2025-08-01-preview
129-
api-key: {{api-key}}
130-
```
124+
[!INCLUDE [Delete knowledge source](includes/how-tos/knowledge-source-delete-rest.md)]
131125
132126
## Learn more
133127

articles/search/agentic-knowledge-source-overview.md

Lines changed: 2 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ A platform-specific knowledge source like the blob knowledge source includes spe
4646
> [!NOTE]
4747
> `WebKnowledgeSource` (also referred to as `WebParameters` in REST APIs) isn't currently operational in the 2025-08-01-preview.
4848
49-
## Create a knowledge source
49+
## Creating knowledge sources
5050

5151
You must have [**Search Service Contributor** permissions](search-security-rbac.md) to create objects on a search service. You also need **Search Index Data Contributor** permissions to load an index if you're using a knowledge source that creates an indexer pipeline. Alternatively, you can [use an API admin key](search-security-api-keys.md) instead of roles.
5252

@@ -57,7 +57,7 @@ You must use the REST API or an Azure SDK preview package to create a knowledge
5757

5858
After the knowledge source is created, you can reference it in a knowledge agent.
5959

60-
## Use a knowledge source
60+
## Using knowledge sources
6161

6262
Properties on the [*knowledge agent*](agentic-retrieval-how-to-create-knowledge-base.md) determine whether and how the knowledge source is used.
6363

@@ -113,36 +113,3 @@ To achieve the fastest possible response times, follow these best practices:
113113
+ Set `knowledgeSources.includeReferenceSourceData` to false if you don't need the verbatim content from the index. Omitting this information simplifies the response and makes it more readable.
114114

115115
1. In the [retrieve action](agentic-retrieval-how-to-retrieve.md), provide a single message query that's fewer than 512 characters.
116-
117-
## Delete a knowledge source
118-
119-
Before you can delete a knowledge source, you must delete or update any knowledge agent that references it. The associated index is a standalone object in Azure AI Search and doesn't need to be deleted or updated in tandem with the knowledge source, but no references to the knowledge source can exist if you want to delete it.
120-
121-
If you try to delete a knowledge source that's in use, the action fails and a list of affected knowledge agents is returned.
122-
123-
1. Get the knowledge agent definition to confirm knowledge source references.
124-
125-
```http
126-
### Get the knowledge agent
127-
GET {{search-endpoint}}/agents/hotels-index-ka?api-version=2025-08-01-preview
128-
api-key: {{api-key}}
129-
Content-Type: application/json
130-
```
131-
132-
1. Either update the knowledge agent by removing the knowledge source, or delete the knowledge agent. This example shows deletion.
133-
134-
```http
135-
### Delete knowledge agent
136-
DELETE {{search-endpoint}}/agents/hotels-index-ka?api-version=2025-08-01-preview
137-
api-key: {{api-key}}
138-
Content-Type: application/json
139-
```
140-
141-
1. Delete the knowledge source.
142-
143-
```http
144-
### Delete a knowledge source definition
145-
GET {{search-endpoint}}/knowledgeSources/hotels-index-ks?api-version=2025-08-01-preview
146-
api-key: {{api-key}}
147-
Content-Type: application/json
148-
```
Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
---
2+
manager: nitinme
3+
author: heidisteen
4+
ms.author: heidist
5+
ms.service: azure-ai-search
6+
ms.topic: include
7+
ms.date: 10/10/2025
8+
---
9+
10+
If you no longer need the knowledge source, or if you need to rebuild it on the search service, use this request to delete the current object.
11+
12+
Before you can delete a knowledge source, you must delete any knowledge agent that references it, or remote the references in an update action. The associated index and any indexer pipeline objects created from the knowledge source are standalone objects and don't need to be deleted or updated in tandem with the knowledge source.
13+
14+
If you try to delete a knowledge source that's in use, the action fails and a list of affected knowledge agents is returned.
15+
16+
1. Start by getting a list of all knowledge agents. This request returns all knowledge agents on your search service.
17+
18+
```http
19+
### Get the knowledge agent
20+
GET {{search-endpoint}}/agents?api-version=2025-08-01-preview&$select=name
21+
api-key: {{api-key}}
22+
Content-Type: application/json
23+
```
24+
25+
An example response might look like the following:
26+
27+
```json
28+
{
29+
"@odata.context": "https://my-demo-search-service.search.windows.net/$metadata#agents(name)",
30+
"value": [
31+
{
32+
"name": "earth-blob-ka"
33+
},
34+
{
35+
"name": "hotels-sample-ka"
36+
}
37+
]
38+
}
39+
```
40+
41+
1. Get the individual knowledge agent definition to check for knowledge source references.
42+
43+
```http
44+
GET {{search-endpoint}}/agents/hotels-sample-ka?api-version=2025-08-01-preview
45+
api-key: {{api-key}}
46+
Content-Type: application/json
47+
```
48+
49+
An example response might look like the following:
50+
51+
```json
52+
{
53+
"name": "hotels-sample-ka",
54+
"description": null,
55+
"retrievalInstructions": null,
56+
"knowledgeSources": [
57+
{
58+
"name": "hotels-sample-ks",
59+
"alwaysQuerySource": false,
60+
"includeReferences": true,
61+
"includeReferenceSourceData": false,
62+
"maxSubQueries": null,
63+
"rerankerThreshold": null
64+
}
65+
],
66+
"models": [ trimmed for brevity ],
67+
"outputConfiguration": { trimmed for brevity },
68+
"requestLimits": { trimmed for brevity},
69+
"encryptionKey": null
70+
}
71+
```
72+
73+
1. Either [update the knowledge agent](/rest/api/searchservice/knowledge-agents/create-or-update?view=rest-searchservice-2025-08-01-preview&preserve-view=true) by removing the knowledge source if you have multiple sources, or delete the knowledge agent. This example shows deletion.
74+
75+
```http
76+
### Delete knowledge agent
77+
DELETE {{search-endpoint}}/agents/hotels-sample-ka?api-version=2025-08-01-preview
78+
api-key: {{api-key}}
79+
Content-Type: application/json
80+
```
81+
82+
1. Delete the knowledge source.
83+
84+
```http
85+
### Delete a knowledge source definition
86+
GET {{search-endpoint}}/knowledgeSources/hotels-sample-ks?api-version=2025-08-01-preview
87+
api-key: {{api-key}}
88+
Content-Type: application/json
89+
```

0 commit comments

Comments
 (0)