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

Python SDK

Tento návod vás provede vytvořením instance AI Search, nahráním obsahu a jejím dotazováním z aplikace Python pomocí Cloudflare Python SDK ↗.

• Python ↗ 3.8 nebo novější.
• Váš ID účtu.

Tento návod používá default namespace, který existuje automaticky pro každý účet. Chcete-li seskupit instance do vlastního jmenného prostoru, vytvořte ho pomocí client.aisearch.namespaces.create().

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

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.

Vytvořte adresář projektu a virtuální prostředí, abyste izolovali své závislosti.

mkdir ai-search-python && cd ai-search-python
python3 -m venv .venv
source .venv/bin/activate

Ve Windows aktivujte virtuální prostředí pomocí .venv\Scripts\activate místo toho.

Nainstalujte oficiální cloudflare balíček:

pip install cloudflare

Exportujte ID účtu a token API jako proměnné prostředí.

export CLOUDFLARE_ACCOUNT_ID="<ACCOUNT_ID>"
export CLOUDFLARE_API_TOKEN="<API_TOKEN>"

Vytvořte soubor s názvem quickstart.py. Následující kód nastaví klienta a vytvoří instanci s názvem my-instance v default jmenný prostor. Protože není zadán žádný zdroj dat, instance používá vestavěné úložiště, abyste do něj mohli nahrávat soubory přímo.

import os

from cloudflare import Cloudflare

client = Cloudflare(api_token=os.environ["CLOUDFLARE_API_TOKEN"])
account_id = os.environ["CLOUDFLARE_ACCOUNT_ID"]

instance = client.aisearch.namespaces.instances.create(
    name="default",
    account_id=account_id,
    id="my-instance",
)

print(f"Created instance: {instance.id}")

Přidejte následující do quickstart.py k nahrání dokumentu. Nastavení wait_for_completion na True počká na dokončení indexování, než vrátí odpověď, aby byl soubor připraven k vyhledávání. Pokud indexování ještě probíhá, item.status může být running; soubor se dál indexuje na pozadí a krátce poté se stane prohledatelným.

item = client.aisearch.namespaces.instances.items.upload(
    id="my-instance",
    account_id=account_id,
    name="default",
    file={
        "file": (
            "getting-started.md",
            b"AI Search indexes uploaded content for retrieval.",
            "text/markdown",
        ),
        "wait_for_completion": True,
    },
)

print(f"Uploaded item status: {item.status}")

Přidejte následující do quickstart.py a spustit tak dotaz nad indexovaným obsahem.

results = client.aisearch.namespaces.instances.search(
    id="my-instance",
    account_id=account_id,
    name="default",
    query="How does AI Search handle uploaded content?",
)

if results.chunks:
    print(results.chunks[0].text)
else:
    print("No results yet — your content may still be indexing. Try again in a moment.")

Spusťte skript:

python quickstart.py

Pokud vyhledávání nevrátí žádné výsledky, obsah se možná ještě indexuje. Chvíli počkejte a vyhledávání spusťte znovu.