← Přehled / ai-search / get-started

REST API

Tento návod vás provede vytvořením instance AI Search pomocí REST API.

1. Vytvořte token API

Potřebujete 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.

2. Vytvořte instanci AI Search

Použijte API pro vytvoření instance a vytvořte instanci. Nahraďte <ACCOUNT_ID> s vaším ID účtu.

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" \
  --data '{
    "id": "my-instance"
  }'

Připojte zdroj dat (volitelné)

Můžete vytvořit instanci připojenou k webu nebo bucketu R2 jako zdroji dat. AI Search obsah automaticky zaindexuje.

Web:

Automaticky procházejte a indexujte web který vlastníte.

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" \
  --data '{
    "id": "my-instance",
    "type": "web-crawler",
    "source": "example.com"
  }'

R2 bucket:

Indexujte dokumenty uložené v R2 bucket. Připojení R2 bucketu vyžaduje servisní token API. Pokud jste ještě nikdy nevytvořili instanci podporovanou R2, musíte předat token_id je pole v požadavku na vytvoření. Přečtěte si konfigurace servisního tokenu API pro pokyny k nastavení.

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" \
  --data '{
    "id": "my-instance",
    "type": "r2",
    "source": "<R2_BUCKET_NAME>",
    "token_id": "<SERVICE_TOKEN_ID>"
  }'

3. Přidejte obsah

Pokud jste nevytvořili instanci propojenou se zdrojem dat, nahrajte soubory pomocí Items API. Tento krok můžete přeskočit, pokud jste připojili web nebo bucket R2.

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

AI Search automaticky indexuje nahrané soubory.

4. Zkontrolujte stav indexování

Zkontrolujte, zda bylo indexování vašeho obsahu dokončeno.

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

Vyzkoušejte to

Jakmile je indexování dokončeno, spusťte svůj první dotaz.

curl "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai-search/instances/my-instance/search" \
  -H "Authorization: Bearer <API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [
      {
        "content": "How do I get started?",
        "role": "user"
      }
    ]
  }'

Dotazy můžete otestovat také v dashboardu: přejděte do své instance a vyberte Playground kartě.

REST API

1. Vytvořte token API

2. Vytvořte instanci AI Search

Připojte zdroj dat (volitelné)

3. Přidejte obsah

4. Zkontrolujte stav indexování

Vyzkoušejte to

Přidat do aplikace

Workers binding

REST API