Knowledge Sources - Upload File

Usługa:
Search Service
Wersja interfejsu API:
2026-08-01-preview

Przesyła plik do źródła wiedzy o pliku do przetwarzania i indeksowania.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
endpoint
 path True

string (uri)

Adres URL punktu końcowego usługi wyszukiwania.
sourceName
 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

Media Types: "application/octet-stream"

Nazwa Wymagane Typ Opis
Content-Disposition True

string

Nagłówek Content-Disposition określający nazwę pliku przesyłanego pliku. Musi przestrzegać formatu: attachment; filename="<filename>". Przykład: attachment; filename="installation-guide.pdf".
x-ms-client-request-id

string (uuid)

Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Treść żądania

Media Types: "application/octet-stream"

Nazwa Typ Opis
file

string (binary)

Zawartość pliku do przesłania.

Odpowiedzi

Nazwa Typ Opis
201 Created

KnowledgeSourceFile

Żądanie zakończyło się pomyślnie i w rezultacie został utworzony nowy zasób.
Other Status Codes

ErrorResponse

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

Nazwa Opis
https://search.azure.com/.default

Przykłady

SearchServiceUploadKnowledgeSourceFile

Przykładowe żądanie

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



"U2FtcGxlIGZpbGUgY29udGVudCBmb3IgdXBsb2FkLg=="

Przykładowa odpowiedź

Kod stanu:
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"
}

Definicje

Nazwa Opis
BlobIndexerParsingMode

Reprezentuje tryb analizowania indeksowania ze źródła danych obiektów blob platformy Azure.
ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail

Szczegóły 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).
FileKnowledgeSourceExtractionMode

Wysiłki związane z ekstrakcją dotyczyły pojedynczego pliku. 'minimalny' (domyślny) wykorzystuje wbudowaną ekstrakcję; 'standardowy' korzysta z Content Understanding.
KnowledgeSourceFile

Metadane pliku przesłanego do źródła wiedzy o pliku.

BlobIndexerParsingMode

Wyliczenie

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

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

Dodatkowe informacje.
type

string

Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie
code

string

Kod błędu.
details

ErrorDetail[]

Szczegóły błędu.
message

string

Komunikat o błędzie.
target

string

Cel błędu.

ErrorResponse

Objekt

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).

Nazwa Typ Opis
error

ErrorDetail

Obiekt błędu.

FileKnowledgeSourceExtractionMode

Wyliczenie

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

Objekt

Metadane pliku przesłanego do źródła wiedzy o pliku.

Nazwa 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

FileKnowledgeSourceExtractionMode

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

BlobIndexerParsingMode

Tryb parsowania zastosowany do pliku (automatycznie wykrywany z pliku).
prefix

string

Prefiks (ścieżka katalogowa) wywodzi się z pełnej nazwy pliku.