INTEGRITY Dokumentace

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

Veřejný koncový bod

Veřejné endpointy AI Search umožňují zpřístupnit funkce AI Search bez nutnosti ověřování. Díky tomu můžete AI Search integrovat do veřejně dostupných aplikací nebo ji sdílet s externími uživateli.

Předpřipravené komponenty pro vyhledávání a chat, které můžete pomocí veřejných koncových bodů vložit na svůj web, najdete v Úryvky UI.

Předpoklady

Povolte veřejné endpointy pro svou instanci AI Search:

  1. Přejděte na AI Search v dashboardu Cloudflare. Přejděte na AI Search ↗
  2. Vyberte svou instanci AI Search.
  3. Přejděte na Nastavení > Veřejný koncový bod.
  4. Zapněte Povolte veřejný endpoint.
  5. Zkopírujte adresu URL veřejného endpointu.

Konfigurační možnosti, jako rate limiting a CORS, najdete v Konfigurace veřejného koncového bodu.

Hostitelské názvy endpointu

Veřejný endpoint můžete povolit pro jednu instanci nebo pro celý namespace. Endpoint jmenného prostoru obsluhuje stejné tři cesty a prohledává instance, které v daném jmenném prostoru povolíte, přičemž výsledky sloučí.

Hostitelský název generuje Cloudflare při povolení endpointu:

Hostname Popis
<PUBLIC_ENDPOINT_ID>.search.ai.cloudflare.com Obsluhuje jednu instanci.
ns-<NAMESPACE_ENDPOINT_ID>.search.ai.cloudflare.com Obsluhuje namespace, vyhledávání napříč několika instancemi.

Formáty požadavku a odpovědi jsou pro obě stejné. Příklady na této stránce používají hostitelský název instance.

Vlastní doména

Stejné endpointy můžete zpřístupnit z hostitelského názvu, který vlastníte, například search.example.com, místo vygenerovaného:

https://search.example.com/search
https://search.example.com/chat/completions
https://search.example.com/mcp

Hostitelský název musí patřit do zóny na stejném účtu Cloudflare. Chcete-li připojit vlastní doménu:

  1. Přejděte na AI Search v dashboardu Cloudflare. Přejděte na AI Search ↗
  2. Vyberte svou instanci nebo jmenný prostor.
  3. Přejděte na Veřejné koncové body a povolte veřejný koncový bod. Vlastní doména vyžaduje aktivní veřejný koncový bod.
  4. Přejděte na Custom Domains a připojte svůj hostitelský název.

Vlastní doména směruje požadavky přes vaši vlastní zónu, takže před ni můžete také umístit Cloudflare Access před endpoint a vyžadovat, aby se volající autentizovali dříve, než se dostanou k AI Search. Access chrání pouze vlastní hostitelský název, proto nastavte default_domain_enabled na false také. V opačném případě výchozí <PUBLIC_ENDPOINT_ID>.search.ai.cloudflare.com hostitelský název i nadále odpovídá na neautentizované požadavky.

Chcete-li místo toho připojit doménu přes API, najdete postup v Vlastní domény.

Chat completions

/chat/completions koncový bod prohledá váš zdroj dat a pomocí modelu a získaného kontextu vygeneruje odpověď. Používá stejný formát kompatibilní s OpenAI jako REST API.

curl https://<PUBLIC_ENDPOINT_ID>.search.ai.cloudflare.com/chat/completions \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [
      {
        "content": "How do I configure AI Search?",
        "role": "user"
      }
    ]
  }'

Úplný seznam možností najdete v Referenční dokumentace k API Chat Completions.

/search koncový bod vrací relevantní chunky z vašeho zdroje dat, aniž by generoval odpověď. Používá stejný formát jako REST API.

curl https://<PUBLIC_ENDPOINT_ID>.search.ai.cloudflare.com/search \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [
      {
        "content": "How do I configure AI Search?",
        "role": "user"
      }
    ]
  }'

Úplný seznam možností najdete v Referenční dokumentace k API Search.

Další kroky