创建搜索索引知识来源

注释

此功能目前处于预览状态。此预览版未随附服务级别协议，建议不要用于生产工作负载。某些功能可能不受支持或者受限。有关详细信息，请参阅适用于 Azure 预览版的补充使用条款。

重要

这些特性和功能是 2026-05-01 预览版 REST API 的一部分。 2026-05-01-preview 作为Azure订阅的一部分获得许可，并受Microsoft产品条款、Microsoft产品和服务数据保护附录（“DPA”）和Azure预览版补充使用条款的约束。

2026-05-01-preview 支持连接到其他 Microsoft 服务和第三方服务。使用这些服务受其各自的条款的约束，可能会导致数据处理或存储超出Azure符合性边界，以及流入Azure符合性边界的数据。

您有责任管理您的数据是否会流出您组织的合规和地理边界之外及其任何相关影响，并确保已配置适当的权限、边界和审批。

你负责仔细查看和测试在特定用例上下文中生成的应用程序，并做出所有适当的决策和自定义。这包括实施自己的负责任的 AI 缓解措施，例如元系统、内容筛选器或其他安全系统，并确保应用程序满足适当的质量、可靠性、安全性和可信度标准。

search 索引知识源将现有的Azure AI 搜索索引（包括索引文本和向量）连接到代理检索管道。知识库是在运行时查询知识库时独立创建的、在知识库中引用的，并用作基础数据。

使用支持

Azure 门户	.NET SDK	Python SDK	Java SDK	JavaScript SDK	REST API
✔️	✔️	✔️	✔️	✔️	✔️

先决条件

在任意提供代理检索功能的区域中提供的 Azure AI 搜索服务。
包含具有语义配置的纯文本或矢量内容的搜索索引。查看用于代理检索的索引条件。索引必须与知识库位于同一搜索服务上。
创建知识源的权限。使用分配给用户帐户的搜索服务参与者角色（建议）或使用 API 密钥配置无密钥身份验证。

所需 Azure.Search.Documents 软件包：
- 对于 2026-05-01-preview 功能，最新的预览包为：dotnet add package Azure.Search.Documents --prerelease
- 关于2026-04-01的功能，最新的稳定包是：dotnet add package Azure.Search.Documents

所需 azure-search-documents 软件包：
- 对于 2026-05-01-preview 功能，最新的预览包为：pip install --pre azure-search-documents
- 关于2026-04-01的功能，最新的稳定包是：pip install azure-search-documents

所需的 REST API 版本：
- 有关预览功能： Search Service 2026-05-01-preview
- 一般可用的功能：搜索服务 2026-04-01

检查现有知识来源

知识来源是顶级可重用对象。了解现有知识源有助于重复使用或命名新对象。

运行以下代码，按名称和类型列出知识源。

// List knowledge sources by name and type
using Azure.Search.Documents.Indexes;

var indexClient = new SearchIndexClient(new Uri(searchEndpoint), credential);
var knowledgeSources = indexClient.GetKnowledgeSourcesAsync();

Console.WriteLine("Knowledge Sources:");

await foreach (var ks in knowledgeSources)
{
    Console.WriteLine($"  Name: {ks.Name}, Type: {ks.GetType().Name}");
}

Reference：SearchIndexClient

# List knowledge sources by name and type
from azure.core.credentials import AzureKeyCredential
from azure.search.documents.indexes import SearchIndexClient

index_client = SearchIndexClient(endpoint = "search_url", credential = AzureKeyCredential("api_key"))

for ks in index_client.list_knowledge_sources():
    print(f"  - {ks.name} ({ks.kind})")

Reference：SearchIndexClient

### List knowledge sources by name and type
GET {{search-url}}/knowledgesources?api-version={{api-version}}&$select=name,kind
api-key: {{api-key}}

参考：知识源 - 列表

还可以按名称返回单个知识来源以查看其 JSON 定义。

using Azure.Search.Documents.Indexes;
using System.Text.Json;

var indexClient = new SearchIndexClient(new Uri(searchEndpoint), credential);

// Specify the knowledge source name to retrieve
string ksNameToGet = "earth-knowledge-source";

// Get its definition
var knowledgeSourceResponse = await indexClient.GetKnowledgeSourceAsync(ksNameToGet);
var ks = knowledgeSourceResponse.Value;

// Serialize to JSON for display
var jsonOptions = new JsonSerializerOptions 
{ 
    WriteIndented = true,
    DefaultIgnoreCondition = System.Text.Json.Serialization.JsonIgnoreCondition.Never
};
Console.WriteLine(JsonSerializer.Serialize(ks, ks.GetType(), jsonOptions));

Reference：SearchIndexClient

# Get a knowledge source definition
from azure.core.credentials import AzureKeyCredential
from azure.search.documents.indexes import SearchIndexClient
import json

index_client = SearchIndexClient(endpoint = "search_url", credential = AzureKeyCredential("api_key"))

ks = index_client.get_knowledge_source("knowledge_source_name")
print(json.dumps(ks.as_dict(), indent = 2))

Reference：SearchIndexClient

### Get a knowledge source definition
GET {{search-url}}/knowledgesources/{{knowledge-source-name}}?api-version={{api-version}}
api-key: {{api-key}}

参考：知识源 - 获取

以下 JSON 是搜索索引知识源的示例响应。请注意，知识来源指定单个索引名称以及要包含在查询中的索引中的字段。

{
  "name": "my-search-index-ks",
  "kind": "searchIndex",
  "description": "A sample search index knowledge source.",
  "encryptionKey": null,
  "searchIndexParameters": {
    "searchIndexName": "my-search-index",
    "semanticConfigurationName": null,
    "sourceDataFields": [],
    "searchFields": []
  }
}

创建知识来源

运行以下代码以创建搜索索引知识源。

2026-05-01-预览
2026-04-01

// Create a search index knowledge source
using Azure.Search.Documents.Indexes;
using Azure.Search.Documents.Indexes.Models;
using Azure;

var indexClient = new SearchIndexClient(new Uri(searchEndpoint), new AzureKeyCredential(apiKey));

var indexKnowledgeSource = new SearchIndexKnowledgeSource(
    name: knowledgeSourceName,
    searchIndexParameters: new SearchIndexKnowledgeSourceParameters(searchIndexName: indexName)
    {
        SearchFields = { new SearchIndexFieldReference(name: "page_chunk") },
        SourceDataFields = { new SearchIndexFieldReference(name: "id"), new SearchIndexFieldReference(name: "page_chunk"), new SearchIndexFieldReference(name: "page_number") }
    }
);

await indexClient.CreateOrUpdateKnowledgeSourceAsync(indexKnowledgeSource);
Console.WriteLine($"Knowledge source '{knowledgeSourceName}' created or updated successfully.");

Reference：SearchIndexClient、 SearchIndexKnowledgeSource

// Create a search index knowledge source
using Azure.Search.Documents.Indexes;
using Azure.Search.Documents.Indexes.Models;
using Azure;

var indexClient = new SearchIndexClient(new Uri(searchEndpoint), new AzureKeyCredential(apiKey));

var indexKnowledgeSource = new SearchIndexKnowledgeSource(
    name: knowledgeSourceName,
    searchIndexParameters: new SearchIndexKnowledgeSourceParameters(searchIndexName: indexName)
    {
        SemanticConfigurationName = "semantic_config",
        SearchFields = { new SearchIndexFieldReference(name: "page_chunk") },
        SourceDataFields = { new SearchIndexFieldReference(name: "id"), new SearchIndexFieldReference(name: "page_chunk"), new SearchIndexFieldReference(name: "page_number") }
    }
);

await indexClient.CreateOrUpdateKnowledgeSourceAsync(indexKnowledgeSource);
Console.WriteLine($"Knowledge source '{knowledgeSourceName}' created or updated successfully.");

Reference：SearchIndexClient、 SearchIndexKnowledgeSource

2026-05-01-预览
2026-04-01

# Create a search index knowledge source
from azure.core.credentials import AzureKeyCredential
from azure.search.documents.indexes import SearchIndexClient
from azure.search.documents.indexes.models import SearchIndexKnowledgeSource, SearchIndexKnowledgeSourceParameters, SearchIndexFieldReference

index_client = SearchIndexClient(endpoint = "search_url", credential = AzureKeyCredential("api_key"))

knowledge_source = SearchIndexKnowledgeSource(
    name = "my-search-index-ks",
    description= "This knowledge source pulls from an existing index designed for agentic retrieval.",
    encryption_key = None,
    search_index_parameters = SearchIndexKnowledgeSourceParameters(
        search_index_name = "search_index_name",
        semantic_configuration_name = "semantic_configuration_name",
        source_data_fields = [
            SearchIndexFieldReference(name="description"),
            SearchIndexFieldReference(name="category"),
        ],
        search_fields = [
            SearchIndexFieldReference(name="id")
        ],
    )
)

index_client.create_or_update_knowledge_source(knowledge_source)
print(f"Knowledge source '{knowledge_source.name}' created or updated successfully.")

Reference：SearchIndexClient

# Create a search index knowledge source
from azure.core.credentials import AzureKeyCredential
from azure.search.documents.indexes import SearchIndexClient
from azure.search.documents.indexes.models import SearchIndexKnowledgeSource, SearchIndexKnowledgeSourceParameters, SearchIndexFieldReference

index_client = SearchIndexClient(endpoint = "search_url", credential = AzureKeyCredential("api_key"))

knowledge_source = SearchIndexKnowledgeSource(
    name = "my-search-index-ks",
    description= "This knowledge source pulls from an existing index designed for agentic retrieval.",
    encryption_key = None,
    search_index_parameters = SearchIndexKnowledgeSourceParameters(
        search_index_name = "search_index_name",
        semantic_configuration_name = "semantic_configuration_name",
        source_data_fields = [
            SearchIndexFieldReference(name="description"),
            SearchIndexFieldReference(name="category"),
        ],
        search_fields = [
            SearchIndexFieldReference(name="id")
        ],
    )
)

index_client.create_or_update_knowledge_source(knowledge_source)
print(f"Knowledge source '{knowledge_source.name}' created or updated successfully.")

Reference：SearchIndexClient

2026-05-01-预览
2026-04-01

### Create a search index knowledge source
PUT {{search-url}}/knowledgesources/my-search-index-ks?api-version=2026-05-01-preview
api-key: {{api-key}}
Content-Type: application/json

{
    "name": "my-search-index-ks",
    "kind": "searchIndex",
    "description": "This knowledge source pulls from an existing index designed for agentic retrieval.",
    "encryptionKey": null,
    "searchIndexParameters": {
        "searchIndexName": "<YOUR INDEX NAME>",
        "semanticConfigurationName": "my-semantic-config",
        "sourceDataFields": [
          { "name": "description" },
          { "name": "category" }
        ]
    }
}

参考：知识源 - 创建或更新

### Create a search index knowledge source
PUT {{search-url}}/knowledgesources/my-search-index-ks?api-version=2026-04-01
api-key: {{api-key}}
Content-Type: application/json

{
    "name": "my-search-index-ks",
    "kind": "searchIndex",
    "description": "This knowledge source pulls from an existing index designed for agentic retrieval.",
    "encryptionKey": null,
    "searchIndexParameters": {
        "searchIndexName": "<YOUR INDEX NAME>",
        "semanticConfigurationName": "my-semantic-config",
        "sourceDataFields": [
          { "name": "description" },
          { "name": "category" }
        ]
    }
}

参考：知识源 - 创建或更新

特定于源的属性

以下属性适用于搜索索引知识源。

Name	Description	类型	可编辑	必选
`Name`	知识源的名称，该名称在知识源集合中必须是唯一的，并遵循 Azure AI 搜索中对象的命名准则。	String	否	是的
`Description`	知识源的说明。	String	是的	否
`EncryptionKey`	客户管理的密钥，用于加密知识源和生成的对象中的敏感信息。	物体	是的	否
`SearchIndexParameters`	特定于搜索索引知识源的参数：`SearchIndexName`、`SemanticConfigurationName`、`SourceDataFields`、`SearchFields` 和 `BaseFilter`（仅限 2026-05-01-preview）。	物体	是的	是的
`SearchIndexName`	现有搜索索引的名称。	String	是的	是的
`SemanticConfigurationName`	替代搜索索引的默认语义配置。	String	是的	否
`SourceDataFields`	在知识库定义中指定 `IncludeReferenceSourceData` 时返回的索引字段。这些字段用于引文，应为 `retrievable`。示例包括文档名称、文件名、页码或章节号。	Array	是的	否
`SearchFields`	要专门搜索的索引字段。如果未指定，将搜索所有字段。	Array	是的	否
`BaseFilter`	保存在知识源上的、适用于每次检索请求的默认筛选表达式。在检索时，该值由请求的 `FilterAddOn`AND 组成。仅在 2026-05-01-preview API 中提供。	String	是的	否

Name	Description	类型	可编辑	必选
`name`	知识源的名称，该名称在知识源集合中必须是唯一的，并遵循 Azure AI 搜索中对象的命名准则。	String	否	是的
`description`	知识源的说明。	String	是的	否
`encryption_key`	客户管理的密钥，用于加密知识源和生成的对象中的敏感信息。	物体	是的	否
`search_index_parameters`	特定于搜索索引知识源的参数：`search_index_name`、`semantic_configuration_name`、`source_data_fields`、`search_fields` 和 `base_filter`（仅限 2026-05-01-preview）。	物体	是的	是的
`search_index_name`	现有搜索索引的名称。	String	是的	是的
`semantic_configuration_name`	替代搜索索引的默认语义配置。	String	是的	否
`source_data_fields`	在知识库定义中指定 `include_reference_source_data` 时返回的索引字段。这些字段用于引文，应为 `retrievable`。示例包括文档名称、文件名、页码或章节号。	Array	是的	否
`search_fields`	要专门搜索的索引字段。如果未指定，将搜索所有字段。	Array	是的	否
`base_filter`	保存在知识源上的、适用于每次检索请求的默认筛选表达式。在检索时，该值由请求的 `filter_add_on`AND 组成。仅在 2026-05-01-preview API 中提供。	String	是的	否

Name	Description	类型	可编辑	必选
`name`	知识源的名称，该名称在知识源集合中必须是唯一的，并遵循 Azure AI 搜索中对象的命名准则。	String	否	是的
`kind`	知识源的类型，其为`searchIndex`在本例中。	String	否	是的
`description`	知识源的说明。	String	是的	否
`encryptionKey`	客户管理的密钥，用于加密知识源和生成的对象中的敏感信息。	物体	是的	否
`searchIndexParameters`	特定于搜索索引知识源的参数：`searchIndexName`、`semanticConfigurationName`、`sourceDataFields`、`searchFields` 和 `baseFilter`（仅限 2026-05-01-preview）。	物体	是的	是的
`searchIndexName`	现有搜索索引的名称。	String	是的	是的
`semanticConfigurationName`	替代搜索索引的默认语义配置。	String	是的	否
`sourceDataFields`	在知识库定义中指定 `includeReferenceSourceData` 时返回的索引字段。这些字段用于引文，应为 `retrievable`。示例包括文档名称、文件名、页码或章节号。	Array	是的	否
`searchFields`	要专门搜索的索引字段。如果未指定，将搜索所有字段。	Array	是的	否

分配给知识库

如果对知识源感到满意，请将其添加到知识库。

查询知识库

配置知识库后，调用检索操作或 MCP 终结点以查询知识源。

删除知识来源

在删除知识库之前，必须删除引用它的任何知识库或更新知识库定义以删除引用。对于生成索引和索引器管道的知识源，所有 生成的对象 都会被删除。但是，如果使用现有索引创建知识源，则不会删除索引。

如果尝试删除正在使用的知识源，该作将失败并返回受影响的知识库列表。

要删除知识源，请执行以下步骤：

获取搜索服务上所有知识库的列表。

using Azure.Search.Documents.Indexes;

var indexClient = new SearchIndexClient(new Uri(searchEndpoint), credential);
var knowledgeBases = indexClient.GetKnowledgeBasesAsync();

Console.WriteLine("Knowledge Bases:");

await foreach (var kb in knowledgeBases)
{
    Console.WriteLine($"  - {kb.Name}");
}

Reference：SearchIndexClient

示例响应可能如下所示：

 {
     "@odata.context": "https://my-search-service.search.azure.cn/$metadata#knowledgebases(name)",
     "value": [
     {
         "name": "my-kb"
     },
     {
         "name": "my-kb-2"
     }
     ]
 }

获取单个知识库定义以检查知识源引用。

using Azure.Search.Documents.Indexes;
using System.Text.Json;

var indexClient = new SearchIndexClient(new Uri(searchEndpoint), credential);

// Specify the knowledge base name to retrieve
string kbNameToGet = "earth-knowledge-base";

// Get a specific knowledge base definition
var knowledgeBaseResponse = await indexClient.GetKnowledgeBaseAsync(kbNameToGet);
var kb = knowledgeBaseResponse.Value;

// Serialize to JSON for display
string json = JsonSerializer.Serialize(kb, new JsonSerializerOptions { WriteIndented = true });
Console.WriteLine(json);

Reference：SearchIndexClient

示例响应可能如下所示：

 {
   "Name": "earth-knowledge-base",
   "KnowledgeSources": [
     {
       "Name": "earth-knowledge-source"
     }
   ],
   "Models": [
     {}
   ],
   "RetrievalReasoningEffort": {},
   "OutputMode": {},
   "ETag": "\u00220x8DE278629D782B3\u0022",
   "EncryptionKey": null,
   "Description": null,
   "RetrievalInstructions": null,
   "AnswerInstructions": null
 }

删除知识库，或者如果有多个知识库，请更新知识库以删除源。此示例显示删除。

using Azure.Search.Documents.Indexes;
var indexClient = new SearchIndexClient(new Uri(searchEndpoint), credential);

await indexClient.DeleteKnowledgeBaseAsync(knowledgeBaseName);
System.Console.WriteLine($"Knowledge base '{knowledgeBaseName}' deleted successfully.");

Reference：SearchIndexClient

删除知识来源。

await indexClient.DeleteKnowledgeSourceAsync(knowledgeSourceName);
System.Console.WriteLine($"Knowledge source '{knowledgeSourceName}' deleted successfully.");

Reference：SearchIndexClient

获取搜索服务上所有知识库的列表。

# Get knowledge bases
from azure.core.credentials import AzureKeyCredential
from azure.search.documents.indexes import SearchIndexClient

index_client = SearchIndexClient(endpoint = "search_url", credential = AzureKeyCredential("api_key"))

print("Knowledge Bases:")
for kb in index_client.list_knowledge_bases():
    print(f"  - {kb.name}")

Reference：SearchIndexClient

示例响应可能如下所示：

 {
     "@odata.context": "https://my-search-service.search.azure.cn/$metadata#knowledgebases(name)",
     "value": [
     {
         "name": "my-kb"
     },
     {
         "name": "my-kb-2"
     }
     ]
 }

获取单个知识库定义以检查知识源引用。

# Get a knowledge base definition
from azure.core.credentials import AzureKeyCredential
from azure.search.documents.indexes import SearchIndexClient

index_client = SearchIndexClient(endpoint = "search_url", credential = AzureKeyCredential("api_key"))
kb = index_client.get_knowledge_base("knowledge_base_name")
print(kb)

Reference：SearchIndexClient

示例响应可能如下所示：

 {
   "name": "my-kb",
   "description": null,
   "retrievalInstructions": null,
   "answerInstructions": null,
   "outputMode": null,
   "knowledgeSources": [
     {
       "name": "my-blob-ks",
     }
   ],
   "models": [],
   "encryptionKey": null,
   "retrievalReasoningEffort": {
     "kind": "low"
   }
 }

删除知识库，或者如果有多个知识库，请更新知识库以删除源。此示例显示删除。

# Delete a knowledge base
from azure.core.credentials import AzureKeyCredential 
from azure.search.documents.indexes import SearchIndexClient

index_client = SearchIndexClient(endpoint = "search_url", credential = AzureKeyCredential("api_key"))
index_client.delete_knowledge_base("knowledge_base_name")
print(f"Knowledge base deleted successfully.")

Reference：SearchIndexClient

删除知识来源。

# Delete a knowledge source
from azure.core.credentials import AzureKeyCredential 
from azure.search.documents.indexes import SearchIndexClient

index_client = SearchIndexClient(endpoint = "search_url", credential = AzureKeyCredential("api_key"))
index_client.delete_knowledge_source("knowledge_source_name")
print(f"Knowledge source deleted successfully.")

Reference：SearchIndexClient

获取搜索服务上所有知识库的列表。

### Get knowledge bases
GET {{search-url}}/knowledgebases?api-version={{api-version}}&$select=name
api-key: {{api-key}}

参考：知识库 - 列表

示例响应可能如下所示：

 {
     "@odata.context": "https://my-search-service.search.azure.cn/$metadata#knowledgebases(name)",
     "value": [
     {
         "name": "my-kb"
     },
     {
         "name": "my-kb-2"
     }
     ]
 }

获取单个知识库定义以检查知识源引用。

### Get a knowledge base definition
GET {{search-url}}/knowledgebases/{{knowledge-base-name}}?api-version={{api-version}}
api-key: {{api-key}}

参考：知识库 - 获取

示例响应可能如下所示：

 {
   "name": "my-kb",
   "description": null,
   "retrievalInstructions": null,
   "answerInstructions": null,
   "outputMode": null,
   "knowledgeSources": [
     {
       "name": "my-blob-ks",
     }
   ],
   "models": [],
   "encryptionKey": null,
   "retrievalReasoningEffort": {
     "kind": "low"
   }
 }

删除知识库，或者如果有多个知识库，请更新知识库以删除源。此示例显示删除。

### Delete a knowledge base
DELETE {{search-url}}/knowledgebases/{{knowledge-base-name}}?api-version={{api-version}}
api-key: {{api-key}}

参考：知识库 - 删除

删除知识来源。

### Delete a knowledge source
DELETE {{search-url}}/knowledgesources/{{knowledge-source-name}}?api-version={{api-version}}
api-key: {{api-key}}

参考：知识源 - 删除

Last updated on 2026-06-30

创建搜索索引知识来源

使用支持

先决条件

检查现有知识来源

创建知识来源

特定于源的属性

分配给知识库

查询知识库

删除知识来源

相关内容

其他資源