Knowledge Sources - Upload File

サービス:: Search Service

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

ファイルをファイル知識ソースにアップロードし、処理とインデックス作成を行います。

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

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string (uri)	検索サービスのエンドポイント URL。
sourceName	path	True	string	ナレッジソースの名前。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求ヘッダー

Media Types: "application/octet-stream"

名前	必須	型	説明
Content-Disposition	True	string	アップロードされたファイルのファイル名を指定するContent-Dispositionヘッダー。フォーマットに従う必要があります: `attachment; filename="<filename>"`。たとえば、 `attachment; filename="installation-guide.pdf"`と指定します。
x-ms-client-request-id		string (uuid)	要求の非透過的なグローバルに一意のクライアント生成文字列識別子。

要求本文

Media Types: "application/octet-stream"

名前	型	説明
file	string (binary)	アップロードするファイルの内容。

応答

名前	型	説明
201 Created	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

例

SearchServiceUploadKnowledgeSourceFile

要求のサンプル

HTTP

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



"dGVzdCBmaWxlIGNvbnRlbnQ="

応答のサンプル

状態コード:: 201

{
  "fileId": "00000000-0000-0000-0000-000000000001",
  "fileName": "example.pdf",
  "fileSizeBytes": 12345,
  "createdAt": "2026-01-01T00:00:00Z",
  "lastUpdatedAt": "2026-01-01T00:00:00Z",
  "errorMessage": null
}

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報
ErrorDetail	エラーの詳細。
ErrorResponse	失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。
KnowledgeSourceFile	ファイル知識ソースにアップロードされたファイルのメタデータ。

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	エラーオブジェクト。

KnowledgeSourceFile

Object

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

名前	型	説明
createdAt	string (date-time)	ファイル作成のタイムスタンプ。
errorMessage	string	ファイル処理に失敗した場合はエラーメッセージ、そうでなければnullとなります。
fileId	string	ファイルの一意識別子。
fileName	string	元のファイル名。
fileSizeBytes	integer (int64)	ファイルサイズ (バイト数)。
lastUpdatedAt	string (date-time)	ファイルの最後に更新されたタイムスタンプ。