Knowledge Sources - Upload File

Serviço:: Search Service

Versão da API:: 2026-08-01-preview

Faz upload de um arquivo para uma fonte de conhecimento de arquivo para processamento e indexação.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string (uri)	A URL do ponto de extremidade do serviço de pesquisa.
sourceName	path	True	string	O nome da fonte de conhecimento.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Media Types: "application/octet-stream"

Nome	Obrigatório	Tipo	Description
Content-Disposition	True	string	O cabeçalho Content-Disposition especificando o nome do arquivo enviado. Deve seguir o formato: `attachment; filename="<filename>"`. Por exemplo: `attachment; filename="installation-guide.pdf"`.
x-ms-client-request-id		string (uuid)	Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Corpo da solicitação

Media Types: "application/octet-stream"

Nome	Tipo	Description
file	string (binary)	O conteúdo do arquivo para enviar.

Respostas

Nome	Tipo	Description
201 Created	KnowledgeSourceFile	A solicitação foi bem-sucedida e um novo recurso foi criado como resultado.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

api-key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Escopos

Nome	Description
https://search.azure.com/.default

Exemplos

SearchServiceUploadKnowledgeSourceFile

Solicitação de exemplo

HTTP

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



"U2FtcGxlIGZpbGUgY29udGVudCBmb3IgdXBsb2FkLg=="

Resposta de exemplo

Código de status:: 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"
}

Definições

Nome	Description
BlobIndexerParsingMode	Representa o modo de análise para indexação de uma fonte de dados de blob do Azure.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).
FileKnowledgeSourceExtractionMode	O esforço de extração aplicava-se a um arquivo individual. 'minimal' (o padrão) usa extração embutida; 'padrão' usa Compreensão de Conteúdo.
KnowledgeSourceFile	Metadados de um arquivo enviado para uma fonte de conhecimento de arquivo.

BlobIndexerParsingMode

Enumeração

Representa o modo de análise para indexação de uma fonte de dados de blob do Azure.

Valor	Description
default	Definido como padrão para o processamento de arquivo normal.
text	Defina como texto para melhorar o desempenho de indexação em arquivos de texto sem formatação no armazenamento de blobs.
delimitedText	Defina como delimititedText quando os blobs forem arquivos CSV sem formatação.
json	Defina como json para extrair conteúdo estruturado de arquivos JSON.
jsonArray	Defina como jsonArray para extrair elementos individuais de uma matriz JSON como documentos separados.
jsonLines	Defina como jsonLines para extrair entidades JSON individuais, separadas por uma nova linha, como documentos separados.
markdown	Defina como markdown para extrair conteúdo de arquivos markdown.

ErrorAdditionalInfo

Objeto

Informações adicionais sobre o erro de gerenciamento de recursos.

Nome	Tipo	Description
info		As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O alvo do erro.

ErrorResponse

Objeto

Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

FileKnowledgeSourceExtractionMode

Enumeração

O esforço de extração aplicava-se a um arquivo individual. 'minimal' (o padrão) usa extração embutida; 'padrão' usa Compreensão de Conteúdo.

Valor	Description
minimal	A extração incorporada foi realizada.
standard	A extração de compreensão de conteúdo foi realizada.

KnowledgeSourceFile

Objeto

Metadados de um arquivo enviado para uma fonte de conhecimento de arquivo.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data em que o arquivo foi criado.
errorMessage	string	A mensagem de erro se o processamento do arquivo falhou, caso contrário é nula.
extractionMode	FileKnowledgeSourceExtractionMode	O modo de extração aplicado ao arquivo.
fileId	string	O identificador único do arquivo.
fileName	string	O nome original do arquivo.
fileSizeBytes	integer (int64)	O tamanho do arquivo em bytes.
lastUpdatedAt	string (date-time)	O carimbo de data e hora da última atualização do arquivo.
metadata	object	Metadados personalizados de chave/valor armazenados com o arquivo. Devolvido, mas não pesquisável ou filtrável.
parsingMode	BlobIndexerParsingMode	O modo de análise se aplicava ao arquivo (detectado automaticamente pelo arquivo).
prefix	string	O prefixo (caminho semelhante a um diretório) derivava do nome completo do arquivo.