Multi-Instance Chat Completions
aisearch.namespaces.chat_completions(strname, NamespaceChatCompletionsParams**kwargs) -> NamespaceChatCompletionsResponse
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:
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:
Multi-Instance Chat Completions
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.namespaces.chat_completions(
name="my-namespace",
account_id="c3dc5f0b34a14ff8e1b3ec04895e1b22",
aisearch_options={
"instance_ids": ["my-ai-search"]
},
messages=[{
"content": "string",
"role": "system",
}],
)
print(response.id){
"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
},
"media_end_ms": 0,
"media_start_ms": 0,
"scoring_details": {
"fusion_method": "rrf",
"keyword_rank": 0,
"keyword_score": 0,
"reranking_score": 0,
"vector_rank": 0,
"vector_score": 0
},
"source_media_type": "audio"
}
],
"id": "id",
"errors": [
{
"instance_id": "instance_id",
"message": "message"
}
],
"model": "model",
"object": "object"
}Returns Examples
{
"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
},
"media_end_ms": 0,
"media_start_ms": 0,
"scoring_details": {
"fusion_method": "rrf",
"keyword_rank": 0,
"keyword_score": 0,
"reranking_score": 0,
"vector_rank": 0,
"vector_score": 0
},
"source_media_type": "audio"
}
],
"id": "id",
"errors": [
{
"instance_id": "instance_id",
"message": "message"
}
],
"model": "model",
"object": "object"
}