Knowledge Sources - List Files
Lista wszystkich plików w źródle wiedzy o plikach.
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
Parametry identyfikatora URI
| Nazwisko | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Adres URL punktu końcowego usługi wyszukiwania. |
|
source
|
path | True |
string |
Nazwa źródła wiedzy. |
|
api-version
|
query | True |
string minLength: 1 |
Wersja interfejsu API do użycia dla tej operacji. |
|
page
|
query |
integer (int32) minimum: 1maximum: 3000 |
Maksymalna liczba pozycji, które należy zwrócić na jednej stronie. Serwer egzekwuje maksimum; jeśli zostanie pominięte, serwer ustala odpowiedni domyślny wybór. |
|
|
prefix
|
query |
string |
Opcjonalny prefiks filtrujący pliki według ich katalogowej ścieżki. |
|
|
search
|
query |
string |
Ciąg służący do zawężenia ogłoszenia, dzięki czemu trzeba przejrzeć mniej wyników. Jeśli zostanie pominięty lub zostanie przekazany pusty ciąg, nie stosuje się zawężania. |
|
|
search
|
query |
Określa, jak parametr wyszukiwania jest interpretowany. Obecnie obsługiwany jest tylko 'prefiks'. |
Nagłówek żądania
| Nazwisko | Wymagane | Typ | Opis |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania. |
|
| Accept |
Nagłówek „Accept”. |
Odpowiedzi
| Nazwisko | Typ | Opis |
|---|---|---|
| 200 OK |
Żądanie zakończyło się pomyślnie. |
|
| Other Status Codes |
Nieoczekiwana odpowiedź na błąd. |
Zabezpieczenia
api-key
Typ:
apiKey
W:
header
OAuth2Auth
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Zakresy
| Nazwisko | Opis |
|---|---|
| https://search.azure.com/.default |
Przykłady
SearchServiceListKnowledgeSourceFiles
Przykładowe żądanie
GET https://typespecstableexampleservice.search.windows.net/knowledgesources('ks-stable-test')/files?api-version=2026-10-01&prefix=&search=&pageSize=&searchType=prefix
Przykładowa odpowiedź
{
"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"
}
}
]
}
Definicje
| Nazwisko | Opis |
|---|---|
| Accept |
Nagłówek „Accept”. |
|
Blob |
Reprezentuje tryb analizowania indeksowania ze źródła danych obiektów blob platformy Azure. |
|
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
|
Error |
Szczegóły błędu. |
|
Error |
Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData). |
|
File |
Wysiłki związane z ekstrakcją dotyczyły pojedynczego pliku. 'minimalny' (domyślny) wykorzystuje wbudowaną ekstrakcję; 'standardowy' korzysta z Content Understanding. |
|
Knowledge |
Metadane pliku przesłanego do źródła wiedzy o pliku. |
|
Listing |
Określa, jak parametr wyszukiwania jest interpretowany podczas zawężania zbioru wyników listingu. Obecnie obsługiwany jest tylko 'prefiks'. |
|
List |
Odpowiedź na wniosek o List Files. |
Accept
Nagłówek „Accept”.
| Wartość | Opis |
|---|---|
| application/json;odata.metadata=minimal |
BlobIndexerParsingMode
Reprezentuje tryb analizowania indeksowania ze źródła danych obiektów blob platformy Azure.
| Wartość | Opis |
|---|---|
| default |
Ustaw wartość domyślną dla normalnego przetwarzania plików. |
| text |
Ustaw wartość na tekst, aby zwiększyć wydajność indeksowania plików zwykłego tekstu w magazynie obiektów blob. |
| delimitedText |
Ustaw wartość na rozdzielanyTekst, gdy obiekty blob są zwykłymi plikami CSV. |
| json |
Ustaw wartość json na wyodrębnianie zawartości ustrukturyzowanej z plików JSON. |
| jsonArray |
Ustaw wartość jsonArray, aby wyodrębnić poszczególne elementy tablicy JSON jako oddzielne dokumenty. |
| jsonLines |
Ustaw wartość jsonLines, aby wyodrębnić poszczególne jednostki JSON oddzielone nowym wierszem jako osobne dokumenty. |
| markdown |
Ustaw wartość markdown, aby wyodrębnić zawartość z plików markdown. |
ErrorAdditionalInfo
Dodatkowe informacje o błędzie zarządzania zasobami.
| Nazwisko | Typ | Opis |
|---|---|---|
| info |
Dodatkowe informacje. |
|
| type |
string |
Dodatkowy typ informacji. |
ErrorDetail
Szczegóły błędu.
| Nazwisko | Typ | Opis |
|---|---|---|
| additionalInfo |
Dodatkowe informacje o błędzie |
|
| code |
string |
Kod błędu. |
| details |
Szczegóły błędu. |
|
| message |
string |
Komunikat o błędzie. |
| target |
string |
Cel błędu. |
ErrorResponse
Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).
| Nazwisko | Typ | Opis |
|---|---|---|
| error |
Obiekt błędu. |
FileKnowledgeSourceExtractionMode
Wysiłki związane z ekstrakcją dotyczyły pojedynczego pliku. 'minimalny' (domyślny) wykorzystuje wbudowaną ekstrakcję; 'standardowy' korzysta z Content Understanding.
| Wartość | Opis |
|---|---|
| minimal |
Przeprowadzono ekstrakcję wbudowaną. |
| standard |
Wykonano ekstrakcję zrozumienia treści. |
KnowledgeSourceFile
Metadane pliku przesłanego do źródła wiedzy o pliku.
| Nazwisko | Typ | Opis |
|---|---|---|
| createdAt |
string (date-time) |
Znacznik czasu utworzenia pliku. |
| errorMessage |
string |
Komunikat o błędzie, jeśli przetwarzanie plików się nie powiodło, w przeciwnym razie jest nul. |
| extractionMode |
Tryb rozpakowania zastosowano do pliku. |
|
| fileId |
string |
Unikalny identyfikator pliku. |
| fileName |
string |
Oryginalna nazwa pliku. |
| fileSizeBytes |
integer (int64) |
Rozmiar pliku w bajtach. |
| lastUpdatedAt |
string (date-time) |
Znacznik czasu ostatniej aktualizacji pliku. |
| metadata |
object |
Niestandardowe metadane klucz/wartość przechowywane w pliku. Zwrócone, ale nie da się przeszukać ani filtrować. |
| parsingMode |
Tryb parsowania zastosowany do pliku (automatycznie wykrywany z pliku). |
|
| prefix |
string |
Prefiks (ścieżka katalogowa) wywodzi się z pełnej nazwy pliku. |
ListingSearchType
Określa, jak parametr wyszukiwania jest interpretowany podczas zawężania zbioru wyników listingu. Obecnie obsługiwany jest tylko 'prefiks'.
| Wartość | Opis |
|---|---|
| prefix |
Dopasowuje elementy, których nazwa zaczyna się od wartości parametru wyszukiwania. |
ListKnowledgeSourceFilesResult
Odpowiedź na wniosek o List Files.
| Nazwisko | Typ | Opis |
|---|---|---|
| @odata.nextLink |
string |
URL, którego można użyć do pobrania kolejnego zestawu wyników. |
| value |
Lista akt. |