--- title: Multi-Instance Chat Completions --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [AI Search](https://developers.cloudflare.com/api/go/resources/ai_search) [Namespaces](https://developers.cloudflare.com/api/go/resources/ai_search/subresources/namespaces) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Multi-Instance Chat Completions client.AISearch.Namespaces.ChatCompletions(ctx, name, params) (\*[NamespaceChatCompletionsResponse](), error) POST/accounts/{account\_id}/ai-search/namespaces/{name}/chat/completions Performs a chat completion request against multiple AI Search instances in parallel, merging retrieved content as context for generating a response. ##### 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 name string [Link to this property](<#(resource)%20ai_search.namespaces%20%3E%20(method)%20chat_completions%20%3E%20(params)%20default%20%3E%20(param)%20name%20%3E%20(schema)>)
params NamespaceChatCompletionsParams AccountID param.Field\[string] Path param Link to this property
AISearchOptions param.Field\[NamespaceChatCompletionsParamsAISearchOptions] Body param InstanceIDs \[]string Link to this property
Cache NamespaceChatCompletionsParamsAISearchOptionsCacheOptional
CacheThreshold NamespaceChatCompletionsParamsAISearchOptionsCacheCacheThresholdOptional One of the following: const NamespaceChatCompletionsParamsAISearchOptionsCacheCacheThresholdSuperStrictMatch NamespaceChatCompletionsParamsAISearchOptionsCacheCacheThreshold = "super\_strict\_match" Link to this property const NamespaceChatCompletionsParamsAISearchOptionsCacheCacheThresholdCloseEnough NamespaceChatCompletionsParamsAISearchOptionsCacheCacheThreshold = "close\_enough" Link to this property const NamespaceChatCompletionsParamsAISearchOptionsCacheCacheThresholdFlexibleFriend NamespaceChatCompletionsParamsAISearchOptionsCacheCacheThreshold = "flexible\_friend" Link to this property const NamespaceChatCompletionsParamsAISearchOptionsCacheCacheThresholdAnythingGoes NamespaceChatCompletionsParamsAISearchOptionsCacheCacheThreshold = "anything\_goes" Link to this property
Link to this property Enabled boolOptional Link to this property
Link to this property
CustomMetadata map\[string, NamespaceChatCompletionsParamsAISearchOptionsCustomMetadataUnion]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 NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteOptional 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 NamespaceChatCompletionsParamsAISearchOptionsRerankingOptional 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 NamespaceChatCompletionsParamsAISearchOptionsRetrievalOptional
BoostBy \[]NamespaceChatCompletionsParamsAISearchOptionsRetrievalBoostByOptional 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 NamespaceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirectionOptional 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 NamespaceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirectionAsc NamespaceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection = "asc" Link to this property const NamespaceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirectionDesc NamespaceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection = "desc" Link to this property const NamespaceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirectionExists NamespaceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection = "exists" Link to this property const NamespaceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirectionNotExists NamespaceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection = "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 NamespaceChatCompletionsParamsAISearchOptionsRetrievalFusionMethodOptional One of the following: const NamespaceChatCompletionsParamsAISearchOptionsRetrievalFusionMethodMax NamespaceChatCompletionsParamsAISearchOptionsRetrievalFusionMethod = "max" Link to this property const NamespaceChatCompletionsParamsAISearchOptionsRetrievalFusionMethodRrf NamespaceChatCompletionsParamsAISearchOptionsRetrievalFusionMethod = "rrf" Link to this property
Link to this property
KeywordMatchMode NamespaceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchModeOptional 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 NamespaceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchModeAnd NamespaceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchMode = "and" Link to this property const NamespaceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchModeOr NamespaceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchMode = "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 NamespaceChatCompletionsParamsAISearchOptionsRetrievalRetrievalTypeOptional One of the following: const NamespaceChatCompletionsParamsAISearchOptionsRetrievalRetrievalTypeVector NamespaceChatCompletionsParamsAISearchOptionsRetrievalRetrievalType = "vector" Link to this property const NamespaceChatCompletionsParamsAISearchOptionsRetrievalRetrievalTypeKeyword NamespaceChatCompletionsParamsAISearchOptionsRetrievalRetrievalType = "keyword" Link to this property const NamespaceChatCompletionsParamsAISearchOptionsRetrievalRetrievalTypeHybrid NamespaceChatCompletionsParamsAISearchOptionsRetrievalRetrievalType = "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\[\[]NamespaceChatCompletionsParamsMessage] Body param
Content NamespaceChatCompletionsParamsMessagesContentUnion One of the following: UnionString Link to this property
type NamespaceChatCompletionsParamsMessagesContentArray \[]NamespaceChatCompletionsParamsMessagesContentArray One of the following:
type NamespaceChatCompletionsParamsMessagesContentArrayObject struct{…} Text string minLength1 Link to this property Type NamespaceChatCompletionsParamsMessagesContentArrayObjectType Link to this property
Link to this property
type NamespaceChatCompletionsParamsMessagesContentArrayObject struct{…}
ImageURL NamespaceChatCompletionsParamsMessagesContentArrayObjectImageURL URL string maxLength20971520 minLength1 Link to this property
Link to this property Type NamespaceChatCompletionsParamsMessagesContentArrayObjectType Link to this property
Link to this property
type NamespaceChatCompletionsParamsMessagesContentArrayObject struct{…}
File NamespaceChatCompletionsParamsMessagesContentArrayObjectFile 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 NamespaceChatCompletionsParamsMessagesContentArrayObjectType Link to this property
Link to this property
Link to this property UnionString Link to this property
Link to this property
Role NamespaceChatCompletionsParamsMessagesRole One of the following: const NamespaceChatCompletionsParamsMessagesRoleSystem NamespaceChatCompletionsParamsMessagesRole = "system" Link to this property const NamespaceChatCompletionsParamsMessagesRoleDeveloper NamespaceChatCompletionsParamsMessagesRole = "developer" Link to this property const NamespaceChatCompletionsParamsMessagesRoleUser NamespaceChatCompletionsParamsMessagesRole = "user" Link to this property const NamespaceChatCompletionsParamsMessagesRoleAssistant NamespaceChatCompletionsParamsMessagesRole = "assistant" Link to this property const NamespaceChatCompletionsParamsMessagesRoleTool NamespaceChatCompletionsParamsMessagesRole = "tool" Link to this property
Link to this property
Link to this property Model param.Field\[string]Optional Body param: 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 Stream param.Field\[bool]Optional Body param Link to this property
[Link to this property](<#(resource)%20ai_search.namespaces%20%3E%20(method)%20chat_completions%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type NamespaceChatCompletionsResponse struct{…}
Choices \[]NamespaceChatCompletionsResponseChoice
Message NamespaceChatCompletionsResponseChoicesMessage
Content NamespaceChatCompletionsResponseChoicesMessageContentUnion One of the following: UnionString Link to this property
type NamespaceChatCompletionsResponseChoicesMessageContentArray \[]NamespaceChatCompletionsResponseChoicesMessageContentArrayItem One of the following:
type NamespaceChatCompletionsResponseChoicesMessageContentArrayObject struct{…} Text string minLength1 Link to this property Type NamespaceChatCompletionsResponseChoicesMessageContentArrayObjectType Link to this property
Link to this property
type NamespaceChatCompletionsResponseChoicesMessageContentArrayObject struct{…}
ImageURL NamespaceChatCompletionsResponseChoicesMessageContentArrayObjectImageURL URL string maxLength20971520 minLength1 Link to this property
Link to this property Type NamespaceChatCompletionsResponseChoicesMessageContentArrayObjectType Link to this property
Link to this property
type NamespaceChatCompletionsResponseChoicesMessageContentArrayObject struct{…}
File NamespaceChatCompletionsResponseChoicesMessageContentArrayObjectFile 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 NamespaceChatCompletionsResponseChoicesMessageContentArrayObjectType Link to this property
Link to this property
Link to this property UnionString Link to this property
Link to this property
Role NamespaceChatCompletionsResponseChoicesMessageRole One of the following: const NamespaceChatCompletionsResponseChoicesMessageRoleSystem NamespaceChatCompletionsResponseChoicesMessageRole = "system" Link to this property const NamespaceChatCompletionsResponseChoicesMessageRoleDeveloper NamespaceChatCompletionsResponseChoicesMessageRole = "developer" Link to this property const NamespaceChatCompletionsResponseChoicesMessageRoleUser NamespaceChatCompletionsResponseChoicesMessageRole = "user" Link to this property const NamespaceChatCompletionsResponseChoicesMessageRoleAssistant NamespaceChatCompletionsResponseChoicesMessageRole = "assistant" Link to this property const NamespaceChatCompletionsResponseChoicesMessageRoleTool NamespaceChatCompletionsResponseChoicesMessageRole = "tool" Link to this property
Link to this property
Link to this property Index int64Optional Link to this property
Link to this property
Chunks \[]NamespaceChatCompletionsResponseChunk ID string Link to this property InstanceID 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 NamespaceChatCompletionsResponseChunksItemOptional 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 NamespaceChatCompletionsResponseChunksScoringDetailsOptional
FusionMethod NamespaceChatCompletionsResponseChunksScoringDetailsFusionMethodOptional One of the following: const NamespaceChatCompletionsResponseChunksScoringDetailsFusionMethodRrf NamespaceChatCompletionsResponseChunksScoringDetailsFusionMethod = "rrf" Link to this property const NamespaceChatCompletionsResponseChunksScoringDetailsFusionMethodMax NamespaceChatCompletionsResponseChunksScoringDetailsFusionMethod = "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 ID stringOptional Link to this property
Errors \[]NamespaceChatCompletionsResponseErrorOptional InstanceID string Link to this property Message string Link to this property
Link to this property Model stringOptional Link to this property Object stringOptional Link to this property
[Link to this property](<#(resource)%20ai_search.namespaces%20%3E%20(model)%20NamespaceChatCompletionsResponse%20%3E%20(schema)>) ### Multi-Instance Chat Completions 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" "github.com/cloudflare/cloudflare-go/shared" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) response, err := client.AISearch.Namespaces.ChatCompletions( context.TODO(), "my-namespace", ai_search.NamespaceChatCompletionsParams{ AccountID: cloudflare.F("c3dc5f0b34a14ff8e1b3ec04895e1b22"), AISearchOptions: cloudflare.F(ai_search.NamespaceChatCompletionsParamsAISearchOptions{ InstanceIDs: cloudflare.F([]string{"my-ai-search"}), }), Messages: cloudflare.F([]ai_search.NamespaceChatCompletionsParamsMessage{ai_search.NamespaceChatCompletionsParamsMessage{ Content: cloudflare.F[ai_search.NamespaceChatCompletionsParamsMessagesContentUnion](shared.UnionString("string")), Role: cloudflare.F(ai_search.NamespaceChatCompletionsParamsMessagesRoleSystem), }}), }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.ID) } ``` 200 example ``` { "choices": [ { "message": { "content": "string", "role": "system" }, "index": 0 } ], "chunks": [ { "id": "id", "instance_id": "instance_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 } } ], "id": "id", "errors": [ { "instance_id": "instance_id", "message": "message" } ], "model": "model", "object": "object" } ``` ##### Returns Examples 200 example ``` { "choices": [ { "message": { "content": "string", "role": "system" }, "index": 0 } ], "chunks": [ { "id": "id", "instance_id": "instance_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 } } ], "id": "id", "errors": [ { "instance_id": "instance_id", "message": "message" } ], "model": "model", "object": "object" } ```