このガイドでは、REST API を使って AI Search インスタンスを作成する手順を説明します。
AI Search:Edit と AI Search:Run の権限を持つ API トークンが必要です。
-
Cloudflare ダッシュボードで、My Profile > API Tokens を開きます。
API Tokens を開く ↗ -
Create Token を選びます。
-
Create Custom Token を選びます。
-
Token name を入力します。例:
AI Search Manager。 -
Permissions で、次の 2 つの権限を追加します。
- Account > AI Search:Edit
- Account > AI Search:Run
-
Continue to summary を選び、Create Token を選びます。
-
トークン値をコピーして保存します。これが
API_TOKENです。
Create instance API を使ってインスタンスを作成します。<ACCOUNT_ID> は アカウント ID に置き換えます。
curl -X POST "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai-search/namespaces/default/instances" \
-H "Authorization: Bearer <API_TOKEN>" \
-H "Content-Type: application/json" \
--data '{
"id": "my-instance"
}'Web サイトまたは R2 バケットをデータソースとして接続したインスタンスを作成できます。AI Search はコンテンツを自動でインデックスします。
Web サイト:
所有する Web サイト を自動クロールしてインデックスします。
curl -X POST "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai-search/namespaces/default/instances" \
-H "Authorization: Bearer <API_TOKEN>" \
-H "Content-Type: application/json" \
--data '{
"id": "my-instance",
"type": "web-crawler",
"source": "example.com"
}'R2 バケット:
R2 バケット に保存されたドキュメントをインデックスします。R2 バケットの接続には サービス API トークン が必要です。R2 ベースのインスタンスを一度も作成したことがない場合は、作成リクエストに token_id フィールドを渡す必要があります。設定手順は サービス API トークンの構成 を参照してください。
curl -X POST "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai-search/namespaces/default/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>"
}'データソースに接続したインスタンスを作成していない場合は、Items API でファイルをアップロードします。Web サイトまたは R2 バケットを接続した場合は、このステップをスキップできます。
curl -X POST "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai-search/namespaces/default/instances/my-instance/items" \
-H "Authorization: Bearer <API_TOKEN>" \
-F "file=@/path/to/your/file.pdf"AI Search はアップロードされたファイルを自動でインデックスします。
コンテンツのインデックスが完了したかを確認します。
curl "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai-search/namespaces/default/instances/my-instance/stats" \
-H "Authorization: Bearer <API_TOKEN>"インデックスが完了したら、最初のクエリを実行します。
curl "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai-search/namespaces/default/instances/my-instance/search" \
-H "Authorization: Bearer <API_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"messages": [
{
"content": "How do I get started?",
"role": "user"
}
]
}'ダッシュボードでインスタンスを開き、Playground タブを選んでクエリをテストすることもできます。