Knowledge Sources - Update File

サービス:: Search Service

API バージョン:: 2026-08-01-preview

既存のファイル知識ソースを更新し、インデックスされた内容を置き換えます。マルチパート/フォームデータを使用します:JSONの「メタデータ」部分(ファイル名とカスタムメタデータ)と、生のファイルバイトを含む「content」部分です。

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

URI パラメーター

名前	/	必須	型	説明
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"

名前	必須	型	説明
x-ms-client-request-id		string (uuid)	要求の非透過的なグローバルに一意のクライアント生成文字列識別子。

応答

名前	型	説明
200 OK	KnowledgeSourceFile	要求は成功しました。
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

api-key

型: apiKey
/: header

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/v2.0/authorize

スコープ

名前	説明
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"
}

定義

名前	説明
BlobIndexerParsingMode	Azure BLOB データソースからのインデックス作成の解析モードを表します。
ErrorAdditionalInfo	リソース管理エラーの追加情報
ErrorDetail	エラーの詳細。
ErrorResponse	失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。
FileKnowledgeSourceExtractionMode	抽出作業は個別のファイルに適用されます。「minimal」(デフォルト)は組み込みの抽出を使用します。「standard」はContent Understandingを使用します。
KnowledgeSourceFile	ファイル知識ソースにアップロードされたファイルのメタデータ。

BlobIndexerParsingMode

列挙

Azure BLOB データソースからのインデックス作成の解析モードを表します。

値	説明
default	通常のファイル処理では既定値に設定されます。
text	BLOB ストレージ内のプレーンテキストファイルのインデックス作成のパフォーマンスを向上させるために、テキストに設定します。
delimitedText	BLOB がプレーン CSV ファイルの場合は、delimitedText に設定します。
json	JSON ファイルから構造化コンテンツを抽出するには、json に設定します。
jsonArray	JSON 配列の個々の要素を個別のドキュメントとして抽出するには、jsonArray に設定します。
jsonLines	jsonLines に設定すると、個別のドキュメントとして、新しい行で区切られた個々の JSON エンティティが抽出されます。
markdown	マークダウンファイルからコンテンツを抽出するには、マークダウンに設定します。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報

名前	型	説明
info		追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーに関する追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーの対象。

ErrorResponse

Object

失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

FileKnowledgeSourceExtractionMode

列挙

抽出作業は個別のファイルに適用されます。「minimal」(デフォルト)は組み込みの抽出を使用します。「standard」はContent Understandingを使用します。

値	説明
minimal	内蔵抽出も実施されました。
standard	コンテンツ理解抽出が行われました。

KnowledgeSourceFile

Object

ファイル知識ソースにアップロードされたファイルのメタデータ。

名前	型	説明
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	プレフィックス(ディレクトリのようなパス)は、完全なファイル名から派生します。