Knowledge Sources - Create Or Update

服務:: Search Service

API 版本:: 2026-05-01-preview

建立新的知識來源或更新知識來源（如果已存在）。

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

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string (uri)	搜尋服務的端點 URL。
sourceName	path	True	string	知識來源的名稱。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

要求標頭

名稱	必要	類型	Description
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)	要求不透明、全域唯一、用戶端產生的字串標識碼。

要求本文

要求主體可以是下列其中一項：

名稱	Description
AzureBlobKnowledgeSource	Azure Blob 儲存體知識來源的設定。
FabricDataAgentKnowledgeSource	Fabric Data Agent 知識來源的設定。
FabricOntologyKnowledgeSource	Fabric 本體的配置知識來源。
FileKnowledgeSource	支援直接檔案上傳與索引的檔案知識來源設定。
IndexedOneLakeKnowledgeSource	OneLake 知識來源的設定。
IndexedSharePointKnowledgeSource	SharePoint 知識來源的設定。
IndexedSqlKnowledgeSource	索引 SQL 知識來源的設定。
McpServerKnowledgeSource	由 MCP（模型情境協定）伺服器支援的知識來源配置。
RemoteSharePointKnowledgeSource	遠端 SharePoint 知識來源的設定。
SearchIndexKnowledgeSource	以搜尋索引為目標的知識來源。
WebKnowledgeSource	以網頁結果為目標的知識來源。
WorkIQKnowledgeSource	WorkIQ 知識來源的設定。

AzureBlobKnowledgeSource

Azure Blob 儲存體知識來源的設定。

名稱	必要	類型	Description
azureBlobParameters	True	AzureBlobKnowledgeSourceParameters	知識來源的類型。
kind	True	string: azureBlob	知識來源的類型。
name	True	string	知識來源的名稱。
@odata.etag		string	知識來源的ETag。
description		string	選用的使用者定義描述。
encryptionKey		SearchResourceEncryptionKey	您在 Azure Key Vault 中建立的加密金鑰描述。當你想要完全確定沒有人，甚至不包括 Microsoft，能解密這些資料時，這個金鑰用來為你的知識來源定義提供額外的靜態加密層級。一旦你加密了你的知識來源定義，它就會一直保持加密狀態。搜尋服務會忽略嘗試將此屬性設定為 Null。如果你想輪換加密金鑰，可以根據需要更改這個屬性;你的知識來源定義不會受到影響。使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。

FabricDataAgentKnowledgeSource

Fabric Data Agent 知識來源的設定。

名稱	必要	類型	Description
fabricDataAgentParameters	True	FabricDataAgentKnowledgeSourceParameters	Fabric Data Agent 知識來源的參數。
kind	True	string: fabricDataAgent	知識來源的類型。
name	True	string	知識來源的名稱。
@odata.etag		string	知識來源的ETag。
description		string	選用的使用者定義描述。
encryptionKey		SearchResourceEncryptionKey	您在 Azure Key Vault 中建立的加密金鑰描述。當你想要完全確定沒有人，甚至不包括 Microsoft，能解密這些資料時，這個金鑰用來為你的知識來源定義提供額外的靜態加密層級。一旦你加密了你的知識來源定義，它就會一直保持加密狀態。搜尋服務會忽略嘗試將此屬性設定為 Null。如果你想輪換加密金鑰，可以根據需要更改這個屬性;你的知識來源定義不會受到影響。使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。

FabricOntologyKnowledgeSource

Fabric 本體的配置知識來源。

名稱	必要	類型	Description
fabricOntologyParameters	True	FabricOntologyKnowledgeSourceParameters	Fabric 本體知識來源的參數。
kind	True	string: fabricOntology	知識來源的類型。
name	True	string	知識來源的名稱。
@odata.etag		string	知識來源的ETag。
description		string	選用的使用者定義描述。
encryptionKey		SearchResourceEncryptionKey	您在 Azure Key Vault 中建立的加密金鑰描述。當你想要完全確定沒有人，甚至不包括 Microsoft，能解密這些資料時，這個金鑰用來為你的知識來源定義提供額外的靜態加密層級。一旦你加密了你的知識來源定義，它就會一直保持加密狀態。搜尋服務會忽略嘗試將此屬性設定為 Null。如果你想輪換加密金鑰，可以根據需要更改這個屬性;你的知識來源定義不會受到影響。使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。

FileKnowledgeSource

支援直接檔案上傳與索引的檔案知識來源設定。

名稱	必要	類型	Description
fileParameters	True	FileKnowledgeSourceParameters	檔案知識來源的參數。
kind	True	string: file	知識來源的類型。
name	True	string	知識來源的名稱。
@odata.etag		string	知識來源的ETag。
description		string	選用的使用者定義描述。
encryptionKey		SearchResourceEncryptionKey	您在 Azure Key Vault 中建立的加密金鑰描述。當你想要完全確定沒有人，甚至不包括 Microsoft，能解密這些資料時，這個金鑰用來為你的知識來源定義提供額外的靜態加密層級。一旦你加密了你的知識來源定義，它就會一直保持加密狀態。搜尋服務會忽略嘗試將此屬性設定為 Null。如果你想輪換加密金鑰，可以根據需要更改這個屬性;你的知識來源定義不會受到影響。使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。

IndexedOneLakeKnowledgeSource

OneLake 知識來源的設定。

名稱	必要	類型	Description
indexedOneLakeParameters	True	IndexedOneLakeKnowledgeSourceParameters	知識來源的參數。
kind	True	string: indexedOneLake	知識來源的類型。
name	True	string	知識來源的名稱。
@odata.etag		string	知識來源的ETag。
description		string	選用的使用者定義描述。
encryptionKey		SearchResourceEncryptionKey	您在 Azure Key Vault 中建立的加密金鑰描述。當你想要完全確定沒有人，甚至不包括 Microsoft，能解密這些資料時，這個金鑰用來為你的知識來源定義提供額外的靜態加密層級。一旦你加密了你的知識來源定義，它就會一直保持加密狀態。搜尋服務會忽略嘗試將此屬性設定為 Null。如果你想輪換加密金鑰，可以根據需要更改這個屬性;你的知識來源定義不會受到影響。使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。

IndexedSharePointKnowledgeSource

SharePoint 知識來源的設定。

名稱	必要	類型	Description
indexedSharePointParameters	True	IndexedSharePointKnowledgeSourceParameters	知識來源的參數。
kind	True	string: indexedSharePoint	知識來源的類型。
name	True	string	知識來源的名稱。
@odata.etag		string	知識來源的ETag。
description		string	選用的使用者定義描述。
encryptionKey		SearchResourceEncryptionKey	您在 Azure Key Vault 中建立的加密金鑰描述。當你想要完全確定沒有人，甚至不包括 Microsoft，能解密這些資料時，這個金鑰用來為你的知識來源定義提供額外的靜態加密層級。一旦你加密了你的知識來源定義，它就會一直保持加密狀態。搜尋服務會忽略嘗試將此屬性設定為 Null。如果你想輪換加密金鑰，可以根據需要更改這個屬性;你的知識來源定義不會受到影響。使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。

IndexedSqlKnowledgeSource

索引 SQL 知識來源的設定。

名稱	必要	類型	Description
indexedSqlParameters	True	IndexedSqlKnowledgeSourceParameters	SQL 知識來源的參數。
kind	True	string: indexedSql	知識來源的類型。
name	True	string	知識來源的名稱。
@odata.etag		string	知識來源的ETag。
description		string	選用的使用者定義描述。
encryptionKey		SearchResourceEncryptionKey	您在 Azure Key Vault 中建立的加密金鑰描述。當你想要完全確定沒有人，甚至不包括 Microsoft，能解密這些資料時，這個金鑰用來為你的知識來源定義提供額外的靜態加密層級。一旦你加密了你的知識來源定義，它就會一直保持加密狀態。搜尋服務會忽略嘗試將此屬性設定為 Null。如果你想輪換加密金鑰，可以根據需要更改這個屬性;你的知識來源定義不會受到影響。使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。

McpServerKnowledgeSource

由 MCP（模型情境協定）伺服器支援的知識來源配置。

名稱	必要	類型	Description
kind	True	string: mcpServer	知識來源的類型。
mcpServerParameters	True	McpServerKnowledgeSourceParameters	MCP 伺服器知識來源的參數。
name	True	string	知識來源的名稱。
@odata.etag		string	知識來源的ETag。
description		string	選用的使用者定義描述。
encryptionKey		SearchResourceEncryptionKey	您在 Azure Key Vault 中建立的加密金鑰描述。當你想要完全確定沒有人，甚至不包括 Microsoft，能解密這些資料時，這個金鑰用來為你的知識來源定義提供額外的靜態加密層級。一旦你加密了你的知識來源定義，它就會一直保持加密狀態。搜尋服務會忽略嘗試將此屬性設定為 Null。如果你想輪換加密金鑰，可以根據需要更改這個屬性;你的知識來源定義不會受到影響。使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。

RemoteSharePointKnowledgeSource

遠端 SharePoint 知識來源的設定。

名稱	必要	類型	Description
kind	True	string: remoteSharePoint	知識來源的類型。
name	True	string	知識來源的名稱。
@odata.etag		string	知識來源的ETag。
description		string	選用的使用者定義描述。
encryptionKey		SearchResourceEncryptionKey	您在 Azure Key Vault 中建立的加密金鑰描述。當你想要完全確定沒有人，甚至不包括 Microsoft，能解密這些資料時，這個金鑰用來為你的知識來源定義提供額外的靜態加密層級。一旦你加密了你的知識來源定義，它就會一直保持加密狀態。搜尋服務會忽略嘗試將此屬性設定為 Null。如果你想輪換加密金鑰，可以根據需要更改這個屬性;你的知識來源定義不會受到影響。使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。
remoteSharePointParameters		RemoteSharePointKnowledgeSourceParameters	遠端 SharePoint 知識來源的參數。

SearchIndexKnowledgeSource

以搜尋索引為目標的知識來源。

名稱	必要	類型	Description
kind	True	string: searchIndex	知識來源的類型。
name	True	string	知識來源的名稱。
searchIndexParameters	True	SearchIndexKnowledgeSourceParameters	知識來源的參數。
@odata.etag		string	知識來源的ETag。
description		string	選用的使用者定義描述。
encryptionKey		SearchResourceEncryptionKey	您在 Azure Key Vault 中建立的加密金鑰描述。當你想要完全確定沒有人，甚至不包括 Microsoft，能解密這些資料時，這個金鑰用來為你的知識來源定義提供額外的靜態加密層級。一旦你加密了你的知識來源定義，它就會一直保持加密狀態。搜尋服務會忽略嘗試將此屬性設定為 Null。如果你想輪換加密金鑰，可以根據需要更改這個屬性;你的知識來源定義不會受到影響。使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。

WebKnowledgeSource

以網頁結果為目標的知識來源。

名稱	必要	類型	Description
kind	True	string: web	知識來源的類型。
name	True	string	知識來源的名稱。
@odata.etag		string	知識來源的ETag。
description		string	選用的使用者定義描述。
encryptionKey		SearchResourceEncryptionKey	您在 Azure Key Vault 中建立的加密金鑰描述。當你想要完全確定沒有人，甚至不包括 Microsoft，能解密這些資料時，這個金鑰用來為你的知識來源定義提供額外的靜態加密層級。一旦你加密了你的知識來源定義，它就會一直保持加密狀態。搜尋服務會忽略嘗試將此屬性設定為 Null。如果你想輪換加密金鑰，可以根據需要更改這個屬性;你的知識來源定義不會受到影響。使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。
webParameters		WebKnowledgeSourceParameters	Web 知識來源的參數。

WorkIQKnowledgeSource

WorkIQ 知識來源的設定。

名稱	必要	類型	Description
kind	True	string: workIQ	知識來源的類型。
name	True	string	知識來源的名稱。
@odata.etag		string	知識來源的ETag。
description		string	選用的使用者定義描述。
encryptionKey		SearchResourceEncryptionKey	您在 Azure Key Vault 中建立的加密金鑰描述。當你想要完全確定沒有人，甚至不包括 Microsoft，能解密這些資料時，這個金鑰用來為你的知識來源定義提供額外的靜態加密層級。一旦你加密了你的知識來源定義，它就會一直保持加密狀態。搜尋服務會忽略嘗試將此屬性設定為 Null。如果你想輪換加密金鑰，可以根據需要更改這個屬性;你的知識來源定義不會受到影響。使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。

回應

名稱	類型	Description
200 OK	KnowledgeSource: AzureBlobKnowledgeSource FabricDataAgentKnowledgeSource FabricOntologyKnowledgeSource FileKnowledgeSource IndexedOneLakeKnowledgeSource IndexedSharePointKnowledgeSource IndexedSqlKnowledgeSource McpServerKnowledgeSource RemoteSharePointKnowledgeSource SearchIndexKnowledgeSource WebKnowledgeSource WorkIQKnowledgeSource	要求已成功。
201 Created	KnowledgeSource: AzureBlobKnowledgeSource FabricDataAgentKnowledgeSource FabricOntologyKnowledgeSource FileKnowledgeSource IndexedOneLakeKnowledgeSource IndexedSharePointKnowledgeSource IndexedSqlKnowledgeSource McpServerKnowledgeSource RemoteSharePointKnowledgeSource SearchIndexKnowledgeSource WebKnowledgeSource WorkIQKnowledgeSource	要求已成功，因此已建立新的資源。
Other Status Codes	ErrorResponse	未預期的錯誤回應。

安全性

api-key

類型: apiKey
位於: header

OAuth2Auth

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

範圍

名稱	Description
https://search.azure.com/.default

範例

SearchServiceCreateOrUpdateKnowledgeSource

SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob

SearchServiceCreateOrUpdateKnowledgeSourceFabricDataAgent

SearchServiceCreateOrUpdateKnowledgeSourceFabricOntology

SearchServiceCreateOrUpdateKnowledgeSourceIndexedOneLake

SearchServiceCreateOrUpdateKnowledgeSourceIndexedSharePoint

SearchServiceCreateOrUpdateKnowledgeSourceMcpServer

SearchServiceCreateOrUpdateKnowledgeSourceWeb

SearchServiceCreateOrUpdateKnowledgeSourceWorkIQ

SearchServiceCreateOrUpdateKnowledgeSource

範例要求

HTTP

PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-05-01-preview





{
  "searchIndexParameters": {
    "searchIndexName": "preview-test",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ],
    "semanticConfigurationName": "testconfig"
  },
  "name": "ks-preview-test",
  "description": "Description of the knowledge source.",
  "kind": "searchIndex",
  "@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-preview-test",
  "kind": "searchIndex",
  "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>"
    }
  },
  "searchIndexParameters": {
    "searchIndexName": "preview-test",
    "semanticConfigurationName": "testconfig",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ]
  }
}

狀態碼:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "searchIndex",
  "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>"
    }
  },
  "searchIndexParameters": {
    "searchIndexName": "preview-test",
    "semanticConfigurationName": "testconfig",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ]
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob

範例要求

HTTP

PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-05-01-preview





{
  "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-4o-mini"
        },
        "kind": "azureOpenAI"
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  },
  "name": "ks-preview-test",
  "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-preview-test",
  "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,
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "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-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "createdResources": {
      "datasource": "ks-preview-test-datasource",
      "indexer": "ks-preview-test-indexer",
      "skillset": "ks-preview-test-skillset",
      "index": "ks-preview-test-index"
    }
  }
}

狀態碼:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "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,
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "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-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "createdResources": {
      "datasource": "ks-preview-test-datasource",
      "indexer": "ks-preview-test-indexer",
      "skillset": "ks-preview-test-skillset",
      "index": "ks-preview-test-index"
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceFabricDataAgent

範例要求

HTTP

PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-fabric-agent-test')?api-version=2026-05-01-preview





{
  "fabricDataAgentParameters": {
    "workspaceId": "fakeWorkspaceId",
    "dataAgentId": "fakeAgentId"
  },
  "name": "ks-fabric-agent-test",
  "description": "Description of the Fabric Data Agent knowledge source.",
  "kind": "fabricDataAgent",
  "@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-fabric-agent-test",
  "kind": "fabricDataAgent",
  "description": "Description of the Fabric Data Agent knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "fabricDataAgentParameters": {
    "workspaceId": "fakeWorkspaceId",
    "dataAgentId": "fakeAgentId"
  }
}

狀態碼:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-fabric-agent-test",
  "kind": "fabricDataAgent",
  "description": "Description of the Fabric Data Agent knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "fabricDataAgentParameters": {
    "workspaceId": "fakeWorkspaceId",
    "dataAgentId": "fakeAgentId"
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceFabricOntology

範例要求

HTTP

PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-fabricontology-test')?api-version=2026-05-01-preview





{
  "fabricOntologyParameters": {
    "workspaceId": "12345678-1234-1234-1234-123456789abc",
    "ontologyId": "ontology-456"
  },
  "name": "ks-fabricontology-test",
  "description": "Description of the Fabric Ontology knowledge source.",
  "kind": "fabricOntology",
  "@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-fabricontology-test",
  "kind": "fabricOntology",
  "description": "Description of the Fabric Ontology knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "fabricOntologyParameters": {
    "workspaceId": "12345678-1234-1234-1234-123456789abc",
    "ontologyId": "ontology-456"
  }
}

狀態碼:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-fabricontology-test",
  "kind": "fabricOntology",
  "description": "Description of the Fabric Ontology knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "fabricOntologyParameters": {
    "workspaceId": "12345678-1234-1234-1234-123456789abc",
    "ontologyId": "ontology-456"
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceIndexedOneLake

範例要求

HTTP

PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-05-01-preview





{
  "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-4o-mini"
        },
        "kind": "azureOpenAI"
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  },
  "name": "ks-preview-test",
  "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-preview-test",
  "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,
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "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-4o-mini"
        }
      },
      "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-preview-test",
  "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,
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "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-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceIndexedSharePoint

範例要求

HTTP

PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-05-01-preview





{
  "indexedSharePointParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "defaultSiteLibrary",
    "query": "*.docx OR *.pdf",
    "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-4o-mini"
        },
        "kind": "azureOpenAI"
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  },
  "name": "ks-preview-test",
  "description": "Description of the SharePoint knowledge source.",
  "kind": "indexedSharePoint",
  "@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-preview-test",
  "kind": "indexedSharePoint",
  "description": "Description of the SharePoint knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedSharePointParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "defaultSiteLibrary",
    "query": "*.docx OR *.pdf",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "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-4o-mini"
        }
      },
      "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-preview-test",
  "kind": "indexedSharePoint",
  "description": "Description of the SharePoint knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedSharePointParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "defaultSiteLibrary",
    "query": "*.docx OR *.pdf",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "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-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceMcpServer

範例要求

HTTP

PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-05-01-preview





{
  "mcpServerParameters": {
    "serverURL": "https://mcp.contoso.com/sse",
    "authentication": {
      "foundryConnectionParameters": {
        "connectionId": "conn-123"
      },
      "kind": "foundryConnection"
    },
    "tools": [
      {
        "name": "search-code",
        "outputParsing": {
          "jsonParameters": {
            "documentsPath": "$.documents[*]",
            "includeContext": true
          },
          "kind": "json"
        },
        "inclusionMode": "reranked",
        "maxOutputTokens": 4096
      }
    ]
  },
  "name": "ks-preview-test",
  "description": "Description of the MCP server knowledge source.",
  "kind": "mcpServer",
  "@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-preview-test",
  "kind": "mcpServer",
  "description": "Description of the MCP server knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "mcpServerParameters": {
    "serverURL": "https://mcp.contoso.com/sse",
    "authentication": {
      "kind": "foundryConnection",
      "foundryConnectionParameters": {
        "connectionId": "conn-123"
      }
    },
    "tools": [
      {
        "name": "search-code",
        "inclusionMode": "reranked",
        "maxOutputTokens": 4096,
        "outputParsing": {
          "kind": "json",
          "jsonParameters": {
            "documentsPath": "$.documents[*]",
            "includeContext": true
          }
        }
      }
    ]
  }
}

狀態碼:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "mcpServer",
  "description": "Description of the MCP server knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "mcpServerParameters": {
    "serverURL": "https://mcp.contoso.com/sse",
    "authentication": {
      "kind": "foundryConnection",
      "foundryConnectionParameters": {
        "connectionId": "conn-123"
      }
    },
    "tools": [
      {
        "name": "search-code",
        "inclusionMode": "reranked",
        "maxOutputTokens": 4096,
        "outputParsing": {
          "kind": "json",
          "jsonParameters": {
            "documentsPath": "$.documents[*]",
            "includeContext": true
          }
        }
      }
    ]
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceWeb

範例要求

HTTP

PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-05-01-preview





{
  "webParameters": {
    "domains": {
      "allowedDomains": [
        {
          "address": "example.com",
          "includeSubpages": true
        },
        {
          "address": "another-example.com"
        }
      ],
      "blockedDomains": [
        {
          "address": "blocked.com"
        },
        {
          "address": "spam.com",
          "includeSubpages": true
        }
      ]
    }
  },
  "name": "ks-preview-test",
  "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-preview-test",
  "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-preview-test",
  "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
        }
      ]
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceWorkIQ

範例要求

HTTP

PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-workiq-test')?api-version=2026-05-01-preview





{
  "name": "ks-workiq-test",
  "description": "Description of the WorkIQ knowledge source.",
  "kind": "workIQ",
  "@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-workiq-test",
  "kind": "workIQ",
  "description": "Description of the WorkIQ knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

狀態碼:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-workiq-test",
  "kind": "workIQ",
  "description": "Description of the WorkIQ knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

定義

名稱	Description
Accept	接受標頭。
AIServices	AI 服務的參數。
AssetStore	用於儲存擷取資產（如影像）的資產儲存設定。
AzureBlobKnowledgeSource	Azure Blob 儲存體知識來源的設定。
AzureBlobKnowledgeSourceParameters	Azure Blob 儲存體知識來源的參數。
AzureOpenAIModelName	將呼叫的 Azure Open AI 模型名稱。
AzureOpenAIVectorizerParameters	指定連線到 Azure OpenAI 資源的參數。
ContentColumnMapping	將 SQL 欄位映射到搜尋索引欄位。
EmbeddingColumnMapping	將 SQL 欄位映射到向量欄位以進行嵌入。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細資料。
ErrorResponse	所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。（這也遵循 OData 錯誤回應格式。）。
FabricDataAgentKnowledgeSource	Fabric Data Agent 知識來源的設定。
FabricDataAgentKnowledgeSourceParameters	Fabric Data Agent 知識來源的參數。
FabricOntologyKnowledgeSource	Fabric 本體的配置知識來源。
FabricOntologyKnowledgeSourceParameters	Fabric 本體論參數知識來源。
FileKnowledgeSource	支援直接檔案上傳與索引的檔案知識來源設定。
FileKnowledgeSourceParameters	檔案知識來源的參數。
FreshnessPolicy	用於新鮮度感知檢索的設定。設定後，較新的文件在檢索過程中會獲得排名提升。
IndexedOneLakeKnowledgeSource	OneLake 知識來源的設定。
IndexedOneLakeKnowledgeSourceParameters	OneLake 知識來源的參數。
IndexedSharePointContainerName	指定要存取的 SharePoint 文件庫。
IndexedSharePointKnowledgeSource	SharePoint 知識來源的設定。
IndexedSharePointKnowledgeSourceParameters	SharePoint 知識來源的參數。
IndexedSqlKnowledgeSource	索引 SQL 知識來源的設定。
IndexedSqlKnowledgeSourceParameters	索引 SQL 知識來源的參數。
IndexingSchedule	表示索引器執行的排程。
KnowledgeBaseAzureOpenAIModel	指定用來執行查詢規劃的 Azure OpenAI 資源。
KnowledgeBaseModelKind	要用於查詢規劃的 AI 模型。
KnowledgeSourceAzureOpenAIVectorizer	指定用來向量化查詢字串的 Azure OpenAI 資源。
KnowledgeSourceIngestionParameters	合併知識來源的所有一般擷取設定。
KnowledgeSourceIngestionPermissionOption	文件內容可同時擷取權限類型。
KnowledgeSourceKind	知識來源的那種。
McpServerAuthenticationKind	那是 MCP 伺服器的認證方式。
McpServerAutoOutputParsing	自動偵測輸出格式並相應解析。
McpServerFoundryConnectionAuthentication	使用 Azure AI Foundry 連線進行認證。
McpServerFoundryConnectionParameters	Foundry 連線驗證的參數。
McpServerJsonOutputParsing	用設定好的 JSON 參數，將輸出解析成 JSON 文件。
McpServerKnowledgeSource	由 MCP（模型情境協定）伺服器支援的知識來源配置。
McpServerKnowledgeSourceParameters	MCP 伺服器知識來源的參數。
McpServerNoneOutputParsing	將輸出視為單一區塊，無需解析。
McpServerOutputParsingJsonParameters	JSON 輸出解析的參數。
McpServerOutputParsingKind	那是 MCP 伺服器工具的輸出解析。
McpServerOutputParsingSplitParameters	分割輸出解析的參數。
McpServerSplitOutputParsing	用設定好的分割參數將輸出拆分成頁面。
McpServerStoredHeadersAuthentication	使用儲存的 HTTP 標頭進行認證。
McpServerStoredHeadersParameters	儲存標頭認證的參數。
McpServerTool	代表 MCP 伺服器知識來源中的單一工具。
McpServerToolInclusionMode	控制解析後的 MCP 工具結果如何整合進最終結果集。
Prefer	針對 HTTP PUT 要求，指示服務在成功時傳回建立/更新的資源。
RemoteSharePointKnowledgeSource	遠端 SharePoint 知識來源的設定。
RemoteSharePointKnowledgeSourceParameters	遠端 SharePoint 知識來源的參數。
SearchIndexerDataNoneIdentity	清除資料源的識別屬性。
SearchIndexerDataUserAssignedIdentity	指定要使用之數據源的身分識別。
SearchIndexFieldReference	搜尋索引的欄位參考。
SearchIndexKnowledgeSource	以搜尋索引為目標的知識來源。
SearchIndexKnowledgeSourceParameters	搜尋索引知識來源的參數。
SearchResourceEncryptionKey	Azure Key Vault 中客戶管理的加密密鑰。您建立和管理的金鑰可用來加密或解密靜態資料，例如索引和同義字對映。
SplitSkillLanguage	SplitSkill 支援輸入文字的語言代碼。
TextSplitMode	值，表示要執行的分割模式。
VectorSearchVectorizerKind	查詢期間要使用的向量化方法。
WebKnowledgeSource	以網頁結果為目標的知識來源。
WebKnowledgeSourceDomain	Web 知識來源網域的設定。
WebKnowledgeSourceDomains	Web 知識來源的網域允許/封鎖設定。
WebKnowledgeSourceParameters	Web 知識來源的參數。
WorkIQKnowledgeSource	WorkIQ 知識來源的設定。

Accept

列舉型別

接受標頭。

值	Description
application/json;odata.metadata=minimal

AIServices

Object

AI 服務的參數。

名稱	類型	Description
apiKey	string	用於存取 AI 服務的 API 金鑰。
uri	string (uri)	AI 服務端點的 URI。

AssetStore

Object

用於儲存擷取資產（如影像）的資產儲存設定。

名稱	類型	Description
connectionString	string	資產儲存的連接字串。
containerName	string	資產儲存中儲存擷取資產（例如圖片）的 blob 容器名稱。

AzureBlobKnowledgeSource

Object

Azure Blob 儲存體知識來源的設定。

名稱	類型	Description
@odata.etag	string	知識來源的ETag。
azureBlobParameters	AzureBlobKnowledgeSourceParameters	知識來源的類型。
description	string	選用的使用者定義描述。
encryptionKey	SearchResourceEncryptionKey	您在 Azure Key Vault 中建立的加密金鑰描述。當你想要完全確定沒有人，甚至不包括 Microsoft，能解密這些資料時，這個金鑰用來為你的知識來源定義提供額外的靜態加密層級。一旦你加密了你的知識來源定義，它就會一直保持加密狀態。搜尋服務會忽略嘗試將此屬性設定為 Null。如果你想輪換加密金鑰，可以根據需要更改這個屬性;你的知識來源定義不會受到影響。使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。
kind	string: azureBlob	知識來源的類型。
name	string	知識來源的名稱。

AzureBlobKnowledgeSourceParameters

Object

Azure Blob 儲存體知識來源的參數。

名稱	類型	預設值	Description
connectionString	string		金鑰型連接字串或 ResourceId 格式（如果使用受控識別）。
containerName	string		那個膠狀儲存容器的名字。
createdResources	object		由知識來源建立的資源。
folderPath	string		容器內的選用資料夾路徑。
ingestionParameters	KnowledgeSourceIngestionParameters		合併所有一般擷取設定。
isADLSGen2	boolean	False	如果連線到 ADLS Gen2 儲存體帳戶，請設定為 true。預設值為 false。

AzureOpenAIModelName

列舉型別

將呼叫的 Azure Open AI 模型名稱。

值	Description
text-embedding-ada-002	TextEmbeddingAda002 模型。
text-embedding-3-large	TextEmbedding3Large 模型。
text-embedding-3-small	TextEmbedding3小型模型。
gpt-4o	Gpt4o 模型。
gpt-4o-mini	Gpt4oMini 型號。
gpt-4.1	GPT41 型號。
gpt-4.1-mini	Gpt41Mini 型號。
gpt-4.1-nano	Gpt41Nano 模型。
gpt-5	GPT5 型號。
gpt-5-mini	Gpt5Mini 型號。
gpt-5-nano	Gpt5Nano 模型。
gpt-5.1	GPT51 型號。
gpt-5.2	Gpt52 型號。
gpt-5.4	GPT54 型號。
gpt-5.4-mini	Gpt54Mini 型號。
gpt-5.4-nano	Gpt54Nano 模型。
gpt-5.5	Gpt55 型號。

AzureOpenAIVectorizerParameters

Object

指定連線到 Azure OpenAI 資源的參數。

名稱	類型	Description
apiKey	string	所指定 Azure OpenAI 資源的 API 金鑰。
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	用於輸出連線的使用者指派受控識別。
deploymentId	string	指定資源上 Azure OpenAI 模型部署的識別碼。
modelName	AzureOpenAIModelName	在提供的 deploymentId 路徑上部署的內嵌模型名稱。
resourceUri	string (uri)	Azure OpenAI 資源的資源 URI。

ContentColumnMapping

Object

將 SQL 欄位映射到搜尋索引欄位。

名稱	類型	Description
name	string	目標索引欄位名稱。
searchFieldType	string	Azure AI 搜尋服務欄位類型（例如，Edm.String， Edm.Int32）.
sourceField	string	SQL 欄位名稱。

EmbeddingColumnMapping

Object

將 SQL 欄位映射到向量欄位以進行嵌入。

名稱	類型	Description
name	string	搜尋索引中的目標向量場名稱。
sourceField	string	SQL 欄位作為嵌入產生的輸入。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info		其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細資料。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤的其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳情
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。（這也遵循 OData 錯誤回應格式。）。

名稱	類型	Description
error	ErrorDetail	error 物件。

FabricDataAgentKnowledgeSource

Object

Fabric Data Agent 知識來源的設定。

名稱	類型	Description
@odata.etag	string	知識來源的ETag。
description	string	選用的使用者定義描述。
encryptionKey	SearchResourceEncryptionKey	您在 Azure Key Vault 中建立的加密金鑰描述。當你想要完全確定沒有人，甚至不包括 Microsoft，能解密這些資料時，這個金鑰用來為你的知識來源定義提供額外的靜態加密層級。一旦你加密了你的知識來源定義，它就會一直保持加密狀態。搜尋服務會忽略嘗試將此屬性設定為 Null。如果你想輪換加密金鑰，可以根據需要更改這個屬性;你的知識來源定義不會受到影響。使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。
fabricDataAgentParameters	FabricDataAgentKnowledgeSourceParameters	Fabric Data Agent 知識來源的參數。
kind	string: fabricDataAgent	知識來源的類型。
name	string	知識來源的名稱。

FabricDataAgentKnowledgeSourceParameters

Object

Fabric Data Agent 知識來源的參數。

名稱	類型	Description
dataAgentId	string	指定要存取哪個 Fabric 資料代理。
workspaceId	string	Fabric 工作區 ID。

FabricOntologyKnowledgeSource

Object

Fabric 本體的配置知識來源。

名稱	類型	Description
@odata.etag	string	知識來源的ETag。
description	string	選用的使用者定義描述。
encryptionKey	SearchResourceEncryptionKey	您在 Azure Key Vault 中建立的加密金鑰描述。當你想要完全確定沒有人，甚至不包括 Microsoft，能解密這些資料時，這個金鑰用來為你的知識來源定義提供額外的靜態加密層級。一旦你加密了你的知識來源定義，它就會一直保持加密狀態。搜尋服務會忽略嘗試將此屬性設定為 Null。如果你想輪換加密金鑰，可以根據需要更改這個屬性;你的知識來源定義不會受到影響。使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。
fabricOntologyParameters	FabricOntologyKnowledgeSourceParameters	Fabric 本體知識來源的參數。
kind	string: fabricOntology	知識來源的類型。
name	string	知識來源的名稱。

FabricOntologyKnowledgeSourceParameters

Object

Fabric 本體論參數知識來源。

名稱	類型	Description
ontologyId	string	從 Fabric 工作區使用的本體 ID。
workspaceId	string	包含本體論的 Fabric 工作空間 ID。

FileKnowledgeSource

Object

支援直接檔案上傳與索引的檔案知識來源設定。

名稱	類型	Description
@odata.etag	string	知識來源的ETag。
description	string	選用的使用者定義描述。
encryptionKey	SearchResourceEncryptionKey	您在 Azure Key Vault 中建立的加密金鑰描述。當你想要完全確定沒有人，甚至不包括 Microsoft，能解密這些資料時，這個金鑰用來為你的知識來源定義提供額外的靜態加密層級。一旦你加密了你的知識來源定義，它就會一直保持加密狀態。搜尋服務會忽略嘗試將此屬性設定為 Null。如果你想輪換加密金鑰，可以根據需要更改這個屬性;你的知識來源定義不會受到影響。使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。
fileParameters	FileKnowledgeSourceParameters	檔案知識來源的參數。
kind	string: file	知識來源的類型。
name	string	知識來源的名稱。

FileKnowledgeSourceParameters

Object

檔案知識來源的參數。

名稱	類型	Description
createdResources	object	由檔案知識來源所建立的資源。
ingestionParameters	KnowledgeSourceIngestionParameters	整合檔案知識來源的所有一般擷取設定，包括內容擷取模式及可選的 embeddingModel。

FreshnessPolicy

Object

用於新鮮度感知檢索的設定。設定後，較新的文件在檢索過程中會獲得排名提升。

名稱	類型	Description
boostingDuration	string	ISO 8601 的新鮮度提升窗口持續時間（例如「P90D」為 90 天）。超過此期限的新文件在檢索過程中會獲得排名提升。

IndexedOneLakeKnowledgeSource

Object

OneLake 知識來源的設定。

名稱	類型	Description
@odata.etag	string	知識來源的ETag。
description	string	選用的使用者定義描述。
encryptionKey	SearchResourceEncryptionKey	您在 Azure Key Vault 中建立的加密金鑰描述。當你想要完全確定沒有人，甚至不包括 Microsoft，能解密這些資料時，這個金鑰用來為你的知識來源定義提供額外的靜態加密層級。一旦你加密了你的知識來源定義，它就會一直保持加密狀態。搜尋服務會忽略嘗試將此屬性設定為 Null。如果你想輪換加密金鑰，可以根據需要更改這個屬性;你的知識來源定義不會受到影響。使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。
indexedOneLakeParameters	IndexedOneLakeKnowledgeSourceParameters	知識來源的參數。
kind	string: indexedOneLake	知識來源的類型。
name	string	知識來源的名稱。

IndexedOneLakeKnowledgeSourceParameters

Object

OneLake 知識來源的參數。

名稱	類型	Description
createdResources	object	由知識來源建立的資源。
fabricWorkspaceId	string	OneLake 工作區識別碼。
ingestionParameters	KnowledgeSourceIngestionParameters	合併所有一般擷取設定。
lakehouseId	string	指定要存取的 OneLake Lakehouse。
targetPath	string	選擇性的 OneLakehouse 資料夾或捷徑，以篩選 OneLake 內容。

IndexedSharePointContainerName

列舉型別

指定要存取的 SharePoint 文件庫。

值	Description
defaultSiteLibrary	從網站的預設文件庫中編製內容索引。
allSiteLibraries	為網站中每個文件庫的內容編製索引。
useQuery	使用查詢來篩選 SharePoint 內容。

IndexedSharePointKnowledgeSource

Object

SharePoint 知識來源的設定。

名稱	類型	Description
@odata.etag	string	知識來源的ETag。
description	string	選用的使用者定義描述。
encryptionKey	SearchResourceEncryptionKey	您在 Azure Key Vault 中建立的加密金鑰描述。當你想要完全確定沒有人，甚至不包括 Microsoft，能解密這些資料時，這個金鑰用來為你的知識來源定義提供額外的靜態加密層級。一旦你加密了你的知識來源定義，它就會一直保持加密狀態。搜尋服務會忽略嘗試將此屬性設定為 Null。如果你想輪換加密金鑰，可以根據需要更改這個屬性;你的知識來源定義不會受到影響。使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。
indexedSharePointParameters	IndexedSharePointKnowledgeSourceParameters	知識來源的參數。
kind	string: indexedSharePoint	知識來源的類型。
name	string	知識來源的名稱。

IndexedSharePointKnowledgeSourceParameters

Object

SharePoint 知識來源的參數。

名稱	類型	Description
connectionString	string	格式為 SharePoint 連接字串：SharePointOnlineEndpoint=[SharePoint 網站 URL];ApplicationId=[Azure AD 應用程式識別碼];ApplicationSecret=[Azure AD 應用程式用戶端密碼];TenantId=[SharePoint 網站租用戶識別碼]
containerName	IndexedSharePointContainerName	指定要存取的 SharePoint 文件庫。
createdResources	object	由知識來源建立的資源。
ingestionParameters	KnowledgeSourceIngestionParameters	合併所有一般擷取設定。
query	string	篩選 SharePoint 內容的選擇性查詢。

IndexedSqlKnowledgeSource

Object

索引 SQL 知識來源的設定。

名稱	類型	Description
@odata.etag	string	知識來源的ETag。
description	string	選用的使用者定義描述。
encryptionKey	SearchResourceEncryptionKey	您在 Azure Key Vault 中建立的加密金鑰描述。當你想要完全確定沒有人，甚至不包括 Microsoft，能解密這些資料時，這個金鑰用來為你的知識來源定義提供額外的靜態加密層級。一旦你加密了你的知識來源定義，它就會一直保持加密狀態。搜尋服務會忽略嘗試將此屬性設定為 Null。如果你想輪換加密金鑰，可以根據需要更改這個屬性;你的知識來源定義不會受到影響。使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。
indexedSqlParameters	IndexedSqlKnowledgeSourceParameters	SQL 知識來源的參數。
kind	string: indexedSql	知識來源的類型。
name	string	知識來源的名稱。

IndexedSqlKnowledgeSourceParameters

Object

索引 SQL 知識來源的參數。

名稱	類型	Description
connectionString	string	是 Azure SQL Database 或 SQL 受管理執行個體的連接字串。
contentColumns	ContentColumnMapping[]	內容欄位可選的欄位映射。若省略，所有欄位皆自動被發現。
createdResources	object	由知識來源建立的資源。
embeddingColumns	EmbeddingColumnMapping[]	可選的欄位映射用於嵌入向量場。若省略，則不會產生向量場。
highWaterMarkColumnName	string	可選的欄位名稱用於高水位標記變化偵測。如提供，請使用 HighWaterMarkChangeDetectionPolicy。
ingestionParameters	KnowledgeSourceIngestionParameters	整合所有一般的擷取設定，包括嵌入模型、排程與身份。
tableOrView	string	索引的表格或視圖名稱。可以是 schema-限定的（例如 'dbo.我的桌子）。

IndexingSchedule

Object

表示索引器執行的排程。

名稱	類型	Description
interval	string (duration)	索引子執行之間的時間間隔。
startTime	string (date-time)	索引子應該開始執行的時間。

KnowledgeBaseAzureOpenAIModel

Object

指定用來執行查詢規劃的 Azure OpenAI 資源。

名稱	類型	Description
azureOpenAIParameters	AzureOpenAIVectorizerParameters	Azure OpenAI 參數。
kind	string: azureOpenAI	要用於查詢規劃的 AI 模型。

KnowledgeBaseModelKind

列舉型別

要用於查詢規劃的 AI 模型。

值	Description
azureOpenAI	使用 Azure Open AI 模型進行查詢規劃。

KnowledgeSourceAzureOpenAIVectorizer

Object

指定用來向量化查詢字串的 Azure OpenAI 資源。

名稱	類型	Description
azureOpenAIParameters	AzureOpenAIVectorizerParameters	包含 Azure OpenAI 內嵌向量化的特定參數。
kind	string: azureOpenAI	要設定為與向量搜尋搭配使用的向量化方法類型的名稱。

KnowledgeSourceIngestionParameters

Object

合併知識來源的所有一般擷取設定。

名稱	類型	預設值	Description
aiServices	AIServices		用於內容處理的選用 AI 服務設定。
assetStore	AssetStore		可選的資產儲存設定用於儲存擷取的資產（如圖片）。
chatCompletionModel	KnowledgeBaseModel: KnowledgeBaseAzureOpenAIModel		可選的聊天完成模型，用於圖像語言化或上下文提取。
contentExtractionMode	enum: minimal standard	minimal	可選的內容擷取模式。預設值為「最小」。
disableImageVerbalization	boolean	False	指出是否應該停用影像語言化。預設值為 false。
embeddingModel	KnowledgeSourceVectorizer: KnowledgeSourceAzureOpenAIVectorizer		用於向量化內容的可選向量化器配置。
freshnessPolicy	FreshnessPolicy		可選的新鮮度政策，用於偏向較新文件檢索。
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		用於此知識來源的明確身分識別。
ingestionPermissionOptions	KnowledgeSourceIngestionPermissionOption[]		可選的權限類型清單，可與文件內容一起擷取。如果指定，它會設定資料來源的索引子許可權選項。
ingestionSchedule	IndexingSchedule		資料擷取的選用排程。

KnowledgeSourceIngestionPermissionOption

列舉型別

文件內容可同時擷取權限類型。

值	Description
userIds	擷取明確的使用者識別碼以及文件內容。
groupIds	擷取群組識別碼以及文件內容。
rbacScope	內嵌 RBAC 範圍資訊以及文件內容。
sensitivityLabels	將 Microsoft Purview 敏感度標籤與文件內容一併導入。

KnowledgeSourceKind

列舉型別

知識來源的那種。

值	Description
searchIndex	從搜尋索引讀取資料的知識來源。
azureBlob	從 Azure Blob 儲存體讀取資料並將其擷取至搜尋索引的知識來源。
indexedSharePoint	一個讀取索引 SharePoint 資料的知識來源。
indexedOneLake	一個讀取索引 OneLake 資料的知識來源。
indexedSql	一個知識來源，能從 Azure SQL Database 或 SQL 受管理執行個體擷取並匯入資料到搜尋索引。
web	一個能從網路讀取資料的知識來源。
remoteSharePoint	一個能從遠端 SharePoint 讀取資料的知識來源。
workIQ	一個讀取工作智商數據的知識來源
file	一個支援直接檔案上傳與索引的知識來源。
mcpServer	一個由MCP（模型情境協定）伺服器支持的知識來源。
fabricDataAgent	一個從 Fabric 資料代理擷取資料的知識來源。
fabricOntology	一個從 Microsoft Fabric 本體論中擷取資料的知識來源。

McpServerAuthenticationKind

列舉型別

那是 MCP 伺服器的認證方式。

值	Description
foundryConnection	使用 Azure AI Foundry 連線進行認證。
storedHeaders	使用儲存的 HTTP 標頭來認證。

McpServerAutoOutputParsing

Object

自動偵測輸出格式並相應解析。

名稱	類型	Description
kind	string: auto	該應用的輸出解析方式。

McpServerFoundryConnectionAuthentication

Object

使用 Azure AI Foundry 連線進行認證。

名稱	類型	Description
foundryConnectionParameters	McpServerFoundryConnectionParameters	Foundry 連線驗證的參數。
kind	string: foundryConnection	該使用的認證方式。

McpServerFoundryConnectionParameters

Object

Foundry 連線驗證的參數。

名稱	類型	Description
connectionId	string	Azure AI Foundry 連線識別碼。

McpServerJsonOutputParsing

Object

用設定好的 JSON 參數，將輸出解析成 JSON 文件。

名稱	類型	Description
jsonParameters	McpServerOutputParsingJsonParameters	JSON 輸出解析的參數。當類型為 'json' 時，必須如此。
kind	string: json	該應用的輸出解析方式。

McpServerKnowledgeSource

Object

由 MCP（模型情境協定）伺服器支援的知識來源配置。

名稱	類型	Description
@odata.etag	string	知識來源的ETag。
description	string	選用的使用者定義描述。
encryptionKey	SearchResourceEncryptionKey	您在 Azure Key Vault 中建立的加密金鑰描述。當你想要完全確定沒有人，甚至不包括 Microsoft，能解密這些資料時，這個金鑰用來為你的知識來源定義提供額外的靜態加密層級。一旦你加密了你的知識來源定義，它就會一直保持加密狀態。搜尋服務會忽略嘗試將此屬性設定為 Null。如果你想輪換加密金鑰，可以根據需要更改這個屬性;你的知識來源定義不會受到影響。使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。
kind	string: mcpServer	知識來源的類型。
mcpServerParameters	McpServerKnowledgeSourceParameters	MCP 伺服器知識來源的參數。
name	string	知識來源的名稱。

McpServerKnowledgeSourceParameters

Object

MCP 伺服器知識來源的參數。

名稱	類型	Description
authentication	McpServerAuthentication: McpServerFoundryConnectionAuthentication McpServerStoredHeadersAuthentication	MCP 伺服器的認證設定。
serverURL	string	MCP 伺服器端點的網址。
tools	McpServerTool[]	在 MCP 伺服器上呼叫的工具清單。

McpServerNoneOutputParsing

Object

將輸出視為單一區塊，無需解析。

名稱	類型	Description
kind	string: none	該應用的輸出解析方式。

McpServerOutputParsingJsonParameters

Object

JSON 輸出解析的參數。

名稱	類型	Description
documentsPath	string	工具輸出中文件陣列的 JSON 路徑。
includeContext	boolean	是否要將 JSON 輸出的相關上下文與擷取文件一同納入。

McpServerOutputParsingKind

列舉型別

那是 MCP 伺服器工具的輸出解析。

值	Description
auto	自動偵測輸出格式並相應解析。
json	用設定好的 JSON 參數，將輸出解析成 JSON 文件。
split	用設定好的分割參數將輸出拆分成頁面。
none	將輸出視為單一區塊，無需解析。

McpServerOutputParsingSplitParameters

Object

分割輸出解析的參數。

名稱	類型	Description
defaultLanguageCode	SplitSkillLanguage	值，指出要使用的語言程序代碼。預設值為 `en`。
maximumPageLength	integer (int32)	每頁最大字元數。
maximumPagesToTake	integer (int32)	從輸出中可取的最大頁數。
pageOverlapLength	integer (int32)	頁面間重疊的字元數量。
textSplitMode	TextSplitMode	使用文字分割模式。

McpServerSplitOutputParsing

Object

用設定好的分割參數將輸出拆分成頁面。

名稱	類型	Description
kind	string: split	該應用的輸出解析方式。
splitParameters	McpServerOutputParsingSplitParameters	分割輸出解析的參數。

McpServerStoredHeadersAuthentication

Object

使用儲存的 HTTP 標頭進行認證。

名稱	類型	Description
kind	string: storedHeaders	該使用的認證方式。
storedHeadersParameters	McpServerStoredHeadersParameters	儲存標頭認證的參數。

McpServerStoredHeadersParameters

Object

儲存標頭認證的參數。

名稱	類型	Description
headers	object	儲存的 HTTP 標頭，包含在 MCP 伺服器請求中。

McpServerTool

Object

代表 MCP 伺服器知識來源中的單一工具。

名稱	類型	Description
inclusionMode	McpServerToolInclusionMode	控制此工具解析結果如何整合進最終結果集。未特別說明時預設為「重新排名」。
maxOutputTokens	integer (int32)	此工具輸出可選的解析後標記上限。指定時必須大於0。
name	string	MCP 工具的名稱。
outputParsing	McpServerOutputParsing: McpServerAutoOutputParsing McpServerJsonOutputParsing McpServerNoneOutputParsing McpServerSplitOutputParsing	解析工具輸出的可選設定。

McpServerToolInclusionMode

列舉型別

控制解析後的 MCP 工具結果如何整合進最終結果集。

值	Description
reranked	工具的結果會經過重新排序與彙整流程，並結合來自其他知識來源的結果。此為預設行為。
always	工具結果可繞過重新排序，且始終包含在代理的情境中。

Prefer

列舉型別

針對 HTTP PUT 要求，指示服務在成功時傳回建立/更新的資源。

值	Description
return=representation

RemoteSharePointKnowledgeSource

Object

遠端 SharePoint 知識來源的設定。

名稱	類型	Description
@odata.etag	string	知識來源的ETag。
description	string	選用的使用者定義描述。
encryptionKey	SearchResourceEncryptionKey	您在 Azure Key Vault 中建立的加密金鑰描述。當你想要完全確定沒有人，甚至不包括 Microsoft，能解密這些資料時，這個金鑰用來為你的知識來源定義提供額外的靜態加密層級。一旦你加密了你的知識來源定義，它就會一直保持加密狀態。搜尋服務會忽略嘗試將此屬性設定為 Null。如果你想輪換加密金鑰，可以根據需要更改這個屬性;你的知識來源定義不會受到影響。使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。
kind	string: remoteSharePoint	知識來源的類型。
name	string	知識來源的名稱。
remoteSharePointParameters	RemoteSharePointKnowledgeSourceParameters	遠端 SharePoint 知識來源的參數。

RemoteSharePointKnowledgeSourceParameters

Object

遠端 SharePoint 知識來源的參數。

名稱	類型	Description
containerTypeId	string	SharePoint Embedded 連線的容器識別碼。當此值為 Null 時，它會使用 SharePoint Online。
filterExpression	string	關鍵字查詢語言（KQL）運算式，其中包含可查詢的 SharePoint 屬性和屬性，可在查詢執行之前設定擷取範圍。
resourceMetadata	string[]	要針對回應中每個專案傳回的中繼資料欄位清單。只有可擷取的中繼資料屬性才能包含在此清單中。依預設，不會傳回任何中繼資料。

SearchIndexerDataNoneIdentity

Object

清除資料源的識別屬性。

名稱	類型	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	指定身分類型的 URI 片段。

SearchIndexerDataUserAssignedIdentity

Object

指定要使用之數據源的身分識別。

名稱	類型	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	指定身分類型的 URI 片段。
federatedIdentityClientId	string	多租戶 User-Assigned 受管理身份支援：多重帳篷應用程式的用戶端 ID，已設定與使用者指派的受管理身份聯合。
userAssignedIdentity	string	使用者指派受控識別的完整 Azure 資源標識符，通常格式為 “/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId”。

SearchIndexFieldReference

Object

搜尋索引的欄位參考。

名稱	類型	Description
name	string	欄位的名稱。

SearchIndexKnowledgeSource

Object

以搜尋索引為目標的知識來源。

名稱	類型	Description
@odata.etag	string	知識來源的ETag。
description	string	選用的使用者定義描述。
encryptionKey	SearchResourceEncryptionKey	您在 Azure Key Vault 中建立的加密金鑰描述。當你想要完全確定沒有人，甚至不包括 Microsoft，能解密這些資料時，這個金鑰用來為你的知識來源定義提供額外的靜態加密層級。一旦你加密了你的知識來源定義，它就會一直保持加密狀態。搜尋服務會忽略嘗試將此屬性設定為 Null。如果你想輪換加密金鑰，可以根據需要更改這個屬性;你的知識來源定義不會受到影響。使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。
kind	string: searchIndex	知識來源的類型。
name	string	知識來源的名稱。
searchIndexParameters	SearchIndexKnowledgeSourceParameters	知識來源的參數。

SearchIndexKnowledgeSourceParameters

Object

搜尋索引知識來源的參數。

名稱	類型	Description
baseFilter	string	在擷取時對索引施加預設的過濾條件（例如「狀態等式 VA」）。可透過查詢時的知識來源執行參數覆寫。
searchFields	SearchIndexFieldReference[]	用來限制要在搜尋索引上搜尋的欄位。
searchIndexName	string	搜尋索引的名稱。
semanticConfigurationName	string	用來在目標搜尋索引上指定預設索引以外的不同語意配置。
sourceDataFields	SearchIndexFieldReference[]	用於請求參考來源資料的其他欄位。

SearchResourceEncryptionKey

Object

Azure Key Vault 中客戶管理的加密密鑰。您建立和管理的金鑰可用來加密或解密靜態資料，例如索引和同義字對映。

名稱	類型	預設值	Description
accessCredentials.applicationId	string		AAD 應用程式識別碼，已將待用數據加密時要使用的 Azure Key Vault 所需訪問許可權授與。應用程式標識碼不應與 AAD 應用程式的物件標識元混淆。
accessCredentials.applicationSecret	string		指定 AAD 應用程式的驗證金鑰。
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		要用於此加密金鑰的明確受控識別。如果未指定，且存取認證屬性為 Null，則會使用系統指派的受控識別。更新資源時，如果未指定明確識別，則會維持不變。如果指定了「none」，則會清除此屬性的值。
isServiceLevelKey	boolean	False	一個可選值，用以指示此鍵是否為服務層級鍵。預設值為 false。
keyVaultKeyName	string		要用來加密待用數據的 Azure Key Vault 金鑰名稱。
keyVaultKeyVersion	string		要用來加密待用數據的 Azure Key Vault 金鑰版本。
keyVaultUri	string		Azure Key Vault 的 URI，也稱為 DNS 名稱，其中包含用來加密待用數據的密鑰。範例 URI 可能會 `https://my-keyvault-name.vault.azure.net`。

SplitSkillLanguage

列舉型別

SplitSkill 支援輸入文字的語言代碼。

值	Description
am	阿姆哈拉語
bs	Bosnian
cs	Czech
da	丹麥語
de	德語
en	English
es	西班牙語
et	Estonian
fi	芬蘭語
fr	法語
he	希伯來文
hi	印地語
hr	克羅埃西亞語
hu	Hungarian
id	Indonesian
is	Icelandic
it	義大利語
ja	日本
ko	韓語
lv	Latvian
nb	挪威語
nl	荷蘭語
pl	波蘭語
pt	葡萄牙語（葡萄牙）
pt-br	葡萄牙語（巴西）
ru	俄語
sk	斯洛伐克語
sl	斯洛維尼亞語
sr	塞爾維亞語
sv	瑞典語
tr	土耳其語
ur	Urdu
zh	中文（簡體）

TextSplitMode

列舉型別

值，表示要執行的分割模式。

值	Description
pages	將文字分割成個別頁面。
sentences	將文字分割成個別句子。

VectorSearchVectorizerKind

列舉型別

查詢期間要使用的向量化方法。

值	Description
azureOpenAI	在查詢時使用 Azure OpenAI 資源產生內嵌。
customWebApi	在查詢時使用自定義 Web 端點產生內嵌。
aiServicesVision	使用 Azure AI 服務視覺向量化 API，在查詢時產生影像或文字輸入的內嵌。
aml	在查詢時使用透過 Azure AI Foundry 模型目錄部署的 Azure Machine Learning 端點產生內嵌。

WebKnowledgeSource

Object

以網頁結果為目標的知識來源。

名稱	類型	Description
@odata.etag	string	知識來源的ETag。
description	string	選用的使用者定義描述。
encryptionKey	SearchResourceEncryptionKey	您在 Azure Key Vault 中建立的加密金鑰描述。當你想要完全確定沒有人，甚至不包括 Microsoft，能解密這些資料時，這個金鑰用來為你的知識來源定義提供額外的靜態加密層級。一旦你加密了你的知識來源定義，它就會一直保持加密狀態。搜尋服務會忽略嘗試將此屬性設定為 Null。如果你想輪換加密金鑰，可以根據需要更改這個屬性;你的知識來源定義不會受到影響。使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。
kind	string: web	知識來源的類型。
name	string	知識來源的名稱。
webParameters	WebKnowledgeSourceParameters	Web 知識來源的參數。

WebKnowledgeSourceDomain

Object

Web 知識來源網域的設定。

名稱	類型	Description
address	string	網域的位址。
includeSubpages	boolean	是否包含此網域的子頁面。

WebKnowledgeSourceDomains

Object

Web 知識來源的網域允許/封鎖設定。

名稱	類型	Description
allowedDomains	WebKnowledgeSourceDomain[]	允許使用網路結果的網域。
blockedDomains	WebKnowledgeSourceDomain[]	被網路搜尋結果封鎖的網域。

WebKnowledgeSourceParameters

Object

Web 知識來源的參數。

名稱	類型	Description
count	integer (int32)	網路結果的預設數量。可透過查詢時的知識來源執行參數覆寫。
domains	WebKnowledgeSourceDomains	網頁結果的網域允許/封鎖設定。
freshness	string	網頁結果的預設新鮮度篩選器。可透過查詢時的知識來源執行參數覆寫。
language	string	網頁結果的預設語言。可透過查詢時的知識來源執行參數覆寫。
market	string	網路結果的預設市場。可透過查詢時的知識來源執行參數覆寫。

WorkIQKnowledgeSource

Object

WorkIQ 知識來源的設定。

名稱	類型	Description
@odata.etag	string	知識來源的ETag。
description	string	選用的使用者定義描述。
encryptionKey	SearchResourceEncryptionKey	您在 Azure Key Vault 中建立的加密金鑰描述。當你想要完全確定沒有人，甚至不包括 Microsoft，能解密這些資料時，這個金鑰用來為你的知識來源定義提供額外的靜態加密層級。一旦你加密了你的知識來源定義，它就會一直保持加密狀態。搜尋服務會忽略嘗試將此屬性設定為 Null。如果你想輪換加密金鑰，可以根據需要更改這個屬性;你的知識來源定義不會受到影響。使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。
kind	string: workIQ	知識來源的類型。
name	string	知識來源的名稱。