Search
aisearch.instances.search(strid, InstanceSearchParams**kwargs) -> InstanceSearchResponse
POST/accounts/{account_id}/ai-search/instances/{id}/search
Executes a semantic search query against an AI Search instance to find relevant indexed content.
Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
Example:
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
Example:
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
Example:
Parameters
Search
import os
from cloudflare import Cloudflare
client = Cloudflare(
api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted
)
response = client.aisearch.instances.search(
id="my-ai-search",
account_id="c3dc5f0b34a14ff8e1b3ec04895e1b22",
messages=[{
"content": "content",
"role": "system",
}],
)
print(response.chunks){
"result": {
"chunks": [
{
"id": "id",
"score": 0,
"text": "text",
"type": "type",
"item": {
"key": "key",
"metadata": {
"foo": "bar"
},
"timestamp": 0
},
"scoring_details": {
"fusion_method": "rrf",
"keyword_rank": 0,
"keyword_score": 0,
"reranking_score": 0,
"vector_rank": 0,
"vector_score": 0
}
}
],
"search_query": "search_query"
},
"success": true
}Returns Examples
{
"result": {
"chunks": [
{
"id": "id",
"score": 0,
"text": "text",
"type": "type",
"item": {
"key": "key",
"metadata": {
"foo": "bar"
},
"timestamp": 0
},
"scoring_details": {
"fusion_method": "rrf",
"keyword_rank": 0,
"keyword_score": 0,
"reranking_score": 0,
"vector_rank": 0,
"vector_score": 0
}
}
],
"search_query": "search_query"
},
"success": true
}