Knowledge Sources - Upload File

Serviço:: Search Service

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

Carrega um ficheiro para uma fonte de conhecimento de ficheiro para processamento e indexação.

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

Parâmetros do URI

Name	Em	Obrigatório	Tipo	Descrição
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 utilizar para esta operação.

Cabeçalho do Pedido

Media Types: "application/octet-stream"

Name	Obrigatório	Tipo	Descrição
Content-Disposition	True	string	O cabeçalho Content-Disposition que especifica o nome do ficheiro carregado. 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 do Pedido

Media Types: "application/octet-stream"

Name	Tipo	Descrição
file	string (binary)	O conteúdo do ficheiro a carregar.

Respostas

Name	Tipo	Descrição
201 Created	KnowledgeSourceFile	O pedido foi bem-sucedido e, como resultado, foi criado um novo recurso.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

api-key

Tipo: apiKey
Em: header

OAuth2Auth

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

Âmbitos

Name	Descrição
https://search.azure.com/.default

Exemplos

SearchServiceUploadKnowledgeSourceFile

Pedido de amostra

HTTP

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



"U2FtcGxlIGZpbGUgY29udGVudCBmb3IgdXBsb2FkLg=="

Resposta da amostra

Código de estado:: 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

Name	Descrição
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 gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar 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 ficheiro individual. 'minimal' (o padrão) usa extração incorporada; 'standard' usa Compreensão de Conteúdo.
KnowledgeSourceFile	Metadados de um ficheiro carregado para uma fonte de conhecimento de ficheiro.

BlobIndexerParsingMode

Enumeração

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

Valor	Descrição
default	Definido como padrão para processamento normal de arquivos.
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 delimitedText quando os blobs forem arquivos CSV simples.
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 de markdown.

ErrorAdditionalInfo

Object

Informações adicionais sobre o erro de gestão de recursos.

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

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Descrição
additionalInfo	ErrorAdditionalInfo[]	As 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

Object

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

Name	Tipo	Descrição
error	ErrorDetail	O objeto de erro.

FileKnowledgeSourceExtractionMode

Enumeração

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

Valor	Descrição
minimal	Foi realizada extração incorporada.
standard	Foi realizada a extração de compreensão do conteúdo.

KnowledgeSourceFile

Object

Metadados de um ficheiro carregado para uma fonte de conhecimento de ficheiro.

Name	Tipo	Descrição
createdAt	string (date-time)	O carimbo temporal em que o ficheiro foi criado.
errorMessage	string	A mensagem de erro se o processamento do ficheiro falhou, caso contrário é nula.
extractionMode	FileKnowledgeSourceExtractionMode	O modo de extração aplicava-se ao ficheiro.
fileId	string	O identificador único do ficheiro.
fileName	string	O nome original do ficheiro.
fileSizeBytes	integer (int64)	O tamanho do arquivo em bytes.
lastUpdatedAt	string (date-time)	O carimbo temporal em que o ficheiro foi atualizado pela última vez.
metadata	object	Metadados personalizados de chave/valor armazenados com o ficheiro. Devolvido, mas não pesquisável nem filtrável.
parsingMode	BlobIndexerParsingMode	O modo de análise analisável aplicava-se ao ficheiro (detetado automaticamente a partir do ficheiro).
prefix	string	O prefixo (caminho semelhante a diretório) derivava do nome completo do ficheiro.