Knowledge Sources - List Files
Listet alle Dateien in einer Datei-Wissensquelle auf.
GET {endpoint}/knowledgesources('{sourceName}')/files?api-version=2026-10-01
GET {endpoint}/knowledgesources('{sourceName}')/files?api-version=2026-10-01&prefix={prefix}&search={search}&pageSize={pageSize}&searchType=prefix
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Die Endpunkt-URL des Suchdiensts. |
|
source
|
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. |
|
page
|
query |
integer (int32) minimum: 1maximum: 3000 |
Die maximale Anzahl an Gegenständen, die auf einer einzigen Seite zurückgegeben werden dürfen. Der Server setzt ein Maximum durch; wenn es weggelassen wird, bestimmt der Server einen geeigneten Standard. |
|
|
prefix
|
query |
string |
Optionales Präfix, um Dateien nach ihrem verzeichnisähnlichen Pfad zu filtern. |
|
|
search
|
query |
string |
Ein String, der verwendet wird, um das Angebot einzugrenzen, sodass weniger Ergebnisse durchgeblättert werden müssen. Wird diese weggelassen oder eine leere Zeichenkette übergeben, wird keine Verengung angewendet. |
|
|
search
|
query |
Spezifiziert, wie der Suchparameter interpretiert wird. Derzeit wird nur "Präfix" unterstützt. |
Anforderungsheader
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung. |
|
| Accept |
Der Accept-Header. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
Die Anforderung ist erfolgreich. |
|
| Other Status Codes |
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
SearchServiceListKnowledgeSourceFiles
Beispielanforderung
GET https://typespecstableexampleservice.search.windows.net/knowledgesources('ks-stable-test')/files?api-version=2026-10-01&prefix=&search=&pageSize=&searchType=prefix
Beispiel für eine Antwort
{
"value": [
{
"fileId": "00000000-0000-0000-0000-000000000001",
"fileName": "notes/build26/kr-features.md",
"fileSizeBytes": 1184,
"createdAt": "2026-08-03T17:04:22Z",
"lastUpdatedAt": "2026-08-03T17:04:22Z",
"prefix": "notes/build26/",
"parsingMode": "markdown",
"extractionMode": "minimal",
"metadata": {
"team": "kr",
"source": "build26-notes"
}
}
]
}
Definitionen
| Name | Beschreibung |
|---|---|
| Accept |
Der Accept-Header. |
|
Blob |
Stellt den Analysemodus für die Indizierung aus einer Azure-Blobdatenquelle dar. |
|
Error |
Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung. |
|
Error |
Die Fehlerdetails. |
|
Error |
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.) |
|
File |
Der Extraktionsprozess bezog sich auf eine einzelne Datei. 'minimal' (der Standard) verwendet eingebaute Extraktion; 'standard' verwendet Content Understanding. |
|
Knowledge |
Metadaten für eine Datei, die in eine Datei-Wissensquelle hochgeladen wird. |
|
Listing |
Spezifiziert, wie der Suchparameter bei der Eingrenzung einer Ergebnismenge interpretiert wird. Derzeit wird nur "Präfix" unterstützt. |
|
List |
Antwort auf eine Anfrage aus den Listen Files. |
Accept
Der Accept-Header.
| Wert | Beschreibung |
|---|---|
| application/json;odata.metadata=minimal |
BlobIndexerParsingMode
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
Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung.
| Name | Typ | Beschreibung |
|---|---|---|
| info |
Zusätzliche Informationen. |
|
| type |
string |
Typ der Zusatzinformationen. |
ErrorDetail
Die Fehlerdetails.
| Name | Typ | Beschreibung |
|---|---|---|
| additionalInfo |
Die Zusatzinformationen zum Fehler. |
|
| code |
string |
Der Fehlercode. |
| details |
Die Fehlerdetails. |
|
| message |
string |
Die Fehlermeldung. |
| target |
string |
Der Fehlerzielwert. |
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.)
| Name | Typ | Beschreibung |
|---|---|---|
| error |
Das Fehlerobjekt. |
FileKnowledgeSourceExtractionMode
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
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 |
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 |
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. |
ListingSearchType
Spezifiziert, wie der Suchparameter bei der Eingrenzung einer Ergebnismenge interpretiert wird. Derzeit wird nur "Präfix" unterstützt.
| Wert | Beschreibung |
|---|---|
| prefix |
Stimmt Elementen ab, deren Name mit dem Wert des Suchparameters beginnt. |
ListKnowledgeSourceFilesResult
Antwort auf eine Anfrage aus den Listen Files.
| Name | Typ | Beschreibung |
|---|---|---|
| @odata.nextLink |
string |
Die URL, die verwendet werden kann, um die nächste Ergebnismenge abzurufen. |
| value |
Die Liste der Akten. |