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

Migrace REST API

Endpointy AutoRAG API jsou starší REST API pro AI Search. Budou nadále fungovat, ale všechny nové funkce a vylepšení jsou dostupné pouze prostřednictvím nového Endpointy AI Search API.

Starší endpointy AutoRAG API pod /autorag/rags/ byly nahrazeny novými endpointy pod /ai-search/instances/.

Nové API také obsahuje endpointy pro správa instance, položky, a vyhledávání na úrovni jmenného prostoru které nejsou dostupné ve starším API. Starší endpointy najdete v Referenční dokumentace k AutoRAG API.

Starší endpointy AutoRAG používaly AutoRAG oprávnění API tokenu. Nové endpointy AI Search vyžadují AI Search oprávnění, proto aktualizujte oprávnění tokenu, který používáte k volání API. Doporučujeme použít API tokeny účtu, které patří účtu, a ne jednotlivému uživateli, a přidáním AI Search oprávnění, které najdete v AI a strojové učení > AI Search.

1. V Cloudflare dashboardu přejděte na Manage Account > API Tokens.
2. Vyberte Create Token, poté spusťte vytváření vlastního tokenu.
3. Zadejte název tokenu.
4. Přidejte zásadu oprávnění a vyberte AI a strojové učení > AI Search, poté zvolte potřebnou úroveň přístupu. AI Search nabízí Čtení, Spustit, a Úprava přístup.
5. (Volitelné) Nastavte filtrování podle IP adresy klienta a platnost tokenu.
6. Vytvořte token a zkopírujte jeho hodnotu.

1. V Cloudflare dashboardu přejděte na Manage Account > API Tokens.
2. Vyberte token, který chcete aktualizovat.
3. Přidejte nebo upravte zásadu oprávnění tak, aby zahrnovala AI a strojové učení > AI Search s úrovní přístupu, kterou potřebujete, a poté uložte.

Úplný postup vytvoření tokenu najdete v Vytvoření API tokenu.

Jak migrovat z AutoRAG /ai-search koncový bod na nový /chat/completions koncový bod:

Před (AutoRAG API):

curl -X POST "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/autorag/rags/<INSTANCE_NAME>/ai-search" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <API_TOKEN>" \
  -d '{
    "query": "What is Cloudflare?"
  }'

Poté (AI Search API):

Nové API používá messages formát pole.

curl -X POST "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai-search/instances/<INSTANCE_NAME>/chat/completions" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <API_TOKEN>" \
  -d '{
    "messages": [
      {
        "content": "What is Cloudflare?",
        "role": "user"
      }
    ]
  }'

Jak migrovat z AutoRAG /search koncový bod na nový /search koncový bod:

Před (AutoRAG API):

curl -X POST "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/autorag/rags/<INSTANCE_NAME>/search" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <API_TOKEN>" \
  -d '{
    "query": "What is Cloudflare?"
  }'

Poté (AI Search API):

Nové API používá messages formát pole. query formát řetězce je také podporován.

curl -X POST "https://api.cloudflare.com/client/v4/accounts/<ACCOUNT_ID>/ai-search/instances/<INSTANCE_NAME>/search" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <API_TOKEN>" \
  -d '{
    "messages": [
      {
        "content": "What is Cloudflare?",
        "role": "user"
      }
    ]
  }'

Ve starém API AutoRAG, když stream byla nastavena na true, obdrželi byste pouze streamovanou odpověď bez načtených částí obsahu.

V novém API AI Search obsahují streamované odpovědi i fragmenty. Načtené fragmenty se odesílají nejprve jako chunks událost, po které následují streamovaná data odpovědi. Díky tomu můžete zdrojové chunky zobrazit ihned, zatímco se vygenerovaná odpověď streamuje uživateli.

Nové REST API pro AI Search používá filtrování metadat ve stylu Vectorize, které se liší od formátu AutoRAG API. Filtry jsou nyní vnořeny pod ai_search_options.retrieval.filters v těle požadavku. Úplnou dokumentaci starého formátu najdete v Formát filtru metadat (legacy).

Operátory filtru byly přejmenovány tak, aby používaly $ prefix:

Filtrování podle jediné položky metadat pomocí implicitní rovnosti:

Před (AutoRAG API):

{
	"filters": {
		"type": "eq",
		"key": "folder",
		"value": "customer-a/"
	}
}

Poté (AI Search API):

{
	"ai_search_options": {
		"retrieval": {
			"filters": { "folder": "customer-a/" }
		}
	}
}

Kombinujte více podmínek, které musí být splněny všechny:

Před (AutoRAG API):

{
	"filters": {
		"type": "and",
		"filters": [
			{ "type": "eq", "key": "folder", "value": "customer-a/" },
			{ "type": "gte", "key": "timestamp", "value": "1735689600000" }
		]
	}
}

Poté (AI Search API):

{
	"ai_search_options": {
		"retrieval": {
			"filters": {
				"folder": "customer-a/",
				"timestamp": { "$gte": 1735689600 }
			}
		}
	}
}

• Dokumentace REST API
• Referenční dokumentace k API Chat Completions
• Referenční dokumentace k API Search
• Referenční dokumentace ke staršímu AutoRAG API