← Přehled / ai-search / api / instances
REST API
Pomocí REST API AI Search spravujte instance a synchronizační úlohy přes HTTP.
Ověřování
Všechny požadavky vyžadují token API s AI Search:Edit a AI Search:Run oprávnění.
-
V Cloudflare dashboardu přejděte na My Profile > API Tokens.
Přejděte na API Tokens ↗ -
Vyberte Create Token.
-
Vyberte Create Custom Token.
-
Zadejte Název tokenu, například
AI Search Manager. -
V části Oprávnění, přidejte dvě oprávnění:
- Účet > AI Search:Edit
- Účet > AI Search:Run
-
Vyberte Pokračovat k souhrnu, pak vyberte Create Token.
-
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.
Instance
Vytvářejte, vypisujte, získávejte, aktualizujte a mažte instance AI Search. Úplnou specifikaci najdete v Referenční dokumentace k Instances API.
| Operace | Metoda | Popis |
|---|---|---|
| Vytvořit | POST |
Vytvořte novou instanci |
| Výpis | GET |
Vypsat všechny instance |
| Získat | GET |
Získat instanci podle ID |
| Aktualizovat | PUT |
Aktualizace konfigurace instance |
| Smazat | DELETE |
Odstranění instance |
| Statistiky | GET |
Získat statistiky indexování |
Příklad: Vytvoření instance
Vytvořte instanci ve výchozím jmenném prostoru:
curl -X POST "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai-search/instances" \
-H "Authorization: Bearer <API_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"id": "my-instance"
}'Úlohy
Spouštění a sledování synchronizační úlohy které prohledávají váš zdroj dat a indexují nový nebo aktualizovaný obsah. Úplnou specifikaci najdete v Referenční dokumentace k Jobs API.
| Operace | Metoda | Popis |
|---|---|---|
| Vytvořit | POST |
Spuštění nové synchronizační úlohy |
| Výpis | GET |
Vypsat všechny úlohy pro instanci |
| Získat | GET |
Získat podrobnosti o úloze |
| Protokoly | GET |
Zobrazení protokolů úlohy |
Příklad: Spuštění synchronizační úlohy
Spusťte novou synchronizační úlohu pro instanci:
curl -X POST "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai-search/instances/<INSTANCE_NAME>/jobs" \
-H "Authorization: Bearer <API_TOKEN>"