Knowledge Sources - Create Or Update

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

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

URI 參數

名稱 位於 必要 類型 Description
endpoint
path True

string (uri)

搜尋服務的端點 URL。

sourceName
path True

string

知識來源的名稱。

api-version
query True

string

minLength: 1

用於此作業的 API 版本。

要求標頭

名稱 必要 類型 Description
x-ms-client-request-id

string (uuid)

要求不透明、全域唯一、用戶端產生的字串標識碼。

Accept

Accept

Accept 標頭。

If-Match

string

定義 If-Match 條件。 只有在伺服器上的 ETag 符合此值時,才會執行作業。

If-None-Match

string

定義 If-None-Match 條件。 只有在伺服器上的 ETag 不符合此值時,才會執行此作業。

Prefer True

Prefer

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

要求本文

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

名稱 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 日或之後建立的付費服務。

resultsProcessing

KnowledgeSourceResultsProcessing

控制該知識來源的結果是否在納入最終結果集前重新排序。 未特別說明時預設為「重新排名」。

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 日或之後建立的付費服務。

resultsProcessing

KnowledgeSourceResultsProcessing

控制該知識來源的結果是否在納入最終結果集前重新排序。 未特別說明時預設為「重新排名」。

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 日或之後建立的付費服務。

resultsProcessing

KnowledgeSourceResultsProcessing

控制該知識來源的結果是否在納入最終結果集前重新排序。 未特別說明時預設為「重新排名」。

FileKnowledgeSource

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

名稱 必要 類型 Description
fileParameters True

FileKnowledgeSourceParameters

檔案知識來源的參數。

kind True string:

file

知識來源的類型。

name True

string

知識來源的名稱。

@odata.etag

string

知識來源的ETag。

corsOptions

CorsOptions

控制檔案知識來源檔案端點(上傳、列表、更新、刪除)的跨來源資源共享(CORS)選項。

description

string

選用的使用者定義描述。

encryptionKey

SearchResourceEncryptionKey

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

resultsProcessing

KnowledgeSourceResultsProcessing

控制該知識來源的結果是否在納入最終結果集前重新排序。 未特別說明時預設為「重新排名」。

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 日或之後建立的付費服務。

resultsProcessing

KnowledgeSourceResultsProcessing

控制該知識來源的結果是否在納入最終結果集前重新排序。 未特別說明時預設為「重新排名」。

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 日或之後建立的付費服務。

resultsProcessing

KnowledgeSourceResultsProcessing

控制該知識來源的結果是否在納入最終結果集前重新排序。 未特別說明時預設為「重新排名」。

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 日或之後建立的付費服務。

resultsProcessing

KnowledgeSourceResultsProcessing

控制該知識來源的結果是否在納入最終結果集前重新排序。 未特別說明時預設為「重新排名」。

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 日或之後建立的付費服務。

resultsProcessing

KnowledgeSourceResultsProcessing

控制該知識來源的結果是否在納入最終結果集前重新排序。 未特別說明時預設為「重新排名」。

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 知識來源的參數。

resultsProcessing

KnowledgeSourceResultsProcessing

控制該知識來源的結果是否在納入最終結果集前重新排序。 未特別說明時預設為「重新排名」。

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 日或之後建立的付費服務。

resultsProcessing

KnowledgeSourceResultsProcessing

控制該知識來源的結果是否在納入最終結果集前重新排序。 未特別說明時預設為「重新排名」。

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 日或之後建立的付費服務。

resultsProcessing

KnowledgeSourceResultsProcessing

控制該知識來源的結果是否在納入最終結果集前重新排序。 未特別說明時預設為「重新排名」。

webParameters

WebKnowledgeSourceParameters

Web 知識來源的參數。

WorkIQKnowledgeSource

WorkIQ 知識來源的設定。

名稱 必要 類型 Description
kind True string:

workIQ

知識來源的類型。

name True

string

知識來源的名稱。

workIQParameters True

WorkIQKnowledgeSourceParameters

WorkIQ 知識來源的參數,包括用於認證的客戶擁有的 Entra 應用程式設定。

@odata.etag

string

知識來源的ETag。

description

string

選用的使用者定義描述。

encryptionKey

SearchResourceEncryptionKey

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

resultsProcessing

KnowledgeSourceResultsProcessing

控制該知識來源的結果是否在納入最終結果集前重新排序。 未特別說明時預設為「重新排名」。

回覆

名稱 類型 Description
200 OK KnowledgeSource:

要求已成功。

201 Created KnowledgeSource:

要求已成功,因此已建立新的資源。

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

範例

SearchServiceAttachKnowledgeSourceGraphOntology
SearchServiceCreateOrUpdateKnowledgeSource
SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob
SearchServiceCreateOrUpdateKnowledgeSourceAzureBlobWithTopicGraphs
SearchServiceCreateOrUpdateKnowledgeSourceCompatibleResponses
SearchServiceCreateOrUpdateKnowledgeSourceFile
SearchServiceCreateOrUpdateKnowledgeSourceIndexedOneLake
SearchServiceCreateOrUpdateKnowledgeSourceIndexedSharePoint
SearchServiceCreateOrUpdateKnowledgeSourceIndexedSql
SearchServiceCreateOrUpdateKnowledgeSourceMcpServer
SearchServiceCreateOrUpdateKnowledgeSourceOpenAICompatible
SearchServiceCreateOrUpdateKnowledgeSourceWeb
SearchServiceCreateOrUpdateKnowledgeSourceWithTopicGraphs
SearchServiceCreateOrUpdateKnowledgeSourceWorkIQ

SearchServiceAttachKnowledgeSourceGraphOntology

範例要求

PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-graph-cache')?api-version=2026-11-01-preview






{
  "name": "ks-graph-cache",
  "kind": "azureBlob",
  "@odata.etag": "\"0\"",
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "isADLSGen2": false,
    "ingestionParameters": {
      "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"
        }
      },
      "disableImageVerbalization": true,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "contentExtractionMode": "minimal",
      "cache": {
        "storageConnectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "enableReprocessing": true
      }
    },
    "graphExtraction": {
      "graphName": "products",
      "ontology": {
        "kind": "inline",
        "name": "product-ontology",
        "value": "{\n  \"@context\": {\n    \"@version\": 1.1,\n    \"owl\": \"http://www.w3.org/2002/07/owl#\",\n    \"rdfs\": \"http://www.w3.org/2000/01/rdf-schema#\",\n    \"xsd\": \"http://www.w3.org/2001/XMLSchema#\",\n    \"ex\": \"https://example.com/products#\"\n  },\n  \"@graph\": [\n    { \"@id\": \"ex:Product\", \"@type\": \"owl:Class\" },\n    { \"@id\": \"ex:Category\", \"@type\": \"owl:Class\" },\n    { \"@id\": \"ex:belongsTo\", \"@type\": \"owl:ObjectProperty\",\n      \"rdfs:domain\": { \"@id\": \"ex:Product\" }, \"rdfs:range\": { \"@id\": \"ex:Category\" } }\n  ]\n}"
      }
    }
  }
}

範例回覆

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-graph-cache",
  "kind": "azureBlob",
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "isADLSGen2": false,
    "ingestionParameters": {
      "disableImageVerbalization": true,
      "contentExtractionMode": "minimal",
      "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"
      },
      "cache": {
        "enableReprocessing": true
      }
    },
    "graphExtraction": {
      "graphName": "products",
      "ontology": {
        "kind": "inline",
        "name": "product-ontology",
        "value": "{\n  \"@context\": {\n    \"@version\": 1.1,\n    \"owl\": \"http://www.w3.org/2002/07/owl#\",\n    \"rdfs\": \"http://www.w3.org/2000/01/rdf-schema#\",\n    \"xsd\": \"http://www.w3.org/2001/XMLSchema#\",\n    \"ex\": \"https://example.com/products#\"\n  },\n  \"@graph\": [\n    { \"@id\": \"ex:Product\", \"@type\": \"owl:Class\" },\n    { \"@id\": \"ex:Category\", \"@type\": \"owl:Class\" },\n    { \"@id\": \"ex:belongsTo\", \"@type\": \"owl:ObjectProperty\",\n      \"rdfs:domain\": { \"@id\": \"ex:Product\" }, \"rdfs:range\": { \"@id\": \"ex:Category\" } }\n  ]\n}"
      }
    },
    "createdResources": {
      "datasource": "ks-graph-cache-datasource",
      "indexer": "ks-graph-cache-indexer",
      "skillset": "ks-graph-cache-skillset",
      "index": "ks-graph-cache-index"
    }
  }
}
{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-graph-cache",
  "kind": "azureBlob",
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "isADLSGen2": false,
    "ingestionParameters": {
      "disableImageVerbalization": true,
      "contentExtractionMode": "minimal",
      "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"
      },
      "cache": {
        "enableReprocessing": true
      }
    },
    "graphExtraction": {
      "graphName": "products",
      "ontology": {
        "kind": "inline",
        "name": "product-ontology",
        "value": "{\n  \"@context\": {\n    \"@version\": 1.1,\n    \"owl\": \"http://www.w3.org/2002/07/owl#\",\n    \"rdfs\": \"http://www.w3.org/2000/01/rdf-schema#\",\n    \"xsd\": \"http://www.w3.org/2001/XMLSchema#\",\n    \"ex\": \"https://example.com/products#\"\n  },\n  \"@graph\": [\n    { \"@id\": \"ex:Product\", \"@type\": \"owl:Class\" },\n    { \"@id\": \"ex:Category\", \"@type\": \"owl:Class\" },\n    { \"@id\": \"ex:belongsTo\", \"@type\": \"owl:ObjectProperty\",\n      \"rdfs:domain\": { \"@id\": \"ex:Product\" }, \"rdfs:range\": { \"@id\": \"ex:Category\" } }\n  ]\n}"
      }
    },
    "createdResources": {
      "datasource": "ks-graph-cache-datasource",
      "indexer": "ks-graph-cache-indexer",
      "skillset": "ks-graph-cache-skillset",
      "index": "ks-graph-cache-index"
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSource

範例要求

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






{
  "name": "ks-preview-test",
  "description": "Description of the knowledge source.",
  "kind": "searchIndex",
  "resultsProcessing": "none",
  "@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>"
    }
  },
  "searchIndexParameters": {
    "searchIndexName": "preview-test",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ],
    "semanticConfigurationName": "testconfig",
    "baseFilter": "category eq 'news'",
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "boostInstructions": "Document language; pick from the user's locale.",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2
        }
      ]
    }
  }
}

範例回覆

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "searchIndex",
  "description": "Description of the knowledge source.",
  "resultsProcessing": "none",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "searchIndexParameters": {
    "searchIndexName": "preview-test",
    "semanticConfigurationName": "testconfig",
    "baseFilter": "category eq 'news'",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ],
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    }
  }
}
{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "searchIndex",
  "description": "Description of the knowledge source.",
  "resultsProcessing": "none",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "searchIndexParameters": {
    "searchIndexName": "preview-test",
    "semanticConfigurationName": "testconfig",
    "baseFilter": "category eq 'news'",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ],
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob

範例要求

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






{
  "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>"
    }
  },
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "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"
        }
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "ingestionPermissionOptions": [
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "freshnessPolicy": {
        "boostingDuration": "P90D"
      },
      "networkAccessMode": "private"
    }
  }
}

範例回覆

{
  "@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",
    "isServiceLevelKey": false,
    "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": [
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "networkAccessMode": "private",
      "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"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "freshnessPolicy": {
        "boostingDuration": "P90D"
      }
    },
    "createdResources": {
      "datasource": "ks-preview-test-datasource",
      "indexer": "ks-preview-test-indexer",
      "skillset": "ks-preview-test-skillset",
      "index": "ks-preview-test-index"
    }
  }
}
{
  "@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",
    "isServiceLevelKey": false,
    "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": [
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "networkAccessMode": "private",
      "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"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "freshnessPolicy": {
        "boostingDuration": "P90D"
      }
    },
    "createdResources": {
      "datasource": "ks-preview-test-datasource",
      "indexer": "ks-preview-test-indexer",
      "skillset": "ks-preview-test-skillset",
      "index": "ks-preview-test-index"
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceAzureBlobWithTopicGraphs

範例要求

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






{
  "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>"
    }
  },
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "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"
        }
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "ingestionPermissionOptions": [
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "freshnessPolicy": {
        "boostingDuration": "P90D"
      },
      "networkAccessMode": "private"
    },
    "topicGraph": {
      "kind": "diverse",
      "minDiversityPoolSize": 1000,
      "diversityFactor": 0.1
    }
  }
}

範例回覆

{
  "@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",
    "isServiceLevelKey": false,
    "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": [
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "networkAccessMode": "private",
      "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"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "freshnessPolicy": {
        "boostingDuration": "P90D"
      }
    },
    "topicGraph": {
      "kind": "diverse",
      "diversityFactor": 0.1,
      "minDiversityPoolSize": 1000
    },
    "createdResources": {
      "datasource": "ks-preview-test-datasource",
      "indexer": "ks-preview-test-indexer",
      "skillset": "ks-preview-test-skillset",
      "index": "ks-preview-test-index"
    }
  }
}
{
  "@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",
    "isServiceLevelKey": false,
    "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": [
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "networkAccessMode": "private",
      "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"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "freshnessPolicy": {
        "boostingDuration": "P90D"
      }
    },
    "topicGraph": {
      "kind": "diverse",
      "diversityFactor": 0.1,
      "minDiversityPoolSize": 1000
    },
    "createdResources": {
      "datasource": "ks-preview-test-datasource",
      "indexer": "ks-preview-test-indexer",
      "skillset": "ks-preview-test-skillset",
      "index": "ks-preview-test-index"
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceCompatibleResponses

範例要求

PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('image-documents')?api-version=2026-11-01-preview




{
  "name": "image-documents",
  "kind": "azureBlob",
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "documents",
    "ingestionParameters": {
      "chatCompletionModel": {
        "kind": "openAICompatible",
        "openAICompatibleParameters": {
          "uri": "https://model-gateway.contoso.com/teams/catalog/responses?route=primary&api-version=2026-01-01",
          "modelName": "gpt-4.1-mini",
          "headers": {
            "api-key": "test-key"
          }
        }
      },
      "disableImageVerbalization": false,
      "contentExtractionMode": "minimal"
    }
  }
}

範例回覆

{
  "name": "image-documents",
  "kind": "azureBlob",
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "documents",
    "ingestionParameters": {
      "chatCompletionModel": {
        "kind": "openAICompatible",
        "openAICompatibleParameters": {
          "uri": "https://model-gateway.contoso.com/teams/catalog/responses?route=primary&api-version=2026-01-01",
          "modelName": "gpt-4.1-mini"
        }
      },
      "disableImageVerbalization": false,
      "contentExtractionMode": "minimal"
    }
  }
}
{
  "name": "image-documents",
  "kind": "azureBlob",
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "documents",
    "ingestionParameters": {
      "chatCompletionModel": {
        "kind": "openAICompatible",
        "openAICompatibleParameters": {
          "uri": "https://model-gateway.contoso.com/teams/catalog/responses?route=primary&api-version=2026-01-01",
          "modelName": "gpt-4.1-mini"
        }
      },
      "disableImageVerbalization": false,
      "contentExtractionMode": "minimal"
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceFile

範例要求

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






{
  "name": "ks-preview-test",
  "description": "Description of the File knowledge source.",
  "kind": "file",
  "fileParameters": {
    "ingestionParameters": {
      "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"
        }
      },
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  },
  "corsOptions": {
    "allowedOrigins": [
      "https://myapp.example.com"
    ],
    "maxAgeInSeconds": 300
  }
}

範例回覆

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "file",
  "description": "Description of the File knowledge source.",
  "fileParameters": {
    "ingestionParameters": {
      "contentExtractionMode": "standard",
      "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"
        }
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "createdResources": {
      "index": "ks-preview-test-index"
    }
  },
  "corsOptions": {
    "allowedOrigins": [
      "https://myapp.example.com"
    ],
    "maxAgeInSeconds": 300
  }
}
{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "file",
  "description": "Description of the File knowledge source.",
  "fileParameters": {
    "ingestionParameters": {
      "contentExtractionMode": "standard",
      "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"
        }
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "createdResources": {
      "index": "ks-preview-test-index"
    }
  },
  "corsOptions": {
    "allowedOrigins": [
      "https://myapp.example.com"
    ],
    "maxAgeInSeconds": 300
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceIndexedOneLake

範例要求

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






{
  "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>"
    }
  },
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "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"
        }
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      }
    }
  }
}

範例回覆

{
  "@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",
    "isServiceLevelKey": false,
    "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-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  }
}
{
  "@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",
    "isServiceLevelKey": false,
    "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-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceIndexedSharePoint

範例要求

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






{
  "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>"
    }
  },
  "indexedSharePointParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "defaultSiteLibrary",
    "query": "*.docx OR *.pdf",
    "ingestionParameters": {
      "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"
        }
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds"
      ],
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "freshnessPolicy": {
        "boostingDuration": "P90D"
      }
    }
  }
}

範例回覆

{
  "@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",
    "isServiceLevelKey": false,
    "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"
      ],
      "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"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "freshnessPolicy": {
        "boostingDuration": "P90D"
      }
    }
  }
}
{
  "@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",
    "isServiceLevelKey": false,
    "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"
      ],
      "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"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "freshnessPolicy": {
        "boostingDuration": "P90D"
      }
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceIndexedSql

範例要求

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






{
  "name": "ks-preview-test",
  "description": "Description of the SQL knowledge source.",
  "kind": "indexedSql",
  "@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>"
    }
  },
  "indexedSqlParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "tableOrView": "dbo.Products",
    "contentColumns": [
      {
        "name": "title",
        "sourceField": "Title",
        "searchFieldType": "Edm.String"
      },
      {
        "name": "description",
        "sourceField": "Description",
        "searchFieldType": "Edm.String"
      },
      {
        "name": "price",
        "sourceField": "Price",
        "searchFieldType": "Edm.Double"
      }
    ],
    "embeddingColumns": [
      {
        "name": "descriptionEmbedding",
        "sourceField": "Description"
      }
    ],
    "ingestionParameters": {
      "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"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "contentExtractionMode": "minimal"
    }
  }
}

範例回覆

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "indexedSql",
  "description": "Description of the SQL 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>"
    }
  },
  "indexedSqlParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "tableOrView": "dbo.Products",
    "contentColumns": [
      {
        "name": "title",
        "sourceField": "Title",
        "searchFieldType": "Edm.String"
      },
      {
        "name": "description",
        "sourceField": "Description",
        "searchFieldType": "Edm.String"
      },
      {
        "name": "price",
        "sourceField": "Price",
        "searchFieldType": "Edm.Double"
      }
    ],
    "embeddingColumns": [
      {
        "name": "descriptionEmbedding",
        "sourceField": "Description"
      }
    ],
    "ingestionParameters": {
      "contentExtractionMode": "minimal",
      "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"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      }
    }
  }
}
{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "indexedSql",
  "description": "Description of the SQL 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>"
    }
  },
  "indexedSqlParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "tableOrView": "dbo.Products",
    "contentColumns": [
      {
        "name": "title",
        "sourceField": "Title",
        "searchFieldType": "Edm.String"
      },
      {
        "name": "description",
        "sourceField": "Description",
        "searchFieldType": "Edm.String"
      },
      {
        "name": "price",
        "sourceField": "Price",
        "searchFieldType": "Edm.Double"
      }
    ],
    "embeddingColumns": [
      {
        "name": "descriptionEmbedding",
        "sourceField": "Description"
      }
    ],
    "ingestionParameters": {
      "contentExtractionMode": "minimal",
      "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"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      }
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceMcpServer

範例要求

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






{
  "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>"
    }
  },
  "mcpServerParameters": {
    "serverURL": "https://mcp.contoso.com/sse",
    "authentication": {
      "kind": "foundryConnection",
      "foundryConnectionParameters": {
        "connectionId": "conn-123"
      }
    },
    "tools": [
      {
        "name": "search-code",
        "outputParsing": {
          "kind": "json",
          "jsonParameters": {
            "documentsPath": "$.documents[*]",
            "includeContext": true
          }
        },
        "resultsProcessing": "rerank",
        "maxOutputTokens": 4096
      }
    ]
  }
}

範例回覆

{
  "@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",
        "resultsProcessing": "rerank",
        "maxOutputTokens": 4096,
        "outputParsing": {
          "kind": "json",
          "jsonParameters": {
            "documentsPath": "$.documents[*]",
            "includeContext": true
          }
        }
      }
    ]
  }
}
{
  "@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",
        "resultsProcessing": "rerank",
        "maxOutputTokens": 4096,
        "outputParsing": {
          "kind": "json",
          "jsonParameters": {
            "documentsPath": "$.documents[*]",
            "includeContext": true
          }
        }
      }
    ]
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceOpenAICompatible

範例要求

PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('compatible-preview-file-source')?api-version=2026-11-01-preview






{
  "name": "compatible-preview-file-source",
  "description": "Description of the File knowledge source.",
  "kind": "file",
  "fileParameters": {
    "ingestionParameters": {
      "embeddingModel": {
        "kind": "openAICompatible",
        "openAICompatibleParameters": {
          "uri": "https://model-gateway.contoso.com/teams/catalog/embeddings?route=primary&api-version=2026-01-01",
          "modelName": "text-embedding-3-small",
          "dimensions": 1024,
          "headers": {
            "api-key": "EXAMPLE-NOT-A-REAL-SECRET",
            "x-route-key": "EXAMPLE-NOT-A-REAL-ROUTING-SECRET"
          }
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  },
  "corsOptions": {
    "allowedOrigins": [
      "https://myapp.example.com"
    ],
    "maxAgeInSeconds": 300
  }
}

範例回覆

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "compatible-preview-file-source",
  "kind": "file",
  "description": "Description of the File knowledge source.",
  "fileParameters": {
    "ingestionParameters": {
      "contentExtractionMode": "standard",
      "embeddingModel": {
        "kind": "openAICompatible",
        "openAICompatibleParameters": {
          "uri": "https://model-gateway.contoso.com/teams/catalog/embeddings?route=primary&api-version=2026-01-01",
          "modelName": "text-embedding-3-small",
          "dimensions": 1024
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "createdResources": {
      "index": "compatible-preview-file-source-index"
    }
  },
  "corsOptions": {
    "allowedOrigins": [
      "https://myapp.example.com"
    ],
    "maxAgeInSeconds": 300
  }
}
{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "compatible-preview-file-source",
  "kind": "file",
  "description": "Description of the File knowledge source.",
  "fileParameters": {
    "ingestionParameters": {
      "contentExtractionMode": "standard",
      "embeddingModel": {
        "kind": "openAICompatible",
        "openAICompatibleParameters": {
          "uri": "https://model-gateway.contoso.com/teams/catalog/embeddings?route=primary&api-version=2026-01-01",
          "modelName": "text-embedding-3-small",
          "dimensions": 1024
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "createdResources": {
      "index": "compatible-preview-file-source-index"
    }
  },
  "corsOptions": {
    "allowedOrigins": [
      "https://myapp.example.com"
    ],
    "maxAgeInSeconds": 300
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceWeb

範例要求

PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-11-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>"
    }
  }
}

範例回覆

{
  "@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",
    "isServiceLevelKey": false,
    "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
        }
      ]
    }
  }
}
{
  "@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",
    "isServiceLevelKey": false,
    "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
        }
      ]
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceWithTopicGraphs

範例要求

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






{
  "name": "ks-preview-test",
  "description": "Description of the knowledge source.",
  "kind": "searchIndex",
  "resultsProcessing": "none",
  "@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>"
    }
  },
  "searchIndexParameters": {
    "searchIndexName": "preview-test",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ],
    "semanticConfigurationName": "testconfig",
    "baseFilter": "category eq 'news'",
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "boostInstructions": "Document language; pick from the user's locale.",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2
        }
      ]
    },
    "topicGraph": {
      "kind": "diverse",
      "minDiversityPoolSize": 1000,
      "diversityFactor": 0.1
    }
  }
}

範例回覆

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "searchIndex",
  "description": "Description of the knowledge source.",
  "resultsProcessing": "none",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "searchIndexParameters": {
    "searchIndexName": "preview-test",
    "semanticConfigurationName": "testconfig",
    "baseFilter": "category eq 'news'",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ],
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    },
    "topicGraph": {
      "kind": "diverse",
      "diversityFactor": 0.1,
      "minDiversityPoolSize": 1000
    }
  }
}
{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "searchIndex",
  "description": "Description of the knowledge source.",
  "resultsProcessing": "none",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "searchIndexParameters": {
    "searchIndexName": "preview-test",
    "semanticConfigurationName": "testconfig",
    "baseFilter": "category eq 'news'",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ],
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    },
    "topicGraph": {
      "kind": "diverse",
      "diversityFactor": 0.1,
      "minDiversityPoolSize": 1000
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceWorkIQ

範例要求

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






{
  "name": "ks-preview-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>"
    }
  },
  "workIQParameters": {
    "entraAppAuthentication": {
      "applicationId": "11111111-1111-1111-1111-111111111111",
      "federatedCredentialId": "22222222-2222-2222-2222-222222222222"
    }
  }
}

範例回覆

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "workIQ",
  "description": "Description of the WorkIQ 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>"
    }
  },
  "workIQParameters": {
    "entraAppAuthentication": {
      "applicationId": "11111111-1111-1111-1111-111111111111",
      "federatedCredentialId": "22222222-2222-2222-2222-222222222222"
    }
  }
}
{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "workIQ",
  "description": "Description of the WorkIQ 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>"
    }
  },
  "workIQParameters": {
    "entraAppAuthentication": {
      "applicationId": "11111111-1111-1111-1111-111111111111",
      "federatedCredentialId": "22222222-2222-2222-2222-222222222222"
    }
  }
}

定義

名稱 Description
Accept

Accept 標頭。

AIServices

AI 服務的參數。

AssetStore

用於儲存擷取資產(如影像)的資產儲存設定。

AzureBlobKnowledgeSource

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

AzureBlobKnowledgeSourceParameters

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

AzureOpenAIModelName

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

AzureOpenAIVectorizerParameters

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

BalancedVectorQueryTopicGraph

將純向量相似性與多樣性感知檢索結合。 建議預設選擇在多樣性與相關性之間取得平衡。

ContentColumnMapping

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

CorsOptions

定義選項,以控制索引的跨原始來源資源分享 (CORS)。

DiverseVectorQueryTopicGraph

採用主題圖譜多樣化檢索。

EmbeddingColumnMapping

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

EntraAppAuthentication

用於聯邦憑證認證的客戶擁有 Microsoft Entra 應用程式註冊配置。

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 資源。

KnowledgeBaseMicrosoftRetriever1Model

指定用於查詢規劃與檢索的 Microsoft Retriever 1。

KnowledgeBaseModelKind

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

KnowledgeBaseOpenAICompatibleModel

指定由客戶控制的 OpenAI 相容模型,用於知識庫檢索或簡約模式知識來源影像的語言化。 在擷取時,模型設定檔會選擇聊天完成或回應。 不支援標準/CU 擷取或包含 Web 知識來源的知識庫。

KnowledgeBaseOpenAICompatibleParameters

支援 OpenAI 的聊天完成或回應端點的連線參數。 建立時必須必須設定一個非空標頭或 managedIdentityAudience。 更新可以省略標頭,以保留未變更連線與模型設定檔的憑證。

KnowledgeSourceAzureOpenAIVectorizer

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

KnowledgeSourceCache

為快取知識來源豐富化結果設定儲存空間。 需要具備 Blob 和 Table 端點的 GPv2 儲存帳戶。 快取儲存綁定與身份在建立後無法更改,且在使用圖擷取工作流程時無法移除快取。

KnowledgeSourceGraphExtractionParameters

在索引前設定從 Azure Blob 知識來源擷取圖形,並啟用原生 Blob 軟刪除功能。 不支援 ADLS Gen2、ACL 攝取及敏感標籤攝取。 不同的本體變更必須等待到尚未啟用同步時進行。

KnowledgeSourceGraphGrounding

一個用於圖擷取的接地來源。 僅支援相同服務的搜尋索引。

KnowledgeSourceGraphGroundingIndex

識別用於擷取實體的搜尋索引。

KnowledgeSourceGraphGroundingSourceKind

明確的來源類型,作為接地參考。 僅支援 searchIndex。

KnowledgeSourceGraphOntology

用於圖擷取的內嵌本體論。 唯一支援的來源是請求中直接提供的受限 JSON-LD 文件。

KnowledgeSourceGraphOntologySourceKind

本體參考的明確來源類型。 目前只支援「inline」模式。

KnowledgeSourceIngestionParameters

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

KnowledgeSourceIngestionPermissionOption

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

KnowledgeSourceKind

知識來源的那種。

KnowledgeSourceNetworkAccessMode

指定知識來源擷取的網路存取模式。 違約是「公開」。

KnowledgeSourceOpenAICompatibleVectorizer

一個相容 OpenAI 的嵌入端點,用於受管理的知識來源擷取與生成的查詢向量化。 從原生嵌入模型轉換,需要重新建立知識來源並重新索引。 URI、modelName 和尺寸在建立後無法更改。

KnowledgeSourceResultsProcessing

控制知識來源的結果是否會被重新排序。

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 伺服器知識來源中的單一工具。

NoneVectorQueryTopicGraph

使用一般向量搜尋,不使用主題圖多樣化檢索。

OpenAICompatibleVectorizerParameters

直接相容 OpenAI 嵌入端點的連線參數。 建立時必須必須設定一個非空標頭或 managedIdentityAudience。 更新可以省略標頭,以保留未變更連線與嵌入設定檔的憑證。

Prefer

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

RemoteSharePointKnowledgeSource

遠端 SharePoint 知識來源的設定。

RemoteSharePointKnowledgeSourceParameters

遠端 SharePoint 知識來源的參數。

SearchIndexerDataNoneIdentity

清除資料源的識別屬性。

SearchIndexerDataUserAssignedIdentity

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

SearchIndexFieldReference

搜尋索引的欄位參考。

SearchIndexKnowledgeSource

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

SearchIndexKnowledgeSourceBoostKind

這是搜尋索引資訊來源的提升提示。

SearchIndexKnowledgeSourceFieldValueBoost

一個提示,根據欄位值提升文件。

SearchIndexKnowledgeSourceFilterHint

一個用來識別欄位的提示,以及查詢規劃器在建立篩選條件時可以使用的詳盡基礎值。

SearchIndexKnowledgeSourceFilterHintAutoConfiguration

自動從目標索引面板解析濾鏡提示的接地值。

SearchIndexKnowledgeSourceMultiWordExpressionBoost

一個基於多字表達式提升文件的提示。

SearchIndexKnowledgeSourceParameters

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

SearchIndexKnowledgeSourceQueryHints

指引查詢規劃,為搜尋索引知識來源提供有用的篩選與提升。

SearchResourceEncryptionKey

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

SplitSkillLanguage

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

TextSplitMode

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

VectorSearchTopicGraphKind

該使用的主題圖向量搜尋類型。

VectorSearchVectorizerKind

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

WebKnowledgeSource

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

WebKnowledgeSourceDomain

Web 知識來源網域的設定。

WebKnowledgeSourceDomains

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

WebKnowledgeSourceParameters

Web 知識來源的參數。

WorkIQKnowledgeSource

WorkIQ 知識來源的設定。

WorkIQKnowledgeSourceParameters

WorkIQ 知識來源的參數。

Accept

Accept 標頭。

值 Description
application/json;odata.metadata=minimal

AIServices

AI 服務的參數。

名稱 類型 Description
apiKey

string

用於存取 AI 服務的 API 金鑰。

uri

string (uri)

AI 服務端點的 URI。

AssetStore

用於儲存擷取資產(如影像)的資產儲存設定。

名稱 類型 Description
connectionString

string

資產儲存的 連接字串。

containerName

string

資產儲存中儲存擷取資產(例如圖片)的 blob 容器名稱。

AzureBlobKnowledgeSource

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

知識來源的名稱。

resultsProcessing

KnowledgeSourceResultsProcessing

控制該知識來源的結果是否在納入最終結果集前重新排序。 未特別說明時預設為「重新排名」。

AzureBlobKnowledgeSourceParameters

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

名稱 類型 預設值 Description
connectionString

string

金鑰型連接字串或 ResourceId 格式 (如果使用受控識別)。

containerName

string

那個膠狀儲存容器的名字。

createdResources

object

由知識來源建立的資源。

folderPath

string

容器內的選用資料夾路徑。

graphExtraction

KnowledgeSourceGraphExtractionParameters

Graph extraction configuration for Azure Blob knowledge sources. 在首次索引執行前,先對來源設定原生 Blob 軟刪除。 此工作流程不支援 ADLS Gen2、ACL 匯入及敏感度標籤匯入。

ingestionParameters

KnowledgeSourceIngestionParameters

合併所有一般擷取設定。

isADLSGen2

boolean

False

如果連線到 ADLS Gen2 儲存體帳戶,請設定為 true。 預設值為 false。

topicGraph VectorQueryTopicGraph:

此 Azure Blob 知識來源的預設主題圖表向量搜尋選項。

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 型號。

gpt-5.6-sol

Gpt56Sol 模型。

gpt-5.6-terra

Gpt56Terra 型號。

gpt-5.6-luna

Gpt56Luna 型號。

gpt-6-astra

Gpt6Astra 型號。

gpt-6-sol

Gpt6Sol 模型。

gpt-6-luna

Gpt6Luna 模型。

gpt-6.1-sol

Gpt61Sol 模型。

AzureOpenAIVectorizerParameters

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

名稱 類型 Description
apiKey

string

所指定 Azure OpenAI 資源的 API 金鑰。

authIdentity SearchIndexerDataIdentity:

用於輸出連線的使用者指派受控識別。

deploymentId

string

指定資源上 Azure OpenAI 模型部署的識別碼。

modelName

AzureOpenAIModelName

在提供的 deploymentId 路徑上部署的內嵌模型名稱。

resourceUri

string (uri)

Azure OpenAI 資源的資源 URI。

BalancedVectorQueryTopicGraph

將純向量相似性與多樣性感知檢索結合。 建議預設選擇在多樣性與相關性之間取得平衡。

名稱 類型 Description
kind string:

balanced

該使用的主題圖向量搜尋類型。

minDiversityPoolSize

integer (int32)

minimum: 250
maximum: 10000

在主題圖抽樣前,需檢索的最小向量候選數量。 預設值為 1,000。

ContentColumnMapping

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

名稱 類型 Description
name

string

目標索引欄位名稱。

searchFieldType

string

Azure AI 搜尋服務 欄位類型(例如,Edm.String, Edm.Int32).

sourceField

string

SQL 欄位名稱。

CorsOptions

定義選項,以控制索引的跨原始來源資源分享 (CORS)。

名稱 類型 Description
allowedOrigins

string[]

JavaScript 程式碼將從中獲得索引存取權的來源清單。 可以包含 {protocol}://{fully-qualified-domain-name}[:{port#}] 形式的主機清單,或單一 '*' 以允許所有來源 (不建議)。

maxAgeInSeconds

integer (int64)

瀏覽器應快取 CORS 預檢回應的持續時間。 預設為 5 分鐘。

DiverseVectorQueryTopicGraph

採用主題圖譜多樣化檢索。

名稱 類型 Description
diversityFactor

number (float)

minimum: 0
maximum: 1

主題圖多樣性檢索所使用的多樣性因子。 若省略,則會使用主題圖表設定檔中預設設定的設定。

kind string:

diverse

該使用的主題圖向量搜尋類型。

minDiversityPoolSize

integer (int32)

minimum: 250
maximum: 10000

在主題圖抽樣前,需檢索的最小向量候選數量。 預設值為 1,000。

EmbeddingColumnMapping

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

名稱 類型 Description
name

string

搜尋索引中的目標向量場名稱。

sourceField

string

SQL 欄位作為嵌入產生的輸入。

EntraAppAuthentication

用於聯邦憑證認證的客戶擁有 Microsoft Entra 應用程式註冊配置。

名稱 類型 Description
applicationId

string (uuid)

客戶擁有的 Entra 應用程式註冊的應用程式(客戶端)ID。

federatedCredentialId

string (uuid)

在應用程式註冊時設定的聯邦憑證 ID,使搜尋服務能以應用程式身份進行認證,而不會儲存用戶端秘密。

tenantId

string (uuid)

App 註冊時的租戶編號。 當應用程式註冊在與搜尋服務不同的租戶時,這是必須的。 若省略,則使用搜尋服務的租戶。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱 類型 Description
info

其他資訊。

type

string

其他信息類型。

ErrorDetail

錯誤詳細資料。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤的其他資訊。

code

string

錯誤碼。

details

ErrorDetail[]

錯誤詳情

message

string

錯誤訊息。

target

string

錯誤目標。

ErrorResponse

所有 Azure Resource Manager API 的常見錯誤回應,用於回傳失敗操作的錯誤細節。 (這也遵循 OData 錯誤回應格式。)。

名稱 類型 Description
error

ErrorDetail

error 物件。

FabricDataAgentKnowledgeSource

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

知識來源的名稱。

resultsProcessing

KnowledgeSourceResultsProcessing

控制該知識來源的結果是否在納入最終結果集前重新排序。 未特別說明時預設為「重新排名」。

FabricDataAgentKnowledgeSourceParameters

Fabric Data Agent 知識來源的參數。

名稱 類型 Description
dataAgentId

string

指定要存取哪個 Fabric 資料代理。

workspaceId

string

Fabric 工作區 ID。

FabricOntologyKnowledgeSource

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

知識來源的名稱。

resultsProcessing

KnowledgeSourceResultsProcessing

控制該知識來源的結果是否在納入最終結果集前重新排序。 未特別說明時預設為「重新排名」。

FabricOntologyKnowledgeSourceParameters

Fabric 本體論參數知識來源。

名稱 類型 Description
ontologyId

string

從 Fabric 工作區使用的本體 ID。

workspaceId

string

包含本體論的 Fabric 工作空間 ID。

FileKnowledgeSource

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

名稱 類型 Description
@odata.etag

string

知識來源的ETag。

corsOptions

CorsOptions

控制檔案知識來源檔案端點(上傳、列表、更新、刪除)的跨來源資源共享(CORS)選項。

description

string

選用的使用者定義描述。

encryptionKey

SearchResourceEncryptionKey

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

fileParameters

FileKnowledgeSourceParameters

檔案知識來源的參數。

kind string:

file

知識來源的類型。

name

string

知識來源的名稱。

resultsProcessing

KnowledgeSourceResultsProcessing

控制該知識來源的結果是否在納入最終結果集前重新排序。 未特別說明時預設為「重新排名」。

FileKnowledgeSourceParameters

檔案知識來源的參數。

名稱 類型 Description
createdResources

object

由檔案知識來源所建立的資源。

ingestionParameters

KnowledgeSourceIngestionParameters

整合檔案知識來源的所有一般擷取設定,包括內容擷取模式及可選的 embeddingModel。

FreshnessPolicy

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

名稱 類型 Description
boostingDuration

string

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

IndexedOneLakeKnowledgeSource

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

知識來源的名稱。

resultsProcessing

KnowledgeSourceResultsProcessing

控制該知識來源的結果是否在納入最終結果集前重新排序。 未特別說明時預設為「重新排名」。

IndexedOneLakeKnowledgeSourceParameters

OneLake 知識來源的參數。

名稱 類型 Description
createdResources

object

由知識來源建立的資源。

fabricWorkspaceId

string

OneLake 工作區識別碼。

ingestionParameters

KnowledgeSourceIngestionParameters

合併所有一般擷取設定。

lakehouseId

string

指定要存取的 OneLake Lakehouse。

targetPath

string

選擇性的 OneLakehouse 資料夾或捷徑,以篩選 OneLake 內容。

IndexedSharePointContainerName

指定要存取的 SharePoint 文件庫。

值 Description
defaultSiteLibrary

從網站的預設文件庫中編製內容索引。

allSiteLibraries

為網站中每個文件庫的內容編製索引。

useQuery

使用查詢來篩選 SharePoint 內容。

allSiteLists

從網站中每個清單中索引內容。

allSitePages

索引網站中每個頁面的內容。

allSiteContent

索引網站中所有支援的資料庫、清單及頁面的內容。

IndexedSharePointKnowledgeSource

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

知識來源的名稱。

resultsProcessing

KnowledgeSourceResultsProcessing

控制該知識來源的結果是否在納入最終結果集前重新排序。 未特別說明時預設為「重新排名」。

IndexedSharePointKnowledgeSourceParameters

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

索引 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

知識來源的名稱。

resultsProcessing

KnowledgeSourceResultsProcessing

控制該知識來源的結果是否在納入最終結果集前重新排序。 未特別說明時預設為「重新排名」。

IndexedSqlKnowledgeSourceParameters

索引 SQL 知識來源的參數。

名稱 類型 Description
connectionString

string

是 Azure SQL Database 或 SQL 受管理執行個體 的 連接字串。

contentColumns

ContentColumnMapping[]

內容欄位可選的欄位映射。 若省略,所有欄位皆自動被發現。

createdResources

object

由知識來源建立的資源。

embeddingColumns

EmbeddingColumnMapping[]

可選的欄位映射用於嵌入向量場。 若省略,則不會產生向量場。

highWaterMarkColumnName

string

可選的欄位名稱用於高水位標記變化偵測。 如提供,請使用 HighWaterMarkChangeDetectionPolicy。

ingestionParameters

KnowledgeSourceIngestionParameters

整合所有一般的擷取設定,包括嵌入模型、排程與身份。

tableOrView

string

索引的表格或視圖名稱。 可以是 schema-限定的(例如 'dbo.我的桌子)。

IndexingSchedule

表示索引器執行的排程。

名稱 類型 Description
interval

string (duration)

索引子執行之間的時間間隔。

startTime

string (date-time)

索引子應該開始執行的時間。

KnowledgeBaseAzureOpenAIModel

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

名稱 類型 Description
azureOpenAIParameters

AzureOpenAIVectorizerParameters

Azure OpenAI 參數。

kind string:

azureOpenAI

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

KnowledgeBaseMicrosoftRetriever1Model

指定用於查詢規劃與檢索的 Microsoft Retriever 1。

名稱 類型 Description
kind string:

microsoftRetriever1

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

KnowledgeBaseModelKind

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

值 Description
azureOpenAI

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

openAICompatible

使用客戶控制的 OpenAI 相容端點來擷取知識庫或進行知識來源影像的口述化。

microsoftRetriever1

使用 Microsoft Retriever 1 進行查詢規劃與檢索。

KnowledgeBaseOpenAICompatibleModel

指定由客戶控制的 OpenAI 相容模型,用於知識庫檢索或簡約模式知識來源影像的語言化。 在擷取時,模型設定檔會選擇聊天完成或回應。 不支援標準/CU 擷取或包含 Web 知識來源的知識庫。

名稱 類型 Description
kind string:

openAICompatible

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

openAICompatibleParameters

KnowledgeBaseOpenAICompatibleParameters

OpenAI 相容端點的連線與驗證參數。

KnowledgeBaseOpenAICompatibleParameters

支援 OpenAI 的聊天完成或回應端點的連線參數。 建立時必須必須設定一個非空標頭或 managedIdentityAudience。 更新可以省略標頭,以保留未變更連線與模型設定檔的憑證。

名稱 類型 Description
authIdentity SearchIndexerDataIdentity:

用於取得 managedIdentityAudience 權杖的使用者指派管理身份。 省略使用搜尋服務系統指派的識別碼。 僅允許與 managedIdentityAudience 合作。

headers

object (password)

非空儲存的 HTTP 標頭用於端點驗證。 名稱與數值皆為機密,且永遠不會在回應中回傳。 空白地圖無效。 與 managedIdentityAudience 及 authIdentity 互斥。 更新時,省略標頭僅保留在同一資源與模型綁定上,且端點、模型設定檔及驗證身份未變;否則,請提供新的憑證。

managedIdentityAudience

string

客戶第三方 Microsoft Entra 應用程式用於管理身份驗證的純標準應用程式 GUID。 請勿包含 api:// 前綴或 /.default 後綴。 互斥且標頭。

modelName

AzureOpenAIModelName

一個支援的聊天模式名稱,用以決定搜尋的功能與限制。 對於知識來源影像的口述,此會作為請求主體中的模型選擇器傳送;URI 路徑會獨立於此名稱之外選取聊天完成或回應。 在知識庫檢索方面,GPT-6 模型檔案使用 Responses,現有模型檔案則使用 Chat Completions;端點必須支援所選協定,包括回應的無狀態工具延續。 擷取請求主體省略模型;URI 或閘道器選擇實際模型並提供所需的提供者模型識別碼。 不支援嵌入模型與任意提供者協定。

uri

string (uri)

完整的 HTTPS POST URL,包括路徑與查詢參數。 未附加路徑或 API 版本而未更改傳送;不會執行重定向。 若要擷取知識庫,端點必須接受模型檔案的聊天完成或回應協定。 對於知識來源影像的口述化,URI 路徑必須以 /chat/completions 或 /response 結尾;查詢參數不會選擇協定。

KnowledgeSourceAzureOpenAIVectorizer

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

名稱 類型 Description
azureOpenAIParameters

AzureOpenAIVectorizerParameters

包含 Azure OpenAI 內嵌向量化的特定參數。

kind string:

azureOpenAI

要設定為與向量搜尋搭配使用的向量化方法類型的名稱。

KnowledgeSourceCache

為快取知識來源豐富化結果設定儲存空間。 需要具備 Blob 和 Table 端點的 GPv2 儲存帳戶。 快取儲存綁定與身份在建立後無法更改,且在使用圖擷取工作流程時無法移除快取。

名稱 類型 預設值 Description
enableReprocessing

boolean

True

當增益設定變更時,快取的豐富化結果是否可以重新處理。 圖形擷取快取重播必須為 true。

identity SearchIndexerDataIdentity:

用於連接至豐富快取的管理識別碼。 如果省略 ResourceId 連接字串,則會使用系統指派的管理識別碼。 快取設定完成後,身份無法更改。

storageConnectionString

string (password)

儲存帳戶的 連接字串,用於儲存快取豐富化結果的儲存帳戶。

KnowledgeSourceGraphExtractionParameters

在索引前設定從 Azure Blob 知識來源擷取圖形,並啟用原生 Blob 軟刪除功能。 不支援 ADLS Gen2、ACL 攝取及敏感標籤攝取。 不同的本體變更必須等待到尚未啟用同步時進行。

名稱 類型 預設值 Description
graphName

string

要建立的圖表名稱。

grounding

KnowledgeSourceGraphGrounding

可選的接地源用於解析擷取實體。

ontology

KnowledgeSourceGraphOntology

用來擷取三元組的本體論。 若建立時缺失或為空,設定的豐富快取允許匯入產生可搜尋區塊與快取豐富,而無需擷取三元組。 一旦本體論被附加,就無法移除。 不同的本體變更必須等待到尚未啟用同步時進行。

pageDegreeOfParallelism

integer (int32)

minimum: 1
maximum: 1024
128

用於圖形擷取時,平行處理的最大頁數。

KnowledgeSourceGraphGrounding

一個用於圖擷取的接地來源。 僅支援相同服務的搜尋索引。

名稱 類型 預設值 Description
index

KnowledgeSourceGraphGroundingIndex

用於接地的同一服務搜尋索引。 搜尋索引來源必填。

kind

KnowledgeSourceGraphGroundingSourceKind

searchIndex

源頭那種。 若省略,則假設為 searchIndex。 其他類型則被拒絕。

KnowledgeSourceGraphGroundingIndex

識別用於擷取實體的搜尋索引。

名稱 類型 Description
indexName

string

接地搜尋索引的名稱。

vectorFieldName

string

在設定向量查找時,用於接地的向量場名稱。

KnowledgeSourceGraphGroundingSourceKind

明確的來源類型,作為接地參考。 僅支援 searchIndex。

值 Description
searchIndex

同一搜尋服務中的搜尋索引。

KnowledgeSourceGraphOntology

用於圖擷取的內嵌本體論。 唯一支援的來源是請求中直接提供的受限 JSON-LD 文件。

名稱 類型 Description
kind

KnowledgeSourceGraphOntologySourceKind

源頭那種。 目前只支援「inline」模式。

name

string

客戶可選的本體名稱,呼應於 graphStatistics.ontologyName。

value

string

一個受限 JSON-LD 1.1 本體文件(平面類別與物件/資料型態屬性),以 JSON 編碼的字串形式提供。

KnowledgeSourceGraphOntologySourceKind

本體參考的明確來源類型。 目前只支援「inline」模式。

值 Description
inline

本體內容以內嵌形式在請求中提供,作為受限 JSON-LD 文件。

KnowledgeSourceIngestionParameters

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

名稱 類型 預設值 Description
aiServices

AIServices

用於內容處理的選用 AI 服務設定。

assetStore

AssetStore

可選的資產儲存設定用於儲存擷取的資產(如圖片)。

cache

KnowledgeSourceCache

Enrichment cache configuration for Azure Blob graph extraction. 需要一個具備 Blob 與 Table 端點並啟用重新處理功能的 GPv2 儲存帳戶。 一旦設定完成,快取無法移除,也無法更改其儲存綁定或身份。

chatCompletionModel KnowledgeBaseModel:

可選的聊天完成模型,用於圖像語言化或上下文提取。

contentExtractionMode enum:
  • minimal
  • standard
minimal

可選的內容擷取模式。 預設值為「最小」。

disableImageVerbalization

boolean

False

指出是否應該停用影像語言化。 預設值為 false。

embeddingModel KnowledgeSourceVectorizer:

用於向量化內容的可選向量化器配置。

freshnessPolicy

FreshnessPolicy

可選的新鮮度政策,用於偏向較新文件檢索。

identity SearchIndexerDataIdentity:

用於此知識來源的明確身分識別。

ingestionPermissionOptions

KnowledgeSourceIngestionPermissionOption[]

可選的權限類型清單,可與文件內容一起擷取。 如果指定,它會設定資料來源的索引子許可權選項。

ingestionSchedule

IndexingSchedule

資料擷取的選用排程。

networkAccessMode

KnowledgeSourceNetworkAccessMode

public

可選的網路存取模式以供擷取。 設為「private」以便在私有執行環境中執行擷取,該環境能透過私有網路存取資料來源與相依性。 違約是「公開」。 這是建立時間設定,知識來源建立後無法更改。

KnowledgeSourceIngestionPermissionOption

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

值 Description
userIds

擷取明確的使用者識別碼以及文件內容。

groupIds

擷取群組識別碼以及文件內容。

rbacScope

內嵌 RBAC 範圍資訊以及文件內容。

oneLakeParentFolders

匯入 OneLake 父資料夾路徑,並對產生的索引啟用 OneLake 權限篩選。 僅支援已索引的 OneLake 知識來源。

oneLakeLakehouseId

匯入來源項目的 OneLake 湖屋 ID,並啟用 OneLake 權限篩選功能。 僅支援已索引的 OneLake 知識來源。

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 本體論中擷取資料的知識來源。

KnowledgeSourceNetworkAccessMode

指定知識來源擷取的網路存取模式。 違約是「公開」。

值 Description
public

資料擷取運行於標準且公開可存取的執行環境中。 此為預設值。

private

擷取在私有執行環境中執行,因此可以透過私有網路(私有端點/共享私有連結)存取資料來源和相依關係。

KnowledgeSourceOpenAICompatibleVectorizer

一個相容 OpenAI 的嵌入端點,用於受管理的知識來源擷取與生成的查詢向量化。 從原生嵌入模型轉換,需要重新建立知識來源並重新索引。 URI、modelName 和尺寸在建立後無法更改。

名稱 類型 Description
kind string:

openAICompatible

要設定為與向量搜尋搭配使用的向量化方法類型的名稱。

openAICompatibleParameters

OpenAICompatibleVectorizerParameters

連線、驗證及嵌入設定參數。

KnowledgeSourceResultsProcessing

控制知識來源的結果是否會被重新排序。

值 Description
rerank

這些知識來源的成果會經過重新排序的流程。 此為預設行為。

none

這些知識來源的結果可繞過重新排序,保留其底層順序。

McpServerAuthenticationKind

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

值 Description
foundryConnection

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

storedHeaders

使用儲存的 HTTP 標頭來認證。

McpServerAutoOutputParsing

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

名稱 類型 Description
kind string:

auto

該應用的輸出解析方式。

McpServerFoundryConnectionAuthentication

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

名稱 類型 Description
foundryConnectionParameters

McpServerFoundryConnectionParameters

Foundry 連線驗證的參數。

kind string:

foundryConnection

該使用的認證方式。

McpServerFoundryConnectionParameters

Foundry 連線驗證的參數。

名稱 類型 Description
connectionId

string

Azure AI Foundry 連線識別碼。

McpServerJsonOutputParsing

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

名稱 類型 Description
jsonParameters

McpServerOutputParsingJsonParameters

JSON 輸出解析的參數。 當類型為 'json' 時,必須如此。

kind string:

json

該應用的輸出解析方式。

McpServerKnowledgeSource

由 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

知識來源的名稱。

resultsProcessing

KnowledgeSourceResultsProcessing

控制該知識來源的結果是否在納入最終結果集前重新排序。 未特別說明時預設為「重新排名」。

McpServerKnowledgeSourceParameters

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

名稱 類型 Description
authentication McpServerAuthentication:

MCP 伺服器的認證設定。

serverURL

string

MCP 伺服器端點的網址。

tools

McpServerTool[]

在 MCP 伺服器上呼叫的工具清單。

McpServerNoneOutputParsing

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

名稱 類型 Description
kind string:

none

該應用的輸出解析方式。

McpServerOutputParsingJsonParameters

JSON 輸出解析的參數。

名稱 類型 Description
documentsPath

string

工具輸出中文件陣列的 JSON 路徑。

includeContext

boolean

是否要將 JSON 輸出的相關上下文與擷取文件一同納入。

McpServerOutputParsingKind

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

值 Description
auto

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

json

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

split

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

none

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

McpServerOutputParsingSplitParameters

分割輸出解析的參數。

名稱 類型 Description
defaultLanguageCode

SplitSkillLanguage

值,指出要使用的語言程序代碼。 預設值為 en。

maximumPageLength

integer (int32)

每頁最大字元數。

maximumPagesToTake

integer (int32)

從輸出中可取的最大頁數。

pageOverlapLength

integer (int32)

頁面間重疊的字元數量。

textSplitMode

TextSplitMode

使用文字分割模式。

McpServerSplitOutputParsing

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

名稱 類型 Description
kind string:

split

該應用的輸出解析方式。

splitParameters

McpServerOutputParsingSplitParameters

分割輸出解析的參數。

McpServerStoredHeadersAuthentication

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

名稱 類型 Description
kind string:

storedHeaders

該使用的認證方式。

storedHeadersParameters

McpServerStoredHeadersParameters

儲存標頭認證的參數。

McpServerStoredHeadersParameters

儲存標頭認證的參數。

名稱 類型 Description
headers

object

儲存的 HTTP 標頭,包含在 MCP 伺服器請求中。

McpServerTool

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

名稱 類型 Description
maxOutputTokens

integer (int32)

此工具輸出可選的解析後標記上限。 指定時必須大於0。

name

string

要呼叫的 MCP 工具名稱。

outputParsing McpServerOutputParsing:

解析工具輸出的可選設定。

resultsProcessing

KnowledgeSourceResultsProcessing

控制此工具解析結果是否會重新排序。 未特別說明時預設為「重新排名」。

NoneVectorQueryTopicGraph

使用一般向量搜尋,不使用主題圖多樣化檢索。

名稱 類型 Description
kind string:

none

該使用的主題圖向量搜尋類型。

OpenAICompatibleVectorizerParameters

直接相容 OpenAI 嵌入端點的連線參數。 建立時必須必須設定一個非空標頭或 managedIdentityAudience。 更新可以省略標頭,以保留未變更連線與嵌入設定檔的憑證。

名稱 類型 Description
authIdentity SearchIndexerDataIdentity:

用於取得 managedIdentityAudience 權杖的使用者指派管理身份。 省略使用搜尋服務系統指派的識別碼。 僅允許與 managedIdentityAudience 合作。

dimensions

integer (int32)

minimum: 1

輸出尺寸,必須與目標向量場相符。 text-embedding-ada-002 和 text-embedding-3-small 預設為 1536,或 text-embedding-3-large 預設為 3072。 Ada 需要 1536 版本;text-embedding-3-small 支援 1 至 1536,text-embedding-3-large 支援 1 至 3072。 在更新時保留省略的標頭需要設定的維度保持不變;省略維度與明確指定預設維度是不同的。

headers

object (password)

非空儲存的 HTTP 標頭用於端點驗證。 名稱與數值皆為機密,且永遠不會在回應中回傳。 空白地圖無效。 與 managedIdentityAudience 及 authIdentity 互斥。 更新時,省略標頭僅會保留在同一資源與向量器綁定上,前提是端點、嵌入設定檔(含已設定尺寸)及驗證身份未變;否則,請提供新的憑證。

managedIdentityAudience

string

客戶第三方 Microsoft Entra 應用程式用於管理身份驗證的純標準應用程式 GUID。 請勿包含 api:// 前綴或 /.default 後綴。 互斥且標頭。

modelName

AzureOpenAIModelName

嵌入設定檔,使用與原生 Azure OpenAI 向量器相同的模型名稱列舉。 在執行時僅支援 text-embedding-ada-002、text-embedding-3-small 與 text-embedding-3-large;共用枚舉中的聊天名稱會被拒絕。 控制搜尋的限制與預設尺寸;出站實體會省略模型,因此 URI 或閘道必須選擇實際模型。 不支援任意提供者協定。

uri

string (uri)

完整的 HTTPS 嵌入 POST URL,包括任何路徑與查詢參數。 未附加路徑或 API 版本,未更改傳送。 重定向不會被執行。

Prefer

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

值 Description
return=representation

RemoteSharePointKnowledgeSource

遠端 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 知識來源的參數。

resultsProcessing

KnowledgeSourceResultsProcessing

控制該知識來源的結果是否在納入最終結果集前重新排序。 未特別說明時預設為「重新排名」。

RemoteSharePointKnowledgeSourceParameters

遠端 SharePoint 知識來源的參數。

名稱 類型 Description
containerTypeId

string

SharePoint Embedded 連線的容器識別碼。 當此值為 Null 時,它會使用 SharePoint Online。

filterExpression

string

關鍵字查詢語言 (KQL) 運算式,其中包含可查詢的 SharePoint 屬性和屬性,可在查詢執行之前設定擷取範圍。

resourceMetadata

string[]

要針對回應中每個專案傳回的中繼資料欄位清單。 只有可擷取的中繼資料屬性才能包含在此清單中。 依預設,不會傳回任何中繼資料。

SearchIndexerDataNoneIdentity

清除資料源的識別屬性。

名稱 類型 Description
@odata.type string:

#Microsoft.Azure.Search.DataNoneIdentity

指定身分類型的 URI 片段。

SearchIndexerDataUserAssignedIdentity

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

名稱 類型 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

搜尋索引的欄位參考。

名稱 類型 Description
name

string

欄位的名稱。

SearchIndexKnowledgeSource

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

名稱 類型 Description
@odata.etag

string

知識來源的ETag。

description

string

選用的使用者定義描述。

encryptionKey

SearchResourceEncryptionKey

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

kind string:

searchIndex

知識來源的類型。

name

string

知識來源的名稱。

resultsProcessing

KnowledgeSourceResultsProcessing

控制該知識來源的結果是否在納入最終結果集前重新排序。 未特別說明時預設為「重新排名」。

searchIndexParameters

SearchIndexKnowledgeSourceParameters

知識來源的參數。

SearchIndexKnowledgeSourceBoostKind

這是搜尋索引資訊來源的提升提示。

值 Description
fieldValue

根據欄位值提升文件。

multiWordExpression

根據多詞表達式提升文件。

SearchIndexKnowledgeSourceFieldValueBoost

一個提示,根據欄位值提升文件。

名稱 類型 Description
boost

number (double)

文件分數的乘數。 必須是不等於 1.0 的正數。

boostInstructions

string

自然語言說明何時以及如何施加加成。

field

string

minLength: 1

搜尋索引欄位的名稱。

fieldValues

string[]

該場的代表性值。

kind string:

fieldValue

那種加速提示。

SearchIndexKnowledgeSourceFilterHint

一個用來識別欄位的提示,以及查詢規劃器在建立篩選條件時可以使用的詳盡基礎值。

名稱 類型 Description
autoConfiguration

SearchIndexKnowledgeSourceFilterHintAutoConfiguration

設定服務以解析欄位各面的接地值。 它的存在可啟用自動設定。 欄位必須具備可篩選性且可面式。 當目標索引啟用文件層級權限或啟用 Purview 敏感度標籤時,不支援此限制;此限制會在知識來源建立/更新及知識庫檢索時驗證。 與 fieldValues互斥。 僅支援於知識來源的儲存 queryHints,不支援請求時 queryHintOverrides。

field

string

minLength: 1

可篩選搜尋索引欄位的名稱。

fieldValues

string[]

該領域的完整數值集合。 最多 160 個值,每個值最多 128 個字元,總共 2048 個字元。 在支援 autoConfiguration的版本中,除非 autoConfiguration 另有說明且與之互斥,否則必須。

filterInstructions

string

自然語言教學,說明何時以及如何在場上篩選。

SearchIndexKnowledgeSourceFilterHintAutoConfiguration

自動從目標索引面板解析濾鏡提示的接地值。

名稱 類型 Description
cacheTtl

integer (int32)

minimum: 60
maximum: 3600

解析的分面數會被快取。 專用服務允許的範圍為 60 至 3600,無伺服器服務則為 60 至 900。 若省略,專用服務預設為 3600 秒,無伺服器服務則為 900 秒。

maxFacetValueCount

integer (int32)

minimum: 1
maximum: 64

用作接地的最大面數值。 預設為 64;允許的範圍為 1 到 64。 數值依面數由多到低排列選取,並受與手動篩選器值相同的 2048 字元合併長度限制及每值 128 字元限制。

SearchIndexKnowledgeSourceMultiWordExpressionBoost

一個基於多字表達式提升文件的提示。

名稱 類型 Description
boost

number (double)

文件分數的乘數。 必須是不等於 1.0 的正數。

boostInstructions

string

自然語言說明何時以及如何施加加成。

fieldValues

string[]

代表性的加速值。

kind string:

multiWordExpression

那種加速提示。

SearchIndexKnowledgeSourceParameters

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

名稱 類型 Description
baseFilter

string

在擷取時對索引施加預設的過濾條件(例如「狀態等式 VA」)。 可透過查詢時的知識來源執行參數覆寫。

queryHints

SearchIndexKnowledgeSourceQueryHints

預設提示,指引查詢規劃,針對此搜尋索引知識來源提供有用的篩選與提升。 請求時查詢提示會取代這些預設,成為完整物件。

searchFields

SearchIndexFieldReference[]

用來限制要在搜尋索引上搜尋的欄位。

searchIndexName

string

搜尋索引的名稱。

semanticConfigurationName

string

用來在目標搜尋索引上指定預設索引以外的不同語意配置。

sourceDataFields

SearchIndexFieldReference[]

用於請求參考來源資料的其他欄位。

topicGraph VectorQueryTopicGraph:

此搜尋索引知識來源的預設主題圖表向量搜尋選項。

SearchIndexKnowledgeSourceQueryHints

指引查詢規劃,為搜尋索引知識來源提供有用的篩選與提升。

名稱 類型 Description
boosts SearchIndexKnowledgeSourceBoost[]:

提升提示,指出查詢規劃者可用來影響文件排名的條件。

filters

SearchIndexKnowledgeSourceFilterHint[]

篩選提示,識別欄位與代表性值,查詢規劃器在構建篩選時可用。

SearchResourceEncryptionKey

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

名稱 類型 預設值 Description
accessCredentials.applicationId

string

AAD 應用程式識別碼,已將待用數據加密時要使用的 Azure Key Vault 所需訪問許可權授與。 應用程式標識碼不應與 AAD 應用程式的物件標識元混淆。

accessCredentials.applicationSecret

string

指定 AAD 應用程式的驗證金鑰。

identity SearchIndexerDataIdentity:

要用於此加密金鑰的明確受控識別。 如果未指定,且存取認證屬性為 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

Amharic

bs

Bosnian

cs

Czech

da

Danish

de

德語

en

English

es

西班牙文

et

Estonian

fi

Finnish

fr

法語

he

希伯來文

hi

印地語

hr

Croatian

hu

Hungarian

id

Indonesian

is

Icelandic

it

義大利語

ja

日本

ko

韓語

lv

Latvian

nb

挪威語

nl

荷蘭語

pl

波蘭語

pt

葡萄牙語(葡萄牙)

pt-br

葡萄牙語(巴西)

ru

俄語

sk

Slovak

sl

Slovenian

sr

塞爾維亞語

sv

Swedish

tr

Turkish

ur

Urdu

zh

中文(簡體)

TextSplitMode

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

值 Description
pages

將文字分割成個別頁面。

sentences

將文字分割成個別句子。

VectorSearchTopicGraphKind

該使用的主題圖向量搜尋類型。

值 Description
none

當主題圖的多樣化檢索失效時,請使用一般向量搜尋。

diverse

使用主題圖譜多樣化檢索。

balanced

將純向量相似性與多樣性感知檢索結合。 建議預設選擇在多樣性與相關性之間取得平衡。

VectorSearchVectorizerKind

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

值 Description
azureOpenAI

在查詢時使用 Azure OpenAI 資源產生內嵌。

openAICompatible

使用客戶控制的 OpenAI 相容嵌入端點生成嵌入。

customWebApi

在查詢時使用自定義 Web 端點產生內嵌。

aiServicesVision

使用 Azure AI 服務視覺向量化 API,在查詢時產生影像或文字輸入的內嵌。

aml

在查詢時使用透過 Azure AI Foundry 模型目錄部署的 Azure Machine Learning 端點產生內嵌。

WebKnowledgeSource

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

名稱 類型 Description
@odata.etag

string

知識來源的ETag。

description

string

選用的使用者定義描述。

encryptionKey

SearchResourceEncryptionKey

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

kind string:

web

知識來源的類型。

name

string

知識來源的名稱。

resultsProcessing

KnowledgeSourceResultsProcessing

控制該知識來源的結果是否在納入最終結果集前重新排序。 未特別說明時預設為「重新排名」。

webParameters

WebKnowledgeSourceParameters

Web 知識來源的參數。

WebKnowledgeSourceDomain

Web 知識來源網域的設定。

名稱 類型 Description
address

string

網域的位址。

includeSubpages

boolean

是否包含此網域的子頁面。

WebKnowledgeSourceDomains

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

名稱 類型 Description
allowedDomains

WebKnowledgeSourceDomain[]

允許使用網路結果的網域。

blockedDomains

WebKnowledgeSourceDomain[]

被網路搜尋結果封鎖的網域。

WebKnowledgeSourceParameters

Web 知識來源的參數。

名稱 類型 Description
count

integer (int32)

網路結果的預設數量。 可透過查詢時的知識來源執行參數覆寫。

domains

WebKnowledgeSourceDomains

網頁結果的網域允許/封鎖設定。

freshness

string

網頁結果的預設新鮮度篩選器。 可透過查詢時的知識來源執行參數覆寫。

language

string

網頁結果的預設語言。 可透過查詢時的知識來源執行參數覆寫。

market

string

網路結果的預設市場。 可透過查詢時的知識來源執行參數覆寫。

WorkIQKnowledgeSource

WorkIQ 知識來源的設定。

名稱 類型 Description
@odata.etag

string

知識來源的ETag。

description

string

選用的使用者定義描述。

encryptionKey

SearchResourceEncryptionKey

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

kind string:

workIQ

知識來源的類型。

name

string

知識來源的名稱。

resultsProcessing

KnowledgeSourceResultsProcessing

控制該知識來源的結果是否在納入最終結果集前重新排序。 未特別說明時預設為「重新排名」。

workIQParameters

WorkIQKnowledgeSourceParameters

WorkIQ 知識來源的參數,包括用於認證的客戶擁有的 Entra 應用程式設定。

WorkIQKnowledgeSourceParameters

WorkIQ 知識來源的參數。

名稱 類型 Description
entraAppAuthentication

EntraAppAuthentication

客戶擁有的 Microsoft Entra 應用程式註冊設定,用於代表 Work IQ API 進行認證。 客戶註冊一個租戶擁有的 Entra 應用程式,授予 WorkIQAgent.Ask 授權權限,並設定聯邦憑證,讓 Azure AI 搜尋服務 能以該應用程式身份認證,且不會儲存客戶端秘密。