Knowledge Sources - Upload File

Service:: Search Service

Version d’API:: 2026-08-01-preview

Télécharge un fichier dans une source de connaissances de fichier pour traitement et indexation.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (uri)	URL du point de terminaison du service de recherche.
sourceName	path	True	string	Nom de la source de connaissances.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

En-tête de la demande

Media Types: "application/octet-stream"

Nom	Obligatoire	Type	Description
Content-Disposition	True	string	L’en-tête Content-Disposition spécifie le nom de fichier du fichier téléchargé. À suivre le format : `attachment; filename="<filename>"`. Par exemple : `attachment; filename="installation-guide.pdf"`.
x-ms-client-request-id		string (uuid)	Identificateur de chaîne opaque, globalement unique et généré par le client pour la requête.

Corps de la demande

Media Types: "application/octet-stream"

Nom	Type	Description
file	string (binary)	Le contenu du fichier à téléverser.

Réponses

Nom	Type	Description
201 Created	KnowledgeSourceFile	La requête a réussi et une nouvelle ressource a été créée en conséquence.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

api-key

Type: apiKey
Dans: header

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Étendues

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

Exemples

SearchServiceUploadKnowledgeSourceFile

Exemple de requête

HTTP

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



"U2FtcGxlIGZpbGUgY29udGVudCBmb3IgdXBsb2FkLg=="

Exemple de réponse

Code d’état:: 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"
}

Définitions

Nom	Description
BlobIndexerParsingMode	Représente le mode d’analyse pour l’indexation à partir d’une source de données d’objet blob Azure.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).
FileKnowledgeSourceExtractionMode	L’effort d’extraction s’appliquait à un fichier individuel. « minimal » (par défaut) utilise une extraction intégrée ; « standard » utilise la compréhension du contenu.
KnowledgeSourceFile	Les métadonnées d’un fichier téléchargé dans une source de connaissances de fichier.

BlobIndexerParsingMode

Énumération

Représente le mode d’analyse pour l’indexation à partir d’une source de données d’objet blob Azure.

Valeur	Description
default	Définissez la valeur par défaut pour le traitement normal des fichiers.
text	Définissez le texte pour améliorer les performances d’indexation sur les fichiers de texte brut dans le stockage d’objets blob.
delimitedText	Définissez la valeur delimitedText lorsque les objets blob sont des fichiers CSV bruts.
json	Définissez sur json pour extraire du contenu structuré à partir de fichiers JSON.
jsonArray	Définissez sur jsonArray pour extraire des éléments individuels d’un tableau JSON en tant que documents distincts.
jsonLines	Définissez sur jsonLines pour extraire des entités JSON individuelles, séparées par une nouvelle ligne, sous forme de documents distincts.
markdown	Définissez sur markdown pour extraire le contenu des fichiers markdown.

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info		Informations supplémentaires
type	string	Le type d’informations supplémentaires.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations complémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet

Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

FileKnowledgeSourceExtractionMode

Énumération

L’effort d’extraction s’appliquait à un fichier individuel. « minimal » (par défaut) utilise une extraction intégrée ; « standard » utilise la compréhension du contenu.

Valeur	Description
minimal	Une extraction intégrée a été réalisée.
standard	L’extraction de compréhension du contenu a été réalisée.

KnowledgeSourceFile

Objet

Les métadonnées d’un fichier téléchargé dans une source de connaissances de fichier.

Nom	Type	Description
createdAt	string (date-time)	L’horodatage de la création du fichier.
errorMessage	string	Le message d’erreur si le traitement du fichier a échoué, nul sinon.
extractionMode	FileKnowledgeSourceExtractionMode	Le mode d’extraction s’appliquait au fichier.
fileId	string	L’identifiant unique du fichier.
fileName	string	Le nom original du fichier.
fileSizeBytes	integer (int64)	Taille du fichier en octets.
lastUpdatedAt	string (date-time)	L’horodatage de la dernière mise à jour du fichier.
metadata	object	Métadonnées personnalisées de clé/valeur stockées avec le fichier. Retourné mais non consultable ni filtrable.
parsingMode	BlobIndexerParsingMode	Le mode d’analyse s’appliquait au fichier (détecté automatiquement à partir du fichier).
prefix	string	Le préfixe (chemin en forme de répertoire) dérive du nom complet du fichier.