INTEGRITY Dokumentace

← Přehled / ai-search / api / items

REST API

Pomocí REST API AI Search nahrávejte, vypisujte a spravujte jednotlivé dokumenty v rámci instance.

Ověřování

Všechny požadavky vyžadují token API s AI Search:Edit a AI Search:Run oprávnění.

  1. V Cloudflare dashboardu přejděte na My Profile > API Tokens.

    Přejděte na API Tokens ↗

  2. Vyberte Create Token.

  3. Vyberte Create Custom Token.

  4. Zadejte Název tokenu, například AI Search Manager.

  5. V části Oprávnění, přidejte dvě oprávnění:

    • Účet > AI Search:Edit
    • Účet > AI Search:Run

  6. Vyberte Pokračovat k souhrnu, pak vyberte Create Token.

  7. Zkopírujte a uložte hodnotu tokenu. Toto je váš API_TOKEN.

Zahrňte token do Authorization hlavička pro všechny požadavky:

Authorization: Bearer <API_TOKEN>

Cesty API

Rozhraní AI Search API jsou dostupná na dvou základních cestách:

Cesta Popis
/accounts/{account_id}/ai-search/instances/{id}/ Pracuje s konkrétní instancí
/accounts/{account_id}/ai-search/namespaces/{namespace}/instances/{id}/ Pracuje s instancemi v rámci namespace

Dostupné operace jsou stejné pro obě cesty. API v rámci jmenného prostoru najdete v Referenční dokumentace API jmenného prostoru.

Položky

Nahrávejte, vypisujte, načítejte, mažte a stahujte položky v rámci instance. Úplnou specifikaci najdete v Referenční dokumentace k Items API.

Operace Metoda Popis
Nahrát POST Nahrání dokumentu k indexaci
Výpis GET Vypsat všechny položky v instanci
Získat GET Získat informace o položce podle ID
Smazat DELETE Odstranění položky
Stáhnout GET Stáhněte původní soubor

Příklad: Nahrání dokumentu

Nahrajte soubor do instance:

curl -X POST "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai-search/instances/<INSTANCE_NAME>/items" \
  -H "Authorization: Bearer <API_TOKEN>" \
  -F "file=@/path/to/your/file.pdf"

Příklad: Výpis položek

Vypište všechny položky v instanci:

curl "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai-search/instances/<INSTANCE_NAME>/items" \
  -H "Authorization: Bearer <API_TOKEN>"

Chcete-li najít konkrétní položku podle přesného klíče objektu, předejte key query parametr:

curl "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai-search/instances/<INSTANCE_NAME>/items?key=docs/readme.md" \
  -H "Authorization: Bearer <API_TOKEN>"

Klíče jsou jedinečné pro každý zdroj dat, proto zkombinujte key hodnotou source (například source=builtin) pro rozlišení, když stejný klíč existuje ve více zdrojích.