Knowledge Sources - Get File Ingestion Operation
Pobiera status oraz, jeśli się powiedzie, wynik operacji importu pliku.
GET {endpoint}/knowledgesources('{sourceName}')/files/operations/{operationId}?api-version=2026-11-01-preview
Parametry identyfikatora URI
| Nazwisko | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Adres URL punktu końcowego usługi wyszukiwania. |
|
operation
|
path | True |
string |
Identyfikator generowany przez serwer zwracany po zaakceptowaniu importu. |
|
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. |
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. Nagłówki Retry-After: integer |
|
| 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
SearchServiceGetKnowledgeSourceFileIngestionOperation
Przykładowe żądanie
GET https://typespecpreviewexampleservice.search.windows.net/knowledgesources('hr-files')/files/operations/00000000-0000-0000-0000-000000000001?api-version=2026-11-01-preview
Przykładowa odpowiedź
{
"id": "00000000-0000-0000-0000-000000000001",
"kind": "knowledgeSourceFileIngestion",
"status": "Succeeded",
"result": {
"fileId": "file-00000000000000000000000000000001",
"fileName": "handbook.txt",
"fileSizeBytes": 18,
"createdAt": "2026-01-01T00:00:00Z",
"lastUpdatedAt": "2026-01-02T00:00:00Z"
}
}
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. |
|
Knowledge |
Błąd zwrócony przez nieudaną operację importu pliku. |
|
Knowledge |
Śledzi asynchroniczne przesyłanie lub zastępowanie pliku w źródle wiedzy. |
|
Operation |
Bieżący stan. Ankietuj, aż operacja zakończy się sukcesem lub niepowodzeniem. |
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. |
KnowledgeSourceFileIngestionError
Błąd zwrócony przez nieudaną operację importu pliku.
| Nazwisko | Typ | Opis |
|---|---|---|
| code |
string |
Kod błędu czytelny dla maszyny. |
| message |
string |
Opis awarii. |
KnowledgeSourceFileIngestionOperation
Śledzi asynchroniczne przesyłanie lub zastępowanie pliku w źródle wiedzy.
| Nazwisko | Typ | Opis |
|---|---|---|
| error |
Szczegóły błędu, widoczne tylko wtedy, gdy ingestacja się nie powiedzie. |
|
| id |
string |
Identyfikator operacji generowany przez serwer. |
| kind |
enum:
knowledge |
Rodzaj operacji. |
| result |
Metadane pliku, widoczne tylko po pomyślnym wczyszczeniu. |
|
| status |
Bieżący stan. Ankietuj, aż operacja zakończy się sukcesem lub niepowodzeniem. |
OperationState
Bieżący stan. Ankietuj, aż operacja zakończy się sukcesem lub niepowodzeniem.
| Wartość | Opis |
|---|---|
| NotStarted |
Operacja nie została uruchomiona. |
| Running |
Operacja jest w toku. |
| Succeeded |
Operacja zakończyła się pomyślnie. |
| Failed |
Operacja nie powiodła się. |
| Canceled |
Operacja została anulowana przez użytkownika. |