Knowledge Sources - Update File

服務:: Search Service

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

更新現有檔案知識來源中的檔案，取代其索引內容。使用多部分/表單資料：一個 JSON 的「元資料」部分（檔案名稱和自訂元資料），另一個是包含原始檔案位元組的「內容」部分。

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

URI 參數

名稱	位於	必要	類型	Description
content	formData	True	file	原始檔案內容。
metadata	formData	True	string	描述該檔案的 JSON 元資料。
endpoint	path	True	string (uri)	搜尋服務的端點 URL。
fileId	path	True	string	檔案的唯一識別碼。
sourceName	path	True	string	知識來源的名稱。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

要求標頭

Media Types: "multipart/form-data"

名稱	必要	類型	Description
x-ms-client-request-id		string (uuid)	要求不透明、全域唯一、用戶端產生的字串標識碼。

回應

名稱	類型	Description
200 OK	KnowledgeSourceFile	要求已成功。
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

範例

SearchServiceUpdateKnowledgeSourceFile

範例要求

HTTP

PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')/files('00000000-0000-0000-0000-000000000001')?api-version=2026-08-01-preview

範例回覆

狀態碼:: 200

{
  "fileId": "00000000-0000-0000-0000-000000000001",
  "fileName": "notes/build26/kr-features.md",
  "fileSizeBytes": 43,
  "createdAt": "2026-08-03T17:04:22Z",
  "lastUpdatedAt": "2026-01-02T00:00:00Z",
  "prefix": "notes/build26/",
  "metadata": {
    "team": "kr",
    "source": "build26-notes"
  },
  "parsingMode": "markdown",
  "extractionMode": "minimal"
}

定義

名稱	Description
BlobIndexerParsingMode	代表從 Azure Blob 資料來源編製索引的剖析模式。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細資料。
ErrorResponse	所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。（這也遵循 OData 錯誤回應格式。）。
FileKnowledgeSourceExtractionMode	擷取作業是針對單一檔案進行的。「最小」（預設）使用內建擷取功能;「標準」則使用內容理解（Content Understanding）。
KnowledgeSourceFile	上傳到檔案知識來源的檔案元資料。

BlobIndexerParsingMode

列舉型別

代表從 Azure Blob 資料來源編製索引的剖析模式。

值	Description
default	針對一般檔案處理，設定為預設值。
text	設定為文字，以改善 Blob 記憶體中純文字檔案的索引編製效能。
delimitedText	當 Blob 是純 CSV 檔案時，設定為 delimitedText。
json	設定為 json，以從 JSON 檔案擷取結構化內容。
jsonArray	設定為 jsonArray 以將 JSON 陣列的個別專案擷取為個別檔。
jsonLines	設定為 jsonLines 以擷取個別 JSON 實體，並以新行分隔為個別檔。
markdown	設定為 markdown 以從 markdown 檔案擷取內容。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

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

ErrorDetail

Object

錯誤詳細資料。

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

ErrorResponse

Object

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

名稱	類型	Description
error	ErrorDetail	error 物件。

FileKnowledgeSourceExtractionMode

列舉型別

擷取作業是針對單一檔案進行的。「最小」（預設）使用內建擷取功能;「標準」則使用內容理解（Content Understanding）。

值	Description
minimal	內建擷取功能。
standard	進行了內容理解擷取。

KnowledgeSourceFile

Object

上傳到檔案知識來源的檔案元資料。

名稱	類型	Description
createdAt	string (date-time)	檔案建立的時間戳。
errorMessage	string	如果檔案處理失敗，則顯示錯誤訊息，否則為 null。
extractionMode	FileKnowledgeSourceExtractionMode	解壓模式套用到檔案上。
fileId	string	檔案的唯一識別碼。
fileName	string	原始檔案名稱。
fileSizeBytes	integer (int64)	以位元組為單位的檔案大小。
lastUpdatedAt	string (date-time)	檔案最後更新的時間戳。
metadata	object	隨檔案儲存的自訂鍵值元資料。已退回，但無法搜尋或篩選。
parsingMode	BlobIndexerParsingMode	解析模式套用在檔案上（自動從檔案偵測）。
prefix	string	前綴（類目錄路徑）源自完整檔案名稱。