--- title: Search --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [AI Search](https://developers.cloudflare.com/api/go/resources/ai_search) [Instances](https://developers.cloudflare.com/api/go/resources/ai_search/subresources/instances) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Search Deprecated client.AISearch.Instances.Search(ctx, id, params) (\*[InstanceSearchResponse](), error) POST/accounts/{account\_id}/ai-search/instances/{id}/search Executes a semantic search query against an AI Search instance to find relevant indexed content. Deprecated: use /accounts/{account\_id}/ai-search/namespaces/{name}/instances (and descendant paths) instead. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### ParametersExpand Collapse id string AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. maxLength64 minLength1 [Link to this property](<#(resource)%20ai_search.instances%20%3E%20(method)%20search%20%3E%20(params)%20default%20%3E%20(param)%20id%20%3E%20(schema)>)
params InstanceSearchParams AccountID param.Field\[string] Path param Link to this property
AISearchOptions param.Field\[InstanceSearchParamsAISearchOptions]Optional Body param
Cache InstanceSearchParamsAISearchOptionsCacheOptional
CacheThreshold InstanceSearchParamsAISearchOptionsCacheCacheThresholdOptional One of the following: const InstanceSearchParamsAISearchOptionsCacheCacheThresholdSuperStrictMatch InstanceSearchParamsAISearchOptionsCacheCacheThreshold = "super\_strict\_match" Link to this property const InstanceSearchParamsAISearchOptionsCacheCacheThresholdCloseEnough InstanceSearchParamsAISearchOptionsCacheCacheThreshold = "close\_enough" Link to this property const InstanceSearchParamsAISearchOptionsCacheCacheThresholdFlexibleFriend InstanceSearchParamsAISearchOptionsCacheCacheThreshold = "flexible\_friend" Link to this property const InstanceSearchParamsAISearchOptionsCacheCacheThresholdAnythingGoes InstanceSearchParamsAISearchOptionsCacheCacheThreshold = "anything\_goes" Link to this property
Link to this property Enabled boolOptional Link to this property
Link to this property
CustomMetadata map\[string, InstanceSearchParamsAISearchOptionsCustomMetadataUnion]Optional Metadata added to AI Gateway logs for requests triggered by this operation. Accepts up to 2 string, number, or boolean entries. Keys ‘ai-search’, ‘task’, ‘origin’, and keys beginning with ‘cf.’ are reserved. One of the following: UnionString Link to this property UnionFloat Link to this property UnionBool Link to this property
Link to this property
QueryRewrite InstanceSearchParamsAISearchOptionsQueryRewriteOptional Enabled boolOptional Link to this property Model stringOptional A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model. Link to this property RewritePrompt stringOptional Link to this property
Link to this property
Reranking InstanceSearchParamsAISearchOptionsRerankingOptional Enabled boolOptional Link to this property MatchThreshold float64Optional maximum1 minimum0 Link to this property Model stringOptional Link to this property
Link to this property
Retrieval InstanceSearchParamsAISearchOptionsRetrievalOptional
BoostBy \[]InstanceSearchParamsAISearchOptionsRetrievalBoostByOptional Metadata fields to boost search results by. Overrides the instance-level boost\_by config. Direction defaults to ‘asc’ for numeric/datetime fields, ‘exists’ for text/boolean fields. Fields must match ‘timestamp’ or a defined custom\_metadata field. Field string Metadata field name to boost by. Use ‘timestamp’ for document freshness, or any custom\_metadata field. Numeric and datetime fields support all four directions (asc, desc, exists, not\_exists); text/boolean fields only support exists/not\_exists. maxLength64 minLength1 Link to this property
Direction InstanceSearchParamsAISearchOptionsRetrievalBoostByDirectionOptional Boost direction. ‘desc’ = higher values rank higher (e.g. newer timestamps). ‘asc’ = lower values rank higher. ‘exists’ = boost chunks that have the field. ‘not\_exists’ = boost chunks that lack the field. Optional — defaults to ‘asc’ for numeric/datetime fields, ‘exists’ for text/boolean fields. One of the following: const InstanceSearchParamsAISearchOptionsRetrievalBoostByDirectionAsc InstanceSearchParamsAISearchOptionsRetrievalBoostByDirection = "asc" Link to this property const InstanceSearchParamsAISearchOptionsRetrievalBoostByDirectionDesc InstanceSearchParamsAISearchOptionsRetrievalBoostByDirection = "desc" Link to this property const InstanceSearchParamsAISearchOptionsRetrievalBoostByDirectionExists InstanceSearchParamsAISearchOptionsRetrievalBoostByDirection = "exists" Link to this property const InstanceSearchParamsAISearchOptionsRetrievalBoostByDirectionNotExists InstanceSearchParamsAISearchOptionsRetrievalBoostByDirection = "not\_exists" Link to this property
Link to this property
Link to this property ContextExpansion int64Optional maximum3 minimum0 Link to this property Filters map\[string, unknown]Optional Link to this property
FusionMethod InstanceSearchParamsAISearchOptionsRetrievalFusionMethodOptional One of the following: const InstanceSearchParamsAISearchOptionsRetrievalFusionMethodMax InstanceSearchParamsAISearchOptionsRetrievalFusionMethod = "max" Link to this property const InstanceSearchParamsAISearchOptionsRetrievalFusionMethodRrf InstanceSearchParamsAISearchOptionsRetrievalFusionMethod = "rrf" Link to this property
Link to this property
KeywordMatchMode InstanceSearchParamsAISearchOptionsRetrievalKeywordMatchModeOptional Controls which documents are candidates for BM25 scoring. ‘and’ restricts candidates to documents containing all query terms; ‘or’ includes any document containing at least one term, ranked by BM25 relevance. When omitted, falls back to the instance-level retrieval\_options.keyword\_match\_mode, then to ‘and’. One of the following: const InstanceSearchParamsAISearchOptionsRetrievalKeywordMatchModeAnd InstanceSearchParamsAISearchOptionsRetrievalKeywordMatchMode = "and" Link to this property const InstanceSearchParamsAISearchOptionsRetrievalKeywordMatchModeOr InstanceSearchParamsAISearchOptionsRetrievalKeywordMatchMode = "or" Link to this property
Link to this property MatchThreshold float64Optional maximum1 minimum0 Link to this property MaxNumResults int64Optional maximum50 minimum1 Link to this property
RetrievalType InstanceSearchParamsAISearchOptionsRetrievalRetrievalTypeOptional One of the following: const InstanceSearchParamsAISearchOptionsRetrievalRetrievalTypeVector InstanceSearchParamsAISearchOptionsRetrievalRetrievalType = "vector" Link to this property const InstanceSearchParamsAISearchOptionsRetrievalRetrievalTypeKeyword InstanceSearchParamsAISearchOptionsRetrievalRetrievalType = "keyword" Link to this property const InstanceSearchParamsAISearchOptionsRetrievalRetrievalTypeHybrid InstanceSearchParamsAISearchOptionsRetrievalRetrievalType = "hybrid" Link to this property
Link to this property ReturnOnFailure boolOptional Link to this property
Link to this property
Link to this property
Messages param.Field\[\[]InstanceSearchParamsMessage]Optional Body param: OpenAI-compatible message array. For multimodal queries, set the last user message’s content to an array of typed parts: [{type:'text', text:'…'}, {type:'image_url', image_url:{url:'…'}}]. Image inputs require the RAG’s embedding\_model to declare ‘image’ in supported\_modalities.
Content InstanceSearchParamsMessagesContentUnion One of the following: UnionString Link to this property
type InstanceSearchParamsMessagesContentArray \[]InstanceSearchParamsMessagesContentArray One of the following:
type InstanceSearchParamsMessagesContentArrayObject struct{…} Text string minLength1 Link to this property Type InstanceSearchParamsMessagesContentArrayObjectType Link to this property
Link to this property
type InstanceSearchParamsMessagesContentArrayObject struct{…}
ImageURL InstanceSearchParamsMessagesContentArrayObjectImageURL URL string maxLength20971520 minLength1 Link to this property
Link to this property Type InstanceSearchParamsMessagesContentArrayObjectType Link to this property
Link to this property
type InstanceSearchParamsMessagesContentArrayObject struct{…}
File InstanceSearchParamsMessagesContentArrayObjectFile Filename string maxLength255 minLength1 Link to this property FileData stringOptional maxLength13981144 minLength1 Link to this property FileID stringOptional Link to this property
Link to this property Type InstanceSearchParamsMessagesContentArrayObjectType Link to this property
Link to this property
Link to this property UnionString Link to this property
Link to this property
Role InstanceSearchParamsMessagesRole One of the following: const InstanceSearchParamsMessagesRoleSystem InstanceSearchParamsMessagesRole = "system" Link to this property const InstanceSearchParamsMessagesRoleDeveloper InstanceSearchParamsMessagesRole = "developer" Link to this property const InstanceSearchParamsMessagesRoleUser InstanceSearchParamsMessagesRole = "user" Link to this property const InstanceSearchParamsMessagesRoleAssistant InstanceSearchParamsMessagesRole = "assistant" Link to this property const InstanceSearchParamsMessagesRoleTool InstanceSearchParamsMessagesRole = "tool" Link to this property
Link to this property
Link to this property Query param.Field\[string]Optional Body param: A simple text query string. Alternative to ‘messages’ — provide either this or ‘messages’, not both. minLength1 Link to this property
[Link to this property](<#(resource)%20ai_search.instances%20%3E%20(method)%20search%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type InstanceSearchResponse struct{…}
Chunks \[]InstanceSearchResponseChunk ID string Link to this property Score float64 maximum1 minimum0 Link to this property Text string Link to this property Type string Link to this property
Item InstanceSearchResponseChunksItemOptional Key string Link to this property Metadata map\[string, unknown]Optional Link to this property Timestamp float64Optional Link to this property
Link to this property
ScoringDetails InstanceSearchResponseChunksScoringDetailsOptional
FusionMethod InstanceSearchResponseChunksScoringDetailsFusionMethodOptional One of the following: const InstanceSearchResponseChunksScoringDetailsFusionMethodRrf InstanceSearchResponseChunksScoringDetailsFusionMethod = "rrf" Link to this property const InstanceSearchResponseChunksScoringDetailsFusionMethodMax InstanceSearchResponseChunksScoringDetailsFusionMethod = "max" Link to this property
Link to this property KeywordRank float64Optional Link to this property KeywordScore float64Optional minimum0 Link to this property RerankingScore float64Optional maximum1 minimum0 Link to this property VectorRank float64Optional Link to this property VectorScore float64Optional maximum1 minimum0 Link to this property
Link to this property
Link to this property
QueryKind InstanceSearchResponseQueryKind One of the following: const InstanceSearchResponseQueryKindText InstanceSearchResponseQueryKind = "text" Link to this property const InstanceSearchResponseQueryKindImage InstanceSearchResponseQueryKind = "image" Link to this property const InstanceSearchResponseQueryKindMultimodal InstanceSearchResponseQueryKind = "multimodal" Link to this property
Link to this property SearchQuery stringOptional Link to this property
[Link to this property](<#(resource)%20ai_search.instances%20%3E%20(model)%20InstanceSearchResponse%20%3E%20(schema)>) ### Search Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/ai_search" "github.com/cloudflare/cloudflare-go/option" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) response, err := client.AISearch.Instances.Search( context.TODO(), "my-ai-search", ai_search.InstanceSearchParams{ AccountID: cloudflare.F("c3dc5f0b34a14ff8e1b3ec04895e1b22"), }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Chunks) } ``` 200 example ``` { "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 } } ], "query_kind": "text", "search_query": "search_query" }, "success": true } ``` ##### Returns Examples 200 example ``` { "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 } } ], "query_kind": "text", "search_query": "search_query" }, "success": true } ```