你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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
授权 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 资源管理器 API 的常见错误响应，以返回失败操作的错误详细信息。（这也遵循 OData 错误响应格式）。
KnowledgeSourceFile	上传到文件知识源的文件元数据。

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称	类型	说明
info		附加信息。
type	string	其他信息类型。

ErrorDetail

对象

错误详情

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误的附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详情。
message	string	错误消息。
target	string	错误的目标。

ErrorResponse

对象

所有 Azure 资源管理器 API 的常见错误响应，以返回失败操作的错误详细信息。（这也遵循 OData 错误响应格式）。

名称	类型	说明
error	ErrorDetail	错误对象。

KnowledgeSourceFile

对象

上传到文件知识源的文件元数据。

名称	类型	说明
createdAt	string (date-time)	文件创建的时间戳。
errorMessage	string	如果文件处理失败，则显示错误信息，否则为空。
fileId	string	文件的唯一标识符。
fileName	string	原始文件名。
fileSizeBytes	integer (int64)	文件大小（以字节为单位）。
lastUpdatedAt	string (date-time)	文件最后更新的时间戳。