Knowledge Sources - List

列出搜尋服務可用的所有知識來源。

GET {endpoint}/knowledgesources?api-version=2026-10-01
GET {endpoint}/knowledgesources?api-version=2026-10-01&search={search}&pageSize={pageSize}&searchType=prefix

URI 參數

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

string (uri)

搜尋服務的端點 URL。

api-version
query True

string

minLength: 1

用於此作業的 API 版本。

pageSize
query

integer (int32)

minimum: 1
maximum: 3000

單頁最多可歸還的項目數量。 伺服器會強制執行最大值;若省略,伺服器會決定適當的預設值。

search
query

string

用字串縮小列表範圍,減少需要翻頁的結果。 若省略或空串,則不進行窄化。

searchType
query

ListingSearchType

指定搜尋參數的解讀方式。 目前僅支援「前綴」。

要求標頭

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

string (uuid)

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

Accept

Accept

Accept 標頭。

回覆

名稱 類型 Description
200 OK

ListKnowledgeSourcesResult

要求已成功。

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

範例

SearchServiceListKnowledgeSources
SearchServiceListKnowledgeSourcesAzureBlob
SearchServiceListKnowledgeSourcesFile
SearchServiceListKnowledgeSourcesIndexedOneLake
SearchServiceListKnowledgeSourcesIndexedSharePoint
SearchServiceListKnowledgeSourcesIndexedSql
SearchServiceListKnowledgeSourcesWeb

SearchServiceListKnowledgeSources

範例要求

GET https://typespecstableexampleservice.search.windows.net/knowledgesources?api-version=2026-10-01&search=&pageSize=&searchType=prefix


範例回覆

{
  "value": [
    {
      "@odata.etag": "0x1234568AE7E58A1",
      "name": "ks-stable-test",
      "kind": "searchIndex",
      "description": "Description of the knowledge source.",
      "encryptionKey": {
        "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
        "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
        "keyVaultUri": "https://myKeyVault.vault.azure.net",
        "accessCredentials": {
          "applicationId": "00000000-0000-0000-0000-000000000000",
          "applicationSecret": "<applicationSecret>"
        }
      },
      "searchIndexParameters": {
        "searchIndexName": "stable-test",
        "semanticConfigurationName": "testconfig",
        "baseFilter": "category eq 'news'",
        "sourceDataFields": [
          {
            "name": "description"
          },
          {
            "name": "category"
          }
        ],
        "searchFields": [
          {
            "name": "*"
          }
        ]
      }
    }
  ]
}

SearchServiceListKnowledgeSourcesAzureBlob

範例要求

GET https://typespecstableexampleservice.search.windows.net/knowledgesources?api-version=2026-10-01&search=&pageSize=&searchType=prefix


範例回覆

{
  "value": [
    {
      "@odata.etag": "0x1234568AE7E58A1",
      "name": "ks-stable-test",
      "kind": "azureBlob",
      "description": "Description of the knowledge source.",
      "encryptionKey": {
        "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
        "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
        "keyVaultUri": "https://myKeyVault.vault.azure.net",
        "accessCredentials": {
          "applicationId": "00000000-0000-0000-0000-000000000000",
          "applicationSecret": "<applicationSecret>"
        }
      },
      "azureBlobParameters": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "test-container",
        "folderPath": "test-path",
        "isADLSGen2": false,
        "ingestionParameters": {
          "disableImageVerbalization": false,
          "ingestionPermissionOptions": [],
          "contentExtractionMode": "standard",
          "networkAccessMode": "public",
          "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": "<redacted>",
              "modelName": "text-embedding-3-large"
            }
          },
          "chatCompletionModel": {
            "kind": "azureOpenAI",
            "azureOpenAIParameters": {
              "resourceUri": "https://test-sample.openai.azure.com",
              "deploymentId": "myDeployment",
              "apiKey": "<redacted>",
              "modelName": "gpt-5-mini"
            }
          },
          "ingestionSchedule": {
            "interval": "P1D",
            "startTime": "2024-06-06T00:01:50.265Z"
          },
          "aiServices": {
            "uri": "https://my-ai-service.azure.com/",
            "apiKey": "<redacted>"
          }
        },
        "createdResources": {
          "datasource": "ks-stable-test-datasource",
          "indexer": "ks-stable-test-indexer",
          "skillset": "ks-stable-test-skillset",
          "index": "ks-stable-test-index"
        }
      }
    }
  ]
}

SearchServiceListKnowledgeSourcesFile

範例要求

GET https://typespecstableexampleservice.search.windows.net/knowledgesources?api-version=2026-10-01&search=&pageSize=&searchType=prefix


範例回覆

{
  "value": [
    {
      "@odata.etag": "0x1234568AE7E58A1",
      "name": "ks-stable-test",
      "kind": "file",
      "description": "Description of the File knowledge source.",
      "fileParameters": {
        "ingestionParameters": {
          "ingestionPermissionOptions": [],
          "contentExtractionMode": "standard",
          "embeddingModel": {
            "kind": "azureOpenAI",
            "azureOpenAIParameters": {
              "resourceUri": "https://test-sample.openai.azure.com",
              "deploymentId": "model",
              "apiKey": "<redacted>",
              "modelName": "text-embedding-3-large"
            }
          },
          "chatCompletionModel": {
            "kind": "azureOpenAI",
            "azureOpenAIParameters": {
              "resourceUri": "https://test-sample.openai.azure.com",
              "deploymentId": "myDeployment",
              "apiKey": "<redacted>",
              "modelName": "gpt-5-mini"
            }
          },
          "aiServices": {
            "uri": "https://my-ai-service.azure.com/",
            "apiKey": "<redacted>"
          }
        },
        "createdResources": {
          "index": "ks-stable-test-index"
        }
      },
      "corsOptions": {
        "allowedOrigins": [
          "https://myapp.example.com"
        ],
        "maxAgeInSeconds": 300
      }
    }
  ]
}

SearchServiceListKnowledgeSourcesIndexedOneLake

範例要求

GET https://typespecstableexampleservice.search.windows.net/knowledgesources?api-version=2026-10-01&search=&pageSize=&searchType=prefix


範例回覆

{
  "value": [
    {
      "@odata.etag": "0x1234568AE7E58A1",
      "name": "ks-stable-test",
      "kind": "indexedOneLake",
      "description": "Description of the OneLake knowledge source.",
      "encryptionKey": {
        "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
        "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
        "keyVaultUri": "https://myKeyVault.vault.azure.net",
        "accessCredentials": {
          "applicationId": "00000000-0000-0000-0000-000000000000",
          "applicationSecret": "<applicationSecret>"
        }
      },
      "indexedOneLakeParameters": {
        "fabricWorkspaceId": "<redacted>",
        "lakehouseId": "fakeLakehouseId",
        "targetPath": "testfolder",
        "ingestionParameters": {
          "disableImageVerbalization": false,
          "ingestionPermissionOptions": [],
          "contentExtractionMode": "standard",
          "networkAccessMode": "public",
          "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": "<redacted>",
              "modelName": "text-embedding-3-large"
            }
          },
          "chatCompletionModel": {
            "kind": "azureOpenAI",
            "azureOpenAIParameters": {
              "resourceUri": "https://test-sample.openai.azure.com",
              "deploymentId": "myDeployment",
              "apiKey": "<redacted>",
              "modelName": "gpt-5-mini"
            }
          },
          "ingestionSchedule": {
            "interval": "P1D",
            "startTime": "2024-06-06T00:01:50.265Z"
          },
          "aiServices": {
            "uri": "https://my-ai-service.azure.com/",
            "apiKey": "<redacted>"
          }
        },
        "createdResources": {
          "datasource": "ks-stable-test-datasource",
          "indexer": "ks-stable-test-indexer",
          "skillset": "ks-stable-test-skillset",
          "index": "ks-stable-test-index"
        }
      }
    }
  ]
}

SearchServiceListKnowledgeSourcesIndexedSharePoint

範例要求

GET https://typespecstableexampleservice.search.windows.net/knowledgesources?api-version=2026-10-01&search=&pageSize=&searchType=prefix


範例回覆

{
  "value": [
    {
      "@odata.etag": "0x1234568AE7E58A1",
      "name": "ks-stable-test",
      "kind": "indexedSharePoint",
      "description": "Description of the SharePoint knowledge source.",
      "encryptionKey": {
        "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
        "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
        "keyVaultUri": "https://myKeyVault.vault.azure.net",
        "accessCredentials": {
          "applicationId": "00000000-0000-0000-0000-000000000000",
          "applicationSecret": "<applicationSecret>"
        }
      },
      "indexedSharePointParameters": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "defaultSiteLibrary",
        "query": "*.docx OR *.pdf",
        "ingestionParameters": {
          "disableImageVerbalization": false,
          "ingestionPermissionOptions": [
            "userIds",
            "groupIds"
          ],
          "contentExtractionMode": "standard",
          "networkAccessMode": "public",
          "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": "<redacted>",
              "modelName": "text-embedding-3-large"
            }
          },
          "chatCompletionModel": {
            "kind": "azureOpenAI",
            "azureOpenAIParameters": {
              "resourceUri": "https://test-sample.openai.azure.com",
              "deploymentId": "myDeployment",
              "apiKey": "<redacted>",
              "modelName": "gpt-5-mini"
            }
          },
          "ingestionSchedule": {
            "interval": "P1D",
            "startTime": "2024-06-06T00:01:50.265Z"
          },
          "aiServices": {
            "uri": "https://my-ai-service.azure.com/",
            "apiKey": "<redacted>"
          }
        },
        "createdResources": {
          "datasource": "ks-stable-test-datasource",
          "indexer": "ks-stable-test-indexer",
          "skillset": "ks-stable-test-skillset",
          "index": "ks-stable-test-index"
        }
      }
    }
  ]
}

SearchServiceListKnowledgeSourcesIndexedSql

範例要求

GET https://typespecstableexampleservice.search.windows.net/knowledgesources?api-version=2026-10-01&search=&pageSize=&searchType=prefix


範例回覆

{
  "value": [
    {
      "@odata.etag": "0x1234568AE7E58A1",
      "name": "ks-stable-test",
      "kind": "indexedSql",
      "description": "Description of the SQL knowledge source.",
      "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": {
          "ingestionPermissionOptions": [],
          "contentExtractionMode": "minimal",
          "networkAccessMode": "public",
          "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": "<redacted>",
              "modelName": "text-embedding-3-large"
            }
          },
          "ingestionSchedule": {
            "interval": "P1D",
            "startTime": "2024-06-06T00:01:50.265Z"
          }
        },
        "createdResources": {
          "datasource": "ks-stable-test-datasource",
          "indexer": "ks-stable-test-indexer",
          "skillset": "ks-stable-test-skillset",
          "index": "ks-stable-test-index"
        }
      }
    }
  ]
}

SearchServiceListKnowledgeSourcesWeb

範例要求

GET https://exampleservice.search.windows.net/knowledgesources?api-version=2026-10-01&searchType=prefix

範例回覆

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

定義

名稱 Description
Accept

Accept 標頭。

AIServices

AI 服務的參數。

AzureBlobKnowledgeSource

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

AzureBlobKnowledgeSourceParameters

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

AzureOpenAIModelName

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

AzureOpenAIVectorizerParameters

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

ContentColumnMapping

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

CorsOptions

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

EmbeddingColumnMapping

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

ErrorAdditionalInfo

資源管理錯誤其他資訊。

ErrorDetail

錯誤詳細資料。

ErrorResponse

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

FileKnowledgeSource

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

FileKnowledgeSourceParameters

檔案知識來源的參數。

IndexedOneLakeKnowledgeSource

OneLake 知識來源的設定。

IndexedOneLakeKnowledgeSourceParameters

OneLake 知識來源的參數。

IndexedSharePointContainerName

指定要存取的 SharePoint 文件庫。

IndexedSharePointKnowledgeSource

SharePoint 知識來源的設定。

IndexedSharePointKnowledgeSourceParameters

SharePoint 知識來源的參數。

IndexedSqlKnowledgeSource

索引 SQL 知識來源的設定。

IndexedSqlKnowledgeSourceParameters

索引 SQL 知識來源的參數。

IndexingSchedule

表示索引器執行的排程。

KnowledgeBaseAzureOpenAIModel

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

KnowledgeBaseModelKind

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

KnowledgeSourceAzureOpenAIVectorizer

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

KnowledgeSourceIngestionParameters

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

KnowledgeSourceIngestionPermissionOption

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

KnowledgeSourceKind

知識來源的那種。

KnowledgeSourceNetworkAccessMode

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

ListingSearchType

指定在縮小列表結果集時如何解釋搜尋參數。 目前僅支援「前綴」。

ListKnowledgeSourcesResult

列出知識來源的結果。

SearchIndexerDataNoneIdentity

清除資料源的識別屬性。

SearchIndexerDataUserAssignedIdentity

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

SearchIndexFieldReference

搜尋索引的欄位參考。

SearchIndexKnowledgeSource

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

SearchIndexKnowledgeSourceParameters

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

SearchResourceEncryptionKey

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

VectorSearchVectorizerKind

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

WebKnowledgeSource

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

WebKnowledgeSourceDomain

Web 知識來源網域的設定。

WebKnowledgeSourceDomains

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

WebKnowledgeSourceParameters

Web 知識來源的參數。

Accept

Accept 標頭。

值 Description
application/json;odata.metadata=minimal

AIServices

AI 服務的參數。

名稱 類型 Description
apiKey

string

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

uri

string (uri)

AI 服務端點的 URI。

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

知識來源的名稱。

AzureBlobKnowledgeSourceParameters

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

名稱 類型 預設值 Description
connectionString

string

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

containerName

string

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

createdResources

object

由知識來源建立的資源。

folderPath

string

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

ingestionParameters

KnowledgeSourceIngestionParameters

合併所有一般擷取設定。

isADLSGen2

boolean

False

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

AzureOpenAIModelName

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

值 Description
text-embedding-ada-002

TextEmbeddingAda002 模型。

text-embedding-3-large

TextEmbedding3Large 模型。

text-embedding-3-small

TextEmbedding3小型模型。

gpt-5-mini

Gpt5Mini 型號。

gpt-5-nano

Gpt5Nano 模型。

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

AzureOpenAIVectorizerParameters

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

名稱 類型 Description
apiKey

string

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

authIdentity SearchIndexerDataIdentity:

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

deploymentId

string

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

modelName

AzureOpenAIModelName

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

resourceUri

string (uri)

Azure OpenAI 資源的資源 URI。

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 分鐘。

EmbeddingColumnMapping

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

名稱 類型 Description
name

string

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

sourceField

string

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

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 物件。

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

知識來源的名稱。

FileKnowledgeSourceParameters

檔案知識來源的參數。

名稱 類型 Description
createdResources

object

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

ingestionParameters

KnowledgeSourceIngestionParameters

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

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

知識來源的名稱。

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

知識來源的名稱。

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

知識來源的名稱。

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

KnowledgeBaseModelKind

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

值 Description
azureOpenAI

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

KnowledgeSourceAzureOpenAIVectorizer

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

名稱 類型 Description
azureOpenAIParameters

AzureOpenAIVectorizerParameters

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

kind string:

azureOpenAI

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

KnowledgeSourceIngestionParameters

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

名稱 類型 預設值 Description
aiServices

AIServices

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

chatCompletionModel KnowledgeBaseModel:

KnowledgeBaseAzureOpenAIModel

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

contentExtractionMode enum:
  • minimal
  • standard
minimal

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

disableImageVerbalization

boolean

False

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

embeddingModel KnowledgeSourceVectorizer:

KnowledgeSourceAzureOpenAIVectorizer

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

identity SearchIndexerDataIdentity:

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

ingestionPermissionOptions

KnowledgeSourceIngestionPermissionOption[]

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

ingestionSchedule

IndexingSchedule

資料擷取的選用排程。

networkAccessMode

KnowledgeSourceNetworkAccessMode

public

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

KnowledgeSourceIngestionPermissionOption

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

值 Description
userIds

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

groupIds

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

rbacScope

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

KnowledgeSourceKind

知識來源的那種。

值 Description
searchIndex

從搜尋索引讀取資料的知識來源。

azureBlob

從 Azure Blob 儲存體讀取資料並將其擷取至搜尋索引的知識來源。

indexedSharePoint

一個讀取索引 SharePoint 資料的知識來源。

indexedOneLake

一個讀取索引 OneLake 資料的知識來源。

indexedSql

一個知識來源,能從 Azure SQL Database 或 SQL 受管理執行個體 擷取並匯入資料到搜尋索引。

web

一個能從網路讀取資料的知識來源。

file

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

KnowledgeSourceNetworkAccessMode

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

值 Description
public

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

private

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

ListingSearchType

指定在縮小列表結果集時如何解釋搜尋參數。 目前僅支援「前綴」。

值 Description
prefix

匹配名稱以搜尋參數值開頭的項目。

ListKnowledgeSourcesResult

列出知識來源的結果。

名稱 類型 Description
@odata.nextLink

string

可以用來取得下一組結果的網址。

value KnowledgeSource[]:

服務中的知識來源。

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

知識來源的名稱。

searchIndexParameters

SearchIndexKnowledgeSourceParameters

知識來源的參數。

SearchIndexKnowledgeSourceParameters

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

名稱 類型 Description
baseFilter

string

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

searchFields

SearchIndexFieldReference[]

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

searchIndexName

string

搜尋索引的名稱。

semanticConfigurationName

string

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

sourceDataFields

SearchIndexFieldReference[]

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

SearchResourceEncryptionKey

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

名稱 類型 Description
accessCredentials.applicationId

string

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

accessCredentials.applicationSecret

string

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

identity SearchIndexerDataIdentity:

要用於此加密金鑰的明確受控識別。 如果未指定,且存取認證屬性為 Null,則會使用系統指派的受控識別。 更新資源時,如果未指定明確識別,則會維持不變。 如果指定了 「none」 ,則會清除此屬性的值。

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。

VectorSearchVectorizerKind

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

值 Description
azureOpenAI

在查詢時使用 Azure 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

知識來源的名稱。

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

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