Knowledge Sources - Upload File

サービス:
Search Service
API バージョン:
2026-08-01-preview

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

POST {endpoint}/knowledgesources('{sourceName}')/files?api-version=2026-08-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

要求のサンプル

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



"U2FtcGxlIGZpbGUgY29udGVudCBmb3IgdXBsb2FkLg=="

応答のサンプル

状態コード:
201 
{
  "fileId": "00000000-0000-0000-0000-000000000001",
  "fileName": "kr-features.md",
  "fileSizeBytes": 31,
  "createdAt": "2026-01-01T00:00:00Z",
  "lastUpdatedAt": "2026-01-02T00:00:00Z",
  "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

プレフィックス(ディレクトリのようなパス)は、完全なファイル名から派生します。