你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Knowledge Bases - List

服务:: Search Service

API 版本:: 2026-04-01

列出可用于搜索服务的所有知识库。

GET {endpoint}/knowledgebases?api-version=2026-04-01

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string (uri)	搜索服务的终结点 URL。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

请求头

名称	必需	类型	说明
Accept		Accept	接受（Accept）首部。
x-ms-client-request-id		string (uuid)	请求的不透明、全局唯一的客户端生成的字符串标识符。

响应

名称	类型	说明
200 OK	ListKnowledgeBasesResult	请求已成功。
Other Status Codes	ErrorResponse	意外的错误响应。

安全性

api-key

类型: apiKey
在: header

OAuth2Auth

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

作用域

名称	说明
https://search.azure.com/.default

示例

SearchServiceListKnowledgeBases

示例请求

HTTP

GET https://exampleservice.search.windows.net/knowledgebases?api-version=2026-04-01

示例响应

状态代码:: 200

{
  "value": [
    {
      "@odata.etag": "0x1234568AE7E58A1",
      "name": "base-example-index",
      "description": "Description of the knowledge base.",
      "knowledgeSources": [
        {
          "name": "ks-example-index"
        }
      ],
      "models": [
        {
          "kind": "azureOpenAI",
          "azureOpenAIParameters": {
            "resourceUri": "https://test-sample.openai.azure.com",
            "deploymentId": "myDeployment",
            "apiKey": "<redacted>",
            "modelName": "gpt-5-nano"
          }
        }
      ],
      "encryptionKey": {
        "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
        "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
        "keyVaultUri": "https://myKeyVault.vault.azure.net",
        "accessCredentials": {
          "applicationId": "00000000-0000-0000-0000-000000000000",
          "applicationSecret": "<applicationSecret>"
        }
      }
    }
  ]
}

定义

名称	说明
Accept	接受（Accept）首部。
AzureOpenAIModelName	将调用的 Azure Open AI 模型名称。
AzureOpenAIVectorizerParameters	指定用于连接到 Azure OpenAI 资源的参数。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	所有 Azure 资源管理器 API 的通用错误响应，用于返回失败操作的错误细节。（这也遵循 OData 错误响应格式）。
KnowledgeBase	代表知识库定义。
KnowledgeBaseAzureOpenAIModel	指定用于执行查询规划的 Azure OpenAI 资源。
KnowledgeBaseModelKind	用于查询规划的 AI 模型。
KnowledgeSourceReference	引用知识来源。
ListKnowledgeBasesResult	列出知识库。
SearchIndexerDataNoneIdentity	清除数据源的标识属性。
SearchIndexerDataUserAssignedIdentity	指定要使用的数据源的标识。
SearchResourceEncryptionKey	Azure 密钥保管库中的客户管理的加密密钥。创建和管理的密钥可用于加密或解密静态数据，例如索引和同义词映射。

Accept

枚举

接受（Accept）首部。

值	说明
application/json;odata.metadata=minimal

AzureOpenAIModelName

枚举

将调用的 Azure Open AI 模型名称。

值	说明
text-embedding-ada-002	TextEmbeddingAda002 模型。
text-embedding-3-large	TextEmbedding3大型模型。
text-embedding-3-small	TextEmbedding3小型模型。
gpt-5-mini	Gpt5Mini型号。
gpt-5-nano	Gpt5Nano模型。
gpt-5.4-mini	GPT54Mini型号。
gpt-5.4-nano	Gpt54Nano型号。

AzureOpenAIVectorizerParameters

对象

指定用于连接到 Azure OpenAI 资源的参数。

名称	类型	说明
apiKey	string	指定的 Azure OpenAI 资源的 API 密钥。
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	用于出站连接的用户分配的托管标识。
deploymentId	string	指定资源上的 Azure OpenAI 模型部署的 ID。
modelName	AzureOpenAIModelName	在提供的 deploymentId 路径中部署的嵌入模型的名称。
resourceUri	string (uri)	Azure OpenAI 资源的资源 URI。

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称	类型	说明
info		附加信息。
type	string	附加信息类型。

ErrorDetail

对象

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

对象

所有 Azure 资源管理器 API 的通用错误响应，用于返回失败操作的错误细节。（这也遵循 OData 错误响应格式）。

名称	类型	说明
error	ErrorDetail	错误对象。

KnowledgeBase

对象

代表知识库定义。

名称	类型	说明
@odata.etag	string	知识库的 ETag。
description	string	知识库的描述。
encryptionKey	SearchResourceEncryptionKey	描述在 Azure 密钥保管库中创建的加密密钥。
knowledgeSources	KnowledgeSourceReference[]	本知识库引用的知识来源。
models	KnowledgeBaseModel[]: KnowledgeBaseAzureOpenAIModel[]	包含有关如何连接到 AI 模型的配置选项。
name	string	知识库的名称。

KnowledgeBaseAzureOpenAIModel

对象

指定用于执行查询规划的 Azure OpenAI 资源。

名称	类型	说明
azureOpenAIParameters	AzureOpenAIVectorizerParameters	Azure OpenAI 参数。
kind	string: azureOpenAI	用于查询规划的 AI 模型。

KnowledgeBaseModelKind

枚举

用于查询规划的 AI 模型。

值	说明
azureOpenAI	使用 Azure Open AI 模型进行查询规划。

KnowledgeSourceReference

对象

引用知识来源。

名称	类型	说明
name	string	知识源的名称。

ListKnowledgeBasesResult

对象

列出知识库。

名称	类型	说明
value	KnowledgeBase[]	服务中的知识库。

SearchIndexerDataNoneIdentity

对象

清除数据源的标识属性。

名称	类型	说明
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	指定身份类型的 URI 片段。

SearchIndexerDataUserAssignedIdentity

对象

指定要使用的数据源的标识。

名称	类型	说明
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	指定身份类型的 URI 片段。
userAssignedIdentity	string	用户分配的托管标识的完全限定的 Azure 资源 ID 通常以“/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentity/myId”的形式分配给搜索服务。

SearchResourceEncryptionKey

对象

Azure 密钥保管库中的客户管理的加密密钥。创建和管理的密钥可用于加密或解密静态数据，例如索引和同义词映射。

名称	类型	说明
accessCredentials.applicationId	string	向 AAD 应用程序 ID 授予对静态数据加密时要使用的 Azure 密钥保管库所需的访问权限。应用程序 ID 不应与 AAD 应用程序的对象 ID 混淆。
accessCredentials.applicationSecret	string	指定的 AAD 应用程序的身份验证密钥。
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	用于此加密密钥的显式托管标识。如果未指定并且访问凭据属性为 null，则使用系统分配的托管标识。更新资源时，如果未指定显式标识，则保持不变。如果指定了“none”，则清除此属性的值。
keyVaultKeyName	string	用于加密静态数据的 Azure 密钥保管库密钥的名称。
keyVaultKeyVersion	string	用于加密静态数据的 Azure 密钥保管库密钥的版本。
keyVaultUri	string	Azure 密钥保管库的 URI（也称为 DNS 名称），其中包含用于加密静态数据的密钥。示例 URI 可能是 `https://my-keyvault-name.vault.azure.net`。