Chat Completions

client.AISearch.Namespaces.Instances.ChatCompletions(ctx, name, id, params) (*NamespaceInstanceChatCompletionsResponse, error)

POST/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/chat/completions

Performs a chat completion request against an AI Search instance, using indexed content as context for generating responses.

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

id string

AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

maxLength64

minLength1

params NamespaceInstanceChatCompletionsParams

AccountID param.Field[string]

Path param

Messages param.Field[[]NamespaceInstanceChatCompletionsParamsMessage]

Body param

Content string

Role NamespaceInstanceChatCompletionsParamsMessagesRole

One of the following:

const NamespaceInstanceChatCompletionsParamsMessagesRoleSystem NamespaceInstanceChatCompletionsParamsMessagesRole = "system"

const NamespaceInstanceChatCompletionsParamsMessagesRoleDeveloper NamespaceInstanceChatCompletionsParamsMessagesRole = "developer"

const NamespaceInstanceChatCompletionsParamsMessagesRoleUser NamespaceInstanceChatCompletionsParamsMessagesRole = "user"

const NamespaceInstanceChatCompletionsParamsMessagesRoleAssistant NamespaceInstanceChatCompletionsParamsMessagesRole = "assistant"

const NamespaceInstanceChatCompletionsParamsMessagesRoleTool NamespaceInstanceChatCompletionsParamsMessagesRole = "tool"

AISearchOptions param.Field[NamespaceInstanceChatCompletionsParamsAISearchOptions]Optional

Body param

Cache NamespaceInstanceChatCompletionsParamsAISearchOptionsCacheOptional

CacheThreshold NamespaceInstanceChatCompletionsParamsAISearchOptionsCacheCacheThresholdOptional

One of the following:

const NamespaceInstanceChatCompletionsParamsAISearchOptionsCacheCacheThresholdSuperStrictMatch NamespaceInstanceChatCompletionsParamsAISearchOptionsCacheCacheThreshold = "super_strict_match"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsCacheCacheThresholdCloseEnough NamespaceInstanceChatCompletionsParamsAISearchOptionsCacheCacheThreshold = "close_enough"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsCacheCacheThresholdFlexibleFriend NamespaceInstanceChatCompletionsParamsAISearchOptionsCacheCacheThreshold = "flexible_friend"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsCacheCacheThresholdAnythingGoes NamespaceInstanceChatCompletionsParamsAISearchOptionsCacheCacheThreshold = "anything_goes"

Enabled boolOptional

QueryRewrite NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteOptional

Enabled boolOptional

Model NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelOptional

One of the following:

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfMetaLlama3_3_70bInstructFp8Fast NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfZaiOrgGlm4_7Flash NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/zai-org/glm-4.7-flash"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfMetaLlama3_1_8bInstructFast NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fast"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfMetaLlama3_1_8bInstructFp8 NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fp8"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfMetaLlama4Scout17b16eInstruct NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/meta/llama-4-scout-17b-16e-instruct"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfQwenQwen3_30bA3bFp8 NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/qwen/qwen3-30b-a3b-fp8"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfDeepseekAIDeepseekR1DistillQwen32b NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfMoonshotaiKimiK2Instruct NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/moonshotai/kimi-k2-instruct"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfGoogleGemma3_12bIt NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/google/gemma-3-12b-it"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfGoogleGemma4_26bA4bIt NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/google/gemma-4-26b-a4b-it"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfMoonshotaiKimiK2_5 NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/moonshotai/kimi-k2.5"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelAnthropicClaude3_7Sonnet NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "anthropic/claude-3-7-sonnet"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelAnthropicClaudeSonnet4 NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "anthropic/claude-sonnet-4"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelAnthropicClaudeOpus4 NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "anthropic/claude-opus-4"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelAnthropicClaude3_5Haiku NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "anthropic/claude-3-5-haiku"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCerebrasQwen3_235bA22bInstruct NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "cerebras/qwen-3-235b-a22b-instruct"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCerebrasQwen3_235bA22bThinking NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "cerebras/qwen-3-235b-a22b-thinking"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCerebrasLlama3_3_70b NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "cerebras/llama-3.3-70b"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCerebrasLlama4Maverick17b128eInstruct NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "cerebras/llama-4-maverick-17b-128e-instruct"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCerebrasLlama4Scout17b16eInstruct NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "cerebras/llama-4-scout-17b-16e-instruct"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCerebrasGptOSs120b NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "cerebras/gpt-oss-120b"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelGoogleAIStudioGemini2_5Flash NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "google-ai-studio/gemini-2.5-flash"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelGoogleAIStudioGemini2_5Pro NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "google-ai-studio/gemini-2.5-pro"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelGrokGrok4 NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "grok/grok-4"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelGroqLlama3_3_70bVersatile NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "groq/llama-3.3-70b-versatile"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelGroqLlama3_1_8bInstant NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "groq/llama-3.1-8b-instant"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelOpenAIGpt5 NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "openai/gpt-5"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelOpenAIGpt5Mini NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "openai/gpt-5-mini"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelOpenAIGpt5Nano NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "openai/gpt-5-nano"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelEmpty NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = ""

RewritePrompt stringOptional

Reranking NamespaceInstanceChatCompletionsParamsAISearchOptionsRerankingOptional

Enabled boolOptional

MatchThreshold float64Optional

maximum1

minimum0

Model NamespaceInstanceChatCompletionsParamsAISearchOptionsRerankingModelOptional

One of the following:

const NamespaceInstanceChatCompletionsParamsAISearchOptionsRerankingModelCfBaaiBgeRerankerBase NamespaceInstanceChatCompletionsParamsAISearchOptionsRerankingModel = "@cf/baai/bge-reranker-base"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsRerankingModelEmpty NamespaceInstanceChatCompletionsParamsAISearchOptionsRerankingModel = ""

Retrieval NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalOptional

BoostBy []NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByOptional

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 asc/desc directions; text/boolean fields support exists/not_exists.

maxLength64

minLength1

Direction NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirectionOptional

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 NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirectionAsc NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection = "asc"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirectionDesc NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection = "desc"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirectionExists NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection = "exists"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirectionNotExists NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection = "not_exists"

ContextExpansion int64Optional

maximum3

minimum0

Filters map[string, unknown]Optional

FusionMethod NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalFusionMethodOptional

One of the following:

const NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalFusionMethodMax NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalFusionMethod = "max"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalFusionMethodRrf NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalFusionMethod = "rrf"

KeywordMatchMode NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchModeOptional

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. Defaults to ‘and’.

One of the following:

const NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchModeAnd NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchMode = "and"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchModeOr NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchMode = "or"

MatchThreshold float64Optional

maximum1

minimum0

MaxNumResults int64Optional

maximum50

minimum1

RetrievalType NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalRetrievalTypeOptional

One of the following:

const NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalRetrievalTypeVector NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalRetrievalType = "vector"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalRetrievalTypeKeyword NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalRetrievalType = "keyword"

const NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalRetrievalTypeHybrid NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalRetrievalType = "hybrid"

ReturnOnFailure boolOptional

Model param.Field[NamespaceInstanceChatCompletionsParamsModel]Optional

Body param

const NamespaceInstanceChatCompletionsParamsModelCfMetaLlama3_3_70bInstructFp8Fast NamespaceInstanceChatCompletionsParamsModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"

const NamespaceInstanceChatCompletionsParamsModelCfZaiOrgGlm4_7Flash NamespaceInstanceChatCompletionsParamsModel = "@cf/zai-org/glm-4.7-flash"

const NamespaceInstanceChatCompletionsParamsModelCfMetaLlama3_1_8bInstructFast NamespaceInstanceChatCompletionsParamsModel = "@cf/meta/llama-3.1-8b-instruct-fast"

const NamespaceInstanceChatCompletionsParamsModelCfMetaLlama3_1_8bInstructFp8 NamespaceInstanceChatCompletionsParamsModel = "@cf/meta/llama-3.1-8b-instruct-fp8"

const NamespaceInstanceChatCompletionsParamsModelCfMetaLlama4Scout17b16eInstruct NamespaceInstanceChatCompletionsParamsModel = "@cf/meta/llama-4-scout-17b-16e-instruct"

const NamespaceInstanceChatCompletionsParamsModelCfQwenQwen3_30bA3bFp8 NamespaceInstanceChatCompletionsParamsModel = "@cf/qwen/qwen3-30b-a3b-fp8"

const NamespaceInstanceChatCompletionsParamsModelCfDeepseekAIDeepseekR1DistillQwen32b NamespaceInstanceChatCompletionsParamsModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"

const NamespaceInstanceChatCompletionsParamsModelCfMoonshotaiKimiK2Instruct NamespaceInstanceChatCompletionsParamsModel = "@cf/moonshotai/kimi-k2-instruct"

const NamespaceInstanceChatCompletionsParamsModelCfGoogleGemma3_12bIt NamespaceInstanceChatCompletionsParamsModel = "@cf/google/gemma-3-12b-it"

const NamespaceInstanceChatCompletionsParamsModelCfGoogleGemma4_26bA4bIt NamespaceInstanceChatCompletionsParamsModel = "@cf/google/gemma-4-26b-a4b-it"

const NamespaceInstanceChatCompletionsParamsModelCfMoonshotaiKimiK2_5 NamespaceInstanceChatCompletionsParamsModel = "@cf/moonshotai/kimi-k2.5"

const NamespaceInstanceChatCompletionsParamsModelAnthropicClaude3_7Sonnet NamespaceInstanceChatCompletionsParamsModel = "anthropic/claude-3-7-sonnet"

const NamespaceInstanceChatCompletionsParamsModelAnthropicClaudeSonnet4 NamespaceInstanceChatCompletionsParamsModel = "anthropic/claude-sonnet-4"

const NamespaceInstanceChatCompletionsParamsModelAnthropicClaudeOpus4 NamespaceInstanceChatCompletionsParamsModel = "anthropic/claude-opus-4"

const NamespaceInstanceChatCompletionsParamsModelAnthropicClaude3_5Haiku NamespaceInstanceChatCompletionsParamsModel = "anthropic/claude-3-5-haiku"

const NamespaceInstanceChatCompletionsParamsModelCerebrasQwen3_235bA22bInstruct NamespaceInstanceChatCompletionsParamsModel = "cerebras/qwen-3-235b-a22b-instruct"

const NamespaceInstanceChatCompletionsParamsModelCerebrasQwen3_235bA22bThinking NamespaceInstanceChatCompletionsParamsModel = "cerebras/qwen-3-235b-a22b-thinking"

const NamespaceInstanceChatCompletionsParamsModelCerebrasLlama3_3_70b NamespaceInstanceChatCompletionsParamsModel = "cerebras/llama-3.3-70b"

const NamespaceInstanceChatCompletionsParamsModelCerebrasLlama4Maverick17b128eInstruct NamespaceInstanceChatCompletionsParamsModel = "cerebras/llama-4-maverick-17b-128e-instruct"

const NamespaceInstanceChatCompletionsParamsModelCerebrasLlama4Scout17b16eInstruct NamespaceInstanceChatCompletionsParamsModel = "cerebras/llama-4-scout-17b-16e-instruct"

const NamespaceInstanceChatCompletionsParamsModelCerebrasGptOSs120b NamespaceInstanceChatCompletionsParamsModel = "cerebras/gpt-oss-120b"

const NamespaceInstanceChatCompletionsParamsModelGoogleAIStudioGemini2_5Flash NamespaceInstanceChatCompletionsParamsModel = "google-ai-studio/gemini-2.5-flash"

const NamespaceInstanceChatCompletionsParamsModelGoogleAIStudioGemini2_5Pro NamespaceInstanceChatCompletionsParamsModel = "google-ai-studio/gemini-2.5-pro"

const NamespaceInstanceChatCompletionsParamsModelGrokGrok4 NamespaceInstanceChatCompletionsParamsModel = "grok/grok-4"

const NamespaceInstanceChatCompletionsParamsModelGroqLlama3_3_70bVersatile NamespaceInstanceChatCompletionsParamsModel = "groq/llama-3.3-70b-versatile"

const NamespaceInstanceChatCompletionsParamsModelGroqLlama3_1_8bInstant NamespaceInstanceChatCompletionsParamsModel = "groq/llama-3.1-8b-instant"

const NamespaceInstanceChatCompletionsParamsModelOpenAIGpt5 NamespaceInstanceChatCompletionsParamsModel = "openai/gpt-5"

const NamespaceInstanceChatCompletionsParamsModelOpenAIGpt5Mini NamespaceInstanceChatCompletionsParamsModel = "openai/gpt-5-mini"

const NamespaceInstanceChatCompletionsParamsModelOpenAIGpt5Nano NamespaceInstanceChatCompletionsParamsModel = "openai/gpt-5-nano"

const NamespaceInstanceChatCompletionsParamsModelEmpty NamespaceInstanceChatCompletionsParamsModel = ""

Stream param.Field[bool]Optional

Body param

ReturnsExpand Collapse

type NamespaceInstanceChatCompletionsResponse struct{…}

Choices []NamespaceInstanceChatCompletionsResponseChoice

Message NamespaceInstanceChatCompletionsResponseChoicesMessage

Content string

Role NamespaceInstanceChatCompletionsResponseChoicesMessageRole

One of the following:

const NamespaceInstanceChatCompletionsResponseChoicesMessageRoleSystem NamespaceInstanceChatCompletionsResponseChoicesMessageRole = "system"

const NamespaceInstanceChatCompletionsResponseChoicesMessageRoleDeveloper NamespaceInstanceChatCompletionsResponseChoicesMessageRole = "developer"

const NamespaceInstanceChatCompletionsResponseChoicesMessageRoleUser NamespaceInstanceChatCompletionsResponseChoicesMessageRole = "user"

const NamespaceInstanceChatCompletionsResponseChoicesMessageRoleAssistant NamespaceInstanceChatCompletionsResponseChoicesMessageRole = "assistant"

const NamespaceInstanceChatCompletionsResponseChoicesMessageRoleTool NamespaceInstanceChatCompletionsResponseChoicesMessageRole = "tool"

Index int64Optional

Chunks []NamespaceInstanceChatCompletionsResponseChunk

ID string

Score float64

maximum1

minimum0

Text string

Type string

Item NamespaceInstanceChatCompletionsResponseChunksItemOptional

Key string

Metadata map[string, unknown]Optional

Timestamp float64Optional

ScoringDetails NamespaceInstanceChatCompletionsResponseChunksScoringDetailsOptional

FusionMethod NamespaceInstanceChatCompletionsResponseChunksScoringDetailsFusionMethodOptional

One of the following:

const NamespaceInstanceChatCompletionsResponseChunksScoringDetailsFusionMethodRrf NamespaceInstanceChatCompletionsResponseChunksScoringDetailsFusionMethod = "rrf"

const NamespaceInstanceChatCompletionsResponseChunksScoringDetailsFusionMethodMax NamespaceInstanceChatCompletionsResponseChunksScoringDetailsFusionMethod = "max"

KeywordRank float64Optional

KeywordScore float64Optional

minimum0

RerankingScore float64Optional

maximum1

minimum0

VectorRank float64Optional

VectorScore float64Optional

maximum1

minimum0

ID stringOptional

Model stringOptional

Object stringOptional

Chat Completions

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.Namespaces.Instances.ChatCompletions(
    context.TODO(),
    "my-namespace",
    "my-ai-search",
    ai_search.NamespaceInstanceChatCompletionsParams{
      AccountID: cloudflare.F("c3dc5f0b34a14ff8e1b3ec04895e1b22"),
      Messages: cloudflare.F([]ai_search.NamespaceInstanceChatCompletionsParamsMessage{ai_search.NamespaceInstanceChatCompletionsParamsMessage{
        Content: cloudflare.F("content"),
        Role: cloudflare.F(ai_search.NamespaceInstanceChatCompletionsParamsMessagesRoleSystem),
      }}),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.ID)
}

{
  "choices": [
    {
      "message": {
        "content": "content",
        "role": "system"
      },
      "index": 0
    }
  ],
  "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
      }
    }
  ],
  "id": "id",
  "model": "model",
  "object": "object"
}

Returns Examples

{
  "choices": [
    {
      "message": {
        "content": "content",
        "role": "system"
      },
      "index": 0
    }
  ],
  "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
      }
    }
  ],
  "id": "id",
  "model": "model",
  "object": "object"
}