Knowledge Sources - Upload File

Dienst:: Search Service

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

Lädt eine Datei in eine Datei-Wissensquelle zur Verarbeitung und Indexierung hoch.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Die Endpunkt-URL des Suchdiensts.
sourceName	path	True	string	Der Name der Wissensquelle.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Media Types: "application/octet-stream"

Name	Erforderlich	Typ	Beschreibung
Content-Disposition	True	string	Der Content-Disposition-Header gibt den Dateinamen der hochgeladenen Datei an. Muss dem Format folgen: `attachment; filename="<filename>"`. Beispiel: `attachment; filename="installation-guide.pdf"`.
x-ms-client-request-id		string (uuid)	Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

Anforderungstext

Media Types: "application/octet-stream"

Name	Typ	Beschreibung
file	string (binary)	Der Dateiinhalt zum Hochladen.

Antworten

Name	Typ	Beschreibung
201 Created	KnowledgeSourceFile	Die Anforderung ist erfolgreich und eine neue Ressource wurde als Ergebnis erstellt.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

api-key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiche

Name	Beschreibung
https://search.azure.com/.default

Beispiele

SearchServiceUploadKnowledgeSourceFile

Beispielanforderung

HTTP

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



"U2FtcGxlIGZpbGUgY29udGVudCBmb3IgdXBsb2FkLg=="

Beispiel für eine Antwort

Statuscode:: 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"
}

Definitionen

Name	Beschreibung
BlobIndexerParsingMode	Stellt den Analysemodus für die Indizierung aus einer Azure-Blobdatenquelle dar.
ErrorAdditionalInfo	Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)
FileKnowledgeSourceExtractionMode	Der Extraktionsprozess bezog sich auf eine einzelne Datei. 'minimal' (der Standard) verwendet eingebaute Extraktion; 'standard' verwendet Content Understanding.
KnowledgeSourceFile	Metadaten für eine Datei, die in eine Datei-Wissensquelle hochgeladen wird.

BlobIndexerParsingMode

Enumeration

Stellt den Analysemodus für die Indizierung aus einer Azure-Blobdatenquelle dar.

Wert	Beschreibung
default	Standardeinstellung für die normale Dateiverarbeitung.
text	Legen Sie diesen Wert auf Text fest, um die Indizierungsleistung für Nur-Text-Dateien im BLOB-Speicher zu verbessern.
delimitedText	Legen Sie diese Eigenschaft auf "delimitedText" fest, wenn Blobs einfache CSV-Dateien sind.
json	Legen Sie auf json fest, um strukturierte Inhalte aus JSON-Dateien zu extrahieren.
jsonArray	Legen Sie "jsonArray" fest, um einzelne Elemente eines JSON-Arrays als separate Dokumente zu extrahieren.
jsonLines	Legen Sie auf jsonLines fest, um einzelne JSON-Entitäten zu extrahieren, getrennt durch eine neue Zeile, als separate Dokumente.
markdown	Legen Sie diese Option auf Markdown fest, um Inhalte aus Markdowndateien zu extrahieren.

ErrorAdditionalInfo

Objekt

Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung.

Name	Typ	Beschreibung
info		Zusätzliche Informationen.
type	string	Typ der Zusatzinformationen.

ErrorDetail

Objekt

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die Zusatzinformationen zum Fehler.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Der Fehlerzielwert.

ErrorResponse

Objekt

Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

FileKnowledgeSourceExtractionMode

Enumeration

Der Extraktionsprozess bezog sich auf eine einzelne Datei. 'minimal' (der Standard) verwendet eingebaute Extraktion; 'standard' verwendet Content Understanding.

Wert	Beschreibung
minimal	Eine eingebaute Extraktion wurde durchgeführt.
standard	Die Extraktion des Inhaltsverstehens wurde durchgeführt.

KnowledgeSourceFile

Objekt

Metadaten für eine Datei, die in eine Datei-Wissensquelle hochgeladen wird.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel, als die Datei erstellt wurde.
errorMessage	string	Die Fehlermeldung, wenn die Dateiverarbeitung fehlgeschlagen hat, ist sonst null.
extractionMode	FileKnowledgeSourceExtractionMode	Der Extrahiermodus wurde auf die Datei angewendet.
fileId	string	Die eindeutige Kennung der Datei.
fileName	string	Der ursprüngliche Dateiname.
fileSizeBytes	integer (int64)	Die Größe der Datei in Byte.
lastUpdatedAt	string (date-time)	Der Zeitstempel, als die Datei zuletzt aktualisiert wurde.
metadata	object	Benutzerdefinierte Schlüssel-/Wertmetadaten, die mit der Datei gespeichert sind. Zurückgegeben, aber nicht durchsuchbar oder filterbar.
parsingMode	BlobIndexerParsingMode	Der Parsing-Modus wurde auf die Datei angewendet (automatisch aus der Datei erkannt).
prefix	string	Das Präfix (verzeichnisartiger Pfad) leitet sich vom vollständigen Dateinamen ab.