ElevenAgentsKnowledge BaseCrawl jobs

Utwórz zadanie indeksowania

Utwórz zadanie indeksowania podanego adresu URL z określoną głębokością i limitem stron.

Nagłówki

xi-api-keystringOpcjonalny

Żądanie

This endpoint expects an object.
urlstringWymagany

URL strony dokumentacji, do której agent będzie mieć dostęp, aby kontaktować się z użytkownikami.

max_pagesintegerOpcjonalny1-10000Domyślnie 1000

Maksymalna liczba stron do przeskanowania (1–10 000), domyślnie 1000.

patternstring or nullOpcjonalny<=2048 characters

Jeśli ustawione, uwzględniane są tylko adresy URL pasujące do tego wzorca.

sitemap_urlslist of strings or nullOpcjonalny

Lista URL-i do crawlowania z mapy witryny (opcjonalna, zastępuje automatyczne wykrywanie URL-i).

parent_folder_idstring or nullOpcjonalny

Jeśli ustawione, utworzony dokument lub folder zostanie umieszczony w podanym folderze.

enable_auto_syncbooleanOpcjonalnyDomyślnie false

Czy włączyć automatyczną synchronizację dla tego dokumentu URL.

auto_removebooleanOpcjonalnyDomyślnie false

Czy automatycznie usuwać dokument, jeśli URL stanie się niedostępny. Dotyczy tylko włączonej automatycznej synchronizacji.

auto_discoverbooleanOpcjonalnyDomyślnie false

Automatycznie wykrywaj i dodawaj nowe strony, do których prowadzą linki ze stron już zindeksowanych podczas automatycznej synchronizacji. Wymaga enable_auto_sync=true.

minimum_frequency_daysinteger or nullOpcjonalny1-180

Minimalna częstotliwość odświeżania kwalifikujących się dokumentów źródłowych (w dniach). Rzeczywisty odstęp może być krótszy, ale nigdy dłuższy. Domyślnie 7; jest dostosowywana do częstotliwości folderu nadrzędnego, jeśli jest bardziej restrykcyjna. Dotyczy tylko włączonej automatycznej synchronizacji.

max_depthintegerOpcjonalnyDomyślnie 3Deprecated

Wycofane — to pole nie ma działania i zostanie usunięte w przyszłej wersji.

Odpowiedź

Pomyślna odpowiedź

idstring
typeenumDomyślnie discovery
Dozwolone wartości:
root_folder_idstring
statusstring
created_atinteger
folder_pathlist of objectsOpcjonalny

Segmenty ścieżki folderów prowadzące do folderu głównego, od katalogu głównego do folderu nadrzędnego.

Błędy

422
Unprocessable Entity Error