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

Knowledge Sources - Create Or Update

服务:
Search Service
API 版本:
2026-04-01

创建新的知识源或更新知识源（如果已存在）。

PUT {endpoint}/knowledgesources('{sourceName}')?api-version=2026-04-01

URI 参数

名称 在 必需 类型 说明
endpoint
 path True

string (uri)

搜索服务的终结点 URL。
sourceName
 path True

string

知识源的名称。
api-version
 query True

string

minLength: 1

用于此操作的 API 版本。

请求头

名称 必需 类型 说明
Accept

Accept

接受（Accept）首部。
If-Match

string

定义 If-Match 条件。 仅当服务器上的 ETag 与此值匹配时，才会执行该作。
If-None-Match

string

定义 If-None-Match 条件。 仅当服务器上的 ETag 与此值不匹配时，才会执行该作。
Prefer True

Prefer

对于 HTTP PUT 请求，指示服务在成功时返回创建/更新的资源。
x-ms-client-request-id

string (uuid)

请求的不透明、全局唯一的客户端生成的字符串标识符。

请求正文

请求正文可以为下列任一内容：

名称 说明
AzureBlobKnowledgeSource

Azure Blob 存储知识源的配置。
IndexedOneLakeKnowledgeSource

OneLake 知识源的配置。
SearchIndexKnowledgeSource

面向搜索索引的知识源。
WebKnowledgeSource

面向 Web 结果的知识源。

AzureBlobKnowledgeSource

Azure Blob 存储知识源的配置。

名称 必需 类型 说明
azureBlobParameters True

AzureBlobKnowledgeSourceParameters

知识源的类型。
kind True string:

azureBlob

知识源的类型。
name True

string

知识源的名称。
@odata.etag

string

知识源的ETag。
description

string

可选的用户定义描述。
encryptionKey

SearchResourceEncryptionKey

描述在 Azure 密钥保管库 中创建的加密密钥。 当你想完全确保没有人，甚至不包括Microsoft，能解密知识源定义时，这个密钥用于为知识源定义提供额外的静止加密层。 一旦你加密了知识源定义，它就会一直保持加密状态。 搜索服务将忽略将此属性设置为 null 的尝试。 如果你想旋转加密密钥，可以根据需要更改该属性;你的知识源定义将不受影响。 使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于在 2019 年 1 月 1 日或之后创建的付费服务。

IndexedOneLakeKnowledgeSource

OneLake 知识源的配置。

名称 必需 类型 说明
indexedOneLakeParameters True

IndexedOneLakeKnowledgeSourceParameters

知识源的参数。
kind True string:

indexedOneLake

知识源的类型。
name True

string

知识源的名称。
@odata.etag

string

知识源的ETag。
description

string

可选的用户定义描述。
encryptionKey

SearchResourceEncryptionKey

描述在 Azure 密钥保管库 中创建的加密密钥。 当你想完全确保没有人，甚至不包括Microsoft，能解密知识源定义时，这个密钥用于为知识源定义提供额外的静止加密层。 一旦你加密了知识源定义，它就会一直保持加密状态。 搜索服务将忽略将此属性设置为 null 的尝试。 如果你想旋转加密密钥，可以根据需要更改该属性;你的知识源定义将不受影响。 使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于在 2019 年 1 月 1 日或之后创建的付费服务。

SearchIndexKnowledgeSource

面向搜索索引的知识源。

名称 必需 类型 说明
kind True string:

searchIndex

知识源的类型。
name True

string

知识源的名称。
searchIndexParameters True

SearchIndexKnowledgeSourceParameters

知识源的参数。
@odata.etag

string

知识源的ETag。
description

string

可选的用户定义描述。
encryptionKey

SearchResourceEncryptionKey

描述在 Azure 密钥保管库 中创建的加密密钥。 当你想完全确保没有人，甚至不包括Microsoft，能解密知识源定义时，这个密钥用于为知识源定义提供额外的静止加密层。 一旦你加密了知识源定义，它就会一直保持加密状态。 搜索服务将忽略将此属性设置为 null 的尝试。 如果你想旋转加密密钥，可以根据需要更改该属性;你的知识源定义将不受影响。 使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于在 2019 年 1 月 1 日或之后创建的付费服务。

WebKnowledgeSource

面向 Web 结果的知识源。

名称 必需 类型 说明
kind True string:

web

知识源的类型。
name True

string

知识源的名称。
@odata.etag

string

知识源的ETag。
description

string

可选的用户定义描述。
encryptionKey

SearchResourceEncryptionKey

描述在 Azure 密钥保管库 中创建的加密密钥。 当你想完全确保没有人，甚至不包括Microsoft，能解密知识源定义时，这个密钥用于为知识源定义提供额外的静止加密层。 一旦你加密了知识源定义，它就会一直保持加密状态。 搜索服务将忽略将此属性设置为 null 的尝试。 如果你想旋转加密密钥，可以根据需要更改该属性;你的知识源定义将不受影响。 使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于在 2019 年 1 月 1 日或之后创建的付费服务。
webParameters

WebKnowledgeSourceParameters

Web 知识源的参数。

响应

名称 类型 说明
200 OK KnowledgeSource:

请求已成功。
201 Created KnowledgeSource:

请求已成功，因此创建了一个新资源。
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

示例

SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob
SearchServiceCreateOrUpdateKnowledgeSourceIndexedOneLake
SearchServiceCreateOrUpdateKnowledgeSourceWeb

SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob

示例请求

PUT https://exampleservice.search.windows.net/knowledgesources('ks-example-index')?api-version=2026-04-01





{
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "identity": {
        "userAssignedIdentity": "/my/userassigned/id",
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity"
      },
      "embeddingModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        },
        "kind": "azureOpenAI"
      },
      "chatCompletionModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-5-nano"
        },
        "kind": "azureOpenAI"
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  },
  "name": "ks-example-index",
  "description": "Description of the knowledge source.",
  "kind": "azureBlob",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

示例响应

状态代码:
200 
{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-example-index",
  "kind": "azureBlob",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-5-nano"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "createdResources": {
      "dataSourceConnection": "ks-example-index-datasource",
      "indexer": "ks-example-index-indexer",
      "skillset": "ks-example-index-skillset",
      "index": "ks-example-index-index"
    }
  }
}
状态代码:
201 
{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-example-index",
  "kind": "azureBlob",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-5-nano"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "createdResources": {
      "dataSourceConnection": "ks-example-index-datasource",
      "indexer": "ks-example-index-indexer",
      "skillset": "ks-example-index-skillset",
      "index": "ks-example-index-index"
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceIndexedOneLake

示例请求

PUT https://exampleservice.search.windows.net/knowledgesources('ks-example-index')?api-version=2026-04-01





{
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "identity": {
        "userAssignedIdentity": "/my/userassigned/id",
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity"
      },
      "embeddingModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        },
        "kind": "azureOpenAI"
      },
      "chatCompletionModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-5-nano"
        },
        "kind": "azureOpenAI"
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  },
  "name": "ks-example-index",
  "description": "Description of the OneLake knowledge source.",
  "kind": "indexedOneLake",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

示例响应

状态代码:
200 
{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-example-index",
  "kind": "indexedOneLake",
  "description": "Description of the OneLake knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-5-nano"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  }
}
状态代码:
201 
{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-example-index",
  "kind": "indexedOneLake",
  "description": "Description of the OneLake knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-5-nano"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceWeb

示例请求

PUT https://exampleservice.search.windows.net/knowledgesources('ks-example-index')?api-version=2026-04-01





{
  "webParameters": {
    "domains": {
      "allowedDomains": [
        {
          "address": "example.com",
          "includeSubpages": true
        },
        {
          "address": "another-example.com"
        }
      ],
      "blockedDomains": [
        {
          "address": "blocked.com"
        },
        {
          "address": "spam.com",
          "includeSubpages": true
        }
      ]
    }
  },
  "name": "ks-example-index",
  "description": "Description of the knowledge source.",
  "kind": "web",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

示例响应

状态代码:
200 
{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-example-index",
  "kind": "web",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "webParameters": {
    "domains": {
      "allowedDomains": [
        {
          "address": "example.com",
          "includeSubpages": true
        },
        {
          "address": "another-example.com"
        }
      ],
      "blockedDomains": [
        {
          "address": "blocked.com"
        },
        {
          "address": "spam.com",
          "includeSubpages": true
        }
      ]
    }
  }
}
状态代码:
201 
{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-example-index",
  "kind": "web",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "webParameters": {
    "domains": {
      "allowedDomains": [
        {
          "address": "example.com",
          "includeSubpages": true
        },
        {
          "address": "another-example.com"
        }
      ],
      "blockedDomains": [
        {
          "address": "blocked.com"
        },
        {
          "address": "spam.com",
          "includeSubpages": true
        }
      ]
    }
  }
}

定义

名称 说明
Accept

接受（Accept）首部。
AIServices

人工智能服务的参数。
AzureBlobKnowledgeSource

Azure Blob 存储知识源的配置。
AzureBlobKnowledgeSourceParameters

Azure Blob 存储知识源的参数。
AzureOpenAIModelName

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

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

资源管理错误附加信息。
ErrorDetail

错误详细信息。
ErrorResponse

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

OneLake 知识源的配置。
IndexedOneLakeKnowledgeSourceParameters

OneLake 知识源的参数。
IndexingSchedule

表示索引器执行的计划。
KnowledgeBaseAzureOpenAIModel

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

用于查询规划的 AI 模型。
KnowledgeSourceAzureOpenAIVectorizer

指定用于矢量化查询字符串的 Azure OpenAI 资源。
KnowledgeSourceIngestionParameters

合并知识源的所有常规引入设置。
KnowledgeSourceKind

知识来源的那种。
Prefer

对于 HTTP PUT 请求，指示服务在成功时返回创建/更新的资源。
SearchIndexerDataNoneIdentity

清除数据源的标识属性。
SearchIndexerDataUserAssignedIdentity

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

搜索索引字段参考。
SearchIndexKnowledgeSource

面向搜索索引的知识源。
SearchIndexKnowledgeSourceParameters

搜索索引知识源的参数。
SearchResourceEncryptionKey

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

查询时要使用的矢量化方法。
WebKnowledgeSource

面向 Web 结果的知识源。
WebKnowledgeSourceDomain

Web 知识源域的配置。
WebKnowledgeSourceDomains

Web 知识源的域允许/阻止配置。
WebKnowledgeSourceParameters

Web 知识源的参数。

Accept

枚举

接受（Accept）首部。

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

AIServices

对象

人工智能服务的参数。

名称 类型 说明
apiKey

string

用于访问 AI 服务的 API 密钥。
uri

string (uri)

AI 服务终结点的 URI。

AzureBlobKnowledgeSource

对象

Azure Blob 存储知识源的配置。

名称 类型 说明
@odata.etag

string

知识源的ETag。
azureBlobParameters

AzureBlobKnowledgeSourceParameters

知识源的类型。
description

string

可选的用户定义描述。
encryptionKey

SearchResourceEncryptionKey

描述在 Azure 密钥保管库 中创建的加密密钥。 当你想完全确保没有人，甚至不包括Microsoft，能解密知识源定义时，这个密钥用于为知识源定义提供额外的静止加密层。 一旦你加密了知识源定义，它就会一直保持加密状态。 搜索服务将忽略将此属性设置为 null 的尝试。 如果你想旋转加密密钥，可以根据需要更改该属性;你的知识源定义将不受影响。 使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于在 2019 年 1 月 1 日或之后创建的付费服务。
kind string:

azureBlob

知识源的类型。
name

string

知识源的名称。

AzureBlobKnowledgeSourceParameters

对象

Azure Blob 存储知识源的参数。

名称 类型 默认值 说明
connectionString

string

基于密钥的连接字符串或 ResourceId 格式（如果使用托管标识）。
containerName

string

Blob 存储容器的名称。
createdResources

object

由知识源创建的资源。
folderPath

string

容器内的可选文件夹路径。
ingestionParameters

KnowledgeSourceIngestionParameters

合并所有常规引入设置。
isADLSGen2

boolean

False

如果连接到 ADLS Gen2 存储帐户，请设置为 true。 默认值为 false。

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:

用于出站连接的用户分配的托管标识。
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

错误对象。

IndexedOneLakeKnowledgeSource

对象

OneLake 知识源的配置。

名称 类型 说明
@odata.etag

string

知识源的ETag。
description

string

可选的用户定义描述。
encryptionKey

SearchResourceEncryptionKey

描述在 Azure 密钥保管库 中创建的加密密钥。 当你想完全确保没有人，甚至不包括Microsoft，能解密知识源定义时，这个密钥用于为知识源定义提供额外的静止加密层。 一旦你加密了知识源定义，它就会一直保持加密状态。 搜索服务将忽略将此属性设置为 null 的尝试。 如果你想旋转加密密钥，可以根据需要更改该属性;你的知识源定义将不受影响。 使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于在 2019 年 1 月 1 日或之后创建的付费服务。
indexedOneLakeParameters

IndexedOneLakeKnowledgeSourceParameters

知识源的参数。
kind string:

indexedOneLake

知识源的类型。
name

string

知识源的名称。

IndexedOneLakeKnowledgeSourceParameters

对象

OneLake 知识源的参数。

名称 类型 说明
createdResources

object

由知识源创建的资源。
fabricWorkspaceId

string

OneLake 工作区 ID。
ingestionParameters

KnowledgeSourceIngestionParameters

合并所有常规引入设置。
lakehouseId

string

指定要访问的 OneLake 湖屋。
targetPath

string

用于筛选 OneLake 内容的可选 OneLakehouse 文件夹或快捷方式。

IndexingSchedule

对象

表示索引器执行的计划。

名称 类型 说明
interval

string (duration)

索引器执行之间的时间间隔。
startTime

string (date-time)

索引器应开始运行的时间。

KnowledgeBaseAzureOpenAIModel

对象

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

名称 类型 说明
azureOpenAIParameters

AzureOpenAIVectorizerParameters

Azure OpenAI 参数。
kind string:

azureOpenAI

用于查询规划的 AI 模型。

KnowledgeBaseModelKind

枚举

用于查询规划的 AI 模型。

值 说明
azureOpenAI

使用 Azure Open AI 模型进行查询规划。

KnowledgeSourceAzureOpenAIVectorizer

对象

指定用于矢量化查询字符串的 Azure OpenAI 资源。

名称 类型 说明
azureOpenAIParameters

AzureOpenAIVectorizerParameters

包含特定于 Azure OpenAI 嵌入矢量化的参数。
kind string:

azureOpenAI

配置为用于向量搜索的矢量化方法的名称。

KnowledgeSourceIngestionParameters

对象

合并知识源的所有常规引入设置。

名称 类型 默认值 说明
aiServices

AIServices

用于内容处理的可选 AI 服务配置。
chatCompletionModel KnowledgeBaseModel:

KnowledgeBaseAzureOpenAIModel

用于图像语言化或上下文提取的可选聊天完成模型。
contentExtractionMode enum:
  • minimal
  • standard
minimal

可选的内容提取模式。 默认值为“最小值”。
disableImageVerbalization

boolean

False

指示是否应禁用图像语言化。 默认值为 false。
embeddingModel KnowledgeSourceVectorizer:

KnowledgeSourceAzureOpenAIVectorizer

用于矢量化内容的可选矢量化器配置。
identity SearchIndexerDataIdentity:

用于此知识源的显式标识。
ingestionSchedule

IndexingSchedule

数据摄取的可选计划。

KnowledgeSourceKind

枚举

知识来源的那种。

值 说明
searchIndex

从搜索索引中读取数据的知识源。
azureBlob

用于读取数据并将其从 Azure Blob 存储引入搜索索引的知识源。
indexedOneLake

一个读取索引 OneLake 数据的知识源。
web

一个从网络读取数据的知识源。

Prefer

枚举

对于 HTTP PUT 请求，指示服务在成功时返回创建/更新的资源。

值 说明
return=representation

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”的形式分配给搜索服务。

SearchIndexFieldReference

对象

搜索索引字段参考。

名称 类型 说明
name

string

字段的名称。

SearchIndexKnowledgeSource

对象

面向搜索索引的知识源。

名称 类型 说明
@odata.etag

string

知识源的ETag。
description

string

可选的用户定义描述。
encryptionKey

SearchResourceEncryptionKey

描述在 Azure 密钥保管库 中创建的加密密钥。 当你想完全确保没有人，甚至不包括Microsoft，能解密知识源定义时，这个密钥用于为知识源定义提供额外的静止加密层。 一旦你加密了知识源定义，它就会一直保持加密状态。 搜索服务将忽略将此属性设置为 null 的尝试。 如果你想旋转加密密钥，可以根据需要更改该属性;你的知识源定义将不受影响。 使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于在 2019 年 1 月 1 日或之后创建的付费服务。
kind string:

searchIndex

知识源的类型。
name

string

知识源的名称。
searchIndexParameters

SearchIndexKnowledgeSourceParameters

知识源的参数。

SearchIndexKnowledgeSourceParameters

对象

搜索索引知识源的参数。

名称 类型 说明
searchFields

SearchIndexFieldReference[]

用于限制在搜索索引上搜索的字段。
searchIndexName

string

搜索索引的名称。
semanticConfigurationName

string

用于在目标搜索索引上指定默认语义配置以外的其他语义配置。
sourceDataFields

SearchIndexFieldReference[]

用于请求引用源数据的其他字段。

SearchResourceEncryptionKey

对象

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

名称 类型 说明
accessCredentials.applicationId

string

向 AAD 应用程序 ID 授予对静态数据加密时要使用的 Azure 密钥保管库 所需的访问权限。 应用程序 ID 不应与 AAD 应用程序的对象 ID 混淆。
accessCredentials.applicationSecret

string

指定的 AAD 应用程序的身份验证密钥。
identity SearchIndexerDataIdentity:

用于此加密密钥的显式托管标识。 如果未指定并且访问凭据属性为 null，则使用系统分配的托管标识。 更新资源时，如果未指定显式标识，则保持不变。 如果指定了“none”，则清除此属性的值。
keyVaultKeyName

string

用于加密静态数据的 Azure 密钥保管库 密钥的名称。
keyVaultKeyVersion

string

用于加密静态数据的 Azure 密钥保管库 密钥的版本。
keyVaultUri

string

Azure 密钥保管库 的 URI（也称为 DNS 名称），其中包含用于加密静态数据的密钥。 示例 URI 可能是 https://my-keyvault-name.vault.azure.net。

VectorSearchVectorizerKind

枚举

查询时要使用的矢量化方法。

值 说明
azureOpenAI

在查询时使用 Azure OpenAI 资源生成嵌入内容。
customWebApi

在查询时使用自定义 Web 终结点生成嵌入内容。
aiServicesVision

使用 Azure AI 服务视觉矢量化 API 在查询时为图像或文本输入生成嵌入。
aml

在查询时使用通过 Azure AI Foundry 模型目录部署的 Azure 机器学习终结点生成嵌入。

WebKnowledgeSource

对象

面向 Web 结果的知识源。

名称 类型 说明
@odata.etag

string

知识源的ETag。
description

string

可选的用户定义描述。
encryptionKey

SearchResourceEncryptionKey

描述在 Azure 密钥保管库 中创建的加密密钥。 当你想完全确保没有人，甚至不包括Microsoft，能解密知识源定义时，这个密钥用于为知识源定义提供额外的静止加密层。 一旦你加密了知识源定义，它就会一直保持加密状态。 搜索服务将忽略将此属性设置为 null 的尝试。 如果你想旋转加密密钥，可以根据需要更改该属性;你的知识源定义将不受影响。 使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于在 2019 年 1 月 1 日或之后创建的付费服务。
kind string:

web

知识源的类型。
name

string

知识源的名称。
webParameters

WebKnowledgeSourceParameters

Web 知识源的参数。

WebKnowledgeSourceDomain

对象

Web 知识源域的配置。

名称 类型 说明
address

string

域的地址。
includeSubpages

boolean

是否包含来自此域的子页面。

WebKnowledgeSourceDomains

对象

Web 知识源的域允许/阻止配置。

名称 类型 说明
allowedDomains

WebKnowledgeSourceDomain[]

允许用于网页结果的域名。
blockedDomains

WebKnowledgeSourceDomain[]

被网络搜索结果屏蔽的域名。

WebKnowledgeSourceParameters

对象

Web 知识源的参数。

名称 类型 说明
domains

WebKnowledgeSourceDomains

Web 结果的域允许/阻止配置。