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
Flow: implicit
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

Представляет режим синтаксического анализа для индексирования из источника данных BLOB-объектов Azure.
ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail

Подробности ошибки.
ErrorResponse

Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).
FileKnowledgeSourceExtractionMode

Работа по извлечению применялась к отдельному файлу. 'minimal' (по умолчанию) использует встроенную экстракцию; 'standard' — Content Understanding.
KnowledgeSourceFile

Метаданные для файла, загруженного в источник знаний File.

BlobIndexerParsingMode

Перечисление

Представляет режим синтаксического анализа для индексирования из источника данных BLOB-объектов Azure.

Значение Описание
default

Установите значение по умолчанию для обычной обработки файлов.
text

Задайте значение text, чтобы повысить производительность индексирования в файлах обычного текста в хранилище BLOB-объектов.
delimitedText

Задайте для разделителя текста, если большие двоичные объекты являются обычными CSV-файлами.
json

Установите значение json, чтобы извлечь структурированное содержимое из JSON-файлов.
jsonArray

Установите значение jsonArray для извлечения отдельных элементов массива JSON в виде отдельных документов.
jsonLines

Установите значение jsonLines для извлечения отдельных сущностей JSON, разделенных новой строкой в виде отдельных документов.
markdown

Установите значение Markdown, чтобы извлечь содержимое из файлов Markdown.

ErrorAdditionalInfo

Объект

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

Дополнительные сведения.
type

string

Тип дополнительных сведений.

ErrorDetail

Объект

Подробности ошибки.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

Сведения об ошибке.
message

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

Объект

Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

FileKnowledgeSourceExtractionMode

Перечисление

Работа по извлечению применялась к отдельному файлу. 'minimal' (по умолчанию) использует встроенную экстракцию; 'standard' — Content Understanding.

Значение Описание
minimal

Была проведена встроенная экстракция.
standard

Была проведена извлечение Content Understanding.

KnowledgeSourceFile

Объект

Метаданные для файла, загруженного в источник знаний File.

Имя Тип Описание
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

Префикс (путь, похожий на каталог) происходит от полного имени файла.