Skip to main content

instances_search

Creates, updates, deletes, gets or lists an instances_search resource.

Overview

Nameinstances_search
TypeResource
Idcloudflare.ai_search.instances_search

Fields

The following fields are returned by SELECT queries:

Returns the search results.

NameDatatypeDescription
resultobject
successboolean

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
search_by_accountselectid, account_idExecutes a semantic search query against an AI Search instance to find relevant indexed content.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
account_idstringThe Cloudflare account ID.
idstringResource ID.

SELECT examples

Executes a semantic search query against an AI Search instance to find relevant indexed content.

SELECT
result,
success
FROM cloudflare.ai_search.instances_search
WHERE id = '{{ id }}' -- required
AND account_id = '{{ account_id }}' -- required
;