ai_search

package
v7.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 29, 2026 License: Apache-2.0 Imports: 20 Imported by: 0

Documentation

Index

Constants

View Source
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source
const CertificateCASSLCom = shared.CertificateCASSLCom

This is an alias to an internal value.

View Source
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source
const CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare

This is an alias to an internal value.

View Source
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow

This is an alias to an internal value.

View Source
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny

This is an alias to an internal value.

View Source
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source
const RatePlanIDBusiness = shared.RatePlanIDBusiness

This is an alias to an internal value.

View Source
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise

This is an alias to an internal value.

View Source
const RatePlanIDFree = shared.RatePlanIDFree

This is an alias to an internal value.

View Source
const RatePlanIDLite = shared.RatePlanIDLite

This is an alias to an internal value.

View Source
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness

This is an alias to an internal value.

View Source
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise

This is an alias to an internal value.

View Source
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree

This is an alias to an internal value.

View Source
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro

This is an alias to an internal value.

View Source
const RatePlanIDPro = shared.RatePlanIDPro

This is an alias to an internal value.

View Source
const RatePlanIDProPlus = shared.RatePlanIDProPlus

This is an alias to an internal value.

View Source
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

View Source
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source
const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source
const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source
const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source
const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

View Source
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow

This is an alias to an internal value.

View Source
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny

This is an alias to an internal value.

View Source
const TokenStatusActive = shared.TokenStatusActive

This is an alias to an internal value.

View Source
const TokenStatusDisabled = shared.TokenStatusDisabled

This is an alias to an internal value.

View Source
const TokenStatusExpired = shared.TokenStatusExpired

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type AISearchService

type AISearchService struct {
	Options    []option.RequestOption
	Namespaces *NamespaceService
	Instances  *InstanceService
	Tokens     *TokenService
}

AISearchService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAISearchService method instead.

func NewAISearchService

func NewAISearchService(opts ...option.RequestOption) (r *AISearchService)

NewAISearchService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type ASN

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType

type AuditLogActorType = shared.AuditLogActorType

The type of actor, whether a User, Cloudflare Admin, or an Automated System.

This is an alias to an internal type.

type AuditLogOwner

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type CertificateCA

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate.

This is an alias to an internal type.

type CertificateRequestType

type CertificateRequestType = shared.CertificateRequestType

Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).

This is an alias to an internal type.

type CloudflareTunnel

type CloudflareTunnel = shared.CloudflareTunnel

A Cloudflare Tunnel that connects your origin to Cloudflare's edge.

This is an alias to an internal type.

type CloudflareTunnelConfigSrc

type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc

Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard.

This is an alias to an internal type.

type CloudflareTunnelConnection

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).

This is an alias to an internal type.

type CloudflareTunnelTunType

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type Error

type Error = apierror.Error

type ErrorData

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ErrorDataSource

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

type InstanceChatCompletionsParams

type InstanceChatCompletionsParams struct {
	AccountID       param.Field[string]                                       `path:"account_id" api:"required"`
	Messages        param.Field[[]InstanceChatCompletionsParamsMessage]       `json:"messages" api:"required"`
	AISearchOptions param.Field[InstanceChatCompletionsParamsAISearchOptions] `json:"ai_search_options"`
	Model           param.Field[InstanceChatCompletionsParamsModel]           `json:"model"`
	Stream          param.Field[bool]                                         `json:"stream"`
}

func (InstanceChatCompletionsParams) MarshalJSON

func (r InstanceChatCompletionsParams) MarshalJSON() (data []byte, err error)

type InstanceChatCompletionsParamsAISearchOptions

type InstanceChatCompletionsParamsAISearchOptions struct {
	Cache        param.Field[InstanceChatCompletionsParamsAISearchOptionsCache]        `json:"cache"`
	QueryRewrite param.Field[InstanceChatCompletionsParamsAISearchOptionsQueryRewrite] `json:"query_rewrite"`
	Reranking    param.Field[InstanceChatCompletionsParamsAISearchOptionsReranking]    `json:"reranking"`
	Retrieval    param.Field[InstanceChatCompletionsParamsAISearchOptionsRetrieval]    `json:"retrieval"`
}

func (InstanceChatCompletionsParamsAISearchOptions) MarshalJSON

func (r InstanceChatCompletionsParamsAISearchOptions) MarshalJSON() (data []byte, err error)

type InstanceChatCompletionsParamsAISearchOptionsCache

type InstanceChatCompletionsParamsAISearchOptionsCache struct {
	CacheThreshold param.Field[InstanceChatCompletionsParamsAISearchOptionsCacheCacheThreshold] `json:"cache_threshold"`
	Enabled        param.Field[bool]                                                            `json:"enabled"`
}

func (InstanceChatCompletionsParamsAISearchOptionsCache) MarshalJSON

func (r InstanceChatCompletionsParamsAISearchOptionsCache) MarshalJSON() (data []byte, err error)

type InstanceChatCompletionsParamsAISearchOptionsCacheCacheThreshold

type InstanceChatCompletionsParamsAISearchOptionsCacheCacheThreshold string
const (
	InstanceChatCompletionsParamsAISearchOptionsCacheCacheThresholdSuperStrictMatch InstanceChatCompletionsParamsAISearchOptionsCacheCacheThreshold = "super_strict_match"
	InstanceChatCompletionsParamsAISearchOptionsCacheCacheThresholdCloseEnough      InstanceChatCompletionsParamsAISearchOptionsCacheCacheThreshold = "close_enough"
	InstanceChatCompletionsParamsAISearchOptionsCacheCacheThresholdFlexibleFriend   InstanceChatCompletionsParamsAISearchOptionsCacheCacheThreshold = "flexible_friend"
	InstanceChatCompletionsParamsAISearchOptionsCacheCacheThresholdAnythingGoes     InstanceChatCompletionsParamsAISearchOptionsCacheCacheThreshold = "anything_goes"
)

func (InstanceChatCompletionsParamsAISearchOptionsCacheCacheThreshold) IsKnown

type InstanceChatCompletionsParamsAISearchOptionsQueryRewrite

type InstanceChatCompletionsParamsAISearchOptionsQueryRewrite struct {
	Enabled       param.Field[bool]                                                          `json:"enabled"`
	Model         param.Field[InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel] `json:"model"`
	RewritePrompt param.Field[string]                                                        `json:"rewrite_prompt"`
}

func (InstanceChatCompletionsParamsAISearchOptionsQueryRewrite) MarshalJSON

type InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel

type InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel string
const (
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfMetaLlama3_3_70bInstructFp8Fast     InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfZaiOrgGlm4_7Flash                   InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/zai-org/glm-4.7-flash"
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfMetaLlama3_1_8bInstructFast         InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfMetaLlama3_1_8bInstructFp8          InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfMetaLlama4Scout17b16eInstruct       InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfQwenQwen3_30bA3bFp8                 InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfDeepseekAIDeepseekR1DistillQwen32b  InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfMoonshotaiKimiK2Instruct            InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/moonshotai/kimi-k2-instruct"
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfGoogleGemma3_12bIt                  InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/google/gemma-3-12b-it"
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfGoogleGemma4_26bA4bIt               InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/google/gemma-4-26b-a4b-it"
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfMoonshotaiKimiK2_5                  InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/moonshotai/kimi-k2.5"
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelAnthropicClaude3_7Sonnet              InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "anthropic/claude-3-7-sonnet"
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelAnthropicClaudeSonnet4                InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "anthropic/claude-sonnet-4"
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelAnthropicClaudeOpus4                  InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "anthropic/claude-opus-4"
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelAnthropicClaude3_5Haiku               InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "anthropic/claude-3-5-haiku"
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCerebrasQwen3_235bA22bInstruct        InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "cerebras/qwen-3-235b-a22b-instruct"
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCerebrasQwen3_235bA22bThinking        InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "cerebras/qwen-3-235b-a22b-thinking"
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCerebrasLlama3_3_70b                  InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "cerebras/llama-3.3-70b"
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCerebrasLlama4Maverick17b128eInstruct InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCerebrasLlama4Scout17b16eInstruct     InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "cerebras/llama-4-scout-17b-16e-instruct"
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCerebrasGptOSs120b                    InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "cerebras/gpt-oss-120b"
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelGoogleAIStudioGemini2_5Flash          InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "google-ai-studio/gemini-2.5-flash"
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelGoogleAIStudioGemini2_5Pro            InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "google-ai-studio/gemini-2.5-pro"
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelGrokGrok4                             InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "grok/grok-4"
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelGroqLlama3_3_70bVersatile             InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "groq/llama-3.3-70b-versatile"
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelGroqLlama3_1_8bInstant                InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "groq/llama-3.1-8b-instant"
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelOpenAIGpt5                            InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "openai/gpt-5"
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelOpenAIGpt5Mini                        InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "openai/gpt-5-mini"
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelOpenAIGpt5Nano                        InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "openai/gpt-5-nano"
	InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelEmpty                                 InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = ""
)

func (InstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel) IsKnown

type InstanceChatCompletionsParamsAISearchOptionsReranking

type InstanceChatCompletionsParamsAISearchOptionsReranking struct {
	Enabled        param.Field[bool]                                                       `json:"enabled"`
	MatchThreshold param.Field[float64]                                                    `json:"match_threshold"`
	Model          param.Field[InstanceChatCompletionsParamsAISearchOptionsRerankingModel] `json:"model"`
}

func (InstanceChatCompletionsParamsAISearchOptionsReranking) MarshalJSON

type InstanceChatCompletionsParamsAISearchOptionsRerankingModel

type InstanceChatCompletionsParamsAISearchOptionsRerankingModel string
const (
	InstanceChatCompletionsParamsAISearchOptionsRerankingModelCfBaaiBgeRerankerBase InstanceChatCompletionsParamsAISearchOptionsRerankingModel = "@cf/baai/bge-reranker-base"
	InstanceChatCompletionsParamsAISearchOptionsRerankingModelEmpty                 InstanceChatCompletionsParamsAISearchOptionsRerankingModel = ""
)

func (InstanceChatCompletionsParamsAISearchOptionsRerankingModel) IsKnown

type InstanceChatCompletionsParamsAISearchOptionsRetrieval

type InstanceChatCompletionsParamsAISearchOptionsRetrieval struct {
	// 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.
	BoostBy          param.Field[[]InstanceChatCompletionsParamsAISearchOptionsRetrievalBoostBy]    `json:"boost_by"`
	ContextExpansion param.Field[int64]                                                             `json:"context_expansion"`
	Filters          param.Field[map[string]interface{}]                                            `json:"filters"`
	FusionMethod     param.Field[InstanceChatCompletionsParamsAISearchOptionsRetrievalFusionMethod] `json:"fusion_method"`
	// 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'.
	KeywordMatchMode param.Field[InstanceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchMode] `json:"keyword_match_mode"`
	MatchThreshold   param.Field[float64]                                                               `json:"match_threshold"`
	MaxNumResults    param.Field[int64]                                                                 `json:"max_num_results"`
	RetrievalType    param.Field[InstanceChatCompletionsParamsAISearchOptionsRetrievalRetrievalType]    `json:"retrieval_type"`
	ReturnOnFailure  param.Field[bool]                                                                  `json:"return_on_failure"`
}

func (InstanceChatCompletionsParamsAISearchOptionsRetrieval) MarshalJSON

type InstanceChatCompletionsParamsAISearchOptionsRetrievalBoostBy

type InstanceChatCompletionsParamsAISearchOptionsRetrievalBoostBy struct {
	// 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.
	Field param.Field[string] `json:"field" api:"required"`
	// 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.
	Direction param.Field[InstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection] `json:"direction"`
}

func (InstanceChatCompletionsParamsAISearchOptionsRetrievalBoostBy) MarshalJSON

type InstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection

type InstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection string

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.

const (
	InstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirectionAsc       InstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection = "asc"
	InstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirectionDesc      InstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection = "desc"
	InstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirectionExists    InstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection = "exists"
	InstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirectionNotExists InstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection = "not_exists"
)

func (InstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection) IsKnown

type InstanceChatCompletionsParamsAISearchOptionsRetrievalFusionMethod

type InstanceChatCompletionsParamsAISearchOptionsRetrievalFusionMethod string
const (
	InstanceChatCompletionsParamsAISearchOptionsRetrievalFusionMethodMax InstanceChatCompletionsParamsAISearchOptionsRetrievalFusionMethod = "max"
	InstanceChatCompletionsParamsAISearchOptionsRetrievalFusionMethodRrf InstanceChatCompletionsParamsAISearchOptionsRetrievalFusionMethod = "rrf"
)

func (InstanceChatCompletionsParamsAISearchOptionsRetrievalFusionMethod) IsKnown

type InstanceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchMode

type InstanceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchMode string

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'.

const (
	InstanceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchModeAnd InstanceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchMode = "and"
	InstanceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchModeOr  InstanceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchMode = "or"
)

func (InstanceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchMode) IsKnown

type InstanceChatCompletionsParamsAISearchOptionsRetrievalRetrievalType

type InstanceChatCompletionsParamsAISearchOptionsRetrievalRetrievalType string
const (
	InstanceChatCompletionsParamsAISearchOptionsRetrievalRetrievalTypeVector  InstanceChatCompletionsParamsAISearchOptionsRetrievalRetrievalType = "vector"
	InstanceChatCompletionsParamsAISearchOptionsRetrievalRetrievalTypeKeyword InstanceChatCompletionsParamsAISearchOptionsRetrievalRetrievalType = "keyword"
	InstanceChatCompletionsParamsAISearchOptionsRetrievalRetrievalTypeHybrid  InstanceChatCompletionsParamsAISearchOptionsRetrievalRetrievalType = "hybrid"
)

func (InstanceChatCompletionsParamsAISearchOptionsRetrievalRetrievalType) IsKnown

type InstanceChatCompletionsParamsMessage

type InstanceChatCompletionsParamsMessage struct {
	Content     param.Field[string]                                    `json:"content" api:"required"`
	Role        param.Field[InstanceChatCompletionsParamsMessagesRole] `json:"role" api:"required"`
	ExtraFields map[string]interface{}                                 `json:"-,extras"`
}

func (InstanceChatCompletionsParamsMessage) MarshalJSON

func (r InstanceChatCompletionsParamsMessage) MarshalJSON() (data []byte, err error)

type InstanceChatCompletionsParamsMessagesRole

type InstanceChatCompletionsParamsMessagesRole string
const (
	InstanceChatCompletionsParamsMessagesRoleSystem    InstanceChatCompletionsParamsMessagesRole = "system"
	InstanceChatCompletionsParamsMessagesRoleDeveloper InstanceChatCompletionsParamsMessagesRole = "developer"
	InstanceChatCompletionsParamsMessagesRoleUser      InstanceChatCompletionsParamsMessagesRole = "user"
	InstanceChatCompletionsParamsMessagesRoleAssistant InstanceChatCompletionsParamsMessagesRole = "assistant"
	InstanceChatCompletionsParamsMessagesRoleTool      InstanceChatCompletionsParamsMessagesRole = "tool"
)

func (InstanceChatCompletionsParamsMessagesRole) IsKnown

type InstanceChatCompletionsParamsModel

type InstanceChatCompletionsParamsModel string
const (
	InstanceChatCompletionsParamsModelCfMetaLlama3_3_70bInstructFp8Fast     InstanceChatCompletionsParamsModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	InstanceChatCompletionsParamsModelCfZaiOrgGlm4_7Flash                   InstanceChatCompletionsParamsModel = "@cf/zai-org/glm-4.7-flash"
	InstanceChatCompletionsParamsModelCfMetaLlama3_1_8bInstructFast         InstanceChatCompletionsParamsModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	InstanceChatCompletionsParamsModelCfMetaLlama3_1_8bInstructFp8          InstanceChatCompletionsParamsModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	InstanceChatCompletionsParamsModelCfMetaLlama4Scout17b16eInstruct       InstanceChatCompletionsParamsModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	InstanceChatCompletionsParamsModelCfQwenQwen3_30bA3bFp8                 InstanceChatCompletionsParamsModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	InstanceChatCompletionsParamsModelCfDeepseekAIDeepseekR1DistillQwen32b  InstanceChatCompletionsParamsModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	InstanceChatCompletionsParamsModelCfMoonshotaiKimiK2Instruct            InstanceChatCompletionsParamsModel = "@cf/moonshotai/kimi-k2-instruct"
	InstanceChatCompletionsParamsModelCfGoogleGemma3_12bIt                  InstanceChatCompletionsParamsModel = "@cf/google/gemma-3-12b-it"
	InstanceChatCompletionsParamsModelCfGoogleGemma4_26bA4bIt               InstanceChatCompletionsParamsModel = "@cf/google/gemma-4-26b-a4b-it"
	InstanceChatCompletionsParamsModelCfMoonshotaiKimiK2_5                  InstanceChatCompletionsParamsModel = "@cf/moonshotai/kimi-k2.5"
	InstanceChatCompletionsParamsModelAnthropicClaude3_7Sonnet              InstanceChatCompletionsParamsModel = "anthropic/claude-3-7-sonnet"
	InstanceChatCompletionsParamsModelAnthropicClaudeSonnet4                InstanceChatCompletionsParamsModel = "anthropic/claude-sonnet-4"
	InstanceChatCompletionsParamsModelAnthropicClaudeOpus4                  InstanceChatCompletionsParamsModel = "anthropic/claude-opus-4"
	InstanceChatCompletionsParamsModelAnthropicClaude3_5Haiku               InstanceChatCompletionsParamsModel = "anthropic/claude-3-5-haiku"
	InstanceChatCompletionsParamsModelCerebrasQwen3_235bA22bInstruct        InstanceChatCompletionsParamsModel = "cerebras/qwen-3-235b-a22b-instruct"
	InstanceChatCompletionsParamsModelCerebrasQwen3_235bA22bThinking        InstanceChatCompletionsParamsModel = "cerebras/qwen-3-235b-a22b-thinking"
	InstanceChatCompletionsParamsModelCerebrasLlama3_3_70b                  InstanceChatCompletionsParamsModel = "cerebras/llama-3.3-70b"
	InstanceChatCompletionsParamsModelCerebrasLlama4Maverick17b128eInstruct InstanceChatCompletionsParamsModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	InstanceChatCompletionsParamsModelCerebrasLlama4Scout17b16eInstruct     InstanceChatCompletionsParamsModel = "cerebras/llama-4-scout-17b-16e-instruct"
	InstanceChatCompletionsParamsModelCerebrasGptOSs120b                    InstanceChatCompletionsParamsModel = "cerebras/gpt-oss-120b"
	InstanceChatCompletionsParamsModelGoogleAIStudioGemini2_5Flash          InstanceChatCompletionsParamsModel = "google-ai-studio/gemini-2.5-flash"
	InstanceChatCompletionsParamsModelGoogleAIStudioGemini2_5Pro            InstanceChatCompletionsParamsModel = "google-ai-studio/gemini-2.5-pro"
	InstanceChatCompletionsParamsModelGrokGrok4                             InstanceChatCompletionsParamsModel = "grok/grok-4"
	InstanceChatCompletionsParamsModelGroqLlama3_3_70bVersatile             InstanceChatCompletionsParamsModel = "groq/llama-3.3-70b-versatile"
	InstanceChatCompletionsParamsModelGroqLlama3_1_8bInstant                InstanceChatCompletionsParamsModel = "groq/llama-3.1-8b-instant"
	InstanceChatCompletionsParamsModelOpenAIGpt5                            InstanceChatCompletionsParamsModel = "openai/gpt-5"
	InstanceChatCompletionsParamsModelOpenAIGpt5Mini                        InstanceChatCompletionsParamsModel = "openai/gpt-5-mini"
	InstanceChatCompletionsParamsModelOpenAIGpt5Nano                        InstanceChatCompletionsParamsModel = "openai/gpt-5-nano"
	InstanceChatCompletionsParamsModelEmpty                                 InstanceChatCompletionsParamsModel = ""
)

func (InstanceChatCompletionsParamsModel) IsKnown

type InstanceChatCompletionsResponse

type InstanceChatCompletionsResponse struct {
	Choices     []InstanceChatCompletionsResponseChoice `json:"choices" api:"required"`
	Chunks      []InstanceChatCompletionsResponseChunk  `json:"chunks" api:"required"`
	ID          string                                  `json:"id"`
	Model       string                                  `json:"model"`
	Object      string                                  `json:"object"`
	ExtraFields map[string]interface{}                  `json:"-" api:"extrafields"`
	JSON        instanceChatCompletionsResponseJSON     `json:"-"`
}

func (*InstanceChatCompletionsResponse) UnmarshalJSON

func (r *InstanceChatCompletionsResponse) UnmarshalJSON(data []byte) (err error)

type InstanceChatCompletionsResponseChoice

type InstanceChatCompletionsResponseChoice struct {
	Message InstanceChatCompletionsResponseChoicesMessage `json:"message" api:"required"`
	Index   int64                                         `json:"index"`
	JSON    instanceChatCompletionsResponseChoiceJSON     `json:"-"`
}

func (*InstanceChatCompletionsResponseChoice) UnmarshalJSON

func (r *InstanceChatCompletionsResponseChoice) UnmarshalJSON(data []byte) (err error)

type InstanceChatCompletionsResponseChoicesMessage

type InstanceChatCompletionsResponseChoicesMessage struct {
	Content     string                                            `json:"content" api:"required,nullable"`
	Role        InstanceChatCompletionsResponseChoicesMessageRole `json:"role" api:"required"`
	ExtraFields map[string]interface{}                            `json:"-" api:"extrafields"`
	JSON        instanceChatCompletionsResponseChoicesMessageJSON `json:"-"`
}

func (*InstanceChatCompletionsResponseChoicesMessage) UnmarshalJSON

func (r *InstanceChatCompletionsResponseChoicesMessage) UnmarshalJSON(data []byte) (err error)

type InstanceChatCompletionsResponseChoicesMessageRole

type InstanceChatCompletionsResponseChoicesMessageRole string
const (
	InstanceChatCompletionsResponseChoicesMessageRoleSystem    InstanceChatCompletionsResponseChoicesMessageRole = "system"
	InstanceChatCompletionsResponseChoicesMessageRoleDeveloper InstanceChatCompletionsResponseChoicesMessageRole = "developer"
	InstanceChatCompletionsResponseChoicesMessageRoleUser      InstanceChatCompletionsResponseChoicesMessageRole = "user"
	InstanceChatCompletionsResponseChoicesMessageRoleAssistant InstanceChatCompletionsResponseChoicesMessageRole = "assistant"
	InstanceChatCompletionsResponseChoicesMessageRoleTool      InstanceChatCompletionsResponseChoicesMessageRole = "tool"
)

func (InstanceChatCompletionsResponseChoicesMessageRole) IsKnown

type InstanceChatCompletionsResponseChunk

type InstanceChatCompletionsResponseChunk struct {
	ID             string                                              `json:"id" api:"required"`
	Score          float64                                             `json:"score" api:"required"`
	Text           string                                              `json:"text" api:"required"`
	Type           string                                              `json:"type" api:"required"`
	Item           InstanceChatCompletionsResponseChunksItem           `json:"item"`
	ScoringDetails InstanceChatCompletionsResponseChunksScoringDetails `json:"scoring_details"`
	JSON           instanceChatCompletionsResponseChunkJSON            `json:"-"`
}

func (*InstanceChatCompletionsResponseChunk) UnmarshalJSON

func (r *InstanceChatCompletionsResponseChunk) UnmarshalJSON(data []byte) (err error)

type InstanceChatCompletionsResponseChunksItem

type InstanceChatCompletionsResponseChunksItem struct {
	Key       string                                        `json:"key" api:"required"`
	Metadata  map[string]interface{}                        `json:"metadata"`
	Timestamp float64                                       `json:"timestamp"`
	JSON      instanceChatCompletionsResponseChunksItemJSON `json:"-"`
}

func (*InstanceChatCompletionsResponseChunksItem) UnmarshalJSON

func (r *InstanceChatCompletionsResponseChunksItem) UnmarshalJSON(data []byte) (err error)

type InstanceChatCompletionsResponseChunksScoringDetails

type InstanceChatCompletionsResponseChunksScoringDetails struct {
	FusionMethod   InstanceChatCompletionsResponseChunksScoringDetailsFusionMethod `json:"fusion_method"`
	KeywordRank    float64                                                         `json:"keyword_rank"`
	KeywordScore   float64                                                         `json:"keyword_score"`
	RerankingScore float64                                                         `json:"reranking_score"`
	VectorRank     float64                                                         `json:"vector_rank"`
	VectorScore    float64                                                         `json:"vector_score"`
	JSON           instanceChatCompletionsResponseChunksScoringDetailsJSON         `json:"-"`
}

func (*InstanceChatCompletionsResponseChunksScoringDetails) UnmarshalJSON

func (r *InstanceChatCompletionsResponseChunksScoringDetails) UnmarshalJSON(data []byte) (err error)

type InstanceChatCompletionsResponseChunksScoringDetailsFusionMethod

type InstanceChatCompletionsResponseChunksScoringDetailsFusionMethod string
const (
	InstanceChatCompletionsResponseChunksScoringDetailsFusionMethodRrf InstanceChatCompletionsResponseChunksScoringDetailsFusionMethod = "rrf"
	InstanceChatCompletionsResponseChunksScoringDetailsFusionMethodMax InstanceChatCompletionsResponseChunksScoringDetailsFusionMethod = "max"
)

func (InstanceChatCompletionsResponseChunksScoringDetailsFusionMethod) IsKnown

type InstanceDeleteParams

type InstanceDeleteParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type InstanceDeleteResponse

type InstanceDeleteResponse struct {
	// AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
	ID             string                               `json:"id" api:"required"`
	CreatedAt      time.Time                            `json:"created_at" api:"required" format:"date-time"`
	ModifiedAt     time.Time                            `json:"modified_at" api:"required" format:"date-time"`
	AIGatewayID    string                               `json:"ai_gateway_id" api:"nullable"`
	AISearchModel  InstanceDeleteResponseAISearchModel  `json:"ai_search_model" api:"nullable"`
	Cache          bool                                 `json:"cache"`
	CacheThreshold InstanceDeleteResponseCacheThreshold `json:"cache_threshold"`
	// Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600
	// (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200
	// (72h), 518400 (6d).
	CacheTTL       InstanceDeleteResponseCacheTTL         `json:"cache_ttl"`
	ChunkOverlap   int64                                  `json:"chunk_overlap"`
	ChunkSize      int64                                  `json:"chunk_size"`
	CreatedBy      string                                 `json:"created_by" api:"nullable"`
	CustomMetadata []InstanceDeleteResponseCustomMetadata `json:"custom_metadata"`
	EmbeddingModel InstanceDeleteResponseEmbeddingModel   `json:"embedding_model" api:"nullable"`
	Enable         bool                                   `json:"enable"`
	EngineVersion  float64                                `json:"engine_version"`
	FusionMethod   InstanceDeleteResponseFusionMethod     `json:"fusion_method"`
	// Deprecated — use index_method instead.
	//
	// Deprecated: deprecated
	HybridSearchEnabled bool `json:"hybrid_search_enabled"`
	// Controls which storage backends are used during indexing. Defaults to
	// vector-only.
	IndexMethod          InstanceDeleteResponseIndexMethod          `json:"index_method"`
	IndexingOptions      InstanceDeleteResponseIndexingOptions      `json:"indexing_options" api:"nullable"`
	LastActivity         time.Time                                  `json:"last_activity" api:"nullable" format:"date-time"`
	MaxNumResults        int64                                      `json:"max_num_results"`
	Metadata             InstanceDeleteResponseMetadata             `json:"metadata"`
	ModifiedBy           string                                     `json:"modified_by" api:"nullable"`
	Namespace            string                                     `json:"namespace" api:"nullable"`
	Paused               bool                                       `json:"paused"`
	PublicEndpointID     string                                     `json:"public_endpoint_id" api:"nullable"`
	PublicEndpointParams InstanceDeleteResponsePublicEndpointParams `json:"public_endpoint_params"`
	Reranking            bool                                       `json:"reranking"`
	RerankingModel       InstanceDeleteResponseRerankingModel       `json:"reranking_model" api:"nullable"`
	RetrievalOptions     InstanceDeleteResponseRetrievalOptions     `json:"retrieval_options" api:"nullable"`
	RewriteModel         InstanceDeleteResponseRewriteModel         `json:"rewrite_model" api:"nullable"`
	RewriteQuery         bool                                       `json:"rewrite_query"`
	ScoreThreshold       float64                                    `json:"score_threshold"`
	Source               string                                     `json:"source" api:"nullable"`
	SourceParams         InstanceDeleteResponseSourceParams         `json:"source_params" api:"nullable"`
	Status               string                                     `json:"status"`
	// Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800
	// (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).
	SyncInterval InstanceDeleteResponseSyncInterval `json:"sync_interval"`
	TokenID      string                             `json:"token_id" format:"uuid"`
	Type         InstanceDeleteResponseType         `json:"type" api:"nullable"`
	JSON         instanceDeleteResponseJSON         `json:"-"`
}

func (*InstanceDeleteResponse) UnmarshalJSON

func (r *InstanceDeleteResponse) UnmarshalJSON(data []byte) (err error)

type InstanceDeleteResponseAISearchModel

type InstanceDeleteResponseAISearchModel string
const (
	InstanceDeleteResponseAISearchModelCfMetaLlama3_3_70bInstructFp8Fast     InstanceDeleteResponseAISearchModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	InstanceDeleteResponseAISearchModelCfZaiOrgGlm4_7Flash                   InstanceDeleteResponseAISearchModel = "@cf/zai-org/glm-4.7-flash"
	InstanceDeleteResponseAISearchModelCfMetaLlama3_1_8bInstructFast         InstanceDeleteResponseAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	InstanceDeleteResponseAISearchModelCfMetaLlama3_1_8bInstructFp8          InstanceDeleteResponseAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	InstanceDeleteResponseAISearchModelCfMetaLlama4Scout17b16eInstruct       InstanceDeleteResponseAISearchModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	InstanceDeleteResponseAISearchModelCfQwenQwen3_30bA3bFp8                 InstanceDeleteResponseAISearchModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	InstanceDeleteResponseAISearchModelCfDeepseekAIDeepseekR1DistillQwen32b  InstanceDeleteResponseAISearchModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	InstanceDeleteResponseAISearchModelCfMoonshotaiKimiK2Instruct            InstanceDeleteResponseAISearchModel = "@cf/moonshotai/kimi-k2-instruct"
	InstanceDeleteResponseAISearchModelCfGoogleGemma3_12bIt                  InstanceDeleteResponseAISearchModel = "@cf/google/gemma-3-12b-it"
	InstanceDeleteResponseAISearchModelCfGoogleGemma4_26bA4bIt               InstanceDeleteResponseAISearchModel = "@cf/google/gemma-4-26b-a4b-it"
	InstanceDeleteResponseAISearchModelCfMoonshotaiKimiK2_5                  InstanceDeleteResponseAISearchModel = "@cf/moonshotai/kimi-k2.5"
	InstanceDeleteResponseAISearchModelAnthropicClaude3_7Sonnet              InstanceDeleteResponseAISearchModel = "anthropic/claude-3-7-sonnet"
	InstanceDeleteResponseAISearchModelAnthropicClaudeSonnet4                InstanceDeleteResponseAISearchModel = "anthropic/claude-sonnet-4"
	InstanceDeleteResponseAISearchModelAnthropicClaudeOpus4                  InstanceDeleteResponseAISearchModel = "anthropic/claude-opus-4"
	InstanceDeleteResponseAISearchModelAnthropicClaude3_5Haiku               InstanceDeleteResponseAISearchModel = "anthropic/claude-3-5-haiku"
	InstanceDeleteResponseAISearchModelCerebrasQwen3_235bA22bInstruct        InstanceDeleteResponseAISearchModel = "cerebras/qwen-3-235b-a22b-instruct"
	InstanceDeleteResponseAISearchModelCerebrasQwen3_235bA22bThinking        InstanceDeleteResponseAISearchModel = "cerebras/qwen-3-235b-a22b-thinking"
	InstanceDeleteResponseAISearchModelCerebrasLlama3_3_70b                  InstanceDeleteResponseAISearchModel = "cerebras/llama-3.3-70b"
	InstanceDeleteResponseAISearchModelCerebrasLlama4Maverick17b128eInstruct InstanceDeleteResponseAISearchModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	InstanceDeleteResponseAISearchModelCerebrasLlama4Scout17b16eInstruct     InstanceDeleteResponseAISearchModel = "cerebras/llama-4-scout-17b-16e-instruct"
	InstanceDeleteResponseAISearchModelCerebrasGptOSs120b                    InstanceDeleteResponseAISearchModel = "cerebras/gpt-oss-120b"
	InstanceDeleteResponseAISearchModelGoogleAIStudioGemini2_5Flash          InstanceDeleteResponseAISearchModel = "google-ai-studio/gemini-2.5-flash"
	InstanceDeleteResponseAISearchModelGoogleAIStudioGemini2_5Pro            InstanceDeleteResponseAISearchModel = "google-ai-studio/gemini-2.5-pro"
	InstanceDeleteResponseAISearchModelGrokGrok4                             InstanceDeleteResponseAISearchModel = "grok/grok-4"
	InstanceDeleteResponseAISearchModelGroqLlama3_3_70bVersatile             InstanceDeleteResponseAISearchModel = "groq/llama-3.3-70b-versatile"
	InstanceDeleteResponseAISearchModelGroqLlama3_1_8bInstant                InstanceDeleteResponseAISearchModel = "groq/llama-3.1-8b-instant"
	InstanceDeleteResponseAISearchModelOpenAIGpt5                            InstanceDeleteResponseAISearchModel = "openai/gpt-5"
	InstanceDeleteResponseAISearchModelOpenAIGpt5Mini                        InstanceDeleteResponseAISearchModel = "openai/gpt-5-mini"
	InstanceDeleteResponseAISearchModelOpenAIGpt5Nano                        InstanceDeleteResponseAISearchModel = "openai/gpt-5-nano"
	InstanceDeleteResponseAISearchModelEmpty                                 InstanceDeleteResponseAISearchModel = ""
)

func (InstanceDeleteResponseAISearchModel) IsKnown

type InstanceDeleteResponseCacheTTL

type InstanceDeleteResponseCacheTTL float64

Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d).

const (
	InstanceDeleteResponseCacheTTL600    InstanceDeleteResponseCacheTTL = 600
	InstanceDeleteResponseCacheTTL1800   InstanceDeleteResponseCacheTTL = 1800
	InstanceDeleteResponseCacheTTL3600   InstanceDeleteResponseCacheTTL = 3600
	InstanceDeleteResponseCacheTTL7200   InstanceDeleteResponseCacheTTL = 7200
	InstanceDeleteResponseCacheTTL21600  InstanceDeleteResponseCacheTTL = 21600
	InstanceDeleteResponseCacheTTL43200  InstanceDeleteResponseCacheTTL = 43200
	InstanceDeleteResponseCacheTTL86400  InstanceDeleteResponseCacheTTL = 86400
	InstanceDeleteResponseCacheTTL172800 InstanceDeleteResponseCacheTTL = 172800
	InstanceDeleteResponseCacheTTL259200 InstanceDeleteResponseCacheTTL = 259200
	InstanceDeleteResponseCacheTTL518400 InstanceDeleteResponseCacheTTL = 518400
)

func (InstanceDeleteResponseCacheTTL) IsKnown

type InstanceDeleteResponseCacheThreshold

type InstanceDeleteResponseCacheThreshold string
const (
	InstanceDeleteResponseCacheThresholdSuperStrictMatch InstanceDeleteResponseCacheThreshold = "super_strict_match"
	InstanceDeleteResponseCacheThresholdCloseEnough      InstanceDeleteResponseCacheThreshold = "close_enough"
	InstanceDeleteResponseCacheThresholdFlexibleFriend   InstanceDeleteResponseCacheThreshold = "flexible_friend"
	InstanceDeleteResponseCacheThresholdAnythingGoes     InstanceDeleteResponseCacheThreshold = "anything_goes"
)

func (InstanceDeleteResponseCacheThreshold) IsKnown

type InstanceDeleteResponseCustomMetadata

type InstanceDeleteResponseCustomMetadata struct {
	DataType  InstanceDeleteResponseCustomMetadataDataType `json:"data_type" api:"required"`
	FieldName string                                       `json:"field_name" api:"required"`
	JSON      instanceDeleteResponseCustomMetadataJSON     `json:"-"`
}

func (*InstanceDeleteResponseCustomMetadata) UnmarshalJSON

func (r *InstanceDeleteResponseCustomMetadata) UnmarshalJSON(data []byte) (err error)

type InstanceDeleteResponseCustomMetadataDataType

type InstanceDeleteResponseCustomMetadataDataType string
const (
	InstanceDeleteResponseCustomMetadataDataTypeText     InstanceDeleteResponseCustomMetadataDataType = "text"
	InstanceDeleteResponseCustomMetadataDataTypeNumber   InstanceDeleteResponseCustomMetadataDataType = "number"
	InstanceDeleteResponseCustomMetadataDataTypeBoolean  InstanceDeleteResponseCustomMetadataDataType = "boolean"
	InstanceDeleteResponseCustomMetadataDataTypeDatetime InstanceDeleteResponseCustomMetadataDataType = "datetime"
)

func (InstanceDeleteResponseCustomMetadataDataType) IsKnown

type InstanceDeleteResponseEmbeddingModel

type InstanceDeleteResponseEmbeddingModel string
const (
	InstanceDeleteResponseEmbeddingModelCfQwenQwen3Embedding0_6b              InstanceDeleteResponseEmbeddingModel = "@cf/qwen/qwen3-embedding-0.6b"
	InstanceDeleteResponseEmbeddingModelCfBaaiBgeM3                           InstanceDeleteResponseEmbeddingModel = "@cf/baai/bge-m3"
	InstanceDeleteResponseEmbeddingModelCfBaaiBgeLargeEnV1_5                  InstanceDeleteResponseEmbeddingModel = "@cf/baai/bge-large-en-v1.5"
	InstanceDeleteResponseEmbeddingModelCfGoogleEmbeddinggemma300m            InstanceDeleteResponseEmbeddingModel = "@cf/google/embeddinggemma-300m"
	InstanceDeleteResponseEmbeddingModelGoogleAIStudioGeminiEmbedding001      InstanceDeleteResponseEmbeddingModel = "google-ai-studio/gemini-embedding-001"
	InstanceDeleteResponseEmbeddingModelGoogleAIStudioGeminiEmbedding2Preview InstanceDeleteResponseEmbeddingModel = "google-ai-studio/gemini-embedding-2-preview"
	InstanceDeleteResponseEmbeddingModelOpenAITextEmbedding3Small             InstanceDeleteResponseEmbeddingModel = "openai/text-embedding-3-small"
	InstanceDeleteResponseEmbeddingModelOpenAITextEmbedding3Large             InstanceDeleteResponseEmbeddingModel = "openai/text-embedding-3-large"
	InstanceDeleteResponseEmbeddingModelEmpty                                 InstanceDeleteResponseEmbeddingModel = ""
)

func (InstanceDeleteResponseEmbeddingModel) IsKnown

type InstanceDeleteResponseEnvelope

type InstanceDeleteResponseEnvelope struct {
	Result  InstanceDeleteResponse             `json:"result" api:"required"`
	Success bool                               `json:"success" api:"required"`
	JSON    instanceDeleteResponseEnvelopeJSON `json:"-"`
}

func (*InstanceDeleteResponseEnvelope) UnmarshalJSON

func (r *InstanceDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InstanceDeleteResponseFusionMethod

type InstanceDeleteResponseFusionMethod string
const (
	InstanceDeleteResponseFusionMethodMax InstanceDeleteResponseFusionMethod = "max"
	InstanceDeleteResponseFusionMethodRrf InstanceDeleteResponseFusionMethod = "rrf"
)

func (InstanceDeleteResponseFusionMethod) IsKnown

type InstanceDeleteResponseIndexMethod

type InstanceDeleteResponseIndexMethod struct {
	// Enable keyword (BM25) storage backend.
	Keyword bool `json:"keyword" api:"required"`
	// Enable vector (embedding) storage backend.
	Vector bool                                  `json:"vector" api:"required"`
	JSON   instanceDeleteResponseIndexMethodJSON `json:"-"`
}

Controls which storage backends are used during indexing. Defaults to vector-only.

func (*InstanceDeleteResponseIndexMethod) UnmarshalJSON

func (r *InstanceDeleteResponseIndexMethod) UnmarshalJSON(data []byte) (err error)

type InstanceDeleteResponseIndexingOptions

type InstanceDeleteResponseIndexingOptions struct {
	// Tokenizer used for keyword search indexing. porter provides word-level
	// tokenization with Porter stemming (good for natural language queries). trigram
	// enables character-level substring matching (good for partial matches, code,
	// identifiers). Changing this triggers a full re-index. Defaults to porter.
	KeywordTokenizer InstanceDeleteResponseIndexingOptionsKeywordTokenizer `json:"keyword_tokenizer"`
	JSON             instanceDeleteResponseIndexingOptionsJSON             `json:"-"`
}

func (*InstanceDeleteResponseIndexingOptions) UnmarshalJSON

func (r *InstanceDeleteResponseIndexingOptions) UnmarshalJSON(data []byte) (err error)

type InstanceDeleteResponseIndexingOptionsKeywordTokenizer

type InstanceDeleteResponseIndexingOptionsKeywordTokenizer string

Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter.

const (
	InstanceDeleteResponseIndexingOptionsKeywordTokenizerPorter  InstanceDeleteResponseIndexingOptionsKeywordTokenizer = "porter"
	InstanceDeleteResponseIndexingOptionsKeywordTokenizerTrigram InstanceDeleteResponseIndexingOptionsKeywordTokenizer = "trigram"
)

func (InstanceDeleteResponseIndexingOptionsKeywordTokenizer) IsKnown

type InstanceDeleteResponseMetadata

type InstanceDeleteResponseMetadata struct {
	CreatedFromAISearchWizard bool                               `json:"created_from_aisearch_wizard"`
	WorkerDomain              string                             `json:"worker_domain"`
	JSON                      instanceDeleteResponseMetadataJSON `json:"-"`
}

func (*InstanceDeleteResponseMetadata) UnmarshalJSON

func (r *InstanceDeleteResponseMetadata) UnmarshalJSON(data []byte) (err error)

type InstanceDeleteResponsePublicEndpointParams

type InstanceDeleteResponsePublicEndpointParams struct {
	AuthorizedHosts         []string                                                          `json:"authorized_hosts"`
	ChatCompletionsEndpoint InstanceDeleteResponsePublicEndpointParamsChatCompletionsEndpoint `json:"chat_completions_endpoint"`
	Enabled                 bool                                                              `json:"enabled"`
	Mcp                     InstanceDeleteResponsePublicEndpointParamsMcp                     `json:"mcp"`
	RateLimit               InstanceDeleteResponsePublicEndpointParamsRateLimit               `json:"rate_limit"`
	SearchEndpoint          InstanceDeleteResponsePublicEndpointParamsSearchEndpoint          `json:"search_endpoint"`
	JSON                    instanceDeleteResponsePublicEndpointParamsJSON                    `json:"-"`
}

func (*InstanceDeleteResponsePublicEndpointParams) UnmarshalJSON

func (r *InstanceDeleteResponsePublicEndpointParams) UnmarshalJSON(data []byte) (err error)

type InstanceDeleteResponsePublicEndpointParamsChatCompletionsEndpoint

type InstanceDeleteResponsePublicEndpointParamsChatCompletionsEndpoint struct {
	// Disable chat completions endpoint for this public endpoint
	Disabled bool                                                                  `json:"disabled"`
	JSON     instanceDeleteResponsePublicEndpointParamsChatCompletionsEndpointJSON `json:"-"`
}

func (*InstanceDeleteResponsePublicEndpointParamsChatCompletionsEndpoint) UnmarshalJSON

type InstanceDeleteResponsePublicEndpointParamsMcp

type InstanceDeleteResponsePublicEndpointParamsMcp struct {
	Description string `json:"description"`
	// Disable MCP endpoint for this public endpoint
	Disabled bool                                              `json:"disabled"`
	JSON     instanceDeleteResponsePublicEndpointParamsMcpJSON `json:"-"`
}

func (*InstanceDeleteResponsePublicEndpointParamsMcp) UnmarshalJSON

func (r *InstanceDeleteResponsePublicEndpointParamsMcp) UnmarshalJSON(data []byte) (err error)

type InstanceDeleteResponsePublicEndpointParamsRateLimit

type InstanceDeleteResponsePublicEndpointParamsRateLimit struct {
	PeriodMs  int64                                                        `json:"period_ms"`
	Requests  int64                                                        `json:"requests"`
	Technique InstanceDeleteResponsePublicEndpointParamsRateLimitTechnique `json:"technique"`
	JSON      instanceDeleteResponsePublicEndpointParamsRateLimitJSON      `json:"-"`
}

func (*InstanceDeleteResponsePublicEndpointParamsRateLimit) UnmarshalJSON

func (r *InstanceDeleteResponsePublicEndpointParamsRateLimit) UnmarshalJSON(data []byte) (err error)

type InstanceDeleteResponsePublicEndpointParamsRateLimitTechnique

type InstanceDeleteResponsePublicEndpointParamsRateLimitTechnique string
const (
	InstanceDeleteResponsePublicEndpointParamsRateLimitTechniqueFixed   InstanceDeleteResponsePublicEndpointParamsRateLimitTechnique = "fixed"
	InstanceDeleteResponsePublicEndpointParamsRateLimitTechniqueSliding InstanceDeleteResponsePublicEndpointParamsRateLimitTechnique = "sliding"
)

func (InstanceDeleteResponsePublicEndpointParamsRateLimitTechnique) IsKnown

type InstanceDeleteResponsePublicEndpointParamsSearchEndpoint

type InstanceDeleteResponsePublicEndpointParamsSearchEndpoint struct {
	// Disable search endpoint for this public endpoint
	Disabled bool                                                         `json:"disabled"`
	JSON     instanceDeleteResponsePublicEndpointParamsSearchEndpointJSON `json:"-"`
}

func (*InstanceDeleteResponsePublicEndpointParamsSearchEndpoint) UnmarshalJSON

type InstanceDeleteResponseRerankingModel

type InstanceDeleteResponseRerankingModel string
const (
	InstanceDeleteResponseRerankingModelCfBaaiBgeRerankerBase InstanceDeleteResponseRerankingModel = "@cf/baai/bge-reranker-base"
	InstanceDeleteResponseRerankingModelEmpty                 InstanceDeleteResponseRerankingModel = ""
)

func (InstanceDeleteResponseRerankingModel) IsKnown

type InstanceDeleteResponseRetrievalOptions

type InstanceDeleteResponseRetrievalOptions struct {
	// Metadata fields to boost search results by. Each entry specifies a metadata
	// field and an optional direction. Direction defaults to 'asc' for
	// numeric/datetime fields and 'exists' for text/boolean fields. Fields must match
	// 'timestamp' or a defined custom_metadata field.
	BoostBy []InstanceDeleteResponseRetrievalOptionsBoostBy `json:"boost_by"`
	// 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'.
	KeywordMatchMode InstanceDeleteResponseRetrievalOptionsKeywordMatchMode `json:"keyword_match_mode"`
	JSON             instanceDeleteResponseRetrievalOptionsJSON             `json:"-"`
}

func (*InstanceDeleteResponseRetrievalOptions) UnmarshalJSON

func (r *InstanceDeleteResponseRetrievalOptions) UnmarshalJSON(data []byte) (err error)

type InstanceDeleteResponseRetrievalOptionsBoostBy

type InstanceDeleteResponseRetrievalOptionsBoostBy struct {
	// 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.
	Field string `json:"field" api:"required"`
	// 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.
	Direction InstanceDeleteResponseRetrievalOptionsBoostByDirection `json:"direction"`
	JSON      instanceDeleteResponseRetrievalOptionsBoostByJSON      `json:"-"`
}

func (*InstanceDeleteResponseRetrievalOptionsBoostBy) UnmarshalJSON

func (r *InstanceDeleteResponseRetrievalOptionsBoostBy) UnmarshalJSON(data []byte) (err error)

type InstanceDeleteResponseRetrievalOptionsBoostByDirection

type InstanceDeleteResponseRetrievalOptionsBoostByDirection string

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.

const (
	InstanceDeleteResponseRetrievalOptionsBoostByDirectionAsc       InstanceDeleteResponseRetrievalOptionsBoostByDirection = "asc"
	InstanceDeleteResponseRetrievalOptionsBoostByDirectionDesc      InstanceDeleteResponseRetrievalOptionsBoostByDirection = "desc"
	InstanceDeleteResponseRetrievalOptionsBoostByDirectionExists    InstanceDeleteResponseRetrievalOptionsBoostByDirection = "exists"
	InstanceDeleteResponseRetrievalOptionsBoostByDirectionNotExists InstanceDeleteResponseRetrievalOptionsBoostByDirection = "not_exists"
)

func (InstanceDeleteResponseRetrievalOptionsBoostByDirection) IsKnown

type InstanceDeleteResponseRetrievalOptionsKeywordMatchMode

type InstanceDeleteResponseRetrievalOptionsKeywordMatchMode string

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'.

const (
	InstanceDeleteResponseRetrievalOptionsKeywordMatchModeAnd InstanceDeleteResponseRetrievalOptionsKeywordMatchMode = "and"
	InstanceDeleteResponseRetrievalOptionsKeywordMatchModeOr  InstanceDeleteResponseRetrievalOptionsKeywordMatchMode = "or"
)

func (InstanceDeleteResponseRetrievalOptionsKeywordMatchMode) IsKnown

type InstanceDeleteResponseRewriteModel

type InstanceDeleteResponseRewriteModel string
const (
	InstanceDeleteResponseRewriteModelCfMetaLlama3_3_70bInstructFp8Fast     InstanceDeleteResponseRewriteModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	InstanceDeleteResponseRewriteModelCfZaiOrgGlm4_7Flash                   InstanceDeleteResponseRewriteModel = "@cf/zai-org/glm-4.7-flash"
	InstanceDeleteResponseRewriteModelCfMetaLlama3_1_8bInstructFast         InstanceDeleteResponseRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	InstanceDeleteResponseRewriteModelCfMetaLlama3_1_8bInstructFp8          InstanceDeleteResponseRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	InstanceDeleteResponseRewriteModelCfMetaLlama4Scout17b16eInstruct       InstanceDeleteResponseRewriteModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	InstanceDeleteResponseRewriteModelCfQwenQwen3_30bA3bFp8                 InstanceDeleteResponseRewriteModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	InstanceDeleteResponseRewriteModelCfDeepseekAIDeepseekR1DistillQwen32b  InstanceDeleteResponseRewriteModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	InstanceDeleteResponseRewriteModelCfMoonshotaiKimiK2Instruct            InstanceDeleteResponseRewriteModel = "@cf/moonshotai/kimi-k2-instruct"
	InstanceDeleteResponseRewriteModelCfGoogleGemma3_12bIt                  InstanceDeleteResponseRewriteModel = "@cf/google/gemma-3-12b-it"
	InstanceDeleteResponseRewriteModelCfGoogleGemma4_26bA4bIt               InstanceDeleteResponseRewriteModel = "@cf/google/gemma-4-26b-a4b-it"
	InstanceDeleteResponseRewriteModelCfMoonshotaiKimiK2_5                  InstanceDeleteResponseRewriteModel = "@cf/moonshotai/kimi-k2.5"
	InstanceDeleteResponseRewriteModelAnthropicClaude3_7Sonnet              InstanceDeleteResponseRewriteModel = "anthropic/claude-3-7-sonnet"
	InstanceDeleteResponseRewriteModelAnthropicClaudeSonnet4                InstanceDeleteResponseRewriteModel = "anthropic/claude-sonnet-4"
	InstanceDeleteResponseRewriteModelAnthropicClaudeOpus4                  InstanceDeleteResponseRewriteModel = "anthropic/claude-opus-4"
	InstanceDeleteResponseRewriteModelAnthropicClaude3_5Haiku               InstanceDeleteResponseRewriteModel = "anthropic/claude-3-5-haiku"
	InstanceDeleteResponseRewriteModelCerebrasQwen3_235bA22bInstruct        InstanceDeleteResponseRewriteModel = "cerebras/qwen-3-235b-a22b-instruct"
	InstanceDeleteResponseRewriteModelCerebrasQwen3_235bA22bThinking        InstanceDeleteResponseRewriteModel = "cerebras/qwen-3-235b-a22b-thinking"
	InstanceDeleteResponseRewriteModelCerebrasLlama3_3_70b                  InstanceDeleteResponseRewriteModel = "cerebras/llama-3.3-70b"
	InstanceDeleteResponseRewriteModelCerebrasLlama4Maverick17b128eInstruct InstanceDeleteResponseRewriteModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	InstanceDeleteResponseRewriteModelCerebrasLlama4Scout17b16eInstruct     InstanceDeleteResponseRewriteModel = "cerebras/llama-4-scout-17b-16e-instruct"
	InstanceDeleteResponseRewriteModelCerebrasGptOSs120b                    InstanceDeleteResponseRewriteModel = "cerebras/gpt-oss-120b"
	InstanceDeleteResponseRewriteModelGoogleAIStudioGemini2_5Flash          InstanceDeleteResponseRewriteModel = "google-ai-studio/gemini-2.5-flash"
	InstanceDeleteResponseRewriteModelGoogleAIStudioGemini2_5Pro            InstanceDeleteResponseRewriteModel = "google-ai-studio/gemini-2.5-pro"
	InstanceDeleteResponseRewriteModelGrokGrok4                             InstanceDeleteResponseRewriteModel = "grok/grok-4"
	InstanceDeleteResponseRewriteModelGroqLlama3_3_70bVersatile             InstanceDeleteResponseRewriteModel = "groq/llama-3.3-70b-versatile"
	InstanceDeleteResponseRewriteModelGroqLlama3_1_8bInstant                InstanceDeleteResponseRewriteModel = "groq/llama-3.1-8b-instant"
	InstanceDeleteResponseRewriteModelOpenAIGpt5                            InstanceDeleteResponseRewriteModel = "openai/gpt-5"
	InstanceDeleteResponseRewriteModelOpenAIGpt5Mini                        InstanceDeleteResponseRewriteModel = "openai/gpt-5-mini"
	InstanceDeleteResponseRewriteModelOpenAIGpt5Nano                        InstanceDeleteResponseRewriteModel = "openai/gpt-5-nano"
	InstanceDeleteResponseRewriteModelEmpty                                 InstanceDeleteResponseRewriteModel = ""
)

func (InstanceDeleteResponseRewriteModel) IsKnown

type InstanceDeleteResponseSourceParams

type InstanceDeleteResponseSourceParams struct {
	// List of path patterns to exclude. Uses micromatch glob syntax: \* matches within
	// a path segment, ** matches across path segments (e.g., /admin/** matches
	// /admin/users and /admin/settings/advanced)
	ExcludeItems []string `json:"exclude_items"`
	// List of path patterns to include. Uses micromatch glob syntax: \* matches within
	// a path segment, ** matches across path segments (e.g., /blog/** matches
	// /blog/post and /blog/2024/post)
	IncludeItems   []string                                     `json:"include_items"`
	Prefix         string                                       `json:"prefix"`
	R2Jurisdiction string                                       `json:"r2_jurisdiction"`
	WebCrawler     InstanceDeleteResponseSourceParamsWebCrawler `json:"web_crawler"`
	JSON           instanceDeleteResponseSourceParamsJSON       `json:"-"`
}

func (*InstanceDeleteResponseSourceParams) UnmarshalJSON

func (r *InstanceDeleteResponseSourceParams) UnmarshalJSON(data []byte) (err error)

type InstanceDeleteResponseSourceParamsWebCrawler

type InstanceDeleteResponseSourceParamsWebCrawler struct {
	CrawlOptions InstanceDeleteResponseSourceParamsWebCrawlerCrawlOptions `json:"crawl_options"`
	ParseOptions InstanceDeleteResponseSourceParamsWebCrawlerParseOptions `json:"parse_options"`
	ParseType    InstanceDeleteResponseSourceParamsWebCrawlerParseType    `json:"parse_type"`
	StoreOptions InstanceDeleteResponseSourceParamsWebCrawlerStoreOptions `json:"store_options"`
	JSON         instanceDeleteResponseSourceParamsWebCrawlerJSON         `json:"-"`
}

func (*InstanceDeleteResponseSourceParamsWebCrawler) UnmarshalJSON

func (r *InstanceDeleteResponseSourceParamsWebCrawler) UnmarshalJSON(data []byte) (err error)

type InstanceDeleteResponseSourceParamsWebCrawlerCrawlOptions

type InstanceDeleteResponseSourceParamsWebCrawlerCrawlOptions struct {
	Depth                float64                                                        `json:"depth"`
	IncludeExternalLinks bool                                                           `json:"include_external_links"`
	IncludeSubdomains    bool                                                           `json:"include_subdomains"`
	MaxAge               float64                                                        `json:"max_age"`
	Source               InstanceDeleteResponseSourceParamsWebCrawlerCrawlOptionsSource `json:"source"`
	JSON                 instanceDeleteResponseSourceParamsWebCrawlerCrawlOptionsJSON   `json:"-"`
}

func (*InstanceDeleteResponseSourceParamsWebCrawlerCrawlOptions) UnmarshalJSON

type InstanceDeleteResponseSourceParamsWebCrawlerCrawlOptionsSource

type InstanceDeleteResponseSourceParamsWebCrawlerCrawlOptionsSource string
const (
	InstanceDeleteResponseSourceParamsWebCrawlerCrawlOptionsSourceAll      InstanceDeleteResponseSourceParamsWebCrawlerCrawlOptionsSource = "all"
	InstanceDeleteResponseSourceParamsWebCrawlerCrawlOptionsSourceSitemaps InstanceDeleteResponseSourceParamsWebCrawlerCrawlOptionsSource = "sitemaps"
	InstanceDeleteResponseSourceParamsWebCrawlerCrawlOptionsSourceLinks    InstanceDeleteResponseSourceParamsWebCrawlerCrawlOptionsSource = "links"
)

func (InstanceDeleteResponseSourceParamsWebCrawlerCrawlOptionsSource) IsKnown

type InstanceDeleteResponseSourceParamsWebCrawlerParseOptions

type InstanceDeleteResponseSourceParamsWebCrawlerParseOptions struct {
	// List of path-to-selector mappings for extracting specific content from crawled
	// pages. Each entry pairs a URL glob pattern with a CSS selector. The first
	// matching path wins. Only the matched HTML fragment is stored and indexed. Omit
	// the field to disable content selection — empty arrays are rejected.
	ContentSelector []InstanceDeleteResponseSourceParamsWebCrawlerParseOptionsContentSelector `json:"content_selector"`
	// Up to 5 custom HTTP headers sent with each crawl request. Names must be RFC-7230
	// token characters (no spaces, colons, or control characters); values must be
	// HTAB + printable ASCII (no CR/LF).
	IncludeHeaders map[string]string `json:"include_headers"`
	IncludeImages  bool              `json:"include_images"`
	// List of specific sitemap URLs to use for crawling. Only valid when parse_type is
	// 'sitemap'.
	SpecificSitemaps    []string                                                     `json:"specific_sitemaps" format:"uri"`
	UseBrowserRendering bool                                                         `json:"use_browser_rendering"`
	JSON                instanceDeleteResponseSourceParamsWebCrawlerParseOptionsJSON `json:"-"`
}

func (*InstanceDeleteResponseSourceParamsWebCrawlerParseOptions) UnmarshalJSON

type InstanceDeleteResponseSourceParamsWebCrawlerParseOptionsContentSelector

type InstanceDeleteResponseSourceParamsWebCrawlerParseOptionsContentSelector struct {
	// Glob pattern to match against the page URL path. Uses standard glob syntax: \*
	// matches within a segment, \*\* crosses directories.
	Path string `json:"path" api:"required"`
	// CSS selector to extract content from pages matching the path pattern. Must not
	// contain disallowed characters (;, `, $, {, }, \). Must target a single element;
	// if multiple elements match, the selector is ignored and the full page is used.
	Selector string                                                                      `json:"selector" api:"required"`
	JSON     instanceDeleteResponseSourceParamsWebCrawlerParseOptionsContentSelectorJSON `json:"-"`
}

func (*InstanceDeleteResponseSourceParamsWebCrawlerParseOptionsContentSelector) UnmarshalJSON

type InstanceDeleteResponseSourceParamsWebCrawlerParseType

type InstanceDeleteResponseSourceParamsWebCrawlerParseType string
const (
	InstanceDeleteResponseSourceParamsWebCrawlerParseTypeSitemap InstanceDeleteResponseSourceParamsWebCrawlerParseType = "sitemap"
	InstanceDeleteResponseSourceParamsWebCrawlerParseTypeFeedRss InstanceDeleteResponseSourceParamsWebCrawlerParseType = "feed-rss"
	InstanceDeleteResponseSourceParamsWebCrawlerParseTypeCrawl   InstanceDeleteResponseSourceParamsWebCrawlerParseType = "crawl"
)

func (InstanceDeleteResponseSourceParamsWebCrawlerParseType) IsKnown

type InstanceDeleteResponseSourceParamsWebCrawlerStoreOptions

type InstanceDeleteResponseSourceParamsWebCrawlerStoreOptions struct {
	StorageID      string                                                       `json:"storage_id" api:"required"`
	R2Jurisdiction string                                                       `json:"r2_jurisdiction"`
	StorageType    r2.Provider                                                  `json:"storage_type"`
	JSON           instanceDeleteResponseSourceParamsWebCrawlerStoreOptionsJSON `json:"-"`
}

func (*InstanceDeleteResponseSourceParamsWebCrawlerStoreOptions) UnmarshalJSON

type InstanceDeleteResponseSyncInterval

type InstanceDeleteResponseSyncInterval float64

Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).

const (
	InstanceDeleteResponseSyncInterval900   InstanceDeleteResponseSyncInterval = 900
	InstanceDeleteResponseSyncInterval1800  InstanceDeleteResponseSyncInterval = 1800
	InstanceDeleteResponseSyncInterval3600  InstanceDeleteResponseSyncInterval = 3600
	InstanceDeleteResponseSyncInterval7200  InstanceDeleteResponseSyncInterval = 7200
	InstanceDeleteResponseSyncInterval14400 InstanceDeleteResponseSyncInterval = 14400
	InstanceDeleteResponseSyncInterval21600 InstanceDeleteResponseSyncInterval = 21600
	InstanceDeleteResponseSyncInterval43200 InstanceDeleteResponseSyncInterval = 43200
	InstanceDeleteResponseSyncInterval86400 InstanceDeleteResponseSyncInterval = 86400
)

func (InstanceDeleteResponseSyncInterval) IsKnown

type InstanceDeleteResponseType

type InstanceDeleteResponseType string
const (
	InstanceDeleteResponseTypeR2         InstanceDeleteResponseType = "r2"
	InstanceDeleteResponseTypeWebCrawler InstanceDeleteResponseType = "web-crawler"
)

func (InstanceDeleteResponseType) IsKnown

func (r InstanceDeleteResponseType) IsKnown() bool

type InstanceJobGetParams

type InstanceJobGetParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type InstanceJobGetResponse

type InstanceJobGetResponse struct {
	ID          string                       `json:"id" api:"required"`
	Source      InstanceJobGetResponseSource `json:"source" api:"required"`
	Description string                       `json:"description"`
	EndReason   string                       `json:"end_reason"`
	EndedAt     string                       `json:"ended_at"`
	LastSeenAt  string                       `json:"last_seen_at"`
	StartedAt   string                       `json:"started_at"`
	JSON        instanceJobGetResponseJSON   `json:"-"`
}

func (*InstanceJobGetResponse) UnmarshalJSON

func (r *InstanceJobGetResponse) UnmarshalJSON(data []byte) (err error)

type InstanceJobGetResponseEnvelope

type InstanceJobGetResponseEnvelope struct {
	Result  InstanceJobGetResponse             `json:"result" api:"required"`
	Success bool                               `json:"success" api:"required"`
	JSON    instanceJobGetResponseEnvelopeJSON `json:"-"`
}

func (*InstanceJobGetResponseEnvelope) UnmarshalJSON

func (r *InstanceJobGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InstanceJobGetResponseSource

type InstanceJobGetResponseSource string
const (
	InstanceJobGetResponseSourceUser     InstanceJobGetResponseSource = "user"
	InstanceJobGetResponseSourceSchedule InstanceJobGetResponseSource = "schedule"
)

func (InstanceJobGetResponseSource) IsKnown

func (r InstanceJobGetResponseSource) IsKnown() bool

type InstanceJobListParams

type InstanceJobListParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	Page      param.Field[int64]  `query:"page"`
	PerPage   param.Field[int64]  `query:"per_page"`
}

func (InstanceJobListParams) URLQuery

func (r InstanceJobListParams) URLQuery() (v url.Values)

URLQuery serializes InstanceJobListParams's query parameters as `url.Values`.

type InstanceJobListResponse

type InstanceJobListResponse struct {
	ID          string                        `json:"id" api:"required"`
	Source      InstanceJobListResponseSource `json:"source" api:"required"`
	Description string                        `json:"description"`
	EndReason   string                        `json:"end_reason"`
	EndedAt     string                        `json:"ended_at"`
	LastSeenAt  string                        `json:"last_seen_at"`
	StartedAt   string                        `json:"started_at"`
	JSON        instanceJobListResponseJSON   `json:"-"`
}

func (*InstanceJobListResponse) UnmarshalJSON

func (r *InstanceJobListResponse) UnmarshalJSON(data []byte) (err error)

type InstanceJobListResponseSource

type InstanceJobListResponseSource string
const (
	InstanceJobListResponseSourceUser     InstanceJobListResponseSource = "user"
	InstanceJobListResponseSourceSchedule InstanceJobListResponseSource = "schedule"
)

func (InstanceJobListResponseSource) IsKnown

func (r InstanceJobListResponseSource) IsKnown() bool

type InstanceJobLogsParams

type InstanceJobLogsParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	Page      param.Field[int64]  `query:"page"`
	PerPage   param.Field[int64]  `query:"per_page"`
}

func (InstanceJobLogsParams) URLQuery

func (r InstanceJobLogsParams) URLQuery() (v url.Values)

URLQuery serializes InstanceJobLogsParams's query parameters as `url.Values`.

type InstanceJobLogsResponse

type InstanceJobLogsResponse struct {
	ID          int64                       `json:"id" api:"required"`
	CreatedAt   float64                     `json:"created_at" api:"required"`
	Message     string                      `json:"message" api:"required"`
	MessageType int64                       `json:"message_type" api:"required"`
	JSON        instanceJobLogsResponseJSON `json:"-"`
}

func (*InstanceJobLogsResponse) UnmarshalJSON

func (r *InstanceJobLogsResponse) UnmarshalJSON(data []byte) (err error)

type InstanceJobLogsResponseEnvelope

type InstanceJobLogsResponseEnvelope struct {
	Result     []InstanceJobLogsResponse                 `json:"result" api:"required"`
	ResultInfo InstanceJobLogsResponseEnvelopeResultInfo `json:"result_info" api:"required"`
	Success    bool                                      `json:"success" api:"required"`
	JSON       instanceJobLogsResponseEnvelopeJSON       `json:"-"`
}

func (*InstanceJobLogsResponseEnvelope) UnmarshalJSON

func (r *InstanceJobLogsResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InstanceJobLogsResponseEnvelopeResultInfo

type InstanceJobLogsResponseEnvelopeResultInfo struct {
	Count      int64                                         `json:"count" api:"required"`
	Page       int64                                         `json:"page" api:"required"`
	PerPage    int64                                         `json:"per_page" api:"required"`
	TotalCount int64                                         `json:"total_count" api:"required"`
	JSON       instanceJobLogsResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*InstanceJobLogsResponseEnvelopeResultInfo) UnmarshalJSON

func (r *InstanceJobLogsResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type InstanceJobNewParams

type InstanceJobNewParams struct {
	AccountID   param.Field[string] `path:"account_id" api:"required"`
	Description param.Field[string] `json:"description"`
}

func (InstanceJobNewParams) MarshalJSON

func (r InstanceJobNewParams) MarshalJSON() (data []byte, err error)

type InstanceJobNewResponse

type InstanceJobNewResponse struct {
	ID          string                       `json:"id" api:"required"`
	Source      InstanceJobNewResponseSource `json:"source" api:"required"`
	Description string                       `json:"description"`
	EndReason   string                       `json:"end_reason"`
	EndedAt     string                       `json:"ended_at"`
	LastSeenAt  string                       `json:"last_seen_at"`
	StartedAt   string                       `json:"started_at"`
	JSON        instanceJobNewResponseJSON   `json:"-"`
}

func (*InstanceJobNewResponse) UnmarshalJSON

func (r *InstanceJobNewResponse) UnmarshalJSON(data []byte) (err error)

type InstanceJobNewResponseEnvelope

type InstanceJobNewResponseEnvelope struct {
	Result  InstanceJobNewResponse             `json:"result" api:"required"`
	Success bool                               `json:"success" api:"required"`
	JSON    instanceJobNewResponseEnvelopeJSON `json:"-"`
}

func (*InstanceJobNewResponseEnvelope) UnmarshalJSON

func (r *InstanceJobNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InstanceJobNewResponseSource

type InstanceJobNewResponseSource string
const (
	InstanceJobNewResponseSourceUser     InstanceJobNewResponseSource = "user"
	InstanceJobNewResponseSourceSchedule InstanceJobNewResponseSource = "schedule"
)

func (InstanceJobNewResponseSource) IsKnown

func (r InstanceJobNewResponseSource) IsKnown() bool

type InstanceJobService

type InstanceJobService struct {
	Options []option.RequestOption
}

InstanceJobService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewInstanceJobService method instead.

func NewInstanceJobService

func NewInstanceJobService(opts ...option.RequestOption) (r *InstanceJobService)

NewInstanceJobService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*InstanceJobService) Get

Retrieves details for a specific AI Search indexing job.

func (*InstanceJobService) List

Lists indexing jobs for an AI Search instance.

func (*InstanceJobService) ListAutoPaging

Lists indexing jobs for an AI Search instance.

func (*InstanceJobService) Logs

Lists log entries for an AI Search indexing job.

func (*InstanceJobService) New

Creates a new indexing job for an AI Search instance.

type InstanceListParams

type InstanceListParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Filter by namespace.
	Namespace param.Field[string] `query:"namespace"`
	// Field to order results by.
	OrderBy param.Field[InstanceListParamsOrderBy] `query:"order_by"`
	// Order direction.
	OrderByDirection param.Field[InstanceListParamsOrderByDirection] `query:"order_by_direction"`
	// Page number (1-indexed).
	Page param.Field[int64] `query:"page"`
	// Number of results per page.
	PerPage param.Field[int64] `query:"per_page"`
	// Filter instances whose id contains this string (case-insensitive).
	Search param.Field[string] `query:"search"`
}

func (InstanceListParams) URLQuery

func (r InstanceListParams) URLQuery() (v url.Values)

URLQuery serializes InstanceListParams's query parameters as `url.Values`.

type InstanceListParamsOrderBy

type InstanceListParamsOrderBy string

Field to order results by.

const (
	InstanceListParamsOrderByCreatedAt InstanceListParamsOrderBy = "created_at"
)

func (InstanceListParamsOrderBy) IsKnown

func (r InstanceListParamsOrderBy) IsKnown() bool

type InstanceListParamsOrderByDirection

type InstanceListParamsOrderByDirection string

Order direction.

const (
	InstanceListParamsOrderByDirectionAsc  InstanceListParamsOrderByDirection = "asc"
	InstanceListParamsOrderByDirectionDesc InstanceListParamsOrderByDirection = "desc"
)

func (InstanceListParamsOrderByDirection) IsKnown

type InstanceListResponse

type InstanceListResponse struct {
	// AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
	ID             string                             `json:"id" api:"required"`
	CreatedAt      time.Time                          `json:"created_at" api:"required" format:"date-time"`
	ModifiedAt     time.Time                          `json:"modified_at" api:"required" format:"date-time"`
	AIGatewayID    string                             `json:"ai_gateway_id" api:"nullable"`
	AISearchModel  InstanceListResponseAISearchModel  `json:"ai_search_model" api:"nullable"`
	Cache          bool                               `json:"cache"`
	CacheThreshold InstanceListResponseCacheThreshold `json:"cache_threshold"`
	// Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600
	// (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200
	// (72h), 518400 (6d).
	CacheTTL       InstanceListResponseCacheTTL         `json:"cache_ttl"`
	ChunkOverlap   int64                                `json:"chunk_overlap"`
	ChunkSize      int64                                `json:"chunk_size"`
	CreatedBy      string                               `json:"created_by" api:"nullable"`
	CustomMetadata []InstanceListResponseCustomMetadata `json:"custom_metadata"`
	EmbeddingModel InstanceListResponseEmbeddingModel   `json:"embedding_model" api:"nullable"`
	Enable         bool                                 `json:"enable"`
	EngineVersion  float64                              `json:"engine_version"`
	FusionMethod   InstanceListResponseFusionMethod     `json:"fusion_method"`
	// Deprecated — use index_method instead.
	//
	// Deprecated: deprecated
	HybridSearchEnabled bool `json:"hybrid_search_enabled"`
	// Controls which storage backends are used during indexing. Defaults to
	// vector-only.
	IndexMethod          InstanceListResponseIndexMethod          `json:"index_method"`
	IndexingOptions      InstanceListResponseIndexingOptions      `json:"indexing_options" api:"nullable"`
	LastActivity         time.Time                                `json:"last_activity" api:"nullable" format:"date-time"`
	MaxNumResults        int64                                    `json:"max_num_results"`
	Metadata             InstanceListResponseMetadata             `json:"metadata"`
	ModifiedBy           string                                   `json:"modified_by" api:"nullable"`
	Namespace            string                                   `json:"namespace" api:"nullable"`
	Paused               bool                                     `json:"paused"`
	PublicEndpointID     string                                   `json:"public_endpoint_id" api:"nullable"`
	PublicEndpointParams InstanceListResponsePublicEndpointParams `json:"public_endpoint_params"`
	Reranking            bool                                     `json:"reranking"`
	RerankingModel       InstanceListResponseRerankingModel       `json:"reranking_model" api:"nullable"`
	RetrievalOptions     InstanceListResponseRetrievalOptions     `json:"retrieval_options" api:"nullable"`
	RewriteModel         InstanceListResponseRewriteModel         `json:"rewrite_model" api:"nullable"`
	RewriteQuery         bool                                     `json:"rewrite_query"`
	ScoreThreshold       float64                                  `json:"score_threshold"`
	Source               string                                   `json:"source" api:"nullable"`
	SourceParams         InstanceListResponseSourceParams         `json:"source_params" api:"nullable"`
	Status               string                                   `json:"status"`
	// Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800
	// (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).
	SyncInterval InstanceListResponseSyncInterval `json:"sync_interval"`
	TokenID      string                           `json:"token_id" format:"uuid"`
	Type         InstanceListResponseType         `json:"type" api:"nullable"`
	JSON         instanceListResponseJSON         `json:"-"`
}

func (*InstanceListResponse) UnmarshalJSON

func (r *InstanceListResponse) UnmarshalJSON(data []byte) (err error)

type InstanceListResponseAISearchModel

type InstanceListResponseAISearchModel string
const (
	InstanceListResponseAISearchModelCfMetaLlama3_3_70bInstructFp8Fast     InstanceListResponseAISearchModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	InstanceListResponseAISearchModelCfZaiOrgGlm4_7Flash                   InstanceListResponseAISearchModel = "@cf/zai-org/glm-4.7-flash"
	InstanceListResponseAISearchModelCfMetaLlama3_1_8bInstructFast         InstanceListResponseAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	InstanceListResponseAISearchModelCfMetaLlama3_1_8bInstructFp8          InstanceListResponseAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	InstanceListResponseAISearchModelCfMetaLlama4Scout17b16eInstruct       InstanceListResponseAISearchModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	InstanceListResponseAISearchModelCfQwenQwen3_30bA3bFp8                 InstanceListResponseAISearchModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	InstanceListResponseAISearchModelCfDeepseekAIDeepseekR1DistillQwen32b  InstanceListResponseAISearchModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	InstanceListResponseAISearchModelCfMoonshotaiKimiK2Instruct            InstanceListResponseAISearchModel = "@cf/moonshotai/kimi-k2-instruct"
	InstanceListResponseAISearchModelCfGoogleGemma3_12bIt                  InstanceListResponseAISearchModel = "@cf/google/gemma-3-12b-it"
	InstanceListResponseAISearchModelCfGoogleGemma4_26bA4bIt               InstanceListResponseAISearchModel = "@cf/google/gemma-4-26b-a4b-it"
	InstanceListResponseAISearchModelCfMoonshotaiKimiK2_5                  InstanceListResponseAISearchModel = "@cf/moonshotai/kimi-k2.5"
	InstanceListResponseAISearchModelAnthropicClaude3_7Sonnet              InstanceListResponseAISearchModel = "anthropic/claude-3-7-sonnet"
	InstanceListResponseAISearchModelAnthropicClaudeSonnet4                InstanceListResponseAISearchModel = "anthropic/claude-sonnet-4"
	InstanceListResponseAISearchModelAnthropicClaudeOpus4                  InstanceListResponseAISearchModel = "anthropic/claude-opus-4"
	InstanceListResponseAISearchModelAnthropicClaude3_5Haiku               InstanceListResponseAISearchModel = "anthropic/claude-3-5-haiku"
	InstanceListResponseAISearchModelCerebrasQwen3_235bA22bInstruct        InstanceListResponseAISearchModel = "cerebras/qwen-3-235b-a22b-instruct"
	InstanceListResponseAISearchModelCerebrasQwen3_235bA22bThinking        InstanceListResponseAISearchModel = "cerebras/qwen-3-235b-a22b-thinking"
	InstanceListResponseAISearchModelCerebrasLlama3_3_70b                  InstanceListResponseAISearchModel = "cerebras/llama-3.3-70b"
	InstanceListResponseAISearchModelCerebrasLlama4Maverick17b128eInstruct InstanceListResponseAISearchModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	InstanceListResponseAISearchModelCerebrasLlama4Scout17b16eInstruct     InstanceListResponseAISearchModel = "cerebras/llama-4-scout-17b-16e-instruct"
	InstanceListResponseAISearchModelCerebrasGptOSs120b                    InstanceListResponseAISearchModel = "cerebras/gpt-oss-120b"
	InstanceListResponseAISearchModelGoogleAIStudioGemini2_5Flash          InstanceListResponseAISearchModel = "google-ai-studio/gemini-2.5-flash"
	InstanceListResponseAISearchModelGoogleAIStudioGemini2_5Pro            InstanceListResponseAISearchModel = "google-ai-studio/gemini-2.5-pro"
	InstanceListResponseAISearchModelGrokGrok4                             InstanceListResponseAISearchModel = "grok/grok-4"
	InstanceListResponseAISearchModelGroqLlama3_3_70bVersatile             InstanceListResponseAISearchModel = "groq/llama-3.3-70b-versatile"
	InstanceListResponseAISearchModelGroqLlama3_1_8bInstant                InstanceListResponseAISearchModel = "groq/llama-3.1-8b-instant"
	InstanceListResponseAISearchModelOpenAIGpt5                            InstanceListResponseAISearchModel = "openai/gpt-5"
	InstanceListResponseAISearchModelOpenAIGpt5Mini                        InstanceListResponseAISearchModel = "openai/gpt-5-mini"
	InstanceListResponseAISearchModelOpenAIGpt5Nano                        InstanceListResponseAISearchModel = "openai/gpt-5-nano"
	InstanceListResponseAISearchModelEmpty                                 InstanceListResponseAISearchModel = ""
)

func (InstanceListResponseAISearchModel) IsKnown

type InstanceListResponseCacheTTL

type InstanceListResponseCacheTTL float64

Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d).

const (
	InstanceListResponseCacheTTL600    InstanceListResponseCacheTTL = 600
	InstanceListResponseCacheTTL1800   InstanceListResponseCacheTTL = 1800
	InstanceListResponseCacheTTL3600   InstanceListResponseCacheTTL = 3600
	InstanceListResponseCacheTTL7200   InstanceListResponseCacheTTL = 7200
	InstanceListResponseCacheTTL21600  InstanceListResponseCacheTTL = 21600
	InstanceListResponseCacheTTL43200  InstanceListResponseCacheTTL = 43200
	InstanceListResponseCacheTTL86400  InstanceListResponseCacheTTL = 86400
	InstanceListResponseCacheTTL172800 InstanceListResponseCacheTTL = 172800
	InstanceListResponseCacheTTL259200 InstanceListResponseCacheTTL = 259200
	InstanceListResponseCacheTTL518400 InstanceListResponseCacheTTL = 518400
)

func (InstanceListResponseCacheTTL) IsKnown

func (r InstanceListResponseCacheTTL) IsKnown() bool

type InstanceListResponseCacheThreshold

type InstanceListResponseCacheThreshold string
const (
	InstanceListResponseCacheThresholdSuperStrictMatch InstanceListResponseCacheThreshold = "super_strict_match"
	InstanceListResponseCacheThresholdCloseEnough      InstanceListResponseCacheThreshold = "close_enough"
	InstanceListResponseCacheThresholdFlexibleFriend   InstanceListResponseCacheThreshold = "flexible_friend"
	InstanceListResponseCacheThresholdAnythingGoes     InstanceListResponseCacheThreshold = "anything_goes"
)

func (InstanceListResponseCacheThreshold) IsKnown

type InstanceListResponseCustomMetadata

type InstanceListResponseCustomMetadata struct {
	DataType  InstanceListResponseCustomMetadataDataType `json:"data_type" api:"required"`
	FieldName string                                     `json:"field_name" api:"required"`
	JSON      instanceListResponseCustomMetadataJSON     `json:"-"`
}

func (*InstanceListResponseCustomMetadata) UnmarshalJSON

func (r *InstanceListResponseCustomMetadata) UnmarshalJSON(data []byte) (err error)

type InstanceListResponseCustomMetadataDataType

type InstanceListResponseCustomMetadataDataType string
const (
	InstanceListResponseCustomMetadataDataTypeText     InstanceListResponseCustomMetadataDataType = "text"
	InstanceListResponseCustomMetadataDataTypeNumber   InstanceListResponseCustomMetadataDataType = "number"
	InstanceListResponseCustomMetadataDataTypeBoolean  InstanceListResponseCustomMetadataDataType = "boolean"
	InstanceListResponseCustomMetadataDataTypeDatetime InstanceListResponseCustomMetadataDataType = "datetime"
)

func (InstanceListResponseCustomMetadataDataType) IsKnown

type InstanceListResponseEmbeddingModel

type InstanceListResponseEmbeddingModel string
const (
	InstanceListResponseEmbeddingModelCfQwenQwen3Embedding0_6b              InstanceListResponseEmbeddingModel = "@cf/qwen/qwen3-embedding-0.6b"
	InstanceListResponseEmbeddingModelCfBaaiBgeM3                           InstanceListResponseEmbeddingModel = "@cf/baai/bge-m3"
	InstanceListResponseEmbeddingModelCfBaaiBgeLargeEnV1_5                  InstanceListResponseEmbeddingModel = "@cf/baai/bge-large-en-v1.5"
	InstanceListResponseEmbeddingModelCfGoogleEmbeddinggemma300m            InstanceListResponseEmbeddingModel = "@cf/google/embeddinggemma-300m"
	InstanceListResponseEmbeddingModelGoogleAIStudioGeminiEmbedding001      InstanceListResponseEmbeddingModel = "google-ai-studio/gemini-embedding-001"
	InstanceListResponseEmbeddingModelGoogleAIStudioGeminiEmbedding2Preview InstanceListResponseEmbeddingModel = "google-ai-studio/gemini-embedding-2-preview"
	InstanceListResponseEmbeddingModelOpenAITextEmbedding3Small             InstanceListResponseEmbeddingModel = "openai/text-embedding-3-small"
	InstanceListResponseEmbeddingModelOpenAITextEmbedding3Large             InstanceListResponseEmbeddingModel = "openai/text-embedding-3-large"
	InstanceListResponseEmbeddingModelEmpty                                 InstanceListResponseEmbeddingModel = ""
)

func (InstanceListResponseEmbeddingModel) IsKnown

type InstanceListResponseFusionMethod

type InstanceListResponseFusionMethod string
const (
	InstanceListResponseFusionMethodMax InstanceListResponseFusionMethod = "max"
	InstanceListResponseFusionMethodRrf InstanceListResponseFusionMethod = "rrf"
)

func (InstanceListResponseFusionMethod) IsKnown

type InstanceListResponseIndexMethod

type InstanceListResponseIndexMethod struct {
	// Enable keyword (BM25) storage backend.
	Keyword bool `json:"keyword" api:"required"`
	// Enable vector (embedding) storage backend.
	Vector bool                                `json:"vector" api:"required"`
	JSON   instanceListResponseIndexMethodJSON `json:"-"`
}

Controls which storage backends are used during indexing. Defaults to vector-only.

func (*InstanceListResponseIndexMethod) UnmarshalJSON

func (r *InstanceListResponseIndexMethod) UnmarshalJSON(data []byte) (err error)

type InstanceListResponseIndexingOptions

type InstanceListResponseIndexingOptions struct {
	// Tokenizer used for keyword search indexing. porter provides word-level
	// tokenization with Porter stemming (good for natural language queries). trigram
	// enables character-level substring matching (good for partial matches, code,
	// identifiers). Changing this triggers a full re-index. Defaults to porter.
	KeywordTokenizer InstanceListResponseIndexingOptionsKeywordTokenizer `json:"keyword_tokenizer"`
	JSON             instanceListResponseIndexingOptionsJSON             `json:"-"`
}

func (*InstanceListResponseIndexingOptions) UnmarshalJSON

func (r *InstanceListResponseIndexingOptions) UnmarshalJSON(data []byte) (err error)

type InstanceListResponseIndexingOptionsKeywordTokenizer

type InstanceListResponseIndexingOptionsKeywordTokenizer string

Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter.

const (
	InstanceListResponseIndexingOptionsKeywordTokenizerPorter  InstanceListResponseIndexingOptionsKeywordTokenizer = "porter"
	InstanceListResponseIndexingOptionsKeywordTokenizerTrigram InstanceListResponseIndexingOptionsKeywordTokenizer = "trigram"
)

func (InstanceListResponseIndexingOptionsKeywordTokenizer) IsKnown

type InstanceListResponseMetadata

type InstanceListResponseMetadata struct {
	CreatedFromAISearchWizard bool                             `json:"created_from_aisearch_wizard"`
	WorkerDomain              string                           `json:"worker_domain"`
	JSON                      instanceListResponseMetadataJSON `json:"-"`
}

func (*InstanceListResponseMetadata) UnmarshalJSON

func (r *InstanceListResponseMetadata) UnmarshalJSON(data []byte) (err error)

type InstanceListResponsePublicEndpointParams

type InstanceListResponsePublicEndpointParams struct {
	AuthorizedHosts         []string                                                        `json:"authorized_hosts"`
	ChatCompletionsEndpoint InstanceListResponsePublicEndpointParamsChatCompletionsEndpoint `json:"chat_completions_endpoint"`
	Enabled                 bool                                                            `json:"enabled"`
	Mcp                     InstanceListResponsePublicEndpointParamsMcp                     `json:"mcp"`
	RateLimit               InstanceListResponsePublicEndpointParamsRateLimit               `json:"rate_limit"`
	SearchEndpoint          InstanceListResponsePublicEndpointParamsSearchEndpoint          `json:"search_endpoint"`
	JSON                    instanceListResponsePublicEndpointParamsJSON                    `json:"-"`
}

func (*InstanceListResponsePublicEndpointParams) UnmarshalJSON

func (r *InstanceListResponsePublicEndpointParams) UnmarshalJSON(data []byte) (err error)

type InstanceListResponsePublicEndpointParamsChatCompletionsEndpoint

type InstanceListResponsePublicEndpointParamsChatCompletionsEndpoint struct {
	// Disable chat completions endpoint for this public endpoint
	Disabled bool                                                                `json:"disabled"`
	JSON     instanceListResponsePublicEndpointParamsChatCompletionsEndpointJSON `json:"-"`
}

func (*InstanceListResponsePublicEndpointParamsChatCompletionsEndpoint) UnmarshalJSON

type InstanceListResponsePublicEndpointParamsMcp

type InstanceListResponsePublicEndpointParamsMcp struct {
	Description string `json:"description"`
	// Disable MCP endpoint for this public endpoint
	Disabled bool                                            `json:"disabled"`
	JSON     instanceListResponsePublicEndpointParamsMcpJSON `json:"-"`
}

func (*InstanceListResponsePublicEndpointParamsMcp) UnmarshalJSON

func (r *InstanceListResponsePublicEndpointParamsMcp) UnmarshalJSON(data []byte) (err error)

type InstanceListResponsePublicEndpointParamsRateLimit

type InstanceListResponsePublicEndpointParamsRateLimit struct {
	PeriodMs  int64                                                      `json:"period_ms"`
	Requests  int64                                                      `json:"requests"`
	Technique InstanceListResponsePublicEndpointParamsRateLimitTechnique `json:"technique"`
	JSON      instanceListResponsePublicEndpointParamsRateLimitJSON      `json:"-"`
}

func (*InstanceListResponsePublicEndpointParamsRateLimit) UnmarshalJSON

func (r *InstanceListResponsePublicEndpointParamsRateLimit) UnmarshalJSON(data []byte) (err error)

type InstanceListResponsePublicEndpointParamsRateLimitTechnique

type InstanceListResponsePublicEndpointParamsRateLimitTechnique string
const (
	InstanceListResponsePublicEndpointParamsRateLimitTechniqueFixed   InstanceListResponsePublicEndpointParamsRateLimitTechnique = "fixed"
	InstanceListResponsePublicEndpointParamsRateLimitTechniqueSliding InstanceListResponsePublicEndpointParamsRateLimitTechnique = "sliding"
)

func (InstanceListResponsePublicEndpointParamsRateLimitTechnique) IsKnown

type InstanceListResponsePublicEndpointParamsSearchEndpoint

type InstanceListResponsePublicEndpointParamsSearchEndpoint struct {
	// Disable search endpoint for this public endpoint
	Disabled bool                                                       `json:"disabled"`
	JSON     instanceListResponsePublicEndpointParamsSearchEndpointJSON `json:"-"`
}

func (*InstanceListResponsePublicEndpointParamsSearchEndpoint) UnmarshalJSON

func (r *InstanceListResponsePublicEndpointParamsSearchEndpoint) UnmarshalJSON(data []byte) (err error)

type InstanceListResponseRerankingModel

type InstanceListResponseRerankingModel string
const (
	InstanceListResponseRerankingModelCfBaaiBgeRerankerBase InstanceListResponseRerankingModel = "@cf/baai/bge-reranker-base"
	InstanceListResponseRerankingModelEmpty                 InstanceListResponseRerankingModel = ""
)

func (InstanceListResponseRerankingModel) IsKnown

type InstanceListResponseRetrievalOptions

type InstanceListResponseRetrievalOptions struct {
	// Metadata fields to boost search results by. Each entry specifies a metadata
	// field and an optional direction. Direction defaults to 'asc' for
	// numeric/datetime fields and 'exists' for text/boolean fields. Fields must match
	// 'timestamp' or a defined custom_metadata field.
	BoostBy []InstanceListResponseRetrievalOptionsBoostBy `json:"boost_by"`
	// 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'.
	KeywordMatchMode InstanceListResponseRetrievalOptionsKeywordMatchMode `json:"keyword_match_mode"`
	JSON             instanceListResponseRetrievalOptionsJSON             `json:"-"`
}

func (*InstanceListResponseRetrievalOptions) UnmarshalJSON

func (r *InstanceListResponseRetrievalOptions) UnmarshalJSON(data []byte) (err error)

type InstanceListResponseRetrievalOptionsBoostBy

type InstanceListResponseRetrievalOptionsBoostBy struct {
	// 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.
	Field string `json:"field" api:"required"`
	// 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.
	Direction InstanceListResponseRetrievalOptionsBoostByDirection `json:"direction"`
	JSON      instanceListResponseRetrievalOptionsBoostByJSON      `json:"-"`
}

func (*InstanceListResponseRetrievalOptionsBoostBy) UnmarshalJSON

func (r *InstanceListResponseRetrievalOptionsBoostBy) UnmarshalJSON(data []byte) (err error)

type InstanceListResponseRetrievalOptionsBoostByDirection

type InstanceListResponseRetrievalOptionsBoostByDirection string

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.

const (
	InstanceListResponseRetrievalOptionsBoostByDirectionAsc       InstanceListResponseRetrievalOptionsBoostByDirection = "asc"
	InstanceListResponseRetrievalOptionsBoostByDirectionDesc      InstanceListResponseRetrievalOptionsBoostByDirection = "desc"
	InstanceListResponseRetrievalOptionsBoostByDirectionExists    InstanceListResponseRetrievalOptionsBoostByDirection = "exists"
	InstanceListResponseRetrievalOptionsBoostByDirectionNotExists InstanceListResponseRetrievalOptionsBoostByDirection = "not_exists"
)

func (InstanceListResponseRetrievalOptionsBoostByDirection) IsKnown

type InstanceListResponseRetrievalOptionsKeywordMatchMode

type InstanceListResponseRetrievalOptionsKeywordMatchMode string

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'.

const (
	InstanceListResponseRetrievalOptionsKeywordMatchModeAnd InstanceListResponseRetrievalOptionsKeywordMatchMode = "and"
	InstanceListResponseRetrievalOptionsKeywordMatchModeOr  InstanceListResponseRetrievalOptionsKeywordMatchMode = "or"
)

func (InstanceListResponseRetrievalOptionsKeywordMatchMode) IsKnown

type InstanceListResponseRewriteModel

type InstanceListResponseRewriteModel string
const (
	InstanceListResponseRewriteModelCfMetaLlama3_3_70bInstructFp8Fast     InstanceListResponseRewriteModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	InstanceListResponseRewriteModelCfZaiOrgGlm4_7Flash                   InstanceListResponseRewriteModel = "@cf/zai-org/glm-4.7-flash"
	InstanceListResponseRewriteModelCfMetaLlama3_1_8bInstructFast         InstanceListResponseRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	InstanceListResponseRewriteModelCfMetaLlama3_1_8bInstructFp8          InstanceListResponseRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	InstanceListResponseRewriteModelCfMetaLlama4Scout17b16eInstruct       InstanceListResponseRewriteModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	InstanceListResponseRewriteModelCfQwenQwen3_30bA3bFp8                 InstanceListResponseRewriteModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	InstanceListResponseRewriteModelCfDeepseekAIDeepseekR1DistillQwen32b  InstanceListResponseRewriteModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	InstanceListResponseRewriteModelCfMoonshotaiKimiK2Instruct            InstanceListResponseRewriteModel = "@cf/moonshotai/kimi-k2-instruct"
	InstanceListResponseRewriteModelCfGoogleGemma3_12bIt                  InstanceListResponseRewriteModel = "@cf/google/gemma-3-12b-it"
	InstanceListResponseRewriteModelCfGoogleGemma4_26bA4bIt               InstanceListResponseRewriteModel = "@cf/google/gemma-4-26b-a4b-it"
	InstanceListResponseRewriteModelCfMoonshotaiKimiK2_5                  InstanceListResponseRewriteModel = "@cf/moonshotai/kimi-k2.5"
	InstanceListResponseRewriteModelAnthropicClaude3_7Sonnet              InstanceListResponseRewriteModel = "anthropic/claude-3-7-sonnet"
	InstanceListResponseRewriteModelAnthropicClaudeSonnet4                InstanceListResponseRewriteModel = "anthropic/claude-sonnet-4"
	InstanceListResponseRewriteModelAnthropicClaudeOpus4                  InstanceListResponseRewriteModel = "anthropic/claude-opus-4"
	InstanceListResponseRewriteModelAnthropicClaude3_5Haiku               InstanceListResponseRewriteModel = "anthropic/claude-3-5-haiku"
	InstanceListResponseRewriteModelCerebrasQwen3_235bA22bInstruct        InstanceListResponseRewriteModel = "cerebras/qwen-3-235b-a22b-instruct"
	InstanceListResponseRewriteModelCerebrasQwen3_235bA22bThinking        InstanceListResponseRewriteModel = "cerebras/qwen-3-235b-a22b-thinking"
	InstanceListResponseRewriteModelCerebrasLlama3_3_70b                  InstanceListResponseRewriteModel = "cerebras/llama-3.3-70b"
	InstanceListResponseRewriteModelCerebrasLlama4Maverick17b128eInstruct InstanceListResponseRewriteModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	InstanceListResponseRewriteModelCerebrasLlama4Scout17b16eInstruct     InstanceListResponseRewriteModel = "cerebras/llama-4-scout-17b-16e-instruct"
	InstanceListResponseRewriteModelCerebrasGptOSs120b                    InstanceListResponseRewriteModel = "cerebras/gpt-oss-120b"
	InstanceListResponseRewriteModelGoogleAIStudioGemini2_5Flash          InstanceListResponseRewriteModel = "google-ai-studio/gemini-2.5-flash"
	InstanceListResponseRewriteModelGoogleAIStudioGemini2_5Pro            InstanceListResponseRewriteModel = "google-ai-studio/gemini-2.5-pro"
	InstanceListResponseRewriteModelGrokGrok4                             InstanceListResponseRewriteModel = "grok/grok-4"
	InstanceListResponseRewriteModelGroqLlama3_3_70bVersatile             InstanceListResponseRewriteModel = "groq/llama-3.3-70b-versatile"
	InstanceListResponseRewriteModelGroqLlama3_1_8bInstant                InstanceListResponseRewriteModel = "groq/llama-3.1-8b-instant"
	InstanceListResponseRewriteModelOpenAIGpt5                            InstanceListResponseRewriteModel = "openai/gpt-5"
	InstanceListResponseRewriteModelOpenAIGpt5Mini                        InstanceListResponseRewriteModel = "openai/gpt-5-mini"
	InstanceListResponseRewriteModelOpenAIGpt5Nano                        InstanceListResponseRewriteModel = "openai/gpt-5-nano"
	InstanceListResponseRewriteModelEmpty                                 InstanceListResponseRewriteModel = ""
)

func (InstanceListResponseRewriteModel) IsKnown

type InstanceListResponseSourceParams

type InstanceListResponseSourceParams struct {
	// List of path patterns to exclude. Uses micromatch glob syntax: \* matches within
	// a path segment, ** matches across path segments (e.g., /admin/** matches
	// /admin/users and /admin/settings/advanced)
	ExcludeItems []string `json:"exclude_items"`
	// List of path patterns to include. Uses micromatch glob syntax: \* matches within
	// a path segment, ** matches across path segments (e.g., /blog/** matches
	// /blog/post and /blog/2024/post)
	IncludeItems   []string                                   `json:"include_items"`
	Prefix         string                                     `json:"prefix"`
	R2Jurisdiction string                                     `json:"r2_jurisdiction"`
	WebCrawler     InstanceListResponseSourceParamsWebCrawler `json:"web_crawler"`
	JSON           instanceListResponseSourceParamsJSON       `json:"-"`
}

func (*InstanceListResponseSourceParams) UnmarshalJSON

func (r *InstanceListResponseSourceParams) UnmarshalJSON(data []byte) (err error)

type InstanceListResponseSourceParamsWebCrawler

type InstanceListResponseSourceParamsWebCrawler struct {
	CrawlOptions InstanceListResponseSourceParamsWebCrawlerCrawlOptions `json:"crawl_options"`
	ParseOptions InstanceListResponseSourceParamsWebCrawlerParseOptions `json:"parse_options"`
	ParseType    InstanceListResponseSourceParamsWebCrawlerParseType    `json:"parse_type"`
	StoreOptions InstanceListResponseSourceParamsWebCrawlerStoreOptions `json:"store_options"`
	JSON         instanceListResponseSourceParamsWebCrawlerJSON         `json:"-"`
}

func (*InstanceListResponseSourceParamsWebCrawler) UnmarshalJSON

func (r *InstanceListResponseSourceParamsWebCrawler) UnmarshalJSON(data []byte) (err error)

type InstanceListResponseSourceParamsWebCrawlerCrawlOptions

type InstanceListResponseSourceParamsWebCrawlerCrawlOptions struct {
	Depth                float64                                                      `json:"depth"`
	IncludeExternalLinks bool                                                         `json:"include_external_links"`
	IncludeSubdomains    bool                                                         `json:"include_subdomains"`
	MaxAge               float64                                                      `json:"max_age"`
	Source               InstanceListResponseSourceParamsWebCrawlerCrawlOptionsSource `json:"source"`
	JSON                 instanceListResponseSourceParamsWebCrawlerCrawlOptionsJSON   `json:"-"`
}

func (*InstanceListResponseSourceParamsWebCrawlerCrawlOptions) UnmarshalJSON

func (r *InstanceListResponseSourceParamsWebCrawlerCrawlOptions) UnmarshalJSON(data []byte) (err error)

type InstanceListResponseSourceParamsWebCrawlerCrawlOptionsSource

type InstanceListResponseSourceParamsWebCrawlerCrawlOptionsSource string
const (
	InstanceListResponseSourceParamsWebCrawlerCrawlOptionsSourceAll      InstanceListResponseSourceParamsWebCrawlerCrawlOptionsSource = "all"
	InstanceListResponseSourceParamsWebCrawlerCrawlOptionsSourceSitemaps InstanceListResponseSourceParamsWebCrawlerCrawlOptionsSource = "sitemaps"
	InstanceListResponseSourceParamsWebCrawlerCrawlOptionsSourceLinks    InstanceListResponseSourceParamsWebCrawlerCrawlOptionsSource = "links"
)

func (InstanceListResponseSourceParamsWebCrawlerCrawlOptionsSource) IsKnown

type InstanceListResponseSourceParamsWebCrawlerParseOptions

type InstanceListResponseSourceParamsWebCrawlerParseOptions struct {
	// List of path-to-selector mappings for extracting specific content from crawled
	// pages. Each entry pairs a URL glob pattern with a CSS selector. The first
	// matching path wins. Only the matched HTML fragment is stored and indexed. Omit
	// the field to disable content selection — empty arrays are rejected.
	ContentSelector []InstanceListResponseSourceParamsWebCrawlerParseOptionsContentSelector `json:"content_selector"`
	// Up to 5 custom HTTP headers sent with each crawl request. Names must be RFC-7230
	// token characters (no spaces, colons, or control characters); values must be
	// HTAB + printable ASCII (no CR/LF).
	IncludeHeaders map[string]string `json:"include_headers"`
	IncludeImages  bool              `json:"include_images"`
	// List of specific sitemap URLs to use for crawling. Only valid when parse_type is
	// 'sitemap'.
	SpecificSitemaps    []string                                                   `json:"specific_sitemaps" format:"uri"`
	UseBrowserRendering bool                                                       `json:"use_browser_rendering"`
	JSON                instanceListResponseSourceParamsWebCrawlerParseOptionsJSON `json:"-"`
}

func (*InstanceListResponseSourceParamsWebCrawlerParseOptions) UnmarshalJSON

func (r *InstanceListResponseSourceParamsWebCrawlerParseOptions) UnmarshalJSON(data []byte) (err error)

type InstanceListResponseSourceParamsWebCrawlerParseOptionsContentSelector

type InstanceListResponseSourceParamsWebCrawlerParseOptionsContentSelector struct {
	// Glob pattern to match against the page URL path. Uses standard glob syntax: \*
	// matches within a segment, \*\* crosses directories.
	Path string `json:"path" api:"required"`
	// CSS selector to extract content from pages matching the path pattern. Must not
	// contain disallowed characters (;, `, $, {, }, \). Must target a single element;
	// if multiple elements match, the selector is ignored and the full page is used.
	Selector string                                                                    `json:"selector" api:"required"`
	JSON     instanceListResponseSourceParamsWebCrawlerParseOptionsContentSelectorJSON `json:"-"`
}

func (*InstanceListResponseSourceParamsWebCrawlerParseOptionsContentSelector) UnmarshalJSON

type InstanceListResponseSourceParamsWebCrawlerParseType

type InstanceListResponseSourceParamsWebCrawlerParseType string
const (
	InstanceListResponseSourceParamsWebCrawlerParseTypeSitemap InstanceListResponseSourceParamsWebCrawlerParseType = "sitemap"
	InstanceListResponseSourceParamsWebCrawlerParseTypeFeedRss InstanceListResponseSourceParamsWebCrawlerParseType = "feed-rss"
	InstanceListResponseSourceParamsWebCrawlerParseTypeCrawl   InstanceListResponseSourceParamsWebCrawlerParseType = "crawl"
)

func (InstanceListResponseSourceParamsWebCrawlerParseType) IsKnown

type InstanceListResponseSourceParamsWebCrawlerStoreOptions

type InstanceListResponseSourceParamsWebCrawlerStoreOptions struct {
	StorageID      string                                                     `json:"storage_id" api:"required"`
	R2Jurisdiction string                                                     `json:"r2_jurisdiction"`
	StorageType    r2.Provider                                                `json:"storage_type"`
	JSON           instanceListResponseSourceParamsWebCrawlerStoreOptionsJSON `json:"-"`
}

func (*InstanceListResponseSourceParamsWebCrawlerStoreOptions) UnmarshalJSON

func (r *InstanceListResponseSourceParamsWebCrawlerStoreOptions) UnmarshalJSON(data []byte) (err error)

type InstanceListResponseSyncInterval

type InstanceListResponseSyncInterval float64

Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).

const (
	InstanceListResponseSyncInterval900   InstanceListResponseSyncInterval = 900
	InstanceListResponseSyncInterval1800  InstanceListResponseSyncInterval = 1800
	InstanceListResponseSyncInterval3600  InstanceListResponseSyncInterval = 3600
	InstanceListResponseSyncInterval7200  InstanceListResponseSyncInterval = 7200
	InstanceListResponseSyncInterval14400 InstanceListResponseSyncInterval = 14400
	InstanceListResponseSyncInterval21600 InstanceListResponseSyncInterval = 21600
	InstanceListResponseSyncInterval43200 InstanceListResponseSyncInterval = 43200
	InstanceListResponseSyncInterval86400 InstanceListResponseSyncInterval = 86400
)

func (InstanceListResponseSyncInterval) IsKnown

type InstanceListResponseType

type InstanceListResponseType string
const (
	InstanceListResponseTypeR2         InstanceListResponseType = "r2"
	InstanceListResponseTypeWebCrawler InstanceListResponseType = "web-crawler"
)

func (InstanceListResponseType) IsKnown

func (r InstanceListResponseType) IsKnown() bool

type InstanceNewParams

type InstanceNewParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
	ID             param.Field[string]                          `json:"id" api:"required"`
	AIGatewayID    param.Field[string]                          `json:"ai_gateway_id"`
	AISearchModel  param.Field[InstanceNewParamsAISearchModel]  `json:"ai_search_model"`
	Cache          param.Field[bool]                            `json:"cache"`
	CacheThreshold param.Field[InstanceNewParamsCacheThreshold] `json:"cache_threshold"`
	// Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600
	// (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200
	// (72h), 518400 (6d).
	CacheTTL       param.Field[InstanceNewParamsCacheTTL]         `json:"cache_ttl"`
	Chunk          param.Field[bool]                              `json:"chunk"`
	ChunkOverlap   param.Field[int64]                             `json:"chunk_overlap"`
	ChunkSize      param.Field[int64]                             `json:"chunk_size"`
	CustomMetadata param.Field[[]InstanceNewParamsCustomMetadata] `json:"custom_metadata"`
	EmbeddingModel param.Field[InstanceNewParamsEmbeddingModel]   `json:"embedding_model"`
	FusionMethod   param.Field[InstanceNewParamsFusionMethod]     `json:"fusion_method"`
	// Deprecated — use index_method instead.
	HybridSearchEnabled param.Field[bool] `json:"hybrid_search_enabled"`
	// Controls which storage backends are used during indexing. Defaults to
	// vector-only.
	IndexMethod          param.Field[InstanceNewParamsIndexMethod]          `json:"index_method"`
	IndexingOptions      param.Field[InstanceNewParamsIndexingOptions]      `json:"indexing_options"`
	MaxNumResults        param.Field[int64]                                 `json:"max_num_results"`
	Metadata             param.Field[InstanceNewParamsMetadata]             `json:"metadata"`
	PublicEndpointParams param.Field[InstanceNewParamsPublicEndpointParams] `json:"public_endpoint_params"`
	Reranking            param.Field[bool]                                  `json:"reranking"`
	RerankingModel       param.Field[InstanceNewParamsRerankingModel]       `json:"reranking_model"`
	RetrievalOptions     param.Field[InstanceNewParamsRetrievalOptions]     `json:"retrieval_options"`
	RewriteModel         param.Field[InstanceNewParamsRewriteModel]         `json:"rewrite_model"`
	RewriteQuery         param.Field[bool]                                  `json:"rewrite_query"`
	ScoreThreshold       param.Field[float64]                               `json:"score_threshold"`
	Source               param.Field[string]                                `json:"source"`
	SourceParams         param.Field[InstanceNewParamsSourceParams]         `json:"source_params"`
	// Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800
	// (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).
	SyncInterval param.Field[InstanceNewParamsSyncInterval] `json:"sync_interval"`
	TokenID      param.Field[string]                        `json:"token_id" format:"uuid"`
	Type         param.Field[InstanceNewParamsType]         `json:"type"`
}

func (InstanceNewParams) MarshalJSON

func (r InstanceNewParams) MarshalJSON() (data []byte, err error)

type InstanceNewParamsAISearchModel

type InstanceNewParamsAISearchModel string
const (
	InstanceNewParamsAISearchModelCfMetaLlama3_3_70bInstructFp8Fast     InstanceNewParamsAISearchModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	InstanceNewParamsAISearchModelCfZaiOrgGlm4_7Flash                   InstanceNewParamsAISearchModel = "@cf/zai-org/glm-4.7-flash"
	InstanceNewParamsAISearchModelCfMetaLlama3_1_8bInstructFast         InstanceNewParamsAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	InstanceNewParamsAISearchModelCfMetaLlama3_1_8bInstructFp8          InstanceNewParamsAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	InstanceNewParamsAISearchModelCfMetaLlama4Scout17b16eInstruct       InstanceNewParamsAISearchModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	InstanceNewParamsAISearchModelCfQwenQwen3_30bA3bFp8                 InstanceNewParamsAISearchModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	InstanceNewParamsAISearchModelCfDeepseekAIDeepseekR1DistillQwen32b  InstanceNewParamsAISearchModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	InstanceNewParamsAISearchModelCfMoonshotaiKimiK2Instruct            InstanceNewParamsAISearchModel = "@cf/moonshotai/kimi-k2-instruct"
	InstanceNewParamsAISearchModelCfGoogleGemma3_12bIt                  InstanceNewParamsAISearchModel = "@cf/google/gemma-3-12b-it"
	InstanceNewParamsAISearchModelCfGoogleGemma4_26bA4bIt               InstanceNewParamsAISearchModel = "@cf/google/gemma-4-26b-a4b-it"
	InstanceNewParamsAISearchModelCfMoonshotaiKimiK2_5                  InstanceNewParamsAISearchModel = "@cf/moonshotai/kimi-k2.5"
	InstanceNewParamsAISearchModelAnthropicClaude3_7Sonnet              InstanceNewParamsAISearchModel = "anthropic/claude-3-7-sonnet"
	InstanceNewParamsAISearchModelAnthropicClaudeSonnet4                InstanceNewParamsAISearchModel = "anthropic/claude-sonnet-4"
	InstanceNewParamsAISearchModelAnthropicClaudeOpus4                  InstanceNewParamsAISearchModel = "anthropic/claude-opus-4"
	InstanceNewParamsAISearchModelAnthropicClaude3_5Haiku               InstanceNewParamsAISearchModel = "anthropic/claude-3-5-haiku"
	InstanceNewParamsAISearchModelCerebrasQwen3_235bA22bInstruct        InstanceNewParamsAISearchModel = "cerebras/qwen-3-235b-a22b-instruct"
	InstanceNewParamsAISearchModelCerebrasQwen3_235bA22bThinking        InstanceNewParamsAISearchModel = "cerebras/qwen-3-235b-a22b-thinking"
	InstanceNewParamsAISearchModelCerebrasLlama3_3_70b                  InstanceNewParamsAISearchModel = "cerebras/llama-3.3-70b"
	InstanceNewParamsAISearchModelCerebrasLlama4Maverick17b128eInstruct InstanceNewParamsAISearchModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	InstanceNewParamsAISearchModelCerebrasLlama4Scout17b16eInstruct     InstanceNewParamsAISearchModel = "cerebras/llama-4-scout-17b-16e-instruct"
	InstanceNewParamsAISearchModelCerebrasGptOSs120b                    InstanceNewParamsAISearchModel = "cerebras/gpt-oss-120b"
	InstanceNewParamsAISearchModelGoogleAIStudioGemini2_5Flash          InstanceNewParamsAISearchModel = "google-ai-studio/gemini-2.5-flash"
	InstanceNewParamsAISearchModelGoogleAIStudioGemini2_5Pro            InstanceNewParamsAISearchModel = "google-ai-studio/gemini-2.5-pro"
	InstanceNewParamsAISearchModelGrokGrok4                             InstanceNewParamsAISearchModel = "grok/grok-4"
	InstanceNewParamsAISearchModelGroqLlama3_3_70bVersatile             InstanceNewParamsAISearchModel = "groq/llama-3.3-70b-versatile"
	InstanceNewParamsAISearchModelGroqLlama3_1_8bInstant                InstanceNewParamsAISearchModel = "groq/llama-3.1-8b-instant"
	InstanceNewParamsAISearchModelOpenAIGpt5                            InstanceNewParamsAISearchModel = "openai/gpt-5"
	InstanceNewParamsAISearchModelOpenAIGpt5Mini                        InstanceNewParamsAISearchModel = "openai/gpt-5-mini"
	InstanceNewParamsAISearchModelOpenAIGpt5Nano                        InstanceNewParamsAISearchModel = "openai/gpt-5-nano"
	InstanceNewParamsAISearchModelEmpty                                 InstanceNewParamsAISearchModel = ""
)

func (InstanceNewParamsAISearchModel) IsKnown

type InstanceNewParamsCacheTTL

type InstanceNewParamsCacheTTL float64

Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d).

const (
	InstanceNewParamsCacheTTL600    InstanceNewParamsCacheTTL = 600
	InstanceNewParamsCacheTTL1800   InstanceNewParamsCacheTTL = 1800
	InstanceNewParamsCacheTTL3600   InstanceNewParamsCacheTTL = 3600
	InstanceNewParamsCacheTTL7200   InstanceNewParamsCacheTTL = 7200
	InstanceNewParamsCacheTTL21600  InstanceNewParamsCacheTTL = 21600
	InstanceNewParamsCacheTTL43200  InstanceNewParamsCacheTTL = 43200
	InstanceNewParamsCacheTTL86400  InstanceNewParamsCacheTTL = 86400
	InstanceNewParamsCacheTTL172800 InstanceNewParamsCacheTTL = 172800
	InstanceNewParamsCacheTTL259200 InstanceNewParamsCacheTTL = 259200
	InstanceNewParamsCacheTTL518400 InstanceNewParamsCacheTTL = 518400
)

func (InstanceNewParamsCacheTTL) IsKnown

func (r InstanceNewParamsCacheTTL) IsKnown() bool

type InstanceNewParamsCacheThreshold

type InstanceNewParamsCacheThreshold string
const (
	InstanceNewParamsCacheThresholdSuperStrictMatch InstanceNewParamsCacheThreshold = "super_strict_match"
	InstanceNewParamsCacheThresholdCloseEnough      InstanceNewParamsCacheThreshold = "close_enough"
	InstanceNewParamsCacheThresholdFlexibleFriend   InstanceNewParamsCacheThreshold = "flexible_friend"
	InstanceNewParamsCacheThresholdAnythingGoes     InstanceNewParamsCacheThreshold = "anything_goes"
)

func (InstanceNewParamsCacheThreshold) IsKnown

type InstanceNewParamsCustomMetadata

type InstanceNewParamsCustomMetadata struct {
	DataType  param.Field[InstanceNewParamsCustomMetadataDataType] `json:"data_type" api:"required"`
	FieldName param.Field[string]                                  `json:"field_name" api:"required"`
}

func (InstanceNewParamsCustomMetadata) MarshalJSON

func (r InstanceNewParamsCustomMetadata) MarshalJSON() (data []byte, err error)

type InstanceNewParamsCustomMetadataDataType

type InstanceNewParamsCustomMetadataDataType string
const (
	InstanceNewParamsCustomMetadataDataTypeText     InstanceNewParamsCustomMetadataDataType = "text"
	InstanceNewParamsCustomMetadataDataTypeNumber   InstanceNewParamsCustomMetadataDataType = "number"
	InstanceNewParamsCustomMetadataDataTypeBoolean  InstanceNewParamsCustomMetadataDataType = "boolean"
	InstanceNewParamsCustomMetadataDataTypeDatetime InstanceNewParamsCustomMetadataDataType = "datetime"
)

func (InstanceNewParamsCustomMetadataDataType) IsKnown

type InstanceNewParamsEmbeddingModel

type InstanceNewParamsEmbeddingModel string
const (
	InstanceNewParamsEmbeddingModelCfQwenQwen3Embedding0_6b              InstanceNewParamsEmbeddingModel = "@cf/qwen/qwen3-embedding-0.6b"
	InstanceNewParamsEmbeddingModelCfBaaiBgeM3                           InstanceNewParamsEmbeddingModel = "@cf/baai/bge-m3"
	InstanceNewParamsEmbeddingModelCfBaaiBgeLargeEnV1_5                  InstanceNewParamsEmbeddingModel = "@cf/baai/bge-large-en-v1.5"
	InstanceNewParamsEmbeddingModelCfGoogleEmbeddinggemma300m            InstanceNewParamsEmbeddingModel = "@cf/google/embeddinggemma-300m"
	InstanceNewParamsEmbeddingModelGoogleAIStudioGeminiEmbedding001      InstanceNewParamsEmbeddingModel = "google-ai-studio/gemini-embedding-001"
	InstanceNewParamsEmbeddingModelGoogleAIStudioGeminiEmbedding2Preview InstanceNewParamsEmbeddingModel = "google-ai-studio/gemini-embedding-2-preview"
	InstanceNewParamsEmbeddingModelOpenAITextEmbedding3Small             InstanceNewParamsEmbeddingModel = "openai/text-embedding-3-small"
	InstanceNewParamsEmbeddingModelOpenAITextEmbedding3Large             InstanceNewParamsEmbeddingModel = "openai/text-embedding-3-large"
	InstanceNewParamsEmbeddingModelEmpty                                 InstanceNewParamsEmbeddingModel = ""
)

func (InstanceNewParamsEmbeddingModel) IsKnown

type InstanceNewParamsFusionMethod

type InstanceNewParamsFusionMethod string
const (
	InstanceNewParamsFusionMethodMax InstanceNewParamsFusionMethod = "max"
	InstanceNewParamsFusionMethodRrf InstanceNewParamsFusionMethod = "rrf"
)

func (InstanceNewParamsFusionMethod) IsKnown

func (r InstanceNewParamsFusionMethod) IsKnown() bool

type InstanceNewParamsIndexMethod

type InstanceNewParamsIndexMethod struct {
	// Enable keyword (BM25) storage backend.
	Keyword param.Field[bool] `json:"keyword" api:"required"`
	// Enable vector (embedding) storage backend.
	Vector param.Field[bool] `json:"vector" api:"required"`
}

Controls which storage backends are used during indexing. Defaults to vector-only.

func (InstanceNewParamsIndexMethod) MarshalJSON

func (r InstanceNewParamsIndexMethod) MarshalJSON() (data []byte, err error)

type InstanceNewParamsIndexingOptions

type InstanceNewParamsIndexingOptions struct {
	// Tokenizer used for keyword search indexing. porter provides word-level
	// tokenization with Porter stemming (good for natural language queries). trigram
	// enables character-level substring matching (good for partial matches, code,
	// identifiers). Changing this triggers a full re-index. Defaults to porter.
	KeywordTokenizer param.Field[InstanceNewParamsIndexingOptionsKeywordTokenizer] `json:"keyword_tokenizer"`
}

func (InstanceNewParamsIndexingOptions) MarshalJSON

func (r InstanceNewParamsIndexingOptions) MarshalJSON() (data []byte, err error)

type InstanceNewParamsIndexingOptionsKeywordTokenizer

type InstanceNewParamsIndexingOptionsKeywordTokenizer string

Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter.

const (
	InstanceNewParamsIndexingOptionsKeywordTokenizerPorter  InstanceNewParamsIndexingOptionsKeywordTokenizer = "porter"
	InstanceNewParamsIndexingOptionsKeywordTokenizerTrigram InstanceNewParamsIndexingOptionsKeywordTokenizer = "trigram"
)

func (InstanceNewParamsIndexingOptionsKeywordTokenizer) IsKnown

type InstanceNewParamsMetadata

type InstanceNewParamsMetadata struct {
	CreatedFromAISearchWizard param.Field[bool]   `json:"created_from_aisearch_wizard"`
	WorkerDomain              param.Field[string] `json:"worker_domain"`
}

func (InstanceNewParamsMetadata) MarshalJSON

func (r InstanceNewParamsMetadata) MarshalJSON() (data []byte, err error)

type InstanceNewParamsPublicEndpointParams

type InstanceNewParamsPublicEndpointParams struct {
	AuthorizedHosts         param.Field[[]string]                                                     `json:"authorized_hosts"`
	ChatCompletionsEndpoint param.Field[InstanceNewParamsPublicEndpointParamsChatCompletionsEndpoint] `json:"chat_completions_endpoint"`
	Enabled                 param.Field[bool]                                                         `json:"enabled"`
	Mcp                     param.Field[InstanceNewParamsPublicEndpointParamsMcp]                     `json:"mcp"`
	RateLimit               param.Field[InstanceNewParamsPublicEndpointParamsRateLimit]               `json:"rate_limit"`
	SearchEndpoint          param.Field[InstanceNewParamsPublicEndpointParamsSearchEndpoint]          `json:"search_endpoint"`
}

func (InstanceNewParamsPublicEndpointParams) MarshalJSON

func (r InstanceNewParamsPublicEndpointParams) MarshalJSON() (data []byte, err error)

type InstanceNewParamsPublicEndpointParamsChatCompletionsEndpoint

type InstanceNewParamsPublicEndpointParamsChatCompletionsEndpoint struct {
	// Disable chat completions endpoint for this public endpoint
	Disabled param.Field[bool] `json:"disabled"`
}

func (InstanceNewParamsPublicEndpointParamsChatCompletionsEndpoint) MarshalJSON

type InstanceNewParamsPublicEndpointParamsMcp

type InstanceNewParamsPublicEndpointParamsMcp struct {
	Description param.Field[string] `json:"description"`
	// Disable MCP endpoint for this public endpoint
	Disabled param.Field[bool] `json:"disabled"`
}

func (InstanceNewParamsPublicEndpointParamsMcp) MarshalJSON

func (r InstanceNewParamsPublicEndpointParamsMcp) MarshalJSON() (data []byte, err error)

type InstanceNewParamsPublicEndpointParamsRateLimit

type InstanceNewParamsPublicEndpointParamsRateLimit struct {
	PeriodMs  param.Field[int64]                                                   `json:"period_ms"`
	Requests  param.Field[int64]                                                   `json:"requests"`
	Technique param.Field[InstanceNewParamsPublicEndpointParamsRateLimitTechnique] `json:"technique"`
}

func (InstanceNewParamsPublicEndpointParamsRateLimit) MarshalJSON

func (r InstanceNewParamsPublicEndpointParamsRateLimit) MarshalJSON() (data []byte, err error)

type InstanceNewParamsPublicEndpointParamsRateLimitTechnique

type InstanceNewParamsPublicEndpointParamsRateLimitTechnique string
const (
	InstanceNewParamsPublicEndpointParamsRateLimitTechniqueFixed   InstanceNewParamsPublicEndpointParamsRateLimitTechnique = "fixed"
	InstanceNewParamsPublicEndpointParamsRateLimitTechniqueSliding InstanceNewParamsPublicEndpointParamsRateLimitTechnique = "sliding"
)

func (InstanceNewParamsPublicEndpointParamsRateLimitTechnique) IsKnown

type InstanceNewParamsPublicEndpointParamsSearchEndpoint

type InstanceNewParamsPublicEndpointParamsSearchEndpoint struct {
	// Disable search endpoint for this public endpoint
	Disabled param.Field[bool] `json:"disabled"`
}

func (InstanceNewParamsPublicEndpointParamsSearchEndpoint) MarshalJSON

func (r InstanceNewParamsPublicEndpointParamsSearchEndpoint) MarshalJSON() (data []byte, err error)

type InstanceNewParamsRerankingModel

type InstanceNewParamsRerankingModel string
const (
	InstanceNewParamsRerankingModelCfBaaiBgeRerankerBase InstanceNewParamsRerankingModel = "@cf/baai/bge-reranker-base"
	InstanceNewParamsRerankingModelEmpty                 InstanceNewParamsRerankingModel = ""
)

func (InstanceNewParamsRerankingModel) IsKnown

type InstanceNewParamsRetrievalOptions

type InstanceNewParamsRetrievalOptions struct {
	// Metadata fields to boost search results by. Each entry specifies a metadata
	// field and an optional direction. Direction defaults to 'asc' for
	// numeric/datetime fields and 'exists' for text/boolean fields. Fields must match
	// 'timestamp' or a defined custom_metadata field.
	BoostBy param.Field[[]InstanceNewParamsRetrievalOptionsBoostBy] `json:"boost_by"`
	// 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'.
	KeywordMatchMode param.Field[InstanceNewParamsRetrievalOptionsKeywordMatchMode] `json:"keyword_match_mode"`
}

func (InstanceNewParamsRetrievalOptions) MarshalJSON

func (r InstanceNewParamsRetrievalOptions) MarshalJSON() (data []byte, err error)

type InstanceNewParamsRetrievalOptionsBoostBy

type InstanceNewParamsRetrievalOptionsBoostBy struct {
	// 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.
	Field param.Field[string] `json:"field" api:"required"`
	// 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.
	Direction param.Field[InstanceNewParamsRetrievalOptionsBoostByDirection] `json:"direction"`
}

func (InstanceNewParamsRetrievalOptionsBoostBy) MarshalJSON

func (r InstanceNewParamsRetrievalOptionsBoostBy) MarshalJSON() (data []byte, err error)

type InstanceNewParamsRetrievalOptionsBoostByDirection

type InstanceNewParamsRetrievalOptionsBoostByDirection string

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.

const (
	InstanceNewParamsRetrievalOptionsBoostByDirectionAsc       InstanceNewParamsRetrievalOptionsBoostByDirection = "asc"
	InstanceNewParamsRetrievalOptionsBoostByDirectionDesc      InstanceNewParamsRetrievalOptionsBoostByDirection = "desc"
	InstanceNewParamsRetrievalOptionsBoostByDirectionExists    InstanceNewParamsRetrievalOptionsBoostByDirection = "exists"
	InstanceNewParamsRetrievalOptionsBoostByDirectionNotExists InstanceNewParamsRetrievalOptionsBoostByDirection = "not_exists"
)

func (InstanceNewParamsRetrievalOptionsBoostByDirection) IsKnown

type InstanceNewParamsRetrievalOptionsKeywordMatchMode

type InstanceNewParamsRetrievalOptionsKeywordMatchMode string

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'.

const (
	InstanceNewParamsRetrievalOptionsKeywordMatchModeAnd InstanceNewParamsRetrievalOptionsKeywordMatchMode = "and"
	InstanceNewParamsRetrievalOptionsKeywordMatchModeOr  InstanceNewParamsRetrievalOptionsKeywordMatchMode = "or"
)

func (InstanceNewParamsRetrievalOptionsKeywordMatchMode) IsKnown

type InstanceNewParamsRewriteModel

type InstanceNewParamsRewriteModel string
const (
	InstanceNewParamsRewriteModelCfMetaLlama3_3_70bInstructFp8Fast     InstanceNewParamsRewriteModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	InstanceNewParamsRewriteModelCfZaiOrgGlm4_7Flash                   InstanceNewParamsRewriteModel = "@cf/zai-org/glm-4.7-flash"
	InstanceNewParamsRewriteModelCfMetaLlama3_1_8bInstructFast         InstanceNewParamsRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	InstanceNewParamsRewriteModelCfMetaLlama3_1_8bInstructFp8          InstanceNewParamsRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	InstanceNewParamsRewriteModelCfMetaLlama4Scout17b16eInstruct       InstanceNewParamsRewriteModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	InstanceNewParamsRewriteModelCfQwenQwen3_30bA3bFp8                 InstanceNewParamsRewriteModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	InstanceNewParamsRewriteModelCfDeepseekAIDeepseekR1DistillQwen32b  InstanceNewParamsRewriteModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	InstanceNewParamsRewriteModelCfMoonshotaiKimiK2Instruct            InstanceNewParamsRewriteModel = "@cf/moonshotai/kimi-k2-instruct"
	InstanceNewParamsRewriteModelCfGoogleGemma3_12bIt                  InstanceNewParamsRewriteModel = "@cf/google/gemma-3-12b-it"
	InstanceNewParamsRewriteModelCfGoogleGemma4_26bA4bIt               InstanceNewParamsRewriteModel = "@cf/google/gemma-4-26b-a4b-it"
	InstanceNewParamsRewriteModelCfMoonshotaiKimiK2_5                  InstanceNewParamsRewriteModel = "@cf/moonshotai/kimi-k2.5"
	InstanceNewParamsRewriteModelAnthropicClaude3_7Sonnet              InstanceNewParamsRewriteModel = "anthropic/claude-3-7-sonnet"
	InstanceNewParamsRewriteModelAnthropicClaudeSonnet4                InstanceNewParamsRewriteModel = "anthropic/claude-sonnet-4"
	InstanceNewParamsRewriteModelAnthropicClaudeOpus4                  InstanceNewParamsRewriteModel = "anthropic/claude-opus-4"
	InstanceNewParamsRewriteModelAnthropicClaude3_5Haiku               InstanceNewParamsRewriteModel = "anthropic/claude-3-5-haiku"
	InstanceNewParamsRewriteModelCerebrasQwen3_235bA22bInstruct        InstanceNewParamsRewriteModel = "cerebras/qwen-3-235b-a22b-instruct"
	InstanceNewParamsRewriteModelCerebrasQwen3_235bA22bThinking        InstanceNewParamsRewriteModel = "cerebras/qwen-3-235b-a22b-thinking"
	InstanceNewParamsRewriteModelCerebrasLlama3_3_70b                  InstanceNewParamsRewriteModel = "cerebras/llama-3.3-70b"
	InstanceNewParamsRewriteModelCerebrasLlama4Maverick17b128eInstruct InstanceNewParamsRewriteModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	InstanceNewParamsRewriteModelCerebrasLlama4Scout17b16eInstruct     InstanceNewParamsRewriteModel = "cerebras/llama-4-scout-17b-16e-instruct"
	InstanceNewParamsRewriteModelCerebrasGptOSs120b                    InstanceNewParamsRewriteModel = "cerebras/gpt-oss-120b"
	InstanceNewParamsRewriteModelGoogleAIStudioGemini2_5Flash          InstanceNewParamsRewriteModel = "google-ai-studio/gemini-2.5-flash"
	InstanceNewParamsRewriteModelGoogleAIStudioGemini2_5Pro            InstanceNewParamsRewriteModel = "google-ai-studio/gemini-2.5-pro"
	InstanceNewParamsRewriteModelGrokGrok4                             InstanceNewParamsRewriteModel = "grok/grok-4"
	InstanceNewParamsRewriteModelGroqLlama3_3_70bVersatile             InstanceNewParamsRewriteModel = "groq/llama-3.3-70b-versatile"
	InstanceNewParamsRewriteModelGroqLlama3_1_8bInstant                InstanceNewParamsRewriteModel = "groq/llama-3.1-8b-instant"
	InstanceNewParamsRewriteModelOpenAIGpt5                            InstanceNewParamsRewriteModel = "openai/gpt-5"
	InstanceNewParamsRewriteModelOpenAIGpt5Mini                        InstanceNewParamsRewriteModel = "openai/gpt-5-mini"
	InstanceNewParamsRewriteModelOpenAIGpt5Nano                        InstanceNewParamsRewriteModel = "openai/gpt-5-nano"
	InstanceNewParamsRewriteModelEmpty                                 InstanceNewParamsRewriteModel = ""
)

func (InstanceNewParamsRewriteModel) IsKnown

func (r InstanceNewParamsRewriteModel) IsKnown() bool

type InstanceNewParamsSourceParams

type InstanceNewParamsSourceParams struct {
	// List of path patterns to exclude. Uses micromatch glob syntax: \* matches within
	// a path segment, ** matches across path segments (e.g., /admin/** matches
	// /admin/users and /admin/settings/advanced)
	ExcludeItems param.Field[[]string] `json:"exclude_items"`
	// List of path patterns to include. Uses micromatch glob syntax: \* matches within
	// a path segment, ** matches across path segments (e.g., /blog/** matches
	// /blog/post and /blog/2024/post)
	IncludeItems   param.Field[[]string]                                `json:"include_items"`
	Prefix         param.Field[string]                                  `json:"prefix"`
	R2Jurisdiction param.Field[string]                                  `json:"r2_jurisdiction"`
	WebCrawler     param.Field[InstanceNewParamsSourceParamsWebCrawler] `json:"web_crawler"`
}

func (InstanceNewParamsSourceParams) MarshalJSON

func (r InstanceNewParamsSourceParams) MarshalJSON() (data []byte, err error)

type InstanceNewParamsSourceParamsWebCrawler

type InstanceNewParamsSourceParamsWebCrawler struct {
	CrawlOptions param.Field[InstanceNewParamsSourceParamsWebCrawlerCrawlOptions] `json:"crawl_options"`
	ParseOptions param.Field[InstanceNewParamsSourceParamsWebCrawlerParseOptions] `json:"parse_options"`
	ParseType    param.Field[InstanceNewParamsSourceParamsWebCrawlerParseType]    `json:"parse_type"`
	StoreOptions param.Field[InstanceNewParamsSourceParamsWebCrawlerStoreOptions] `json:"store_options"`
}

func (InstanceNewParamsSourceParamsWebCrawler) MarshalJSON

func (r InstanceNewParamsSourceParamsWebCrawler) MarshalJSON() (data []byte, err error)

type InstanceNewParamsSourceParamsWebCrawlerCrawlOptions

type InstanceNewParamsSourceParamsWebCrawlerCrawlOptions struct {
	Depth                param.Field[float64]                                                   `json:"depth"`
	IncludeExternalLinks param.Field[bool]                                                      `json:"include_external_links"`
	IncludeSubdomains    param.Field[bool]                                                      `json:"include_subdomains"`
	MaxAge               param.Field[float64]                                                   `json:"max_age"`
	Source               param.Field[InstanceNewParamsSourceParamsWebCrawlerCrawlOptionsSource] `json:"source"`
}

func (InstanceNewParamsSourceParamsWebCrawlerCrawlOptions) MarshalJSON

func (r InstanceNewParamsSourceParamsWebCrawlerCrawlOptions) MarshalJSON() (data []byte, err error)

type InstanceNewParamsSourceParamsWebCrawlerCrawlOptionsSource

type InstanceNewParamsSourceParamsWebCrawlerCrawlOptionsSource string
const (
	InstanceNewParamsSourceParamsWebCrawlerCrawlOptionsSourceAll      InstanceNewParamsSourceParamsWebCrawlerCrawlOptionsSource = "all"
	InstanceNewParamsSourceParamsWebCrawlerCrawlOptionsSourceSitemaps InstanceNewParamsSourceParamsWebCrawlerCrawlOptionsSource = "sitemaps"
	InstanceNewParamsSourceParamsWebCrawlerCrawlOptionsSourceLinks    InstanceNewParamsSourceParamsWebCrawlerCrawlOptionsSource = "links"
)

func (InstanceNewParamsSourceParamsWebCrawlerCrawlOptionsSource) IsKnown

type InstanceNewParamsSourceParamsWebCrawlerParseOptions

type InstanceNewParamsSourceParamsWebCrawlerParseOptions struct {
	// List of path-to-selector mappings for extracting specific content from crawled
	// pages. Each entry pairs a URL glob pattern with a CSS selector. The first
	// matching path wins. Only the matched HTML fragment is stored and indexed. Omit
	// the field to disable content selection — empty arrays are rejected.
	ContentSelector param.Field[[]InstanceNewParamsSourceParamsWebCrawlerParseOptionsContentSelector] `json:"content_selector"`
	// Up to 5 custom HTTP headers sent with each crawl request. Names must be RFC-7230
	// token characters (no spaces, colons, or control characters); values must be
	// HTAB + printable ASCII (no CR/LF).
	IncludeHeaders param.Field[map[string]string] `json:"include_headers"`
	IncludeImages  param.Field[bool]              `json:"include_images"`
	// List of specific sitemap URLs to use for crawling. Only valid when parse_type is
	// 'sitemap'.
	SpecificSitemaps    param.Field[[]string] `json:"specific_sitemaps" format:"uri"`
	UseBrowserRendering param.Field[bool]     `json:"use_browser_rendering"`
}

func (InstanceNewParamsSourceParamsWebCrawlerParseOptions) MarshalJSON

func (r InstanceNewParamsSourceParamsWebCrawlerParseOptions) MarshalJSON() (data []byte, err error)

type InstanceNewParamsSourceParamsWebCrawlerParseOptionsContentSelector

type InstanceNewParamsSourceParamsWebCrawlerParseOptionsContentSelector struct {
	// Glob pattern to match against the page URL path. Uses standard glob syntax: \*
	// matches within a segment, \*\* crosses directories.
	Path param.Field[string] `json:"path" api:"required"`
	// CSS selector to extract content from pages matching the path pattern. Must not
	// contain disallowed characters (;, `, $, {, }, \). Must target a single element;
	// if multiple elements match, the selector is ignored and the full page is used.
	Selector param.Field[string] `json:"selector" api:"required"`
}

func (InstanceNewParamsSourceParamsWebCrawlerParseOptionsContentSelector) MarshalJSON

type InstanceNewParamsSourceParamsWebCrawlerParseType

type InstanceNewParamsSourceParamsWebCrawlerParseType string
const (
	InstanceNewParamsSourceParamsWebCrawlerParseTypeSitemap InstanceNewParamsSourceParamsWebCrawlerParseType = "sitemap"
	InstanceNewParamsSourceParamsWebCrawlerParseTypeFeedRss InstanceNewParamsSourceParamsWebCrawlerParseType = "feed-rss"
	InstanceNewParamsSourceParamsWebCrawlerParseTypeCrawl   InstanceNewParamsSourceParamsWebCrawlerParseType = "crawl"
)

func (InstanceNewParamsSourceParamsWebCrawlerParseType) IsKnown

type InstanceNewParamsSourceParamsWebCrawlerStoreOptions

type InstanceNewParamsSourceParamsWebCrawlerStoreOptions struct {
	StorageID      param.Field[string]      `json:"storage_id" api:"required"`
	R2Jurisdiction param.Field[string]      `json:"r2_jurisdiction"`
	StorageType    param.Field[r2.Provider] `json:"storage_type"`
}

func (InstanceNewParamsSourceParamsWebCrawlerStoreOptions) MarshalJSON

func (r InstanceNewParamsSourceParamsWebCrawlerStoreOptions) MarshalJSON() (data []byte, err error)

type InstanceNewParamsSyncInterval

type InstanceNewParamsSyncInterval float64

Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).

const (
	InstanceNewParamsSyncInterval900   InstanceNewParamsSyncInterval = 900
	InstanceNewParamsSyncInterval1800  InstanceNewParamsSyncInterval = 1800
	InstanceNewParamsSyncInterval3600  InstanceNewParamsSyncInterval = 3600
	InstanceNewParamsSyncInterval7200  InstanceNewParamsSyncInterval = 7200
	InstanceNewParamsSyncInterval14400 InstanceNewParamsSyncInterval = 14400
	InstanceNewParamsSyncInterval21600 InstanceNewParamsSyncInterval = 21600
	InstanceNewParamsSyncInterval43200 InstanceNewParamsSyncInterval = 43200
	InstanceNewParamsSyncInterval86400 InstanceNewParamsSyncInterval = 86400
)

func (InstanceNewParamsSyncInterval) IsKnown

func (r InstanceNewParamsSyncInterval) IsKnown() bool

type InstanceNewParamsType

type InstanceNewParamsType string
const (
	InstanceNewParamsTypeR2         InstanceNewParamsType = "r2"
	InstanceNewParamsTypeWebCrawler InstanceNewParamsType = "web-crawler"
)

func (InstanceNewParamsType) IsKnown

func (r InstanceNewParamsType) IsKnown() bool

type InstanceNewResponse

type InstanceNewResponse struct {
	// AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
	ID             string                            `json:"id" api:"required"`
	CreatedAt      time.Time                         `json:"created_at" api:"required" format:"date-time"`
	ModifiedAt     time.Time                         `json:"modified_at" api:"required" format:"date-time"`
	AIGatewayID    string                            `json:"ai_gateway_id" api:"nullable"`
	AISearchModel  InstanceNewResponseAISearchModel  `json:"ai_search_model" api:"nullable"`
	Cache          bool                              `json:"cache"`
	CacheThreshold InstanceNewResponseCacheThreshold `json:"cache_threshold"`
	// Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600
	// (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200
	// (72h), 518400 (6d).
	CacheTTL       InstanceNewResponseCacheTTL         `json:"cache_ttl"`
	ChunkOverlap   int64                               `json:"chunk_overlap"`
	ChunkSize      int64                               `json:"chunk_size"`
	CreatedBy      string                              `json:"created_by" api:"nullable"`
	CustomMetadata []InstanceNewResponseCustomMetadata `json:"custom_metadata"`
	EmbeddingModel InstanceNewResponseEmbeddingModel   `json:"embedding_model" api:"nullable"`
	Enable         bool                                `json:"enable"`
	EngineVersion  float64                             `json:"engine_version"`
	FusionMethod   InstanceNewResponseFusionMethod     `json:"fusion_method"`
	// Deprecated — use index_method instead.
	//
	// Deprecated: deprecated
	HybridSearchEnabled bool `json:"hybrid_search_enabled"`
	// Controls which storage backends are used during indexing. Defaults to
	// vector-only.
	IndexMethod          InstanceNewResponseIndexMethod          `json:"index_method"`
	IndexingOptions      InstanceNewResponseIndexingOptions      `json:"indexing_options" api:"nullable"`
	LastActivity         time.Time                               `json:"last_activity" api:"nullable" format:"date-time"`
	MaxNumResults        int64                                   `json:"max_num_results"`
	Metadata             InstanceNewResponseMetadata             `json:"metadata"`
	ModifiedBy           string                                  `json:"modified_by" api:"nullable"`
	Namespace            string                                  `json:"namespace" api:"nullable"`
	Paused               bool                                    `json:"paused"`
	PublicEndpointID     string                                  `json:"public_endpoint_id" api:"nullable"`
	PublicEndpointParams InstanceNewResponsePublicEndpointParams `json:"public_endpoint_params"`
	Reranking            bool                                    `json:"reranking"`
	RerankingModel       InstanceNewResponseRerankingModel       `json:"reranking_model" api:"nullable"`
	RetrievalOptions     InstanceNewResponseRetrievalOptions     `json:"retrieval_options" api:"nullable"`
	RewriteModel         InstanceNewResponseRewriteModel         `json:"rewrite_model" api:"nullable"`
	RewriteQuery         bool                                    `json:"rewrite_query"`
	ScoreThreshold       float64                                 `json:"score_threshold"`
	Source               string                                  `json:"source" api:"nullable"`
	SourceParams         InstanceNewResponseSourceParams         `json:"source_params" api:"nullable"`
	Status               string                                  `json:"status"`
	// Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800
	// (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).
	SyncInterval InstanceNewResponseSyncInterval `json:"sync_interval"`
	TokenID      string                          `json:"token_id" format:"uuid"`
	Type         InstanceNewResponseType         `json:"type" api:"nullable"`
	JSON         instanceNewResponseJSON         `json:"-"`
}

func (*InstanceNewResponse) UnmarshalJSON

func (r *InstanceNewResponse) UnmarshalJSON(data []byte) (err error)

type InstanceNewResponseAISearchModel

type InstanceNewResponseAISearchModel string
const (
	InstanceNewResponseAISearchModelCfMetaLlama3_3_70bInstructFp8Fast     InstanceNewResponseAISearchModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	InstanceNewResponseAISearchModelCfZaiOrgGlm4_7Flash                   InstanceNewResponseAISearchModel = "@cf/zai-org/glm-4.7-flash"
	InstanceNewResponseAISearchModelCfMetaLlama3_1_8bInstructFast         InstanceNewResponseAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	InstanceNewResponseAISearchModelCfMetaLlama3_1_8bInstructFp8          InstanceNewResponseAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	InstanceNewResponseAISearchModelCfMetaLlama4Scout17b16eInstruct       InstanceNewResponseAISearchModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	InstanceNewResponseAISearchModelCfQwenQwen3_30bA3bFp8                 InstanceNewResponseAISearchModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	InstanceNewResponseAISearchModelCfDeepseekAIDeepseekR1DistillQwen32b  InstanceNewResponseAISearchModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	InstanceNewResponseAISearchModelCfMoonshotaiKimiK2Instruct            InstanceNewResponseAISearchModel = "@cf/moonshotai/kimi-k2-instruct"
	InstanceNewResponseAISearchModelCfGoogleGemma3_12bIt                  InstanceNewResponseAISearchModel = "@cf/google/gemma-3-12b-it"
	InstanceNewResponseAISearchModelCfGoogleGemma4_26bA4bIt               InstanceNewResponseAISearchModel = "@cf/google/gemma-4-26b-a4b-it"
	InstanceNewResponseAISearchModelCfMoonshotaiKimiK2_5                  InstanceNewResponseAISearchModel = "@cf/moonshotai/kimi-k2.5"
	InstanceNewResponseAISearchModelAnthropicClaude3_7Sonnet              InstanceNewResponseAISearchModel = "anthropic/claude-3-7-sonnet"
	InstanceNewResponseAISearchModelAnthropicClaudeSonnet4                InstanceNewResponseAISearchModel = "anthropic/claude-sonnet-4"
	InstanceNewResponseAISearchModelAnthropicClaudeOpus4                  InstanceNewResponseAISearchModel = "anthropic/claude-opus-4"
	InstanceNewResponseAISearchModelAnthropicClaude3_5Haiku               InstanceNewResponseAISearchModel = "anthropic/claude-3-5-haiku"
	InstanceNewResponseAISearchModelCerebrasQwen3_235bA22bInstruct        InstanceNewResponseAISearchModel = "cerebras/qwen-3-235b-a22b-instruct"
	InstanceNewResponseAISearchModelCerebrasQwen3_235bA22bThinking        InstanceNewResponseAISearchModel = "cerebras/qwen-3-235b-a22b-thinking"
	InstanceNewResponseAISearchModelCerebrasLlama3_3_70b                  InstanceNewResponseAISearchModel = "cerebras/llama-3.3-70b"
	InstanceNewResponseAISearchModelCerebrasLlama4Maverick17b128eInstruct InstanceNewResponseAISearchModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	InstanceNewResponseAISearchModelCerebrasLlama4Scout17b16eInstruct     InstanceNewResponseAISearchModel = "cerebras/llama-4-scout-17b-16e-instruct"
	InstanceNewResponseAISearchModelCerebrasGptOSs120b                    InstanceNewResponseAISearchModel = "cerebras/gpt-oss-120b"
	InstanceNewResponseAISearchModelGoogleAIStudioGemini2_5Flash          InstanceNewResponseAISearchModel = "google-ai-studio/gemini-2.5-flash"
	InstanceNewResponseAISearchModelGoogleAIStudioGemini2_5Pro            InstanceNewResponseAISearchModel = "google-ai-studio/gemini-2.5-pro"
	InstanceNewResponseAISearchModelGrokGrok4                             InstanceNewResponseAISearchModel = "grok/grok-4"
	InstanceNewResponseAISearchModelGroqLlama3_3_70bVersatile             InstanceNewResponseAISearchModel = "groq/llama-3.3-70b-versatile"
	InstanceNewResponseAISearchModelGroqLlama3_1_8bInstant                InstanceNewResponseAISearchModel = "groq/llama-3.1-8b-instant"
	InstanceNewResponseAISearchModelOpenAIGpt5                            InstanceNewResponseAISearchModel = "openai/gpt-5"
	InstanceNewResponseAISearchModelOpenAIGpt5Mini                        InstanceNewResponseAISearchModel = "openai/gpt-5-mini"
	InstanceNewResponseAISearchModelOpenAIGpt5Nano                        InstanceNewResponseAISearchModel = "openai/gpt-5-nano"
	InstanceNewResponseAISearchModelEmpty                                 InstanceNewResponseAISearchModel = ""
)

func (InstanceNewResponseAISearchModel) IsKnown

type InstanceNewResponseCacheTTL

type InstanceNewResponseCacheTTL float64

Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d).

const (
	InstanceNewResponseCacheTTL600    InstanceNewResponseCacheTTL = 600
	InstanceNewResponseCacheTTL1800   InstanceNewResponseCacheTTL = 1800
	InstanceNewResponseCacheTTL3600   InstanceNewResponseCacheTTL = 3600
	InstanceNewResponseCacheTTL7200   InstanceNewResponseCacheTTL = 7200
	InstanceNewResponseCacheTTL21600  InstanceNewResponseCacheTTL = 21600
	InstanceNewResponseCacheTTL43200  InstanceNewResponseCacheTTL = 43200
	InstanceNewResponseCacheTTL86400  InstanceNewResponseCacheTTL = 86400
	InstanceNewResponseCacheTTL172800 InstanceNewResponseCacheTTL = 172800
	InstanceNewResponseCacheTTL259200 InstanceNewResponseCacheTTL = 259200
	InstanceNewResponseCacheTTL518400 InstanceNewResponseCacheTTL = 518400
)

func (InstanceNewResponseCacheTTL) IsKnown

func (r InstanceNewResponseCacheTTL) IsKnown() bool

type InstanceNewResponseCacheThreshold

type InstanceNewResponseCacheThreshold string
const (
	InstanceNewResponseCacheThresholdSuperStrictMatch InstanceNewResponseCacheThreshold = "super_strict_match"
	InstanceNewResponseCacheThresholdCloseEnough      InstanceNewResponseCacheThreshold = "close_enough"
	InstanceNewResponseCacheThresholdFlexibleFriend   InstanceNewResponseCacheThreshold = "flexible_friend"
	InstanceNewResponseCacheThresholdAnythingGoes     InstanceNewResponseCacheThreshold = "anything_goes"
)

func (InstanceNewResponseCacheThreshold) IsKnown

type InstanceNewResponseCustomMetadata

type InstanceNewResponseCustomMetadata struct {
	DataType  InstanceNewResponseCustomMetadataDataType `json:"data_type" api:"required"`
	FieldName string                                    `json:"field_name" api:"required"`
	JSON      instanceNewResponseCustomMetadataJSON     `json:"-"`
}

func (*InstanceNewResponseCustomMetadata) UnmarshalJSON

func (r *InstanceNewResponseCustomMetadata) UnmarshalJSON(data []byte) (err error)

type InstanceNewResponseCustomMetadataDataType

type InstanceNewResponseCustomMetadataDataType string
const (
	InstanceNewResponseCustomMetadataDataTypeText     InstanceNewResponseCustomMetadataDataType = "text"
	InstanceNewResponseCustomMetadataDataTypeNumber   InstanceNewResponseCustomMetadataDataType = "number"
	InstanceNewResponseCustomMetadataDataTypeBoolean  InstanceNewResponseCustomMetadataDataType = "boolean"
	InstanceNewResponseCustomMetadataDataTypeDatetime InstanceNewResponseCustomMetadataDataType = "datetime"
)

func (InstanceNewResponseCustomMetadataDataType) IsKnown

type InstanceNewResponseEmbeddingModel

type InstanceNewResponseEmbeddingModel string
const (
	InstanceNewResponseEmbeddingModelCfQwenQwen3Embedding0_6b              InstanceNewResponseEmbeddingModel = "@cf/qwen/qwen3-embedding-0.6b"
	InstanceNewResponseEmbeddingModelCfBaaiBgeM3                           InstanceNewResponseEmbeddingModel = "@cf/baai/bge-m3"
	InstanceNewResponseEmbeddingModelCfBaaiBgeLargeEnV1_5                  InstanceNewResponseEmbeddingModel = "@cf/baai/bge-large-en-v1.5"
	InstanceNewResponseEmbeddingModelCfGoogleEmbeddinggemma300m            InstanceNewResponseEmbeddingModel = "@cf/google/embeddinggemma-300m"
	InstanceNewResponseEmbeddingModelGoogleAIStudioGeminiEmbedding001      InstanceNewResponseEmbeddingModel = "google-ai-studio/gemini-embedding-001"
	InstanceNewResponseEmbeddingModelGoogleAIStudioGeminiEmbedding2Preview InstanceNewResponseEmbeddingModel = "google-ai-studio/gemini-embedding-2-preview"
	InstanceNewResponseEmbeddingModelOpenAITextEmbedding3Small             InstanceNewResponseEmbeddingModel = "openai/text-embedding-3-small"
	InstanceNewResponseEmbeddingModelOpenAITextEmbedding3Large             InstanceNewResponseEmbeddingModel = "openai/text-embedding-3-large"
	InstanceNewResponseEmbeddingModelEmpty                                 InstanceNewResponseEmbeddingModel = ""
)

func (InstanceNewResponseEmbeddingModel) IsKnown

type InstanceNewResponseEnvelope

type InstanceNewResponseEnvelope struct {
	Result  InstanceNewResponse             `json:"result" api:"required"`
	Success bool                            `json:"success" api:"required"`
	JSON    instanceNewResponseEnvelopeJSON `json:"-"`
}

func (*InstanceNewResponseEnvelope) UnmarshalJSON

func (r *InstanceNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InstanceNewResponseFusionMethod

type InstanceNewResponseFusionMethod string
const (
	InstanceNewResponseFusionMethodMax InstanceNewResponseFusionMethod = "max"
	InstanceNewResponseFusionMethodRrf InstanceNewResponseFusionMethod = "rrf"
)

func (InstanceNewResponseFusionMethod) IsKnown

type InstanceNewResponseIndexMethod

type InstanceNewResponseIndexMethod struct {
	// Enable keyword (BM25) storage backend.
	Keyword bool `json:"keyword" api:"required"`
	// Enable vector (embedding) storage backend.
	Vector bool                               `json:"vector" api:"required"`
	JSON   instanceNewResponseIndexMethodJSON `json:"-"`
}

Controls which storage backends are used during indexing. Defaults to vector-only.

func (*InstanceNewResponseIndexMethod) UnmarshalJSON

func (r *InstanceNewResponseIndexMethod) UnmarshalJSON(data []byte) (err error)

type InstanceNewResponseIndexingOptions

type InstanceNewResponseIndexingOptions struct {
	// Tokenizer used for keyword search indexing. porter provides word-level
	// tokenization with Porter stemming (good for natural language queries). trigram
	// enables character-level substring matching (good for partial matches, code,
	// identifiers). Changing this triggers a full re-index. Defaults to porter.
	KeywordTokenizer InstanceNewResponseIndexingOptionsKeywordTokenizer `json:"keyword_tokenizer"`
	JSON             instanceNewResponseIndexingOptionsJSON             `json:"-"`
}

func (*InstanceNewResponseIndexingOptions) UnmarshalJSON

func (r *InstanceNewResponseIndexingOptions) UnmarshalJSON(data []byte) (err error)

type InstanceNewResponseIndexingOptionsKeywordTokenizer

type InstanceNewResponseIndexingOptionsKeywordTokenizer string

Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter.

const (
	InstanceNewResponseIndexingOptionsKeywordTokenizerPorter  InstanceNewResponseIndexingOptionsKeywordTokenizer = "porter"
	InstanceNewResponseIndexingOptionsKeywordTokenizerTrigram InstanceNewResponseIndexingOptionsKeywordTokenizer = "trigram"
)

func (InstanceNewResponseIndexingOptionsKeywordTokenizer) IsKnown

type InstanceNewResponseMetadata

type InstanceNewResponseMetadata struct {
	CreatedFromAISearchWizard bool                            `json:"created_from_aisearch_wizard"`
	WorkerDomain              string                          `json:"worker_domain"`
	JSON                      instanceNewResponseMetadataJSON `json:"-"`
}

func (*InstanceNewResponseMetadata) UnmarshalJSON

func (r *InstanceNewResponseMetadata) UnmarshalJSON(data []byte) (err error)

type InstanceNewResponsePublicEndpointParams

type InstanceNewResponsePublicEndpointParams struct {
	AuthorizedHosts         []string                                                       `json:"authorized_hosts"`
	ChatCompletionsEndpoint InstanceNewResponsePublicEndpointParamsChatCompletionsEndpoint `json:"chat_completions_endpoint"`
	Enabled                 bool                                                           `json:"enabled"`
	Mcp                     InstanceNewResponsePublicEndpointParamsMcp                     `json:"mcp"`
	RateLimit               InstanceNewResponsePublicEndpointParamsRateLimit               `json:"rate_limit"`
	SearchEndpoint          InstanceNewResponsePublicEndpointParamsSearchEndpoint          `json:"search_endpoint"`
	JSON                    instanceNewResponsePublicEndpointParamsJSON                    `json:"-"`
}

func (*InstanceNewResponsePublicEndpointParams) UnmarshalJSON

func (r *InstanceNewResponsePublicEndpointParams) UnmarshalJSON(data []byte) (err error)

type InstanceNewResponsePublicEndpointParamsChatCompletionsEndpoint

type InstanceNewResponsePublicEndpointParamsChatCompletionsEndpoint struct {
	// Disable chat completions endpoint for this public endpoint
	Disabled bool                                                               `json:"disabled"`
	JSON     instanceNewResponsePublicEndpointParamsChatCompletionsEndpointJSON `json:"-"`
}

func (*InstanceNewResponsePublicEndpointParamsChatCompletionsEndpoint) UnmarshalJSON

type InstanceNewResponsePublicEndpointParamsMcp

type InstanceNewResponsePublicEndpointParamsMcp struct {
	Description string `json:"description"`
	// Disable MCP endpoint for this public endpoint
	Disabled bool                                           `json:"disabled"`
	JSON     instanceNewResponsePublicEndpointParamsMcpJSON `json:"-"`
}

func (*InstanceNewResponsePublicEndpointParamsMcp) UnmarshalJSON

func (r *InstanceNewResponsePublicEndpointParamsMcp) UnmarshalJSON(data []byte) (err error)

type InstanceNewResponsePublicEndpointParamsRateLimit

type InstanceNewResponsePublicEndpointParamsRateLimit struct {
	PeriodMs  int64                                                     `json:"period_ms"`
	Requests  int64                                                     `json:"requests"`
	Technique InstanceNewResponsePublicEndpointParamsRateLimitTechnique `json:"technique"`
	JSON      instanceNewResponsePublicEndpointParamsRateLimitJSON      `json:"-"`
}

func (*InstanceNewResponsePublicEndpointParamsRateLimit) UnmarshalJSON

func (r *InstanceNewResponsePublicEndpointParamsRateLimit) UnmarshalJSON(data []byte) (err error)

type InstanceNewResponsePublicEndpointParamsRateLimitTechnique

type InstanceNewResponsePublicEndpointParamsRateLimitTechnique string
const (
	InstanceNewResponsePublicEndpointParamsRateLimitTechniqueFixed   InstanceNewResponsePublicEndpointParamsRateLimitTechnique = "fixed"
	InstanceNewResponsePublicEndpointParamsRateLimitTechniqueSliding InstanceNewResponsePublicEndpointParamsRateLimitTechnique = "sliding"
)

func (InstanceNewResponsePublicEndpointParamsRateLimitTechnique) IsKnown

type InstanceNewResponsePublicEndpointParamsSearchEndpoint

type InstanceNewResponsePublicEndpointParamsSearchEndpoint struct {
	// Disable search endpoint for this public endpoint
	Disabled bool                                                      `json:"disabled"`
	JSON     instanceNewResponsePublicEndpointParamsSearchEndpointJSON `json:"-"`
}

func (*InstanceNewResponsePublicEndpointParamsSearchEndpoint) UnmarshalJSON

func (r *InstanceNewResponsePublicEndpointParamsSearchEndpoint) UnmarshalJSON(data []byte) (err error)

type InstanceNewResponseRerankingModel

type InstanceNewResponseRerankingModel string
const (
	InstanceNewResponseRerankingModelCfBaaiBgeRerankerBase InstanceNewResponseRerankingModel = "@cf/baai/bge-reranker-base"
	InstanceNewResponseRerankingModelEmpty                 InstanceNewResponseRerankingModel = ""
)

func (InstanceNewResponseRerankingModel) IsKnown

type InstanceNewResponseRetrievalOptions

type InstanceNewResponseRetrievalOptions struct {
	// Metadata fields to boost search results by. Each entry specifies a metadata
	// field and an optional direction. Direction defaults to 'asc' for
	// numeric/datetime fields and 'exists' for text/boolean fields. Fields must match
	// 'timestamp' or a defined custom_metadata field.
	BoostBy []InstanceNewResponseRetrievalOptionsBoostBy `json:"boost_by"`
	// 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'.
	KeywordMatchMode InstanceNewResponseRetrievalOptionsKeywordMatchMode `json:"keyword_match_mode"`
	JSON             instanceNewResponseRetrievalOptionsJSON             `json:"-"`
}

func (*InstanceNewResponseRetrievalOptions) UnmarshalJSON

func (r *InstanceNewResponseRetrievalOptions) UnmarshalJSON(data []byte) (err error)

type InstanceNewResponseRetrievalOptionsBoostBy

type InstanceNewResponseRetrievalOptionsBoostBy struct {
	// 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.
	Field string `json:"field" api:"required"`
	// 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.
	Direction InstanceNewResponseRetrievalOptionsBoostByDirection `json:"direction"`
	JSON      instanceNewResponseRetrievalOptionsBoostByJSON      `json:"-"`
}

func (*InstanceNewResponseRetrievalOptionsBoostBy) UnmarshalJSON

func (r *InstanceNewResponseRetrievalOptionsBoostBy) UnmarshalJSON(data []byte) (err error)

type InstanceNewResponseRetrievalOptionsBoostByDirection

type InstanceNewResponseRetrievalOptionsBoostByDirection string

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.

const (
	InstanceNewResponseRetrievalOptionsBoostByDirectionAsc       InstanceNewResponseRetrievalOptionsBoostByDirection = "asc"
	InstanceNewResponseRetrievalOptionsBoostByDirectionDesc      InstanceNewResponseRetrievalOptionsBoostByDirection = "desc"
	InstanceNewResponseRetrievalOptionsBoostByDirectionExists    InstanceNewResponseRetrievalOptionsBoostByDirection = "exists"
	InstanceNewResponseRetrievalOptionsBoostByDirectionNotExists InstanceNewResponseRetrievalOptionsBoostByDirection = "not_exists"
)

func (InstanceNewResponseRetrievalOptionsBoostByDirection) IsKnown

type InstanceNewResponseRetrievalOptionsKeywordMatchMode

type InstanceNewResponseRetrievalOptionsKeywordMatchMode string

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'.

const (
	InstanceNewResponseRetrievalOptionsKeywordMatchModeAnd InstanceNewResponseRetrievalOptionsKeywordMatchMode = "and"
	InstanceNewResponseRetrievalOptionsKeywordMatchModeOr  InstanceNewResponseRetrievalOptionsKeywordMatchMode = "or"
)

func (InstanceNewResponseRetrievalOptionsKeywordMatchMode) IsKnown

type InstanceNewResponseRewriteModel

type InstanceNewResponseRewriteModel string
const (
	InstanceNewResponseRewriteModelCfMetaLlama3_3_70bInstructFp8Fast     InstanceNewResponseRewriteModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	InstanceNewResponseRewriteModelCfZaiOrgGlm4_7Flash                   InstanceNewResponseRewriteModel = "@cf/zai-org/glm-4.7-flash"
	InstanceNewResponseRewriteModelCfMetaLlama3_1_8bInstructFast         InstanceNewResponseRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	InstanceNewResponseRewriteModelCfMetaLlama3_1_8bInstructFp8          InstanceNewResponseRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	InstanceNewResponseRewriteModelCfMetaLlama4Scout17b16eInstruct       InstanceNewResponseRewriteModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	InstanceNewResponseRewriteModelCfQwenQwen3_30bA3bFp8                 InstanceNewResponseRewriteModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	InstanceNewResponseRewriteModelCfDeepseekAIDeepseekR1DistillQwen32b  InstanceNewResponseRewriteModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	InstanceNewResponseRewriteModelCfMoonshotaiKimiK2Instruct            InstanceNewResponseRewriteModel = "@cf/moonshotai/kimi-k2-instruct"
	InstanceNewResponseRewriteModelCfGoogleGemma3_12bIt                  InstanceNewResponseRewriteModel = "@cf/google/gemma-3-12b-it"
	InstanceNewResponseRewriteModelCfGoogleGemma4_26bA4bIt               InstanceNewResponseRewriteModel = "@cf/google/gemma-4-26b-a4b-it"
	InstanceNewResponseRewriteModelCfMoonshotaiKimiK2_5                  InstanceNewResponseRewriteModel = "@cf/moonshotai/kimi-k2.5"
	InstanceNewResponseRewriteModelAnthropicClaude3_7Sonnet              InstanceNewResponseRewriteModel = "anthropic/claude-3-7-sonnet"
	InstanceNewResponseRewriteModelAnthropicClaudeSonnet4                InstanceNewResponseRewriteModel = "anthropic/claude-sonnet-4"
	InstanceNewResponseRewriteModelAnthropicClaudeOpus4                  InstanceNewResponseRewriteModel = "anthropic/claude-opus-4"
	InstanceNewResponseRewriteModelAnthropicClaude3_5Haiku               InstanceNewResponseRewriteModel = "anthropic/claude-3-5-haiku"
	InstanceNewResponseRewriteModelCerebrasQwen3_235bA22bInstruct        InstanceNewResponseRewriteModel = "cerebras/qwen-3-235b-a22b-instruct"
	InstanceNewResponseRewriteModelCerebrasQwen3_235bA22bThinking        InstanceNewResponseRewriteModel = "cerebras/qwen-3-235b-a22b-thinking"
	InstanceNewResponseRewriteModelCerebrasLlama3_3_70b                  InstanceNewResponseRewriteModel = "cerebras/llama-3.3-70b"
	InstanceNewResponseRewriteModelCerebrasLlama4Maverick17b128eInstruct InstanceNewResponseRewriteModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	InstanceNewResponseRewriteModelCerebrasLlama4Scout17b16eInstruct     InstanceNewResponseRewriteModel = "cerebras/llama-4-scout-17b-16e-instruct"
	InstanceNewResponseRewriteModelCerebrasGptOSs120b                    InstanceNewResponseRewriteModel = "cerebras/gpt-oss-120b"
	InstanceNewResponseRewriteModelGoogleAIStudioGemini2_5Flash          InstanceNewResponseRewriteModel = "google-ai-studio/gemini-2.5-flash"
	InstanceNewResponseRewriteModelGoogleAIStudioGemini2_5Pro            InstanceNewResponseRewriteModel = "google-ai-studio/gemini-2.5-pro"
	InstanceNewResponseRewriteModelGrokGrok4                             InstanceNewResponseRewriteModel = "grok/grok-4"
	InstanceNewResponseRewriteModelGroqLlama3_3_70bVersatile             InstanceNewResponseRewriteModel = "groq/llama-3.3-70b-versatile"
	InstanceNewResponseRewriteModelGroqLlama3_1_8bInstant                InstanceNewResponseRewriteModel = "groq/llama-3.1-8b-instant"
	InstanceNewResponseRewriteModelOpenAIGpt5                            InstanceNewResponseRewriteModel = "openai/gpt-5"
	InstanceNewResponseRewriteModelOpenAIGpt5Mini                        InstanceNewResponseRewriteModel = "openai/gpt-5-mini"
	InstanceNewResponseRewriteModelOpenAIGpt5Nano                        InstanceNewResponseRewriteModel = "openai/gpt-5-nano"
	InstanceNewResponseRewriteModelEmpty                                 InstanceNewResponseRewriteModel = ""
)

func (InstanceNewResponseRewriteModel) IsKnown

type InstanceNewResponseSourceParams

type InstanceNewResponseSourceParams struct {
	// List of path patterns to exclude. Uses micromatch glob syntax: \* matches within
	// a path segment, ** matches across path segments (e.g., /admin/** matches
	// /admin/users and /admin/settings/advanced)
	ExcludeItems []string `json:"exclude_items"`
	// List of path patterns to include. Uses micromatch glob syntax: \* matches within
	// a path segment, ** matches across path segments (e.g., /blog/** matches
	// /blog/post and /blog/2024/post)
	IncludeItems   []string                                  `json:"include_items"`
	Prefix         string                                    `json:"prefix"`
	R2Jurisdiction string                                    `json:"r2_jurisdiction"`
	WebCrawler     InstanceNewResponseSourceParamsWebCrawler `json:"web_crawler"`
	JSON           instanceNewResponseSourceParamsJSON       `json:"-"`
}

func (*InstanceNewResponseSourceParams) UnmarshalJSON

func (r *InstanceNewResponseSourceParams) UnmarshalJSON(data []byte) (err error)

type InstanceNewResponseSourceParamsWebCrawler

type InstanceNewResponseSourceParamsWebCrawler struct {
	CrawlOptions InstanceNewResponseSourceParamsWebCrawlerCrawlOptions `json:"crawl_options"`
	ParseOptions InstanceNewResponseSourceParamsWebCrawlerParseOptions `json:"parse_options"`
	ParseType    InstanceNewResponseSourceParamsWebCrawlerParseType    `json:"parse_type"`
	StoreOptions InstanceNewResponseSourceParamsWebCrawlerStoreOptions `json:"store_options"`
	JSON         instanceNewResponseSourceParamsWebCrawlerJSON         `json:"-"`
}

func (*InstanceNewResponseSourceParamsWebCrawler) UnmarshalJSON

func (r *InstanceNewResponseSourceParamsWebCrawler) UnmarshalJSON(data []byte) (err error)

type InstanceNewResponseSourceParamsWebCrawlerCrawlOptions

type InstanceNewResponseSourceParamsWebCrawlerCrawlOptions struct {
	Depth                float64                                                     `json:"depth"`
	IncludeExternalLinks bool                                                        `json:"include_external_links"`
	IncludeSubdomains    bool                                                        `json:"include_subdomains"`
	MaxAge               float64                                                     `json:"max_age"`
	Source               InstanceNewResponseSourceParamsWebCrawlerCrawlOptionsSource `json:"source"`
	JSON                 instanceNewResponseSourceParamsWebCrawlerCrawlOptionsJSON   `json:"-"`
}

func (*InstanceNewResponseSourceParamsWebCrawlerCrawlOptions) UnmarshalJSON

func (r *InstanceNewResponseSourceParamsWebCrawlerCrawlOptions) UnmarshalJSON(data []byte) (err error)

type InstanceNewResponseSourceParamsWebCrawlerCrawlOptionsSource

type InstanceNewResponseSourceParamsWebCrawlerCrawlOptionsSource string
const (
	InstanceNewResponseSourceParamsWebCrawlerCrawlOptionsSourceAll      InstanceNewResponseSourceParamsWebCrawlerCrawlOptionsSource = "all"
	InstanceNewResponseSourceParamsWebCrawlerCrawlOptionsSourceSitemaps InstanceNewResponseSourceParamsWebCrawlerCrawlOptionsSource = "sitemaps"
	InstanceNewResponseSourceParamsWebCrawlerCrawlOptionsSourceLinks    InstanceNewResponseSourceParamsWebCrawlerCrawlOptionsSource = "links"
)

func (InstanceNewResponseSourceParamsWebCrawlerCrawlOptionsSource) IsKnown

type InstanceNewResponseSourceParamsWebCrawlerParseOptions

type InstanceNewResponseSourceParamsWebCrawlerParseOptions struct {
	// List of path-to-selector mappings for extracting specific content from crawled
	// pages. Each entry pairs a URL glob pattern with a CSS selector. The first
	// matching path wins. Only the matched HTML fragment is stored and indexed. Omit
	// the field to disable content selection — empty arrays are rejected.
	ContentSelector []InstanceNewResponseSourceParamsWebCrawlerParseOptionsContentSelector `json:"content_selector"`
	// Up to 5 custom HTTP headers sent with each crawl request. Names must be RFC-7230
	// token characters (no spaces, colons, or control characters); values must be
	// HTAB + printable ASCII (no CR/LF).
	IncludeHeaders map[string]string `json:"include_headers"`
	IncludeImages  bool              `json:"include_images"`
	// List of specific sitemap URLs to use for crawling. Only valid when parse_type is
	// 'sitemap'.
	SpecificSitemaps    []string                                                  `json:"specific_sitemaps" format:"uri"`
	UseBrowserRendering bool                                                      `json:"use_browser_rendering"`
	JSON                instanceNewResponseSourceParamsWebCrawlerParseOptionsJSON `json:"-"`
}

func (*InstanceNewResponseSourceParamsWebCrawlerParseOptions) UnmarshalJSON

func (r *InstanceNewResponseSourceParamsWebCrawlerParseOptions) UnmarshalJSON(data []byte) (err error)

type InstanceNewResponseSourceParamsWebCrawlerParseOptionsContentSelector

type InstanceNewResponseSourceParamsWebCrawlerParseOptionsContentSelector struct {
	// Glob pattern to match against the page URL path. Uses standard glob syntax: \*
	// matches within a segment, \*\* crosses directories.
	Path string `json:"path" api:"required"`
	// CSS selector to extract content from pages matching the path pattern. Must not
	// contain disallowed characters (;, `, $, {, }, \). Must target a single element;
	// if multiple elements match, the selector is ignored and the full page is used.
	Selector string                                                                   `json:"selector" api:"required"`
	JSON     instanceNewResponseSourceParamsWebCrawlerParseOptionsContentSelectorJSON `json:"-"`
}

func (*InstanceNewResponseSourceParamsWebCrawlerParseOptionsContentSelector) UnmarshalJSON

type InstanceNewResponseSourceParamsWebCrawlerParseType

type InstanceNewResponseSourceParamsWebCrawlerParseType string
const (
	InstanceNewResponseSourceParamsWebCrawlerParseTypeSitemap InstanceNewResponseSourceParamsWebCrawlerParseType = "sitemap"
	InstanceNewResponseSourceParamsWebCrawlerParseTypeFeedRss InstanceNewResponseSourceParamsWebCrawlerParseType = "feed-rss"
	InstanceNewResponseSourceParamsWebCrawlerParseTypeCrawl   InstanceNewResponseSourceParamsWebCrawlerParseType = "crawl"
)

func (InstanceNewResponseSourceParamsWebCrawlerParseType) IsKnown

type InstanceNewResponseSourceParamsWebCrawlerStoreOptions

type InstanceNewResponseSourceParamsWebCrawlerStoreOptions struct {
	StorageID      string                                                    `json:"storage_id" api:"required"`
	R2Jurisdiction string                                                    `json:"r2_jurisdiction"`
	StorageType    r2.Provider                                               `json:"storage_type"`
	JSON           instanceNewResponseSourceParamsWebCrawlerStoreOptionsJSON `json:"-"`
}

func (*InstanceNewResponseSourceParamsWebCrawlerStoreOptions) UnmarshalJSON

func (r *InstanceNewResponseSourceParamsWebCrawlerStoreOptions) UnmarshalJSON(data []byte) (err error)

type InstanceNewResponseSyncInterval

type InstanceNewResponseSyncInterval float64

Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).

const (
	InstanceNewResponseSyncInterval900   InstanceNewResponseSyncInterval = 900
	InstanceNewResponseSyncInterval1800  InstanceNewResponseSyncInterval = 1800
	InstanceNewResponseSyncInterval3600  InstanceNewResponseSyncInterval = 3600
	InstanceNewResponseSyncInterval7200  InstanceNewResponseSyncInterval = 7200
	InstanceNewResponseSyncInterval14400 InstanceNewResponseSyncInterval = 14400
	InstanceNewResponseSyncInterval21600 InstanceNewResponseSyncInterval = 21600
	InstanceNewResponseSyncInterval43200 InstanceNewResponseSyncInterval = 43200
	InstanceNewResponseSyncInterval86400 InstanceNewResponseSyncInterval = 86400
)

func (InstanceNewResponseSyncInterval) IsKnown

type InstanceNewResponseType

type InstanceNewResponseType string
const (
	InstanceNewResponseTypeR2         InstanceNewResponseType = "r2"
	InstanceNewResponseTypeWebCrawler InstanceNewResponseType = "web-crawler"
)

func (InstanceNewResponseType) IsKnown

func (r InstanceNewResponseType) IsKnown() bool

type InstanceReadParams

type InstanceReadParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type InstanceReadResponse

type InstanceReadResponse struct {
	// AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
	ID             string                             `json:"id" api:"required"`
	CreatedAt      time.Time                          `json:"created_at" api:"required" format:"date-time"`
	ModifiedAt     time.Time                          `json:"modified_at" api:"required" format:"date-time"`
	AIGatewayID    string                             `json:"ai_gateway_id" api:"nullable"`
	AISearchModel  InstanceReadResponseAISearchModel  `json:"ai_search_model" api:"nullable"`
	Cache          bool                               `json:"cache"`
	CacheThreshold InstanceReadResponseCacheThreshold `json:"cache_threshold"`
	// Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600
	// (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200
	// (72h), 518400 (6d).
	CacheTTL       InstanceReadResponseCacheTTL         `json:"cache_ttl"`
	ChunkOverlap   int64                                `json:"chunk_overlap"`
	ChunkSize      int64                                `json:"chunk_size"`
	CreatedBy      string                               `json:"created_by" api:"nullable"`
	CustomMetadata []InstanceReadResponseCustomMetadata `json:"custom_metadata"`
	EmbeddingModel InstanceReadResponseEmbeddingModel   `json:"embedding_model" api:"nullable"`
	Enable         bool                                 `json:"enable"`
	EngineVersion  float64                              `json:"engine_version"`
	FusionMethod   InstanceReadResponseFusionMethod     `json:"fusion_method"`
	// Deprecated — use index_method instead.
	//
	// Deprecated: deprecated
	HybridSearchEnabled bool `json:"hybrid_search_enabled"`
	// Controls which storage backends are used during indexing. Defaults to
	// vector-only.
	IndexMethod          InstanceReadResponseIndexMethod          `json:"index_method"`
	IndexingOptions      InstanceReadResponseIndexingOptions      `json:"indexing_options" api:"nullable"`
	LastActivity         time.Time                                `json:"last_activity" api:"nullable" format:"date-time"`
	MaxNumResults        int64                                    `json:"max_num_results"`
	Metadata             InstanceReadResponseMetadata             `json:"metadata"`
	ModifiedBy           string                                   `json:"modified_by" api:"nullable"`
	Namespace            string                                   `json:"namespace" api:"nullable"`
	Paused               bool                                     `json:"paused"`
	PublicEndpointID     string                                   `json:"public_endpoint_id" api:"nullable"`
	PublicEndpointParams InstanceReadResponsePublicEndpointParams `json:"public_endpoint_params"`
	Reranking            bool                                     `json:"reranking"`
	RerankingModel       InstanceReadResponseRerankingModel       `json:"reranking_model" api:"nullable"`
	RetrievalOptions     InstanceReadResponseRetrievalOptions     `json:"retrieval_options" api:"nullable"`
	RewriteModel         InstanceReadResponseRewriteModel         `json:"rewrite_model" api:"nullable"`
	RewriteQuery         bool                                     `json:"rewrite_query"`
	ScoreThreshold       float64                                  `json:"score_threshold"`
	Source               string                                   `json:"source" api:"nullable"`
	SourceParams         InstanceReadResponseSourceParams         `json:"source_params" api:"nullable"`
	Status               string                                   `json:"status"`
	// Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800
	// (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).
	SyncInterval InstanceReadResponseSyncInterval `json:"sync_interval"`
	TokenID      string                           `json:"token_id" format:"uuid"`
	Type         InstanceReadResponseType         `json:"type" api:"nullable"`
	JSON         instanceReadResponseJSON         `json:"-"`
}

func (*InstanceReadResponse) UnmarshalJSON

func (r *InstanceReadResponse) UnmarshalJSON(data []byte) (err error)

type InstanceReadResponseAISearchModel

type InstanceReadResponseAISearchModel string
const (
	InstanceReadResponseAISearchModelCfMetaLlama3_3_70bInstructFp8Fast     InstanceReadResponseAISearchModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	InstanceReadResponseAISearchModelCfZaiOrgGlm4_7Flash                   InstanceReadResponseAISearchModel = "@cf/zai-org/glm-4.7-flash"
	InstanceReadResponseAISearchModelCfMetaLlama3_1_8bInstructFast         InstanceReadResponseAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	InstanceReadResponseAISearchModelCfMetaLlama3_1_8bInstructFp8          InstanceReadResponseAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	InstanceReadResponseAISearchModelCfMetaLlama4Scout17b16eInstruct       InstanceReadResponseAISearchModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	InstanceReadResponseAISearchModelCfQwenQwen3_30bA3bFp8                 InstanceReadResponseAISearchModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	InstanceReadResponseAISearchModelCfDeepseekAIDeepseekR1DistillQwen32b  InstanceReadResponseAISearchModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	InstanceReadResponseAISearchModelCfMoonshotaiKimiK2Instruct            InstanceReadResponseAISearchModel = "@cf/moonshotai/kimi-k2-instruct"
	InstanceReadResponseAISearchModelCfGoogleGemma3_12bIt                  InstanceReadResponseAISearchModel = "@cf/google/gemma-3-12b-it"
	InstanceReadResponseAISearchModelCfGoogleGemma4_26bA4bIt               InstanceReadResponseAISearchModel = "@cf/google/gemma-4-26b-a4b-it"
	InstanceReadResponseAISearchModelCfMoonshotaiKimiK2_5                  InstanceReadResponseAISearchModel = "@cf/moonshotai/kimi-k2.5"
	InstanceReadResponseAISearchModelAnthropicClaude3_7Sonnet              InstanceReadResponseAISearchModel = "anthropic/claude-3-7-sonnet"
	InstanceReadResponseAISearchModelAnthropicClaudeSonnet4                InstanceReadResponseAISearchModel = "anthropic/claude-sonnet-4"
	InstanceReadResponseAISearchModelAnthropicClaudeOpus4                  InstanceReadResponseAISearchModel = "anthropic/claude-opus-4"
	InstanceReadResponseAISearchModelAnthropicClaude3_5Haiku               InstanceReadResponseAISearchModel = "anthropic/claude-3-5-haiku"
	InstanceReadResponseAISearchModelCerebrasQwen3_235bA22bInstruct        InstanceReadResponseAISearchModel = "cerebras/qwen-3-235b-a22b-instruct"
	InstanceReadResponseAISearchModelCerebrasQwen3_235bA22bThinking        InstanceReadResponseAISearchModel = "cerebras/qwen-3-235b-a22b-thinking"
	InstanceReadResponseAISearchModelCerebrasLlama3_3_70b                  InstanceReadResponseAISearchModel = "cerebras/llama-3.3-70b"
	InstanceReadResponseAISearchModelCerebrasLlama4Maverick17b128eInstruct InstanceReadResponseAISearchModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	InstanceReadResponseAISearchModelCerebrasLlama4Scout17b16eInstruct     InstanceReadResponseAISearchModel = "cerebras/llama-4-scout-17b-16e-instruct"
	InstanceReadResponseAISearchModelCerebrasGptOSs120b                    InstanceReadResponseAISearchModel = "cerebras/gpt-oss-120b"
	InstanceReadResponseAISearchModelGoogleAIStudioGemini2_5Flash          InstanceReadResponseAISearchModel = "google-ai-studio/gemini-2.5-flash"
	InstanceReadResponseAISearchModelGoogleAIStudioGemini2_5Pro            InstanceReadResponseAISearchModel = "google-ai-studio/gemini-2.5-pro"
	InstanceReadResponseAISearchModelGrokGrok4                             InstanceReadResponseAISearchModel = "grok/grok-4"
	InstanceReadResponseAISearchModelGroqLlama3_3_70bVersatile             InstanceReadResponseAISearchModel = "groq/llama-3.3-70b-versatile"
	InstanceReadResponseAISearchModelGroqLlama3_1_8bInstant                InstanceReadResponseAISearchModel = "groq/llama-3.1-8b-instant"
	InstanceReadResponseAISearchModelOpenAIGpt5                            InstanceReadResponseAISearchModel = "openai/gpt-5"
	InstanceReadResponseAISearchModelOpenAIGpt5Mini                        InstanceReadResponseAISearchModel = "openai/gpt-5-mini"
	InstanceReadResponseAISearchModelOpenAIGpt5Nano                        InstanceReadResponseAISearchModel = "openai/gpt-5-nano"
	InstanceReadResponseAISearchModelEmpty                                 InstanceReadResponseAISearchModel = ""
)

func (InstanceReadResponseAISearchModel) IsKnown

type InstanceReadResponseCacheTTL

type InstanceReadResponseCacheTTL float64

Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d).

const (
	InstanceReadResponseCacheTTL600    InstanceReadResponseCacheTTL = 600
	InstanceReadResponseCacheTTL1800   InstanceReadResponseCacheTTL = 1800
	InstanceReadResponseCacheTTL3600   InstanceReadResponseCacheTTL = 3600
	InstanceReadResponseCacheTTL7200   InstanceReadResponseCacheTTL = 7200
	InstanceReadResponseCacheTTL21600  InstanceReadResponseCacheTTL = 21600
	InstanceReadResponseCacheTTL43200  InstanceReadResponseCacheTTL = 43200
	InstanceReadResponseCacheTTL86400  InstanceReadResponseCacheTTL = 86400
	InstanceReadResponseCacheTTL172800 InstanceReadResponseCacheTTL = 172800
	InstanceReadResponseCacheTTL259200 InstanceReadResponseCacheTTL = 259200
	InstanceReadResponseCacheTTL518400 InstanceReadResponseCacheTTL = 518400
)

func (InstanceReadResponseCacheTTL) IsKnown

func (r InstanceReadResponseCacheTTL) IsKnown() bool

type InstanceReadResponseCacheThreshold

type InstanceReadResponseCacheThreshold string
const (
	InstanceReadResponseCacheThresholdSuperStrictMatch InstanceReadResponseCacheThreshold = "super_strict_match"
	InstanceReadResponseCacheThresholdCloseEnough      InstanceReadResponseCacheThreshold = "close_enough"
	InstanceReadResponseCacheThresholdFlexibleFriend   InstanceReadResponseCacheThreshold = "flexible_friend"
	InstanceReadResponseCacheThresholdAnythingGoes     InstanceReadResponseCacheThreshold = "anything_goes"
)

func (InstanceReadResponseCacheThreshold) IsKnown

type InstanceReadResponseCustomMetadata

type InstanceReadResponseCustomMetadata struct {
	DataType  InstanceReadResponseCustomMetadataDataType `json:"data_type" api:"required"`
	FieldName string                                     `json:"field_name" api:"required"`
	JSON      instanceReadResponseCustomMetadataJSON     `json:"-"`
}

func (*InstanceReadResponseCustomMetadata) UnmarshalJSON

func (r *InstanceReadResponseCustomMetadata) UnmarshalJSON(data []byte) (err error)

type InstanceReadResponseCustomMetadataDataType

type InstanceReadResponseCustomMetadataDataType string
const (
	InstanceReadResponseCustomMetadataDataTypeText     InstanceReadResponseCustomMetadataDataType = "text"
	InstanceReadResponseCustomMetadataDataTypeNumber   InstanceReadResponseCustomMetadataDataType = "number"
	InstanceReadResponseCustomMetadataDataTypeBoolean  InstanceReadResponseCustomMetadataDataType = "boolean"
	InstanceReadResponseCustomMetadataDataTypeDatetime InstanceReadResponseCustomMetadataDataType = "datetime"
)

func (InstanceReadResponseCustomMetadataDataType) IsKnown

type InstanceReadResponseEmbeddingModel

type InstanceReadResponseEmbeddingModel string
const (
	InstanceReadResponseEmbeddingModelCfQwenQwen3Embedding0_6b              InstanceReadResponseEmbeddingModel = "@cf/qwen/qwen3-embedding-0.6b"
	InstanceReadResponseEmbeddingModelCfBaaiBgeM3                           InstanceReadResponseEmbeddingModel = "@cf/baai/bge-m3"
	InstanceReadResponseEmbeddingModelCfBaaiBgeLargeEnV1_5                  InstanceReadResponseEmbeddingModel = "@cf/baai/bge-large-en-v1.5"
	InstanceReadResponseEmbeddingModelCfGoogleEmbeddinggemma300m            InstanceReadResponseEmbeddingModel = "@cf/google/embeddinggemma-300m"
	InstanceReadResponseEmbeddingModelGoogleAIStudioGeminiEmbedding001      InstanceReadResponseEmbeddingModel = "google-ai-studio/gemini-embedding-001"
	InstanceReadResponseEmbeddingModelGoogleAIStudioGeminiEmbedding2Preview InstanceReadResponseEmbeddingModel = "google-ai-studio/gemini-embedding-2-preview"
	InstanceReadResponseEmbeddingModelOpenAITextEmbedding3Small             InstanceReadResponseEmbeddingModel = "openai/text-embedding-3-small"
	InstanceReadResponseEmbeddingModelOpenAITextEmbedding3Large             InstanceReadResponseEmbeddingModel = "openai/text-embedding-3-large"
	InstanceReadResponseEmbeddingModelEmpty                                 InstanceReadResponseEmbeddingModel = ""
)

func (InstanceReadResponseEmbeddingModel) IsKnown

type InstanceReadResponseEnvelope

type InstanceReadResponseEnvelope struct {
	Result  InstanceReadResponse             `json:"result" api:"required"`
	Success bool                             `json:"success" api:"required"`
	JSON    instanceReadResponseEnvelopeJSON `json:"-"`
}

func (*InstanceReadResponseEnvelope) UnmarshalJSON

func (r *InstanceReadResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InstanceReadResponseFusionMethod

type InstanceReadResponseFusionMethod string
const (
	InstanceReadResponseFusionMethodMax InstanceReadResponseFusionMethod = "max"
	InstanceReadResponseFusionMethodRrf InstanceReadResponseFusionMethod = "rrf"
)

func (InstanceReadResponseFusionMethod) IsKnown

type InstanceReadResponseIndexMethod

type InstanceReadResponseIndexMethod struct {
	// Enable keyword (BM25) storage backend.
	Keyword bool `json:"keyword" api:"required"`
	// Enable vector (embedding) storage backend.
	Vector bool                                `json:"vector" api:"required"`
	JSON   instanceReadResponseIndexMethodJSON `json:"-"`
}

Controls which storage backends are used during indexing. Defaults to vector-only.

func (*InstanceReadResponseIndexMethod) UnmarshalJSON

func (r *InstanceReadResponseIndexMethod) UnmarshalJSON(data []byte) (err error)

type InstanceReadResponseIndexingOptions

type InstanceReadResponseIndexingOptions struct {
	// Tokenizer used for keyword search indexing. porter provides word-level
	// tokenization with Porter stemming (good for natural language queries). trigram
	// enables character-level substring matching (good for partial matches, code,
	// identifiers). Changing this triggers a full re-index. Defaults to porter.
	KeywordTokenizer InstanceReadResponseIndexingOptionsKeywordTokenizer `json:"keyword_tokenizer"`
	JSON             instanceReadResponseIndexingOptionsJSON             `json:"-"`
}

func (*InstanceReadResponseIndexingOptions) UnmarshalJSON

func (r *InstanceReadResponseIndexingOptions) UnmarshalJSON(data []byte) (err error)

type InstanceReadResponseIndexingOptionsKeywordTokenizer

type InstanceReadResponseIndexingOptionsKeywordTokenizer string

Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter.

const (
	InstanceReadResponseIndexingOptionsKeywordTokenizerPorter  InstanceReadResponseIndexingOptionsKeywordTokenizer = "porter"
	InstanceReadResponseIndexingOptionsKeywordTokenizerTrigram InstanceReadResponseIndexingOptionsKeywordTokenizer = "trigram"
)

func (InstanceReadResponseIndexingOptionsKeywordTokenizer) IsKnown

type InstanceReadResponseMetadata

type InstanceReadResponseMetadata struct {
	CreatedFromAISearchWizard bool                             `json:"created_from_aisearch_wizard"`
	WorkerDomain              string                           `json:"worker_domain"`
	JSON                      instanceReadResponseMetadataJSON `json:"-"`
}

func (*InstanceReadResponseMetadata) UnmarshalJSON

func (r *InstanceReadResponseMetadata) UnmarshalJSON(data []byte) (err error)

type InstanceReadResponsePublicEndpointParams

type InstanceReadResponsePublicEndpointParams struct {
	AuthorizedHosts         []string                                                        `json:"authorized_hosts"`
	ChatCompletionsEndpoint InstanceReadResponsePublicEndpointParamsChatCompletionsEndpoint `json:"chat_completions_endpoint"`
	Enabled                 bool                                                            `json:"enabled"`
	Mcp                     InstanceReadResponsePublicEndpointParamsMcp                     `json:"mcp"`
	RateLimit               InstanceReadResponsePublicEndpointParamsRateLimit               `json:"rate_limit"`
	SearchEndpoint          InstanceReadResponsePublicEndpointParamsSearchEndpoint          `json:"search_endpoint"`
	JSON                    instanceReadResponsePublicEndpointParamsJSON                    `json:"-"`
}

func (*InstanceReadResponsePublicEndpointParams) UnmarshalJSON

func (r *InstanceReadResponsePublicEndpointParams) UnmarshalJSON(data []byte) (err error)

type InstanceReadResponsePublicEndpointParamsChatCompletionsEndpoint

type InstanceReadResponsePublicEndpointParamsChatCompletionsEndpoint struct {
	// Disable chat completions endpoint for this public endpoint
	Disabled bool                                                                `json:"disabled"`
	JSON     instanceReadResponsePublicEndpointParamsChatCompletionsEndpointJSON `json:"-"`
}

func (*InstanceReadResponsePublicEndpointParamsChatCompletionsEndpoint) UnmarshalJSON

type InstanceReadResponsePublicEndpointParamsMcp

type InstanceReadResponsePublicEndpointParamsMcp struct {
	Description string `json:"description"`
	// Disable MCP endpoint for this public endpoint
	Disabled bool                                            `json:"disabled"`
	JSON     instanceReadResponsePublicEndpointParamsMcpJSON `json:"-"`
}

func (*InstanceReadResponsePublicEndpointParamsMcp) UnmarshalJSON

func (r *InstanceReadResponsePublicEndpointParamsMcp) UnmarshalJSON(data []byte) (err error)

type InstanceReadResponsePublicEndpointParamsRateLimit

type InstanceReadResponsePublicEndpointParamsRateLimit struct {
	PeriodMs  int64                                                      `json:"period_ms"`
	Requests  int64                                                      `json:"requests"`
	Technique InstanceReadResponsePublicEndpointParamsRateLimitTechnique `json:"technique"`
	JSON      instanceReadResponsePublicEndpointParamsRateLimitJSON      `json:"-"`
}

func (*InstanceReadResponsePublicEndpointParamsRateLimit) UnmarshalJSON

func (r *InstanceReadResponsePublicEndpointParamsRateLimit) UnmarshalJSON(data []byte) (err error)

type InstanceReadResponsePublicEndpointParamsRateLimitTechnique

type InstanceReadResponsePublicEndpointParamsRateLimitTechnique string
const (
	InstanceReadResponsePublicEndpointParamsRateLimitTechniqueFixed   InstanceReadResponsePublicEndpointParamsRateLimitTechnique = "fixed"
	InstanceReadResponsePublicEndpointParamsRateLimitTechniqueSliding InstanceReadResponsePublicEndpointParamsRateLimitTechnique = "sliding"
)

func (InstanceReadResponsePublicEndpointParamsRateLimitTechnique) IsKnown

type InstanceReadResponsePublicEndpointParamsSearchEndpoint

type InstanceReadResponsePublicEndpointParamsSearchEndpoint struct {
	// Disable search endpoint for this public endpoint
	Disabled bool                                                       `json:"disabled"`
	JSON     instanceReadResponsePublicEndpointParamsSearchEndpointJSON `json:"-"`
}

func (*InstanceReadResponsePublicEndpointParamsSearchEndpoint) UnmarshalJSON

func (r *InstanceReadResponsePublicEndpointParamsSearchEndpoint) UnmarshalJSON(data []byte) (err error)

type InstanceReadResponseRerankingModel

type InstanceReadResponseRerankingModel string
const (
	InstanceReadResponseRerankingModelCfBaaiBgeRerankerBase InstanceReadResponseRerankingModel = "@cf/baai/bge-reranker-base"
	InstanceReadResponseRerankingModelEmpty                 InstanceReadResponseRerankingModel = ""
)

func (InstanceReadResponseRerankingModel) IsKnown

type InstanceReadResponseRetrievalOptions

type InstanceReadResponseRetrievalOptions struct {
	// Metadata fields to boost search results by. Each entry specifies a metadata
	// field and an optional direction. Direction defaults to 'asc' for
	// numeric/datetime fields and 'exists' for text/boolean fields. Fields must match
	// 'timestamp' or a defined custom_metadata field.
	BoostBy []InstanceReadResponseRetrievalOptionsBoostBy `json:"boost_by"`
	// 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'.
	KeywordMatchMode InstanceReadResponseRetrievalOptionsKeywordMatchMode `json:"keyword_match_mode"`
	JSON             instanceReadResponseRetrievalOptionsJSON             `json:"-"`
}

func (*InstanceReadResponseRetrievalOptions) UnmarshalJSON

func (r *InstanceReadResponseRetrievalOptions) UnmarshalJSON(data []byte) (err error)

type InstanceReadResponseRetrievalOptionsBoostBy

type InstanceReadResponseRetrievalOptionsBoostBy struct {
	// 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.
	Field string `json:"field" api:"required"`
	// 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.
	Direction InstanceReadResponseRetrievalOptionsBoostByDirection `json:"direction"`
	JSON      instanceReadResponseRetrievalOptionsBoostByJSON      `json:"-"`
}

func (*InstanceReadResponseRetrievalOptionsBoostBy) UnmarshalJSON

func (r *InstanceReadResponseRetrievalOptionsBoostBy) UnmarshalJSON(data []byte) (err error)

type InstanceReadResponseRetrievalOptionsBoostByDirection

type InstanceReadResponseRetrievalOptionsBoostByDirection string

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.

const (
	InstanceReadResponseRetrievalOptionsBoostByDirectionAsc       InstanceReadResponseRetrievalOptionsBoostByDirection = "asc"
	InstanceReadResponseRetrievalOptionsBoostByDirectionDesc      InstanceReadResponseRetrievalOptionsBoostByDirection = "desc"
	InstanceReadResponseRetrievalOptionsBoostByDirectionExists    InstanceReadResponseRetrievalOptionsBoostByDirection = "exists"
	InstanceReadResponseRetrievalOptionsBoostByDirectionNotExists InstanceReadResponseRetrievalOptionsBoostByDirection = "not_exists"
)

func (InstanceReadResponseRetrievalOptionsBoostByDirection) IsKnown

type InstanceReadResponseRetrievalOptionsKeywordMatchMode

type InstanceReadResponseRetrievalOptionsKeywordMatchMode string

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'.

const (
	InstanceReadResponseRetrievalOptionsKeywordMatchModeAnd InstanceReadResponseRetrievalOptionsKeywordMatchMode = "and"
	InstanceReadResponseRetrievalOptionsKeywordMatchModeOr  InstanceReadResponseRetrievalOptionsKeywordMatchMode = "or"
)

func (InstanceReadResponseRetrievalOptionsKeywordMatchMode) IsKnown

type InstanceReadResponseRewriteModel

type InstanceReadResponseRewriteModel string
const (
	InstanceReadResponseRewriteModelCfMetaLlama3_3_70bInstructFp8Fast     InstanceReadResponseRewriteModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	InstanceReadResponseRewriteModelCfZaiOrgGlm4_7Flash                   InstanceReadResponseRewriteModel = "@cf/zai-org/glm-4.7-flash"
	InstanceReadResponseRewriteModelCfMetaLlama3_1_8bInstructFast         InstanceReadResponseRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	InstanceReadResponseRewriteModelCfMetaLlama3_1_8bInstructFp8          InstanceReadResponseRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	InstanceReadResponseRewriteModelCfMetaLlama4Scout17b16eInstruct       InstanceReadResponseRewriteModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	InstanceReadResponseRewriteModelCfQwenQwen3_30bA3bFp8                 InstanceReadResponseRewriteModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	InstanceReadResponseRewriteModelCfDeepseekAIDeepseekR1DistillQwen32b  InstanceReadResponseRewriteModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	InstanceReadResponseRewriteModelCfMoonshotaiKimiK2Instruct            InstanceReadResponseRewriteModel = "@cf/moonshotai/kimi-k2-instruct"
	InstanceReadResponseRewriteModelCfGoogleGemma3_12bIt                  InstanceReadResponseRewriteModel = "@cf/google/gemma-3-12b-it"
	InstanceReadResponseRewriteModelCfGoogleGemma4_26bA4bIt               InstanceReadResponseRewriteModel = "@cf/google/gemma-4-26b-a4b-it"
	InstanceReadResponseRewriteModelCfMoonshotaiKimiK2_5                  InstanceReadResponseRewriteModel = "@cf/moonshotai/kimi-k2.5"
	InstanceReadResponseRewriteModelAnthropicClaude3_7Sonnet              InstanceReadResponseRewriteModel = "anthropic/claude-3-7-sonnet"
	InstanceReadResponseRewriteModelAnthropicClaudeSonnet4                InstanceReadResponseRewriteModel = "anthropic/claude-sonnet-4"
	InstanceReadResponseRewriteModelAnthropicClaudeOpus4                  InstanceReadResponseRewriteModel = "anthropic/claude-opus-4"
	InstanceReadResponseRewriteModelAnthropicClaude3_5Haiku               InstanceReadResponseRewriteModel = "anthropic/claude-3-5-haiku"
	InstanceReadResponseRewriteModelCerebrasQwen3_235bA22bInstruct        InstanceReadResponseRewriteModel = "cerebras/qwen-3-235b-a22b-instruct"
	InstanceReadResponseRewriteModelCerebrasQwen3_235bA22bThinking        InstanceReadResponseRewriteModel = "cerebras/qwen-3-235b-a22b-thinking"
	InstanceReadResponseRewriteModelCerebrasLlama3_3_70b                  InstanceReadResponseRewriteModel = "cerebras/llama-3.3-70b"
	InstanceReadResponseRewriteModelCerebrasLlama4Maverick17b128eInstruct InstanceReadResponseRewriteModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	InstanceReadResponseRewriteModelCerebrasLlama4Scout17b16eInstruct     InstanceReadResponseRewriteModel = "cerebras/llama-4-scout-17b-16e-instruct"
	InstanceReadResponseRewriteModelCerebrasGptOSs120b                    InstanceReadResponseRewriteModel = "cerebras/gpt-oss-120b"
	InstanceReadResponseRewriteModelGoogleAIStudioGemini2_5Flash          InstanceReadResponseRewriteModel = "google-ai-studio/gemini-2.5-flash"
	InstanceReadResponseRewriteModelGoogleAIStudioGemini2_5Pro            InstanceReadResponseRewriteModel = "google-ai-studio/gemini-2.5-pro"
	InstanceReadResponseRewriteModelGrokGrok4                             InstanceReadResponseRewriteModel = "grok/grok-4"
	InstanceReadResponseRewriteModelGroqLlama3_3_70bVersatile             InstanceReadResponseRewriteModel = "groq/llama-3.3-70b-versatile"
	InstanceReadResponseRewriteModelGroqLlama3_1_8bInstant                InstanceReadResponseRewriteModel = "groq/llama-3.1-8b-instant"
	InstanceReadResponseRewriteModelOpenAIGpt5                            InstanceReadResponseRewriteModel = "openai/gpt-5"
	InstanceReadResponseRewriteModelOpenAIGpt5Mini                        InstanceReadResponseRewriteModel = "openai/gpt-5-mini"
	InstanceReadResponseRewriteModelOpenAIGpt5Nano                        InstanceReadResponseRewriteModel = "openai/gpt-5-nano"
	InstanceReadResponseRewriteModelEmpty                                 InstanceReadResponseRewriteModel = ""
)

func (InstanceReadResponseRewriteModel) IsKnown

type InstanceReadResponseSourceParams

type InstanceReadResponseSourceParams struct {
	// List of path patterns to exclude. Uses micromatch glob syntax: \* matches within
	// a path segment, ** matches across path segments (e.g., /admin/** matches
	// /admin/users and /admin/settings/advanced)
	ExcludeItems []string `json:"exclude_items"`
	// List of path patterns to include. Uses micromatch glob syntax: \* matches within
	// a path segment, ** matches across path segments (e.g., /blog/** matches
	// /blog/post and /blog/2024/post)
	IncludeItems   []string                                   `json:"include_items"`
	Prefix         string                                     `json:"prefix"`
	R2Jurisdiction string                                     `json:"r2_jurisdiction"`
	WebCrawler     InstanceReadResponseSourceParamsWebCrawler `json:"web_crawler"`
	JSON           instanceReadResponseSourceParamsJSON       `json:"-"`
}

func (*InstanceReadResponseSourceParams) UnmarshalJSON

func (r *InstanceReadResponseSourceParams) UnmarshalJSON(data []byte) (err error)

type InstanceReadResponseSourceParamsWebCrawler

type InstanceReadResponseSourceParamsWebCrawler struct {
	CrawlOptions InstanceReadResponseSourceParamsWebCrawlerCrawlOptions `json:"crawl_options"`
	ParseOptions InstanceReadResponseSourceParamsWebCrawlerParseOptions `json:"parse_options"`
	ParseType    InstanceReadResponseSourceParamsWebCrawlerParseType    `json:"parse_type"`
	StoreOptions InstanceReadResponseSourceParamsWebCrawlerStoreOptions `json:"store_options"`
	JSON         instanceReadResponseSourceParamsWebCrawlerJSON         `json:"-"`
}

func (*InstanceReadResponseSourceParamsWebCrawler) UnmarshalJSON

func (r *InstanceReadResponseSourceParamsWebCrawler) UnmarshalJSON(data []byte) (err error)

type InstanceReadResponseSourceParamsWebCrawlerCrawlOptions

type InstanceReadResponseSourceParamsWebCrawlerCrawlOptions struct {
	Depth                float64                                                      `json:"depth"`
	IncludeExternalLinks bool                                                         `json:"include_external_links"`
	IncludeSubdomains    bool                                                         `json:"include_subdomains"`
	MaxAge               float64                                                      `json:"max_age"`
	Source               InstanceReadResponseSourceParamsWebCrawlerCrawlOptionsSource `json:"source"`
	JSON                 instanceReadResponseSourceParamsWebCrawlerCrawlOptionsJSON   `json:"-"`
}

func (*InstanceReadResponseSourceParamsWebCrawlerCrawlOptions) UnmarshalJSON

func (r *InstanceReadResponseSourceParamsWebCrawlerCrawlOptions) UnmarshalJSON(data []byte) (err error)

type InstanceReadResponseSourceParamsWebCrawlerCrawlOptionsSource

type InstanceReadResponseSourceParamsWebCrawlerCrawlOptionsSource string
const (
	InstanceReadResponseSourceParamsWebCrawlerCrawlOptionsSourceAll      InstanceReadResponseSourceParamsWebCrawlerCrawlOptionsSource = "all"
	InstanceReadResponseSourceParamsWebCrawlerCrawlOptionsSourceSitemaps InstanceReadResponseSourceParamsWebCrawlerCrawlOptionsSource = "sitemaps"
	InstanceReadResponseSourceParamsWebCrawlerCrawlOptionsSourceLinks    InstanceReadResponseSourceParamsWebCrawlerCrawlOptionsSource = "links"
)

func (InstanceReadResponseSourceParamsWebCrawlerCrawlOptionsSource) IsKnown

type InstanceReadResponseSourceParamsWebCrawlerParseOptions

type InstanceReadResponseSourceParamsWebCrawlerParseOptions struct {
	// List of path-to-selector mappings for extracting specific content from crawled
	// pages. Each entry pairs a URL glob pattern with a CSS selector. The first
	// matching path wins. Only the matched HTML fragment is stored and indexed. Omit
	// the field to disable content selection — empty arrays are rejected.
	ContentSelector []InstanceReadResponseSourceParamsWebCrawlerParseOptionsContentSelector `json:"content_selector"`
	// Up to 5 custom HTTP headers sent with each crawl request. Names must be RFC-7230
	// token characters (no spaces, colons, or control characters); values must be
	// HTAB + printable ASCII (no CR/LF).
	IncludeHeaders map[string]string `json:"include_headers"`
	IncludeImages  bool              `json:"include_images"`
	// List of specific sitemap URLs to use for crawling. Only valid when parse_type is
	// 'sitemap'.
	SpecificSitemaps    []string                                                   `json:"specific_sitemaps" format:"uri"`
	UseBrowserRendering bool                                                       `json:"use_browser_rendering"`
	JSON                instanceReadResponseSourceParamsWebCrawlerParseOptionsJSON `json:"-"`
}

func (*InstanceReadResponseSourceParamsWebCrawlerParseOptions) UnmarshalJSON

func (r *InstanceReadResponseSourceParamsWebCrawlerParseOptions) UnmarshalJSON(data []byte) (err error)

type InstanceReadResponseSourceParamsWebCrawlerParseOptionsContentSelector

type InstanceReadResponseSourceParamsWebCrawlerParseOptionsContentSelector struct {
	// Glob pattern to match against the page URL path. Uses standard glob syntax: \*
	// matches within a segment, \*\* crosses directories.
	Path string `json:"path" api:"required"`
	// CSS selector to extract content from pages matching the path pattern. Must not
	// contain disallowed characters (;, `, $, {, }, \). Must target a single element;
	// if multiple elements match, the selector is ignored and the full page is used.
	Selector string                                                                    `json:"selector" api:"required"`
	JSON     instanceReadResponseSourceParamsWebCrawlerParseOptionsContentSelectorJSON `json:"-"`
}

func (*InstanceReadResponseSourceParamsWebCrawlerParseOptionsContentSelector) UnmarshalJSON

type InstanceReadResponseSourceParamsWebCrawlerParseType

type InstanceReadResponseSourceParamsWebCrawlerParseType string
const (
	InstanceReadResponseSourceParamsWebCrawlerParseTypeSitemap InstanceReadResponseSourceParamsWebCrawlerParseType = "sitemap"
	InstanceReadResponseSourceParamsWebCrawlerParseTypeFeedRss InstanceReadResponseSourceParamsWebCrawlerParseType = "feed-rss"
	InstanceReadResponseSourceParamsWebCrawlerParseTypeCrawl   InstanceReadResponseSourceParamsWebCrawlerParseType = "crawl"
)

func (InstanceReadResponseSourceParamsWebCrawlerParseType) IsKnown

type InstanceReadResponseSourceParamsWebCrawlerStoreOptions

type InstanceReadResponseSourceParamsWebCrawlerStoreOptions struct {
	StorageID      string                                                     `json:"storage_id" api:"required"`
	R2Jurisdiction string                                                     `json:"r2_jurisdiction"`
	StorageType    r2.Provider                                                `json:"storage_type"`
	JSON           instanceReadResponseSourceParamsWebCrawlerStoreOptionsJSON `json:"-"`
}

func (*InstanceReadResponseSourceParamsWebCrawlerStoreOptions) UnmarshalJSON

func (r *InstanceReadResponseSourceParamsWebCrawlerStoreOptions) UnmarshalJSON(data []byte) (err error)

type InstanceReadResponseSyncInterval

type InstanceReadResponseSyncInterval float64

Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).

const (
	InstanceReadResponseSyncInterval900   InstanceReadResponseSyncInterval = 900
	InstanceReadResponseSyncInterval1800  InstanceReadResponseSyncInterval = 1800
	InstanceReadResponseSyncInterval3600  InstanceReadResponseSyncInterval = 3600
	InstanceReadResponseSyncInterval7200  InstanceReadResponseSyncInterval = 7200
	InstanceReadResponseSyncInterval14400 InstanceReadResponseSyncInterval = 14400
	InstanceReadResponseSyncInterval21600 InstanceReadResponseSyncInterval = 21600
	InstanceReadResponseSyncInterval43200 InstanceReadResponseSyncInterval = 43200
	InstanceReadResponseSyncInterval86400 InstanceReadResponseSyncInterval = 86400
)

func (InstanceReadResponseSyncInterval) IsKnown

type InstanceReadResponseType

type InstanceReadResponseType string
const (
	InstanceReadResponseTypeR2         InstanceReadResponseType = "r2"
	InstanceReadResponseTypeWebCrawler InstanceReadResponseType = "web-crawler"
)

func (InstanceReadResponseType) IsKnown

func (r InstanceReadResponseType) IsKnown() bool

type InstanceSearchParams

type InstanceSearchParams struct {
	AccountID       param.Field[string]                              `path:"account_id" api:"required"`
	AISearchOptions param.Field[InstanceSearchParamsAISearchOptions] `json:"ai_search_options"`
	Messages        param.Field[[]InstanceSearchParamsMessage]       `json:"messages"`
	// A simple text query string. Alternative to 'messages' — provide either this or
	// 'messages', not both.
	Query param.Field[string] `json:"query"`
}

func (InstanceSearchParams) MarshalJSON

func (r InstanceSearchParams) MarshalJSON() (data []byte, err error)

type InstanceSearchParamsAISearchOptions

type InstanceSearchParamsAISearchOptions struct {
	Cache        param.Field[InstanceSearchParamsAISearchOptionsCache]        `json:"cache"`
	QueryRewrite param.Field[InstanceSearchParamsAISearchOptionsQueryRewrite] `json:"query_rewrite"`
	Reranking    param.Field[InstanceSearchParamsAISearchOptionsReranking]    `json:"reranking"`
	Retrieval    param.Field[InstanceSearchParamsAISearchOptionsRetrieval]    `json:"retrieval"`
}

func (InstanceSearchParamsAISearchOptions) MarshalJSON

func (r InstanceSearchParamsAISearchOptions) MarshalJSON() (data []byte, err error)

type InstanceSearchParamsAISearchOptionsCache

type InstanceSearchParamsAISearchOptionsCache struct {
	CacheThreshold param.Field[InstanceSearchParamsAISearchOptionsCacheCacheThreshold] `json:"cache_threshold"`
	Enabled        param.Field[bool]                                                   `json:"enabled"`
}

func (InstanceSearchParamsAISearchOptionsCache) MarshalJSON

func (r InstanceSearchParamsAISearchOptionsCache) MarshalJSON() (data []byte, err error)

type InstanceSearchParamsAISearchOptionsCacheCacheThreshold

type InstanceSearchParamsAISearchOptionsCacheCacheThreshold string
const (
	InstanceSearchParamsAISearchOptionsCacheCacheThresholdSuperStrictMatch InstanceSearchParamsAISearchOptionsCacheCacheThreshold = "super_strict_match"
	InstanceSearchParamsAISearchOptionsCacheCacheThresholdCloseEnough      InstanceSearchParamsAISearchOptionsCacheCacheThreshold = "close_enough"
	InstanceSearchParamsAISearchOptionsCacheCacheThresholdFlexibleFriend   InstanceSearchParamsAISearchOptionsCacheCacheThreshold = "flexible_friend"
	InstanceSearchParamsAISearchOptionsCacheCacheThresholdAnythingGoes     InstanceSearchParamsAISearchOptionsCacheCacheThreshold = "anything_goes"
)

func (InstanceSearchParamsAISearchOptionsCacheCacheThreshold) IsKnown

type InstanceSearchParamsAISearchOptionsQueryRewrite

type InstanceSearchParamsAISearchOptionsQueryRewrite struct {
	Enabled       param.Field[bool]                                                 `json:"enabled"`
	Model         param.Field[InstanceSearchParamsAISearchOptionsQueryRewriteModel] `json:"model"`
	RewritePrompt param.Field[string]                                               `json:"rewrite_prompt"`
}

func (InstanceSearchParamsAISearchOptionsQueryRewrite) MarshalJSON

func (r InstanceSearchParamsAISearchOptionsQueryRewrite) MarshalJSON() (data []byte, err error)

type InstanceSearchParamsAISearchOptionsQueryRewriteModel

type InstanceSearchParamsAISearchOptionsQueryRewriteModel string
const (
	InstanceSearchParamsAISearchOptionsQueryRewriteModelCfMetaLlama3_3_70bInstructFp8Fast     InstanceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	InstanceSearchParamsAISearchOptionsQueryRewriteModelCfZaiOrgGlm4_7Flash                   InstanceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/zai-org/glm-4.7-flash"
	InstanceSearchParamsAISearchOptionsQueryRewriteModelCfMetaLlama3_1_8bInstructFast         InstanceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	InstanceSearchParamsAISearchOptionsQueryRewriteModelCfMetaLlama3_1_8bInstructFp8          InstanceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	InstanceSearchParamsAISearchOptionsQueryRewriteModelCfMetaLlama4Scout17b16eInstruct       InstanceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	InstanceSearchParamsAISearchOptionsQueryRewriteModelCfQwenQwen3_30bA3bFp8                 InstanceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	InstanceSearchParamsAISearchOptionsQueryRewriteModelCfDeepseekAIDeepseekR1DistillQwen32b  InstanceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	InstanceSearchParamsAISearchOptionsQueryRewriteModelCfMoonshotaiKimiK2Instruct            InstanceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/moonshotai/kimi-k2-instruct"
	InstanceSearchParamsAISearchOptionsQueryRewriteModelCfGoogleGemma3_12bIt                  InstanceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/google/gemma-3-12b-it"
	InstanceSearchParamsAISearchOptionsQueryRewriteModelCfGoogleGemma4_26bA4bIt               InstanceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/google/gemma-4-26b-a4b-it"
	InstanceSearchParamsAISearchOptionsQueryRewriteModelCfMoonshotaiKimiK2_5                  InstanceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/moonshotai/kimi-k2.5"
	InstanceSearchParamsAISearchOptionsQueryRewriteModelAnthropicClaude3_7Sonnet              InstanceSearchParamsAISearchOptionsQueryRewriteModel = "anthropic/claude-3-7-sonnet"
	InstanceSearchParamsAISearchOptionsQueryRewriteModelAnthropicClaudeSonnet4                InstanceSearchParamsAISearchOptionsQueryRewriteModel = "anthropic/claude-sonnet-4"
	InstanceSearchParamsAISearchOptionsQueryRewriteModelAnthropicClaudeOpus4                  InstanceSearchParamsAISearchOptionsQueryRewriteModel = "anthropic/claude-opus-4"
	InstanceSearchParamsAISearchOptionsQueryRewriteModelAnthropicClaude3_5Haiku               InstanceSearchParamsAISearchOptionsQueryRewriteModel = "anthropic/claude-3-5-haiku"
	InstanceSearchParamsAISearchOptionsQueryRewriteModelCerebrasQwen3_235bA22bInstruct        InstanceSearchParamsAISearchOptionsQueryRewriteModel = "cerebras/qwen-3-235b-a22b-instruct"
	InstanceSearchParamsAISearchOptionsQueryRewriteModelCerebrasQwen3_235bA22bThinking        InstanceSearchParamsAISearchOptionsQueryRewriteModel = "cerebras/qwen-3-235b-a22b-thinking"
	InstanceSearchParamsAISearchOptionsQueryRewriteModelCerebrasLlama3_3_70b                  InstanceSearchParamsAISearchOptionsQueryRewriteModel = "cerebras/llama-3.3-70b"
	InstanceSearchParamsAISearchOptionsQueryRewriteModelCerebrasLlama4Maverick17b128eInstruct InstanceSearchParamsAISearchOptionsQueryRewriteModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	InstanceSearchParamsAISearchOptionsQueryRewriteModelCerebrasLlama4Scout17b16eInstruct     InstanceSearchParamsAISearchOptionsQueryRewriteModel = "cerebras/llama-4-scout-17b-16e-instruct"
	InstanceSearchParamsAISearchOptionsQueryRewriteModelCerebrasGptOSs120b                    InstanceSearchParamsAISearchOptionsQueryRewriteModel = "cerebras/gpt-oss-120b"
	InstanceSearchParamsAISearchOptionsQueryRewriteModelGoogleAIStudioGemini2_5Flash          InstanceSearchParamsAISearchOptionsQueryRewriteModel = "google-ai-studio/gemini-2.5-flash"
	InstanceSearchParamsAISearchOptionsQueryRewriteModelGoogleAIStudioGemini2_5Pro            InstanceSearchParamsAISearchOptionsQueryRewriteModel = "google-ai-studio/gemini-2.5-pro"
	InstanceSearchParamsAISearchOptionsQueryRewriteModelGrokGrok4                             InstanceSearchParamsAISearchOptionsQueryRewriteModel = "grok/grok-4"
	InstanceSearchParamsAISearchOptionsQueryRewriteModelGroqLlama3_3_70bVersatile             InstanceSearchParamsAISearchOptionsQueryRewriteModel = "groq/llama-3.3-70b-versatile"
	InstanceSearchParamsAISearchOptionsQueryRewriteModelGroqLlama3_1_8bInstant                InstanceSearchParamsAISearchOptionsQueryRewriteModel = "groq/llama-3.1-8b-instant"
	InstanceSearchParamsAISearchOptionsQueryRewriteModelOpenAIGpt5                            InstanceSearchParamsAISearchOptionsQueryRewriteModel = "openai/gpt-5"
	InstanceSearchParamsAISearchOptionsQueryRewriteModelOpenAIGpt5Mini                        InstanceSearchParamsAISearchOptionsQueryRewriteModel = "openai/gpt-5-mini"
	InstanceSearchParamsAISearchOptionsQueryRewriteModelOpenAIGpt5Nano                        InstanceSearchParamsAISearchOptionsQueryRewriteModel = "openai/gpt-5-nano"
	InstanceSearchParamsAISearchOptionsQueryRewriteModelEmpty                                 InstanceSearchParamsAISearchOptionsQueryRewriteModel = ""
)

func (InstanceSearchParamsAISearchOptionsQueryRewriteModel) IsKnown

type InstanceSearchParamsAISearchOptionsReranking

type InstanceSearchParamsAISearchOptionsReranking struct {
	Enabled        param.Field[bool]                                              `json:"enabled"`
	MatchThreshold param.Field[float64]                                           `json:"match_threshold"`
	Model          param.Field[InstanceSearchParamsAISearchOptionsRerankingModel] `json:"model"`
}

func (InstanceSearchParamsAISearchOptionsReranking) MarshalJSON

func (r InstanceSearchParamsAISearchOptionsReranking) MarshalJSON() (data []byte, err error)

type InstanceSearchParamsAISearchOptionsRerankingModel

type InstanceSearchParamsAISearchOptionsRerankingModel string
const (
	InstanceSearchParamsAISearchOptionsRerankingModelCfBaaiBgeRerankerBase InstanceSearchParamsAISearchOptionsRerankingModel = "@cf/baai/bge-reranker-base"
	InstanceSearchParamsAISearchOptionsRerankingModelEmpty                 InstanceSearchParamsAISearchOptionsRerankingModel = ""
)

func (InstanceSearchParamsAISearchOptionsRerankingModel) IsKnown

type InstanceSearchParamsAISearchOptionsRetrieval

type InstanceSearchParamsAISearchOptionsRetrieval struct {
	// 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.
	BoostBy          param.Field[[]InstanceSearchParamsAISearchOptionsRetrievalBoostBy]    `json:"boost_by"`
	ContextExpansion param.Field[int64]                                                    `json:"context_expansion"`
	Filters          param.Field[map[string]interface{}]                                   `json:"filters"`
	FusionMethod     param.Field[InstanceSearchParamsAISearchOptionsRetrievalFusionMethod] `json:"fusion_method"`
	// 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'.
	KeywordMatchMode param.Field[InstanceSearchParamsAISearchOptionsRetrievalKeywordMatchMode] `json:"keyword_match_mode"`
	MatchThreshold   param.Field[float64]                                                      `json:"match_threshold"`
	MaxNumResults    param.Field[int64]                                                        `json:"max_num_results"`
	RetrievalType    param.Field[InstanceSearchParamsAISearchOptionsRetrievalRetrievalType]    `json:"retrieval_type"`
	ReturnOnFailure  param.Field[bool]                                                         `json:"return_on_failure"`
}

func (InstanceSearchParamsAISearchOptionsRetrieval) MarshalJSON

func (r InstanceSearchParamsAISearchOptionsRetrieval) MarshalJSON() (data []byte, err error)

type InstanceSearchParamsAISearchOptionsRetrievalBoostBy

type InstanceSearchParamsAISearchOptionsRetrievalBoostBy struct {
	// 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.
	Field param.Field[string] `json:"field" api:"required"`
	// 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.
	Direction param.Field[InstanceSearchParamsAISearchOptionsRetrievalBoostByDirection] `json:"direction"`
}

func (InstanceSearchParamsAISearchOptionsRetrievalBoostBy) MarshalJSON

func (r InstanceSearchParamsAISearchOptionsRetrievalBoostBy) MarshalJSON() (data []byte, err error)

type InstanceSearchParamsAISearchOptionsRetrievalBoostByDirection

type InstanceSearchParamsAISearchOptionsRetrievalBoostByDirection string

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.

const (
	InstanceSearchParamsAISearchOptionsRetrievalBoostByDirectionAsc       InstanceSearchParamsAISearchOptionsRetrievalBoostByDirection = "asc"
	InstanceSearchParamsAISearchOptionsRetrievalBoostByDirectionDesc      InstanceSearchParamsAISearchOptionsRetrievalBoostByDirection = "desc"
	InstanceSearchParamsAISearchOptionsRetrievalBoostByDirectionExists    InstanceSearchParamsAISearchOptionsRetrievalBoostByDirection = "exists"
	InstanceSearchParamsAISearchOptionsRetrievalBoostByDirectionNotExists InstanceSearchParamsAISearchOptionsRetrievalBoostByDirection = "not_exists"
)

func (InstanceSearchParamsAISearchOptionsRetrievalBoostByDirection) IsKnown

type InstanceSearchParamsAISearchOptionsRetrievalFusionMethod

type InstanceSearchParamsAISearchOptionsRetrievalFusionMethod string
const (
	InstanceSearchParamsAISearchOptionsRetrievalFusionMethodMax InstanceSearchParamsAISearchOptionsRetrievalFusionMethod = "max"
	InstanceSearchParamsAISearchOptionsRetrievalFusionMethodRrf InstanceSearchParamsAISearchOptionsRetrievalFusionMethod = "rrf"
)

func (InstanceSearchParamsAISearchOptionsRetrievalFusionMethod) IsKnown

type InstanceSearchParamsAISearchOptionsRetrievalKeywordMatchMode

type InstanceSearchParamsAISearchOptionsRetrievalKeywordMatchMode string

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'.

const (
	InstanceSearchParamsAISearchOptionsRetrievalKeywordMatchModeAnd InstanceSearchParamsAISearchOptionsRetrievalKeywordMatchMode = "and"
	InstanceSearchParamsAISearchOptionsRetrievalKeywordMatchModeOr  InstanceSearchParamsAISearchOptionsRetrievalKeywordMatchMode = "or"
)

func (InstanceSearchParamsAISearchOptionsRetrievalKeywordMatchMode) IsKnown

type InstanceSearchParamsAISearchOptionsRetrievalRetrievalType

type InstanceSearchParamsAISearchOptionsRetrievalRetrievalType string
const (
	InstanceSearchParamsAISearchOptionsRetrievalRetrievalTypeVector  InstanceSearchParamsAISearchOptionsRetrievalRetrievalType = "vector"
	InstanceSearchParamsAISearchOptionsRetrievalRetrievalTypeKeyword InstanceSearchParamsAISearchOptionsRetrievalRetrievalType = "keyword"
	InstanceSearchParamsAISearchOptionsRetrievalRetrievalTypeHybrid  InstanceSearchParamsAISearchOptionsRetrievalRetrievalType = "hybrid"
)

func (InstanceSearchParamsAISearchOptionsRetrievalRetrievalType) IsKnown

type InstanceSearchParamsMessage

type InstanceSearchParamsMessage struct {
	Content     param.Field[string]                           `json:"content" api:"required"`
	Role        param.Field[InstanceSearchParamsMessagesRole] `json:"role" api:"required"`
	ExtraFields map[string]interface{}                        `json:"-,extras"`
}

func (InstanceSearchParamsMessage) MarshalJSON

func (r InstanceSearchParamsMessage) MarshalJSON() (data []byte, err error)

type InstanceSearchParamsMessagesRole

type InstanceSearchParamsMessagesRole string
const (
	InstanceSearchParamsMessagesRoleSystem    InstanceSearchParamsMessagesRole = "system"
	InstanceSearchParamsMessagesRoleDeveloper InstanceSearchParamsMessagesRole = "developer"
	InstanceSearchParamsMessagesRoleUser      InstanceSearchParamsMessagesRole = "user"
	InstanceSearchParamsMessagesRoleAssistant InstanceSearchParamsMessagesRole = "assistant"
	InstanceSearchParamsMessagesRoleTool      InstanceSearchParamsMessagesRole = "tool"
)

func (InstanceSearchParamsMessagesRole) IsKnown

type InstanceSearchResponse

type InstanceSearchResponse struct {
	Chunks      []InstanceSearchResponseChunk `json:"chunks" api:"required"`
	SearchQuery string                        `json:"search_query" api:"required"`
	JSON        instanceSearchResponseJSON    `json:"-"`
}

func (*InstanceSearchResponse) UnmarshalJSON

func (r *InstanceSearchResponse) UnmarshalJSON(data []byte) (err error)

type InstanceSearchResponseChunk

type InstanceSearchResponseChunk struct {
	ID             string                                     `json:"id" api:"required"`
	Score          float64                                    `json:"score" api:"required"`
	Text           string                                     `json:"text" api:"required"`
	Type           string                                     `json:"type" api:"required"`
	Item           InstanceSearchResponseChunksItem           `json:"item"`
	ScoringDetails InstanceSearchResponseChunksScoringDetails `json:"scoring_details"`
	JSON           instanceSearchResponseChunkJSON            `json:"-"`
}

func (*InstanceSearchResponseChunk) UnmarshalJSON

func (r *InstanceSearchResponseChunk) UnmarshalJSON(data []byte) (err error)

type InstanceSearchResponseChunksItem

type InstanceSearchResponseChunksItem struct {
	Key       string                               `json:"key" api:"required"`
	Metadata  map[string]interface{}               `json:"metadata"`
	Timestamp float64                              `json:"timestamp"`
	JSON      instanceSearchResponseChunksItemJSON `json:"-"`
}

func (*InstanceSearchResponseChunksItem) UnmarshalJSON

func (r *InstanceSearchResponseChunksItem) UnmarshalJSON(data []byte) (err error)

type InstanceSearchResponseChunksScoringDetails

type InstanceSearchResponseChunksScoringDetails struct {
	FusionMethod   InstanceSearchResponseChunksScoringDetailsFusionMethod `json:"fusion_method"`
	KeywordRank    float64                                                `json:"keyword_rank"`
	KeywordScore   float64                                                `json:"keyword_score"`
	RerankingScore float64                                                `json:"reranking_score"`
	VectorRank     float64                                                `json:"vector_rank"`
	VectorScore    float64                                                `json:"vector_score"`
	JSON           instanceSearchResponseChunksScoringDetailsJSON         `json:"-"`
}

func (*InstanceSearchResponseChunksScoringDetails) UnmarshalJSON

func (r *InstanceSearchResponseChunksScoringDetails) UnmarshalJSON(data []byte) (err error)

type InstanceSearchResponseChunksScoringDetailsFusionMethod

type InstanceSearchResponseChunksScoringDetailsFusionMethod string
const (
	InstanceSearchResponseChunksScoringDetailsFusionMethodRrf InstanceSearchResponseChunksScoringDetailsFusionMethod = "rrf"
	InstanceSearchResponseChunksScoringDetailsFusionMethodMax InstanceSearchResponseChunksScoringDetailsFusionMethod = "max"
)

func (InstanceSearchResponseChunksScoringDetailsFusionMethod) IsKnown

type InstanceSearchResponseEnvelope

type InstanceSearchResponseEnvelope struct {
	Result  InstanceSearchResponse             `json:"result" api:"required"`
	Success bool                               `json:"success" api:"required"`
	JSON    instanceSearchResponseEnvelopeJSON `json:"-"`
}

func (*InstanceSearchResponseEnvelope) UnmarshalJSON

func (r *InstanceSearchResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InstanceService

type InstanceService struct {
	Options []option.RequestOption
	Jobs    *InstanceJobService
}

InstanceService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewInstanceService method instead.

func NewInstanceService

func NewInstanceService(opts ...option.RequestOption) (r *InstanceService)

NewInstanceService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*InstanceService) ChatCompletions

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

func (*InstanceService) Delete

Delete instance.

func (*InstanceService) List

List instances.

func (*InstanceService) ListAutoPaging

List instances.

func (*InstanceService) New

Create a new instance.

func (*InstanceService) Read

Read instance.

func (*InstanceService) Search

Executes a semantic search query against an AI Search instance to find relevant indexed content.

func (*InstanceService) Stats

Retrieves usage statistics for AI Search instances.

func (*InstanceService) Update

Update instance.

type InstanceStatsParams

type InstanceStatsParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type InstanceStatsResponse

type InstanceStatsResponse struct {
	Completed int64 `json:"completed"`
	// True when status counts are unavailable (e.g. legacy stats query exceeded D1
	// statement-size limit). Counts are omitted in this case.
	Degraded bool `json:"degraded"`
	// Engine-specific metadata. Present only for managed (v3) instances.
	Engine            InstanceStatsResponseEngine `json:"engine"`
	Error             int64                       `json:"error"`
	FileEmbedErrors   map[string]interface{}      `json:"file_embed_errors"`
	IndexSourceErrors map[string]interface{}      `json:"index_source_errors"`
	LastActivity      time.Time                   `json:"last_activity" format:"date-time"`
	Outdated          int64                       `json:"outdated"`
	Queued            int64                       `json:"queued"`
	Running           int64                       `json:"running"`
	Skipped           int64                       `json:"skipped"`
	JSON              instanceStatsResponseJSON   `json:"-"`
}

func (*InstanceStatsResponse) UnmarshalJSON

func (r *InstanceStatsResponse) UnmarshalJSON(data []byte) (err error)

type InstanceStatsResponseEngine

type InstanceStatsResponseEngine struct {
	// R2 bucket storage usage in bytes.
	R2 InstanceStatsResponseEngineR2 `json:"r2"`
	// Vectorize index metadata (dimensions, vector count).
	Vectorize InstanceStatsResponseEngineVectorize `json:"vectorize"`
	JSON      instanceStatsResponseEngineJSON      `json:"-"`
}

Engine-specific metadata. Present only for managed (v3) instances.

func (*InstanceStatsResponseEngine) UnmarshalJSON

func (r *InstanceStatsResponseEngine) UnmarshalJSON(data []byte) (err error)

type InstanceStatsResponseEngineR2

type InstanceStatsResponseEngineR2 struct {
	MetadataSizeBytes int64                             `json:"metadataSizeBytes" api:"required"`
	ObjectCount       int64                             `json:"objectCount" api:"required"`
	PayloadSizeBytes  int64                             `json:"payloadSizeBytes" api:"required"`
	JSON              instanceStatsResponseEngineR2JSON `json:"-"`
}

R2 bucket storage usage in bytes.

func (*InstanceStatsResponseEngineR2) UnmarshalJSON

func (r *InstanceStatsResponseEngineR2) UnmarshalJSON(data []byte) (err error)

type InstanceStatsResponseEngineVectorize

type InstanceStatsResponseEngineVectorize struct {
	Dimensions   int64                                    `json:"dimensions" api:"required"`
	VectorsCount int64                                    `json:"vectorsCount" api:"required"`
	JSON         instanceStatsResponseEngineVectorizeJSON `json:"-"`
}

Vectorize index metadata (dimensions, vector count).

func (*InstanceStatsResponseEngineVectorize) UnmarshalJSON

func (r *InstanceStatsResponseEngineVectorize) UnmarshalJSON(data []byte) (err error)

type InstanceStatsResponseEnvelope

type InstanceStatsResponseEnvelope struct {
	Result  InstanceStatsResponse             `json:"result" api:"required"`
	Success bool                              `json:"success" api:"required"`
	JSON    instanceStatsResponseEnvelopeJSON `json:"-"`
}

func (*InstanceStatsResponseEnvelope) UnmarshalJSON

func (r *InstanceStatsResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InstanceUpdateParams

type InstanceUpdateParams struct {
	AccountID      param.Field[string]                             `path:"account_id" api:"required"`
	AIGatewayID    param.Field[string]                             `json:"ai_gateway_id"`
	AISearchModel  param.Field[InstanceUpdateParamsAISearchModel]  `json:"ai_search_model"`
	Cache          param.Field[bool]                               `json:"cache"`
	CacheThreshold param.Field[InstanceUpdateParamsCacheThreshold] `json:"cache_threshold"`
	// Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600
	// (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200
	// (72h), 518400 (6d).
	CacheTTL       param.Field[InstanceUpdateParamsCacheTTL]         `json:"cache_ttl"`
	Chunk          param.Field[bool]                                 `json:"chunk"`
	ChunkOverlap   param.Field[int64]                                `json:"chunk_overlap"`
	ChunkSize      param.Field[int64]                                `json:"chunk_size"`
	CustomMetadata param.Field[[]InstanceUpdateParamsCustomMetadata] `json:"custom_metadata"`
	EmbeddingModel param.Field[InstanceUpdateParamsEmbeddingModel]   `json:"embedding_model"`
	FusionMethod   param.Field[InstanceUpdateParamsFusionMethod]     `json:"fusion_method"`
	// Controls which storage backends are used during indexing. Defaults to
	// vector-only.
	IndexMethod          param.Field[InstanceUpdateParamsIndexMethod]          `json:"index_method"`
	IndexingOptions      param.Field[InstanceUpdateParamsIndexingOptions]      `json:"indexing_options"`
	MaxNumResults        param.Field[int64]                                    `json:"max_num_results"`
	Metadata             param.Field[InstanceUpdateParamsMetadata]             `json:"metadata"`
	Paused               param.Field[bool]                                     `json:"paused"`
	PublicEndpointParams param.Field[InstanceUpdateParamsPublicEndpointParams] `json:"public_endpoint_params"`
	Reranking            param.Field[bool]                                     `json:"reranking"`
	RerankingModel       param.Field[InstanceUpdateParamsRerankingModel]       `json:"reranking_model"`
	RetrievalOptions     param.Field[InstanceUpdateParamsRetrievalOptions]     `json:"retrieval_options"`
	RewriteModel         param.Field[InstanceUpdateParamsRewriteModel]         `json:"rewrite_model"`
	RewriteQuery         param.Field[bool]                                     `json:"rewrite_query"`
	ScoreThreshold       param.Field[float64]                                  `json:"score_threshold"`
	SourceParams         param.Field[InstanceUpdateParamsSourceParams]         `json:"source_params"`
	Summarization        param.Field[bool]                                     `json:"summarization"`
	SummarizationModel   param.Field[InstanceUpdateParamsSummarizationModel]   `json:"summarization_model"`
	// Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800
	// (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).
	SyncInterval                   param.Field[InstanceUpdateParamsSyncInterval] `json:"sync_interval"`
	SystemPromptAISearch           param.Field[string]                           `json:"system_prompt_ai_search"`
	SystemPromptIndexSummarization param.Field[string]                           `json:"system_prompt_index_summarization"`
	SystemPromptRewriteQuery       param.Field[string]                           `json:"system_prompt_rewrite_query"`
	TokenID                        param.Field[string]                           `json:"token_id" format:"uuid"`
}

func (InstanceUpdateParams) MarshalJSON

func (r InstanceUpdateParams) MarshalJSON() (data []byte, err error)

type InstanceUpdateParamsAISearchModel

type InstanceUpdateParamsAISearchModel string
const (
	InstanceUpdateParamsAISearchModelCfMetaLlama3_3_70bInstructFp8Fast     InstanceUpdateParamsAISearchModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	InstanceUpdateParamsAISearchModelCfZaiOrgGlm4_7Flash                   InstanceUpdateParamsAISearchModel = "@cf/zai-org/glm-4.7-flash"
	InstanceUpdateParamsAISearchModelCfMetaLlama3_1_8bInstructFast         InstanceUpdateParamsAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	InstanceUpdateParamsAISearchModelCfMetaLlama3_1_8bInstructFp8          InstanceUpdateParamsAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	InstanceUpdateParamsAISearchModelCfMetaLlama4Scout17b16eInstruct       InstanceUpdateParamsAISearchModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	InstanceUpdateParamsAISearchModelCfQwenQwen3_30bA3bFp8                 InstanceUpdateParamsAISearchModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	InstanceUpdateParamsAISearchModelCfDeepseekAIDeepseekR1DistillQwen32b  InstanceUpdateParamsAISearchModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	InstanceUpdateParamsAISearchModelCfMoonshotaiKimiK2Instruct            InstanceUpdateParamsAISearchModel = "@cf/moonshotai/kimi-k2-instruct"
	InstanceUpdateParamsAISearchModelCfGoogleGemma3_12bIt                  InstanceUpdateParamsAISearchModel = "@cf/google/gemma-3-12b-it"
	InstanceUpdateParamsAISearchModelCfGoogleGemma4_26bA4bIt               InstanceUpdateParamsAISearchModel = "@cf/google/gemma-4-26b-a4b-it"
	InstanceUpdateParamsAISearchModelCfMoonshotaiKimiK2_5                  InstanceUpdateParamsAISearchModel = "@cf/moonshotai/kimi-k2.5"
	InstanceUpdateParamsAISearchModelAnthropicClaude3_7Sonnet              InstanceUpdateParamsAISearchModel = "anthropic/claude-3-7-sonnet"
	InstanceUpdateParamsAISearchModelAnthropicClaudeSonnet4                InstanceUpdateParamsAISearchModel = "anthropic/claude-sonnet-4"
	InstanceUpdateParamsAISearchModelAnthropicClaudeOpus4                  InstanceUpdateParamsAISearchModel = "anthropic/claude-opus-4"
	InstanceUpdateParamsAISearchModelAnthropicClaude3_5Haiku               InstanceUpdateParamsAISearchModel = "anthropic/claude-3-5-haiku"
	InstanceUpdateParamsAISearchModelCerebrasQwen3_235bA22bInstruct        InstanceUpdateParamsAISearchModel = "cerebras/qwen-3-235b-a22b-instruct"
	InstanceUpdateParamsAISearchModelCerebrasQwen3_235bA22bThinking        InstanceUpdateParamsAISearchModel = "cerebras/qwen-3-235b-a22b-thinking"
	InstanceUpdateParamsAISearchModelCerebrasLlama3_3_70b                  InstanceUpdateParamsAISearchModel = "cerebras/llama-3.3-70b"
	InstanceUpdateParamsAISearchModelCerebrasLlama4Maverick17b128eInstruct InstanceUpdateParamsAISearchModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	InstanceUpdateParamsAISearchModelCerebrasLlama4Scout17b16eInstruct     InstanceUpdateParamsAISearchModel = "cerebras/llama-4-scout-17b-16e-instruct"
	InstanceUpdateParamsAISearchModelCerebrasGptOSs120b                    InstanceUpdateParamsAISearchModel = "cerebras/gpt-oss-120b"
	InstanceUpdateParamsAISearchModelGoogleAIStudioGemini2_5Flash          InstanceUpdateParamsAISearchModel = "google-ai-studio/gemini-2.5-flash"
	InstanceUpdateParamsAISearchModelGoogleAIStudioGemini2_5Pro            InstanceUpdateParamsAISearchModel = "google-ai-studio/gemini-2.5-pro"
	InstanceUpdateParamsAISearchModelGrokGrok4                             InstanceUpdateParamsAISearchModel = "grok/grok-4"
	InstanceUpdateParamsAISearchModelGroqLlama3_3_70bVersatile             InstanceUpdateParamsAISearchModel = "groq/llama-3.3-70b-versatile"
	InstanceUpdateParamsAISearchModelGroqLlama3_1_8bInstant                InstanceUpdateParamsAISearchModel = "groq/llama-3.1-8b-instant"
	InstanceUpdateParamsAISearchModelOpenAIGpt5                            InstanceUpdateParamsAISearchModel = "openai/gpt-5"
	InstanceUpdateParamsAISearchModelOpenAIGpt5Mini                        InstanceUpdateParamsAISearchModel = "openai/gpt-5-mini"
	InstanceUpdateParamsAISearchModelOpenAIGpt5Nano                        InstanceUpdateParamsAISearchModel = "openai/gpt-5-nano"
	InstanceUpdateParamsAISearchModelEmpty                                 InstanceUpdateParamsAISearchModel = ""
)

func (InstanceUpdateParamsAISearchModel) IsKnown

type InstanceUpdateParamsCacheTTL

type InstanceUpdateParamsCacheTTL float64

Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d).

const (
	InstanceUpdateParamsCacheTTL600    InstanceUpdateParamsCacheTTL = 600
	InstanceUpdateParamsCacheTTL1800   InstanceUpdateParamsCacheTTL = 1800
	InstanceUpdateParamsCacheTTL3600   InstanceUpdateParamsCacheTTL = 3600
	InstanceUpdateParamsCacheTTL7200   InstanceUpdateParamsCacheTTL = 7200
	InstanceUpdateParamsCacheTTL21600  InstanceUpdateParamsCacheTTL = 21600
	InstanceUpdateParamsCacheTTL43200  InstanceUpdateParamsCacheTTL = 43200
	InstanceUpdateParamsCacheTTL86400  InstanceUpdateParamsCacheTTL = 86400
	InstanceUpdateParamsCacheTTL172800 InstanceUpdateParamsCacheTTL = 172800
	InstanceUpdateParamsCacheTTL259200 InstanceUpdateParamsCacheTTL = 259200
	InstanceUpdateParamsCacheTTL518400 InstanceUpdateParamsCacheTTL = 518400
)

func (InstanceUpdateParamsCacheTTL) IsKnown

func (r InstanceUpdateParamsCacheTTL) IsKnown() bool

type InstanceUpdateParamsCacheThreshold

type InstanceUpdateParamsCacheThreshold string
const (
	InstanceUpdateParamsCacheThresholdSuperStrictMatch InstanceUpdateParamsCacheThreshold = "super_strict_match"
	InstanceUpdateParamsCacheThresholdCloseEnough      InstanceUpdateParamsCacheThreshold = "close_enough"
	InstanceUpdateParamsCacheThresholdFlexibleFriend   InstanceUpdateParamsCacheThreshold = "flexible_friend"
	InstanceUpdateParamsCacheThresholdAnythingGoes     InstanceUpdateParamsCacheThreshold = "anything_goes"
)

func (InstanceUpdateParamsCacheThreshold) IsKnown

type InstanceUpdateParamsCustomMetadata

type InstanceUpdateParamsCustomMetadata struct {
	DataType  param.Field[InstanceUpdateParamsCustomMetadataDataType] `json:"data_type" api:"required"`
	FieldName param.Field[string]                                     `json:"field_name" api:"required"`
}

func (InstanceUpdateParamsCustomMetadata) MarshalJSON

func (r InstanceUpdateParamsCustomMetadata) MarshalJSON() (data []byte, err error)

type InstanceUpdateParamsCustomMetadataDataType

type InstanceUpdateParamsCustomMetadataDataType string
const (
	InstanceUpdateParamsCustomMetadataDataTypeText     InstanceUpdateParamsCustomMetadataDataType = "text"
	InstanceUpdateParamsCustomMetadataDataTypeNumber   InstanceUpdateParamsCustomMetadataDataType = "number"
	InstanceUpdateParamsCustomMetadataDataTypeBoolean  InstanceUpdateParamsCustomMetadataDataType = "boolean"
	InstanceUpdateParamsCustomMetadataDataTypeDatetime InstanceUpdateParamsCustomMetadataDataType = "datetime"
)

func (InstanceUpdateParamsCustomMetadataDataType) IsKnown

type InstanceUpdateParamsEmbeddingModel

type InstanceUpdateParamsEmbeddingModel string
const (
	InstanceUpdateParamsEmbeddingModelCfQwenQwen3Embedding0_6b              InstanceUpdateParamsEmbeddingModel = "@cf/qwen/qwen3-embedding-0.6b"
	InstanceUpdateParamsEmbeddingModelCfBaaiBgeM3                           InstanceUpdateParamsEmbeddingModel = "@cf/baai/bge-m3"
	InstanceUpdateParamsEmbeddingModelCfBaaiBgeLargeEnV1_5                  InstanceUpdateParamsEmbeddingModel = "@cf/baai/bge-large-en-v1.5"
	InstanceUpdateParamsEmbeddingModelCfGoogleEmbeddinggemma300m            InstanceUpdateParamsEmbeddingModel = "@cf/google/embeddinggemma-300m"
	InstanceUpdateParamsEmbeddingModelGoogleAIStudioGeminiEmbedding001      InstanceUpdateParamsEmbeddingModel = "google-ai-studio/gemini-embedding-001"
	InstanceUpdateParamsEmbeddingModelGoogleAIStudioGeminiEmbedding2Preview InstanceUpdateParamsEmbeddingModel = "google-ai-studio/gemini-embedding-2-preview"
	InstanceUpdateParamsEmbeddingModelOpenAITextEmbedding3Small             InstanceUpdateParamsEmbeddingModel = "openai/text-embedding-3-small"
	InstanceUpdateParamsEmbeddingModelOpenAITextEmbedding3Large             InstanceUpdateParamsEmbeddingModel = "openai/text-embedding-3-large"
	InstanceUpdateParamsEmbeddingModelEmpty                                 InstanceUpdateParamsEmbeddingModel = ""
)

func (InstanceUpdateParamsEmbeddingModel) IsKnown

type InstanceUpdateParamsFusionMethod

type InstanceUpdateParamsFusionMethod string
const (
	InstanceUpdateParamsFusionMethodMax InstanceUpdateParamsFusionMethod = "max"
	InstanceUpdateParamsFusionMethodRrf InstanceUpdateParamsFusionMethod = "rrf"
)

func (InstanceUpdateParamsFusionMethod) IsKnown

type InstanceUpdateParamsIndexMethod

type InstanceUpdateParamsIndexMethod struct {
	// Enable keyword (BM25) storage backend.
	Keyword param.Field[bool] `json:"keyword" api:"required"`
	// Enable vector (embedding) storage backend.
	Vector param.Field[bool] `json:"vector" api:"required"`
}

Controls which storage backends are used during indexing. Defaults to vector-only.

func (InstanceUpdateParamsIndexMethod) MarshalJSON

func (r InstanceUpdateParamsIndexMethod) MarshalJSON() (data []byte, err error)

type InstanceUpdateParamsIndexingOptions

type InstanceUpdateParamsIndexingOptions struct {
	// Tokenizer used for keyword search indexing. porter provides word-level
	// tokenization with Porter stemming (good for natural language queries). trigram
	// enables character-level substring matching (good for partial matches, code,
	// identifiers). Changing this triggers a full re-index. Defaults to porter.
	KeywordTokenizer param.Field[InstanceUpdateParamsIndexingOptionsKeywordTokenizer] `json:"keyword_tokenizer"`
}

func (InstanceUpdateParamsIndexingOptions) MarshalJSON

func (r InstanceUpdateParamsIndexingOptions) MarshalJSON() (data []byte, err error)

type InstanceUpdateParamsIndexingOptionsKeywordTokenizer

type InstanceUpdateParamsIndexingOptionsKeywordTokenizer string

Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter.

const (
	InstanceUpdateParamsIndexingOptionsKeywordTokenizerPorter  InstanceUpdateParamsIndexingOptionsKeywordTokenizer = "porter"
	InstanceUpdateParamsIndexingOptionsKeywordTokenizerTrigram InstanceUpdateParamsIndexingOptionsKeywordTokenizer = "trigram"
)

func (InstanceUpdateParamsIndexingOptionsKeywordTokenizer) IsKnown

type InstanceUpdateParamsMetadata

type InstanceUpdateParamsMetadata struct {
	CreatedFromAISearchWizard param.Field[bool]   `json:"created_from_aisearch_wizard"`
	WorkerDomain              param.Field[string] `json:"worker_domain"`
}

func (InstanceUpdateParamsMetadata) MarshalJSON

func (r InstanceUpdateParamsMetadata) MarshalJSON() (data []byte, err error)

type InstanceUpdateParamsPublicEndpointParams

type InstanceUpdateParamsPublicEndpointParams struct {
	AuthorizedHosts         param.Field[[]string]                                                        `json:"authorized_hosts"`
	ChatCompletionsEndpoint param.Field[InstanceUpdateParamsPublicEndpointParamsChatCompletionsEndpoint] `json:"chat_completions_endpoint"`
	Enabled                 param.Field[bool]                                                            `json:"enabled"`
	Mcp                     param.Field[InstanceUpdateParamsPublicEndpointParamsMcp]                     `json:"mcp"`
	RateLimit               param.Field[InstanceUpdateParamsPublicEndpointParamsRateLimit]               `json:"rate_limit"`
	SearchEndpoint          param.Field[InstanceUpdateParamsPublicEndpointParamsSearchEndpoint]          `json:"search_endpoint"`
}

func (InstanceUpdateParamsPublicEndpointParams) MarshalJSON

func (r InstanceUpdateParamsPublicEndpointParams) MarshalJSON() (data []byte, err error)

type InstanceUpdateParamsPublicEndpointParamsChatCompletionsEndpoint

type InstanceUpdateParamsPublicEndpointParamsChatCompletionsEndpoint struct {
	// Disable chat completions endpoint for this public endpoint
	Disabled param.Field[bool] `json:"disabled"`
}

func (InstanceUpdateParamsPublicEndpointParamsChatCompletionsEndpoint) MarshalJSON

type InstanceUpdateParamsPublicEndpointParamsMcp

type InstanceUpdateParamsPublicEndpointParamsMcp struct {
	Description param.Field[string] `json:"description"`
	// Disable MCP endpoint for this public endpoint
	Disabled param.Field[bool] `json:"disabled"`
}

func (InstanceUpdateParamsPublicEndpointParamsMcp) MarshalJSON

func (r InstanceUpdateParamsPublicEndpointParamsMcp) MarshalJSON() (data []byte, err error)

type InstanceUpdateParamsPublicEndpointParamsRateLimit

type InstanceUpdateParamsPublicEndpointParamsRateLimit struct {
	PeriodMs  param.Field[int64]                                                      `json:"period_ms"`
	Requests  param.Field[int64]                                                      `json:"requests"`
	Technique param.Field[InstanceUpdateParamsPublicEndpointParamsRateLimitTechnique] `json:"technique"`
}

func (InstanceUpdateParamsPublicEndpointParamsRateLimit) MarshalJSON

func (r InstanceUpdateParamsPublicEndpointParamsRateLimit) MarshalJSON() (data []byte, err error)

type InstanceUpdateParamsPublicEndpointParamsRateLimitTechnique

type InstanceUpdateParamsPublicEndpointParamsRateLimitTechnique string
const (
	InstanceUpdateParamsPublicEndpointParamsRateLimitTechniqueFixed   InstanceUpdateParamsPublicEndpointParamsRateLimitTechnique = "fixed"
	InstanceUpdateParamsPublicEndpointParamsRateLimitTechniqueSliding InstanceUpdateParamsPublicEndpointParamsRateLimitTechnique = "sliding"
)

func (InstanceUpdateParamsPublicEndpointParamsRateLimitTechnique) IsKnown

type InstanceUpdateParamsPublicEndpointParamsSearchEndpoint

type InstanceUpdateParamsPublicEndpointParamsSearchEndpoint struct {
	// Disable search endpoint for this public endpoint
	Disabled param.Field[bool] `json:"disabled"`
}

func (InstanceUpdateParamsPublicEndpointParamsSearchEndpoint) MarshalJSON

type InstanceUpdateParamsRerankingModel

type InstanceUpdateParamsRerankingModel string
const (
	InstanceUpdateParamsRerankingModelCfBaaiBgeRerankerBase InstanceUpdateParamsRerankingModel = "@cf/baai/bge-reranker-base"
	InstanceUpdateParamsRerankingModelEmpty                 InstanceUpdateParamsRerankingModel = ""
)

func (InstanceUpdateParamsRerankingModel) IsKnown

type InstanceUpdateParamsRetrievalOptions

type InstanceUpdateParamsRetrievalOptions struct {
	// Metadata fields to boost search results by. Each entry specifies a metadata
	// field and an optional direction. Direction defaults to 'asc' for
	// numeric/datetime fields and 'exists' for text/boolean fields. Fields must match
	// 'timestamp' or a defined custom_metadata field.
	BoostBy param.Field[[]InstanceUpdateParamsRetrievalOptionsBoostBy] `json:"boost_by"`
	// 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'.
	KeywordMatchMode param.Field[InstanceUpdateParamsRetrievalOptionsKeywordMatchMode] `json:"keyword_match_mode"`
}

func (InstanceUpdateParamsRetrievalOptions) MarshalJSON

func (r InstanceUpdateParamsRetrievalOptions) MarshalJSON() (data []byte, err error)

type InstanceUpdateParamsRetrievalOptionsBoostBy

type InstanceUpdateParamsRetrievalOptionsBoostBy struct {
	// 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.
	Field param.Field[string] `json:"field" api:"required"`
	// 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.
	Direction param.Field[InstanceUpdateParamsRetrievalOptionsBoostByDirection] `json:"direction"`
}

func (InstanceUpdateParamsRetrievalOptionsBoostBy) MarshalJSON

func (r InstanceUpdateParamsRetrievalOptionsBoostBy) MarshalJSON() (data []byte, err error)

type InstanceUpdateParamsRetrievalOptionsBoostByDirection

type InstanceUpdateParamsRetrievalOptionsBoostByDirection string

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.

const (
	InstanceUpdateParamsRetrievalOptionsBoostByDirectionAsc       InstanceUpdateParamsRetrievalOptionsBoostByDirection = "asc"
	InstanceUpdateParamsRetrievalOptionsBoostByDirectionDesc      InstanceUpdateParamsRetrievalOptionsBoostByDirection = "desc"
	InstanceUpdateParamsRetrievalOptionsBoostByDirectionExists    InstanceUpdateParamsRetrievalOptionsBoostByDirection = "exists"
	InstanceUpdateParamsRetrievalOptionsBoostByDirectionNotExists InstanceUpdateParamsRetrievalOptionsBoostByDirection = "not_exists"
)

func (InstanceUpdateParamsRetrievalOptionsBoostByDirection) IsKnown

type InstanceUpdateParamsRetrievalOptionsKeywordMatchMode

type InstanceUpdateParamsRetrievalOptionsKeywordMatchMode string

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'.

const (
	InstanceUpdateParamsRetrievalOptionsKeywordMatchModeAnd InstanceUpdateParamsRetrievalOptionsKeywordMatchMode = "and"
	InstanceUpdateParamsRetrievalOptionsKeywordMatchModeOr  InstanceUpdateParamsRetrievalOptionsKeywordMatchMode = "or"
)

func (InstanceUpdateParamsRetrievalOptionsKeywordMatchMode) IsKnown

type InstanceUpdateParamsRewriteModel

type InstanceUpdateParamsRewriteModel string
const (
	InstanceUpdateParamsRewriteModelCfMetaLlama3_3_70bInstructFp8Fast     InstanceUpdateParamsRewriteModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	InstanceUpdateParamsRewriteModelCfZaiOrgGlm4_7Flash                   InstanceUpdateParamsRewriteModel = "@cf/zai-org/glm-4.7-flash"
	InstanceUpdateParamsRewriteModelCfMetaLlama3_1_8bInstructFast         InstanceUpdateParamsRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	InstanceUpdateParamsRewriteModelCfMetaLlama3_1_8bInstructFp8          InstanceUpdateParamsRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	InstanceUpdateParamsRewriteModelCfMetaLlama4Scout17b16eInstruct       InstanceUpdateParamsRewriteModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	InstanceUpdateParamsRewriteModelCfQwenQwen3_30bA3bFp8                 InstanceUpdateParamsRewriteModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	InstanceUpdateParamsRewriteModelCfDeepseekAIDeepseekR1DistillQwen32b  InstanceUpdateParamsRewriteModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	InstanceUpdateParamsRewriteModelCfMoonshotaiKimiK2Instruct            InstanceUpdateParamsRewriteModel = "@cf/moonshotai/kimi-k2-instruct"
	InstanceUpdateParamsRewriteModelCfGoogleGemma3_12bIt                  InstanceUpdateParamsRewriteModel = "@cf/google/gemma-3-12b-it"
	InstanceUpdateParamsRewriteModelCfGoogleGemma4_26bA4bIt               InstanceUpdateParamsRewriteModel = "@cf/google/gemma-4-26b-a4b-it"
	InstanceUpdateParamsRewriteModelCfMoonshotaiKimiK2_5                  InstanceUpdateParamsRewriteModel = "@cf/moonshotai/kimi-k2.5"
	InstanceUpdateParamsRewriteModelAnthropicClaude3_7Sonnet              InstanceUpdateParamsRewriteModel = "anthropic/claude-3-7-sonnet"
	InstanceUpdateParamsRewriteModelAnthropicClaudeSonnet4                InstanceUpdateParamsRewriteModel = "anthropic/claude-sonnet-4"
	InstanceUpdateParamsRewriteModelAnthropicClaudeOpus4                  InstanceUpdateParamsRewriteModel = "anthropic/claude-opus-4"
	InstanceUpdateParamsRewriteModelAnthropicClaude3_5Haiku               InstanceUpdateParamsRewriteModel = "anthropic/claude-3-5-haiku"
	InstanceUpdateParamsRewriteModelCerebrasQwen3_235bA22bInstruct        InstanceUpdateParamsRewriteModel = "cerebras/qwen-3-235b-a22b-instruct"
	InstanceUpdateParamsRewriteModelCerebrasQwen3_235bA22bThinking        InstanceUpdateParamsRewriteModel = "cerebras/qwen-3-235b-a22b-thinking"
	InstanceUpdateParamsRewriteModelCerebrasLlama3_3_70b                  InstanceUpdateParamsRewriteModel = "cerebras/llama-3.3-70b"
	InstanceUpdateParamsRewriteModelCerebrasLlama4Maverick17b128eInstruct InstanceUpdateParamsRewriteModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	InstanceUpdateParamsRewriteModelCerebrasLlama4Scout17b16eInstruct     InstanceUpdateParamsRewriteModel = "cerebras/llama-4-scout-17b-16e-instruct"
	InstanceUpdateParamsRewriteModelCerebrasGptOSs120b                    InstanceUpdateParamsRewriteModel = "cerebras/gpt-oss-120b"
	InstanceUpdateParamsRewriteModelGoogleAIStudioGemini2_5Flash          InstanceUpdateParamsRewriteModel = "google-ai-studio/gemini-2.5-flash"
	InstanceUpdateParamsRewriteModelGoogleAIStudioGemini2_5Pro            InstanceUpdateParamsRewriteModel = "google-ai-studio/gemini-2.5-pro"
	InstanceUpdateParamsRewriteModelGrokGrok4                             InstanceUpdateParamsRewriteModel = "grok/grok-4"
	InstanceUpdateParamsRewriteModelGroqLlama3_3_70bVersatile             InstanceUpdateParamsRewriteModel = "groq/llama-3.3-70b-versatile"
	InstanceUpdateParamsRewriteModelGroqLlama3_1_8bInstant                InstanceUpdateParamsRewriteModel = "groq/llama-3.1-8b-instant"
	InstanceUpdateParamsRewriteModelOpenAIGpt5                            InstanceUpdateParamsRewriteModel = "openai/gpt-5"
	InstanceUpdateParamsRewriteModelOpenAIGpt5Mini                        InstanceUpdateParamsRewriteModel = "openai/gpt-5-mini"
	InstanceUpdateParamsRewriteModelOpenAIGpt5Nano                        InstanceUpdateParamsRewriteModel = "openai/gpt-5-nano"
	InstanceUpdateParamsRewriteModelEmpty                                 InstanceUpdateParamsRewriteModel = ""
)

func (InstanceUpdateParamsRewriteModel) IsKnown

type InstanceUpdateParamsSourceParams

type InstanceUpdateParamsSourceParams struct {
	// List of path patterns to exclude. Uses micromatch glob syntax: \* matches within
	// a path segment, ** matches across path segments (e.g., /admin/** matches
	// /admin/users and /admin/settings/advanced)
	ExcludeItems param.Field[[]string] `json:"exclude_items"`
	// List of path patterns to include. Uses micromatch glob syntax: \* matches within
	// a path segment, ** matches across path segments (e.g., /blog/** matches
	// /blog/post and /blog/2024/post)
	IncludeItems   param.Field[[]string]                                   `json:"include_items"`
	Prefix         param.Field[string]                                     `json:"prefix"`
	R2Jurisdiction param.Field[string]                                     `json:"r2_jurisdiction"`
	WebCrawler     param.Field[InstanceUpdateParamsSourceParamsWebCrawler] `json:"web_crawler"`
}

func (InstanceUpdateParamsSourceParams) MarshalJSON

func (r InstanceUpdateParamsSourceParams) MarshalJSON() (data []byte, err error)

type InstanceUpdateParamsSourceParamsWebCrawler

type InstanceUpdateParamsSourceParamsWebCrawler struct {
	CrawlOptions param.Field[InstanceUpdateParamsSourceParamsWebCrawlerCrawlOptions] `json:"crawl_options"`
	ParseOptions param.Field[InstanceUpdateParamsSourceParamsWebCrawlerParseOptions] `json:"parse_options"`
	ParseType    param.Field[InstanceUpdateParamsSourceParamsWebCrawlerParseType]    `json:"parse_type"`
	StoreOptions param.Field[InstanceUpdateParamsSourceParamsWebCrawlerStoreOptions] `json:"store_options"`
}

func (InstanceUpdateParamsSourceParamsWebCrawler) MarshalJSON

func (r InstanceUpdateParamsSourceParamsWebCrawler) MarshalJSON() (data []byte, err error)

type InstanceUpdateParamsSourceParamsWebCrawlerCrawlOptions

type InstanceUpdateParamsSourceParamsWebCrawlerCrawlOptions struct {
	Depth                param.Field[float64]                                                      `json:"depth"`
	IncludeExternalLinks param.Field[bool]                                                         `json:"include_external_links"`
	IncludeSubdomains    param.Field[bool]                                                         `json:"include_subdomains"`
	MaxAge               param.Field[float64]                                                      `json:"max_age"`
	Source               param.Field[InstanceUpdateParamsSourceParamsWebCrawlerCrawlOptionsSource] `json:"source"`
}

func (InstanceUpdateParamsSourceParamsWebCrawlerCrawlOptions) MarshalJSON

type InstanceUpdateParamsSourceParamsWebCrawlerCrawlOptionsSource

type InstanceUpdateParamsSourceParamsWebCrawlerCrawlOptionsSource string
const (
	InstanceUpdateParamsSourceParamsWebCrawlerCrawlOptionsSourceAll      InstanceUpdateParamsSourceParamsWebCrawlerCrawlOptionsSource = "all"
	InstanceUpdateParamsSourceParamsWebCrawlerCrawlOptionsSourceSitemaps InstanceUpdateParamsSourceParamsWebCrawlerCrawlOptionsSource = "sitemaps"
	InstanceUpdateParamsSourceParamsWebCrawlerCrawlOptionsSourceLinks    InstanceUpdateParamsSourceParamsWebCrawlerCrawlOptionsSource = "links"
)

func (InstanceUpdateParamsSourceParamsWebCrawlerCrawlOptionsSource) IsKnown

type InstanceUpdateParamsSourceParamsWebCrawlerParseOptions

type InstanceUpdateParamsSourceParamsWebCrawlerParseOptions struct {
	// List of path-to-selector mappings for extracting specific content from crawled
	// pages. Each entry pairs a URL glob pattern with a CSS selector. The first
	// matching path wins. Only the matched HTML fragment is stored and indexed. Omit
	// the field to disable content selection — empty arrays are rejected.
	ContentSelector param.Field[[]InstanceUpdateParamsSourceParamsWebCrawlerParseOptionsContentSelector] `json:"content_selector"`
	// Up to 5 custom HTTP headers sent with each crawl request. Names must be RFC-7230
	// token characters (no spaces, colons, or control characters); values must be
	// HTAB + printable ASCII (no CR/LF).
	IncludeHeaders param.Field[map[string]string] `json:"include_headers"`
	IncludeImages  param.Field[bool]              `json:"include_images"`
	// List of specific sitemap URLs to use for crawling. Only valid when parse_type is
	// 'sitemap'.
	SpecificSitemaps    param.Field[[]string] `json:"specific_sitemaps" format:"uri"`
	UseBrowserRendering param.Field[bool]     `json:"use_browser_rendering"`
}

func (InstanceUpdateParamsSourceParamsWebCrawlerParseOptions) MarshalJSON

type InstanceUpdateParamsSourceParamsWebCrawlerParseOptionsContentSelector

type InstanceUpdateParamsSourceParamsWebCrawlerParseOptionsContentSelector struct {
	// Glob pattern to match against the page URL path. Uses standard glob syntax: \*
	// matches within a segment, \*\* crosses directories.
	Path param.Field[string] `json:"path" api:"required"`
	// CSS selector to extract content from pages matching the path pattern. Must not
	// contain disallowed characters (;, `, $, {, }, \). Must target a single element;
	// if multiple elements match, the selector is ignored and the full page is used.
	Selector param.Field[string] `json:"selector" api:"required"`
}

func (InstanceUpdateParamsSourceParamsWebCrawlerParseOptionsContentSelector) MarshalJSON

type InstanceUpdateParamsSourceParamsWebCrawlerParseType

type InstanceUpdateParamsSourceParamsWebCrawlerParseType string
const (
	InstanceUpdateParamsSourceParamsWebCrawlerParseTypeSitemap InstanceUpdateParamsSourceParamsWebCrawlerParseType = "sitemap"
	InstanceUpdateParamsSourceParamsWebCrawlerParseTypeFeedRss InstanceUpdateParamsSourceParamsWebCrawlerParseType = "feed-rss"
	InstanceUpdateParamsSourceParamsWebCrawlerParseTypeCrawl   InstanceUpdateParamsSourceParamsWebCrawlerParseType = "crawl"
)

func (InstanceUpdateParamsSourceParamsWebCrawlerParseType) IsKnown

type InstanceUpdateParamsSourceParamsWebCrawlerStoreOptions

type InstanceUpdateParamsSourceParamsWebCrawlerStoreOptions struct {
	StorageID      param.Field[string]      `json:"storage_id" api:"required"`
	R2Jurisdiction param.Field[string]      `json:"r2_jurisdiction"`
	StorageType    param.Field[r2.Provider] `json:"storage_type"`
}

func (InstanceUpdateParamsSourceParamsWebCrawlerStoreOptions) MarshalJSON

type InstanceUpdateParamsSummarizationModel

type InstanceUpdateParamsSummarizationModel string
const (
	InstanceUpdateParamsSummarizationModelCfMetaLlama3_3_70bInstructFp8Fast     InstanceUpdateParamsSummarizationModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	InstanceUpdateParamsSummarizationModelCfZaiOrgGlm4_7Flash                   InstanceUpdateParamsSummarizationModel = "@cf/zai-org/glm-4.7-flash"
	InstanceUpdateParamsSummarizationModelCfMetaLlama3_1_8bInstructFast         InstanceUpdateParamsSummarizationModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	InstanceUpdateParamsSummarizationModelCfMetaLlama3_1_8bInstructFp8          InstanceUpdateParamsSummarizationModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	InstanceUpdateParamsSummarizationModelCfMetaLlama4Scout17b16eInstruct       InstanceUpdateParamsSummarizationModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	InstanceUpdateParamsSummarizationModelCfQwenQwen3_30bA3bFp8                 InstanceUpdateParamsSummarizationModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	InstanceUpdateParamsSummarizationModelCfDeepseekAIDeepseekR1DistillQwen32b  InstanceUpdateParamsSummarizationModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	InstanceUpdateParamsSummarizationModelCfMoonshotaiKimiK2Instruct            InstanceUpdateParamsSummarizationModel = "@cf/moonshotai/kimi-k2-instruct"
	InstanceUpdateParamsSummarizationModelCfGoogleGemma3_12bIt                  InstanceUpdateParamsSummarizationModel = "@cf/google/gemma-3-12b-it"
	InstanceUpdateParamsSummarizationModelCfGoogleGemma4_26bA4bIt               InstanceUpdateParamsSummarizationModel = "@cf/google/gemma-4-26b-a4b-it"
	InstanceUpdateParamsSummarizationModelCfMoonshotaiKimiK2_5                  InstanceUpdateParamsSummarizationModel = "@cf/moonshotai/kimi-k2.5"
	InstanceUpdateParamsSummarizationModelAnthropicClaude3_7Sonnet              InstanceUpdateParamsSummarizationModel = "anthropic/claude-3-7-sonnet"
	InstanceUpdateParamsSummarizationModelAnthropicClaudeSonnet4                InstanceUpdateParamsSummarizationModel = "anthropic/claude-sonnet-4"
	InstanceUpdateParamsSummarizationModelAnthropicClaudeOpus4                  InstanceUpdateParamsSummarizationModel = "anthropic/claude-opus-4"
	InstanceUpdateParamsSummarizationModelAnthropicClaude3_5Haiku               InstanceUpdateParamsSummarizationModel = "anthropic/claude-3-5-haiku"
	InstanceUpdateParamsSummarizationModelCerebrasQwen3_235bA22bInstruct        InstanceUpdateParamsSummarizationModel = "cerebras/qwen-3-235b-a22b-instruct"
	InstanceUpdateParamsSummarizationModelCerebrasQwen3_235bA22bThinking        InstanceUpdateParamsSummarizationModel = "cerebras/qwen-3-235b-a22b-thinking"
	InstanceUpdateParamsSummarizationModelCerebrasLlama3_3_70b                  InstanceUpdateParamsSummarizationModel = "cerebras/llama-3.3-70b"
	InstanceUpdateParamsSummarizationModelCerebrasLlama4Maverick17b128eInstruct InstanceUpdateParamsSummarizationModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	InstanceUpdateParamsSummarizationModelCerebrasLlama4Scout17b16eInstruct     InstanceUpdateParamsSummarizationModel = "cerebras/llama-4-scout-17b-16e-instruct"
	InstanceUpdateParamsSummarizationModelCerebrasGptOSs120b                    InstanceUpdateParamsSummarizationModel = "cerebras/gpt-oss-120b"
	InstanceUpdateParamsSummarizationModelGoogleAIStudioGemini2_5Flash          InstanceUpdateParamsSummarizationModel = "google-ai-studio/gemini-2.5-flash"
	InstanceUpdateParamsSummarizationModelGoogleAIStudioGemini2_5Pro            InstanceUpdateParamsSummarizationModel = "google-ai-studio/gemini-2.5-pro"
	InstanceUpdateParamsSummarizationModelGrokGrok4                             InstanceUpdateParamsSummarizationModel = "grok/grok-4"
	InstanceUpdateParamsSummarizationModelGroqLlama3_3_70bVersatile             InstanceUpdateParamsSummarizationModel = "groq/llama-3.3-70b-versatile"
	InstanceUpdateParamsSummarizationModelGroqLlama3_1_8bInstant                InstanceUpdateParamsSummarizationModel = "groq/llama-3.1-8b-instant"
	InstanceUpdateParamsSummarizationModelOpenAIGpt5                            InstanceUpdateParamsSummarizationModel = "openai/gpt-5"
	InstanceUpdateParamsSummarizationModelOpenAIGpt5Mini                        InstanceUpdateParamsSummarizationModel = "openai/gpt-5-mini"
	InstanceUpdateParamsSummarizationModelOpenAIGpt5Nano                        InstanceUpdateParamsSummarizationModel = "openai/gpt-5-nano"
	InstanceUpdateParamsSummarizationModelEmpty                                 InstanceUpdateParamsSummarizationModel = ""
)

func (InstanceUpdateParamsSummarizationModel) IsKnown

type InstanceUpdateParamsSyncInterval

type InstanceUpdateParamsSyncInterval float64

Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).

const (
	InstanceUpdateParamsSyncInterval900   InstanceUpdateParamsSyncInterval = 900
	InstanceUpdateParamsSyncInterval1800  InstanceUpdateParamsSyncInterval = 1800
	InstanceUpdateParamsSyncInterval3600  InstanceUpdateParamsSyncInterval = 3600
	InstanceUpdateParamsSyncInterval7200  InstanceUpdateParamsSyncInterval = 7200
	InstanceUpdateParamsSyncInterval14400 InstanceUpdateParamsSyncInterval = 14400
	InstanceUpdateParamsSyncInterval21600 InstanceUpdateParamsSyncInterval = 21600
	InstanceUpdateParamsSyncInterval43200 InstanceUpdateParamsSyncInterval = 43200
	InstanceUpdateParamsSyncInterval86400 InstanceUpdateParamsSyncInterval = 86400
)

func (InstanceUpdateParamsSyncInterval) IsKnown

type InstanceUpdateResponse

type InstanceUpdateResponse struct {
	// AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
	ID             string                               `json:"id" api:"required"`
	CreatedAt      time.Time                            `json:"created_at" api:"required" format:"date-time"`
	ModifiedAt     time.Time                            `json:"modified_at" api:"required" format:"date-time"`
	AIGatewayID    string                               `json:"ai_gateway_id" api:"nullable"`
	AISearchModel  InstanceUpdateResponseAISearchModel  `json:"ai_search_model" api:"nullable"`
	Cache          bool                                 `json:"cache"`
	CacheThreshold InstanceUpdateResponseCacheThreshold `json:"cache_threshold"`
	// Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600
	// (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200
	// (72h), 518400 (6d).
	CacheTTL       InstanceUpdateResponseCacheTTL         `json:"cache_ttl"`
	ChunkOverlap   int64                                  `json:"chunk_overlap"`
	ChunkSize      int64                                  `json:"chunk_size"`
	CreatedBy      string                                 `json:"created_by" api:"nullable"`
	CustomMetadata []InstanceUpdateResponseCustomMetadata `json:"custom_metadata"`
	EmbeddingModel InstanceUpdateResponseEmbeddingModel   `json:"embedding_model" api:"nullable"`
	Enable         bool                                   `json:"enable"`
	EngineVersion  float64                                `json:"engine_version"`
	FusionMethod   InstanceUpdateResponseFusionMethod     `json:"fusion_method"`
	// Deprecated — use index_method instead.
	//
	// Deprecated: deprecated
	HybridSearchEnabled bool `json:"hybrid_search_enabled"`
	// Controls which storage backends are used during indexing. Defaults to
	// vector-only.
	IndexMethod          InstanceUpdateResponseIndexMethod          `json:"index_method"`
	IndexingOptions      InstanceUpdateResponseIndexingOptions      `json:"indexing_options" api:"nullable"`
	LastActivity         time.Time                                  `json:"last_activity" api:"nullable" format:"date-time"`
	MaxNumResults        int64                                      `json:"max_num_results"`
	Metadata             InstanceUpdateResponseMetadata             `json:"metadata"`
	ModifiedBy           string                                     `json:"modified_by" api:"nullable"`
	Namespace            string                                     `json:"namespace" api:"nullable"`
	Paused               bool                                       `json:"paused"`
	PublicEndpointID     string                                     `json:"public_endpoint_id" api:"nullable"`
	PublicEndpointParams InstanceUpdateResponsePublicEndpointParams `json:"public_endpoint_params"`
	Reranking            bool                                       `json:"reranking"`
	RerankingModel       InstanceUpdateResponseRerankingModel       `json:"reranking_model" api:"nullable"`
	RetrievalOptions     InstanceUpdateResponseRetrievalOptions     `json:"retrieval_options" api:"nullable"`
	RewriteModel         InstanceUpdateResponseRewriteModel         `json:"rewrite_model" api:"nullable"`
	RewriteQuery         bool                                       `json:"rewrite_query"`
	ScoreThreshold       float64                                    `json:"score_threshold"`
	Source               string                                     `json:"source" api:"nullable"`
	SourceParams         InstanceUpdateResponseSourceParams         `json:"source_params" api:"nullable"`
	Status               string                                     `json:"status"`
	// Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800
	// (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).
	SyncInterval InstanceUpdateResponseSyncInterval `json:"sync_interval"`
	TokenID      string                             `json:"token_id" format:"uuid"`
	Type         InstanceUpdateResponseType         `json:"type" api:"nullable"`
	JSON         instanceUpdateResponseJSON         `json:"-"`
}

func (*InstanceUpdateResponse) UnmarshalJSON

func (r *InstanceUpdateResponse) UnmarshalJSON(data []byte) (err error)

type InstanceUpdateResponseAISearchModel

type InstanceUpdateResponseAISearchModel string
const (
	InstanceUpdateResponseAISearchModelCfMetaLlama3_3_70bInstructFp8Fast     InstanceUpdateResponseAISearchModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	InstanceUpdateResponseAISearchModelCfZaiOrgGlm4_7Flash                   InstanceUpdateResponseAISearchModel = "@cf/zai-org/glm-4.7-flash"
	InstanceUpdateResponseAISearchModelCfMetaLlama3_1_8bInstructFast         InstanceUpdateResponseAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	InstanceUpdateResponseAISearchModelCfMetaLlama3_1_8bInstructFp8          InstanceUpdateResponseAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	InstanceUpdateResponseAISearchModelCfMetaLlama4Scout17b16eInstruct       InstanceUpdateResponseAISearchModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	InstanceUpdateResponseAISearchModelCfQwenQwen3_30bA3bFp8                 InstanceUpdateResponseAISearchModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	InstanceUpdateResponseAISearchModelCfDeepseekAIDeepseekR1DistillQwen32b  InstanceUpdateResponseAISearchModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	InstanceUpdateResponseAISearchModelCfMoonshotaiKimiK2Instruct            InstanceUpdateResponseAISearchModel = "@cf/moonshotai/kimi-k2-instruct"
	InstanceUpdateResponseAISearchModelCfGoogleGemma3_12bIt                  InstanceUpdateResponseAISearchModel = "@cf/google/gemma-3-12b-it"
	InstanceUpdateResponseAISearchModelCfGoogleGemma4_26bA4bIt               InstanceUpdateResponseAISearchModel = "@cf/google/gemma-4-26b-a4b-it"
	InstanceUpdateResponseAISearchModelCfMoonshotaiKimiK2_5                  InstanceUpdateResponseAISearchModel = "@cf/moonshotai/kimi-k2.5"
	InstanceUpdateResponseAISearchModelAnthropicClaude3_7Sonnet              InstanceUpdateResponseAISearchModel = "anthropic/claude-3-7-sonnet"
	InstanceUpdateResponseAISearchModelAnthropicClaudeSonnet4                InstanceUpdateResponseAISearchModel = "anthropic/claude-sonnet-4"
	InstanceUpdateResponseAISearchModelAnthropicClaudeOpus4                  InstanceUpdateResponseAISearchModel = "anthropic/claude-opus-4"
	InstanceUpdateResponseAISearchModelAnthropicClaude3_5Haiku               InstanceUpdateResponseAISearchModel = "anthropic/claude-3-5-haiku"
	InstanceUpdateResponseAISearchModelCerebrasQwen3_235bA22bInstruct        InstanceUpdateResponseAISearchModel = "cerebras/qwen-3-235b-a22b-instruct"
	InstanceUpdateResponseAISearchModelCerebrasQwen3_235bA22bThinking        InstanceUpdateResponseAISearchModel = "cerebras/qwen-3-235b-a22b-thinking"
	InstanceUpdateResponseAISearchModelCerebrasLlama3_3_70b                  InstanceUpdateResponseAISearchModel = "cerebras/llama-3.3-70b"
	InstanceUpdateResponseAISearchModelCerebrasLlama4Maverick17b128eInstruct InstanceUpdateResponseAISearchModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	InstanceUpdateResponseAISearchModelCerebrasLlama4Scout17b16eInstruct     InstanceUpdateResponseAISearchModel = "cerebras/llama-4-scout-17b-16e-instruct"
	InstanceUpdateResponseAISearchModelCerebrasGptOSs120b                    InstanceUpdateResponseAISearchModel = "cerebras/gpt-oss-120b"
	InstanceUpdateResponseAISearchModelGoogleAIStudioGemini2_5Flash          InstanceUpdateResponseAISearchModel = "google-ai-studio/gemini-2.5-flash"
	InstanceUpdateResponseAISearchModelGoogleAIStudioGemini2_5Pro            InstanceUpdateResponseAISearchModel = "google-ai-studio/gemini-2.5-pro"
	InstanceUpdateResponseAISearchModelGrokGrok4                             InstanceUpdateResponseAISearchModel = "grok/grok-4"
	InstanceUpdateResponseAISearchModelGroqLlama3_3_70bVersatile             InstanceUpdateResponseAISearchModel = "groq/llama-3.3-70b-versatile"
	InstanceUpdateResponseAISearchModelGroqLlama3_1_8bInstant                InstanceUpdateResponseAISearchModel = "groq/llama-3.1-8b-instant"
	InstanceUpdateResponseAISearchModelOpenAIGpt5                            InstanceUpdateResponseAISearchModel = "openai/gpt-5"
	InstanceUpdateResponseAISearchModelOpenAIGpt5Mini                        InstanceUpdateResponseAISearchModel = "openai/gpt-5-mini"
	InstanceUpdateResponseAISearchModelOpenAIGpt5Nano                        InstanceUpdateResponseAISearchModel = "openai/gpt-5-nano"
	InstanceUpdateResponseAISearchModelEmpty                                 InstanceUpdateResponseAISearchModel = ""
)

func (InstanceUpdateResponseAISearchModel) IsKnown

type InstanceUpdateResponseCacheTTL

type InstanceUpdateResponseCacheTTL float64

Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d).

const (
	InstanceUpdateResponseCacheTTL600    InstanceUpdateResponseCacheTTL = 600
	InstanceUpdateResponseCacheTTL1800   InstanceUpdateResponseCacheTTL = 1800
	InstanceUpdateResponseCacheTTL3600   InstanceUpdateResponseCacheTTL = 3600
	InstanceUpdateResponseCacheTTL7200   InstanceUpdateResponseCacheTTL = 7200
	InstanceUpdateResponseCacheTTL21600  InstanceUpdateResponseCacheTTL = 21600
	InstanceUpdateResponseCacheTTL43200  InstanceUpdateResponseCacheTTL = 43200
	InstanceUpdateResponseCacheTTL86400  InstanceUpdateResponseCacheTTL = 86400
	InstanceUpdateResponseCacheTTL172800 InstanceUpdateResponseCacheTTL = 172800
	InstanceUpdateResponseCacheTTL259200 InstanceUpdateResponseCacheTTL = 259200
	InstanceUpdateResponseCacheTTL518400 InstanceUpdateResponseCacheTTL = 518400
)

func (InstanceUpdateResponseCacheTTL) IsKnown

type InstanceUpdateResponseCacheThreshold

type InstanceUpdateResponseCacheThreshold string
const (
	InstanceUpdateResponseCacheThresholdSuperStrictMatch InstanceUpdateResponseCacheThreshold = "super_strict_match"
	InstanceUpdateResponseCacheThresholdCloseEnough      InstanceUpdateResponseCacheThreshold = "close_enough"
	InstanceUpdateResponseCacheThresholdFlexibleFriend   InstanceUpdateResponseCacheThreshold = "flexible_friend"
	InstanceUpdateResponseCacheThresholdAnythingGoes     InstanceUpdateResponseCacheThreshold = "anything_goes"
)

func (InstanceUpdateResponseCacheThreshold) IsKnown

type InstanceUpdateResponseCustomMetadata

type InstanceUpdateResponseCustomMetadata struct {
	DataType  InstanceUpdateResponseCustomMetadataDataType `json:"data_type" api:"required"`
	FieldName string                                       `json:"field_name" api:"required"`
	JSON      instanceUpdateResponseCustomMetadataJSON     `json:"-"`
}

func (*InstanceUpdateResponseCustomMetadata) UnmarshalJSON

func (r *InstanceUpdateResponseCustomMetadata) UnmarshalJSON(data []byte) (err error)

type InstanceUpdateResponseCustomMetadataDataType

type InstanceUpdateResponseCustomMetadataDataType string
const (
	InstanceUpdateResponseCustomMetadataDataTypeText     InstanceUpdateResponseCustomMetadataDataType = "text"
	InstanceUpdateResponseCustomMetadataDataTypeNumber   InstanceUpdateResponseCustomMetadataDataType = "number"
	InstanceUpdateResponseCustomMetadataDataTypeBoolean  InstanceUpdateResponseCustomMetadataDataType = "boolean"
	InstanceUpdateResponseCustomMetadataDataTypeDatetime InstanceUpdateResponseCustomMetadataDataType = "datetime"
)

func (InstanceUpdateResponseCustomMetadataDataType) IsKnown

type InstanceUpdateResponseEmbeddingModel

type InstanceUpdateResponseEmbeddingModel string
const (
	InstanceUpdateResponseEmbeddingModelCfQwenQwen3Embedding0_6b              InstanceUpdateResponseEmbeddingModel = "@cf/qwen/qwen3-embedding-0.6b"
	InstanceUpdateResponseEmbeddingModelCfBaaiBgeM3                           InstanceUpdateResponseEmbeddingModel = "@cf/baai/bge-m3"
	InstanceUpdateResponseEmbeddingModelCfBaaiBgeLargeEnV1_5                  InstanceUpdateResponseEmbeddingModel = "@cf/baai/bge-large-en-v1.5"
	InstanceUpdateResponseEmbeddingModelCfGoogleEmbeddinggemma300m            InstanceUpdateResponseEmbeddingModel = "@cf/google/embeddinggemma-300m"
	InstanceUpdateResponseEmbeddingModelGoogleAIStudioGeminiEmbedding001      InstanceUpdateResponseEmbeddingModel = "google-ai-studio/gemini-embedding-001"
	InstanceUpdateResponseEmbeddingModelGoogleAIStudioGeminiEmbedding2Preview InstanceUpdateResponseEmbeddingModel = "google-ai-studio/gemini-embedding-2-preview"
	InstanceUpdateResponseEmbeddingModelOpenAITextEmbedding3Small             InstanceUpdateResponseEmbeddingModel = "openai/text-embedding-3-small"
	InstanceUpdateResponseEmbeddingModelOpenAITextEmbedding3Large             InstanceUpdateResponseEmbeddingModel = "openai/text-embedding-3-large"
	InstanceUpdateResponseEmbeddingModelEmpty                                 InstanceUpdateResponseEmbeddingModel = ""
)

func (InstanceUpdateResponseEmbeddingModel) IsKnown

type InstanceUpdateResponseEnvelope

type InstanceUpdateResponseEnvelope struct {
	Result  InstanceUpdateResponse             `json:"result" api:"required"`
	Success bool                               `json:"success" api:"required"`
	JSON    instanceUpdateResponseEnvelopeJSON `json:"-"`
}

func (*InstanceUpdateResponseEnvelope) UnmarshalJSON

func (r *InstanceUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InstanceUpdateResponseFusionMethod

type InstanceUpdateResponseFusionMethod string
const (
	InstanceUpdateResponseFusionMethodMax InstanceUpdateResponseFusionMethod = "max"
	InstanceUpdateResponseFusionMethodRrf InstanceUpdateResponseFusionMethod = "rrf"
)

func (InstanceUpdateResponseFusionMethod) IsKnown

type InstanceUpdateResponseIndexMethod

type InstanceUpdateResponseIndexMethod struct {
	// Enable keyword (BM25) storage backend.
	Keyword bool `json:"keyword" api:"required"`
	// Enable vector (embedding) storage backend.
	Vector bool                                  `json:"vector" api:"required"`
	JSON   instanceUpdateResponseIndexMethodJSON `json:"-"`
}

Controls which storage backends are used during indexing. Defaults to vector-only.

func (*InstanceUpdateResponseIndexMethod) UnmarshalJSON

func (r *InstanceUpdateResponseIndexMethod) UnmarshalJSON(data []byte) (err error)

type InstanceUpdateResponseIndexingOptions

type InstanceUpdateResponseIndexingOptions struct {
	// Tokenizer used for keyword search indexing. porter provides word-level
	// tokenization with Porter stemming (good for natural language queries). trigram
	// enables character-level substring matching (good for partial matches, code,
	// identifiers). Changing this triggers a full re-index. Defaults to porter.
	KeywordTokenizer InstanceUpdateResponseIndexingOptionsKeywordTokenizer `json:"keyword_tokenizer"`
	JSON             instanceUpdateResponseIndexingOptionsJSON             `json:"-"`
}

func (*InstanceUpdateResponseIndexingOptions) UnmarshalJSON

func (r *InstanceUpdateResponseIndexingOptions) UnmarshalJSON(data []byte) (err error)

type InstanceUpdateResponseIndexingOptionsKeywordTokenizer

type InstanceUpdateResponseIndexingOptionsKeywordTokenizer string

Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter.

const (
	InstanceUpdateResponseIndexingOptionsKeywordTokenizerPorter  InstanceUpdateResponseIndexingOptionsKeywordTokenizer = "porter"
	InstanceUpdateResponseIndexingOptionsKeywordTokenizerTrigram InstanceUpdateResponseIndexingOptionsKeywordTokenizer = "trigram"
)

func (InstanceUpdateResponseIndexingOptionsKeywordTokenizer) IsKnown

type InstanceUpdateResponseMetadata

type InstanceUpdateResponseMetadata struct {
	CreatedFromAISearchWizard bool                               `json:"created_from_aisearch_wizard"`
	WorkerDomain              string                             `json:"worker_domain"`
	JSON                      instanceUpdateResponseMetadataJSON `json:"-"`
}

func (*InstanceUpdateResponseMetadata) UnmarshalJSON

func (r *InstanceUpdateResponseMetadata) UnmarshalJSON(data []byte) (err error)

type InstanceUpdateResponsePublicEndpointParams

type InstanceUpdateResponsePublicEndpointParams struct {
	AuthorizedHosts         []string                                                          `json:"authorized_hosts"`
	ChatCompletionsEndpoint InstanceUpdateResponsePublicEndpointParamsChatCompletionsEndpoint `json:"chat_completions_endpoint"`
	Enabled                 bool                                                              `json:"enabled"`
	Mcp                     InstanceUpdateResponsePublicEndpointParamsMcp                     `json:"mcp"`
	RateLimit               InstanceUpdateResponsePublicEndpointParamsRateLimit               `json:"rate_limit"`
	SearchEndpoint          InstanceUpdateResponsePublicEndpointParamsSearchEndpoint          `json:"search_endpoint"`
	JSON                    instanceUpdateResponsePublicEndpointParamsJSON                    `json:"-"`
}

func (*InstanceUpdateResponsePublicEndpointParams) UnmarshalJSON

func (r *InstanceUpdateResponsePublicEndpointParams) UnmarshalJSON(data []byte) (err error)

type InstanceUpdateResponsePublicEndpointParamsChatCompletionsEndpoint

type InstanceUpdateResponsePublicEndpointParamsChatCompletionsEndpoint struct {
	// Disable chat completions endpoint for this public endpoint
	Disabled bool                                                                  `json:"disabled"`
	JSON     instanceUpdateResponsePublicEndpointParamsChatCompletionsEndpointJSON `json:"-"`
}

func (*InstanceUpdateResponsePublicEndpointParamsChatCompletionsEndpoint) UnmarshalJSON

type InstanceUpdateResponsePublicEndpointParamsMcp

type InstanceUpdateResponsePublicEndpointParamsMcp struct {
	Description string `json:"description"`
	// Disable MCP endpoint for this public endpoint
	Disabled bool                                              `json:"disabled"`
	JSON     instanceUpdateResponsePublicEndpointParamsMcpJSON `json:"-"`
}

func (*InstanceUpdateResponsePublicEndpointParamsMcp) UnmarshalJSON

func (r *InstanceUpdateResponsePublicEndpointParamsMcp) UnmarshalJSON(data []byte) (err error)

type InstanceUpdateResponsePublicEndpointParamsRateLimit

type InstanceUpdateResponsePublicEndpointParamsRateLimit struct {
	PeriodMs  int64                                                        `json:"period_ms"`
	Requests  int64                                                        `json:"requests"`
	Technique InstanceUpdateResponsePublicEndpointParamsRateLimitTechnique `json:"technique"`
	JSON      instanceUpdateResponsePublicEndpointParamsRateLimitJSON      `json:"-"`
}

func (*InstanceUpdateResponsePublicEndpointParamsRateLimit) UnmarshalJSON

func (r *InstanceUpdateResponsePublicEndpointParamsRateLimit) UnmarshalJSON(data []byte) (err error)

type InstanceUpdateResponsePublicEndpointParamsRateLimitTechnique

type InstanceUpdateResponsePublicEndpointParamsRateLimitTechnique string
const (
	InstanceUpdateResponsePublicEndpointParamsRateLimitTechniqueFixed   InstanceUpdateResponsePublicEndpointParamsRateLimitTechnique = "fixed"
	InstanceUpdateResponsePublicEndpointParamsRateLimitTechniqueSliding InstanceUpdateResponsePublicEndpointParamsRateLimitTechnique = "sliding"
)

func (InstanceUpdateResponsePublicEndpointParamsRateLimitTechnique) IsKnown

type InstanceUpdateResponsePublicEndpointParamsSearchEndpoint

type InstanceUpdateResponsePublicEndpointParamsSearchEndpoint struct {
	// Disable search endpoint for this public endpoint
	Disabled bool                                                         `json:"disabled"`
	JSON     instanceUpdateResponsePublicEndpointParamsSearchEndpointJSON `json:"-"`
}

func (*InstanceUpdateResponsePublicEndpointParamsSearchEndpoint) UnmarshalJSON

type InstanceUpdateResponseRerankingModel

type InstanceUpdateResponseRerankingModel string
const (
	InstanceUpdateResponseRerankingModelCfBaaiBgeRerankerBase InstanceUpdateResponseRerankingModel = "@cf/baai/bge-reranker-base"
	InstanceUpdateResponseRerankingModelEmpty                 InstanceUpdateResponseRerankingModel = ""
)

func (InstanceUpdateResponseRerankingModel) IsKnown

type InstanceUpdateResponseRetrievalOptions

type InstanceUpdateResponseRetrievalOptions struct {
	// Metadata fields to boost search results by. Each entry specifies a metadata
	// field and an optional direction. Direction defaults to 'asc' for
	// numeric/datetime fields and 'exists' for text/boolean fields. Fields must match
	// 'timestamp' or a defined custom_metadata field.
	BoostBy []InstanceUpdateResponseRetrievalOptionsBoostBy `json:"boost_by"`
	// 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'.
	KeywordMatchMode InstanceUpdateResponseRetrievalOptionsKeywordMatchMode `json:"keyword_match_mode"`
	JSON             instanceUpdateResponseRetrievalOptionsJSON             `json:"-"`
}

func (*InstanceUpdateResponseRetrievalOptions) UnmarshalJSON

func (r *InstanceUpdateResponseRetrievalOptions) UnmarshalJSON(data []byte) (err error)

type InstanceUpdateResponseRetrievalOptionsBoostBy

type InstanceUpdateResponseRetrievalOptionsBoostBy struct {
	// 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.
	Field string `json:"field" api:"required"`
	// 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.
	Direction InstanceUpdateResponseRetrievalOptionsBoostByDirection `json:"direction"`
	JSON      instanceUpdateResponseRetrievalOptionsBoostByJSON      `json:"-"`
}

func (*InstanceUpdateResponseRetrievalOptionsBoostBy) UnmarshalJSON

func (r *InstanceUpdateResponseRetrievalOptionsBoostBy) UnmarshalJSON(data []byte) (err error)

type InstanceUpdateResponseRetrievalOptionsBoostByDirection

type InstanceUpdateResponseRetrievalOptionsBoostByDirection string

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.

const (
	InstanceUpdateResponseRetrievalOptionsBoostByDirectionAsc       InstanceUpdateResponseRetrievalOptionsBoostByDirection = "asc"
	InstanceUpdateResponseRetrievalOptionsBoostByDirectionDesc      InstanceUpdateResponseRetrievalOptionsBoostByDirection = "desc"
	InstanceUpdateResponseRetrievalOptionsBoostByDirectionExists    InstanceUpdateResponseRetrievalOptionsBoostByDirection = "exists"
	InstanceUpdateResponseRetrievalOptionsBoostByDirectionNotExists InstanceUpdateResponseRetrievalOptionsBoostByDirection = "not_exists"
)

func (InstanceUpdateResponseRetrievalOptionsBoostByDirection) IsKnown

type InstanceUpdateResponseRetrievalOptionsKeywordMatchMode

type InstanceUpdateResponseRetrievalOptionsKeywordMatchMode string

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'.

const (
	InstanceUpdateResponseRetrievalOptionsKeywordMatchModeAnd InstanceUpdateResponseRetrievalOptionsKeywordMatchMode = "and"
	InstanceUpdateResponseRetrievalOptionsKeywordMatchModeOr  InstanceUpdateResponseRetrievalOptionsKeywordMatchMode = "or"
)

func (InstanceUpdateResponseRetrievalOptionsKeywordMatchMode) IsKnown

type InstanceUpdateResponseRewriteModel

type InstanceUpdateResponseRewriteModel string
const (
	InstanceUpdateResponseRewriteModelCfMetaLlama3_3_70bInstructFp8Fast     InstanceUpdateResponseRewriteModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	InstanceUpdateResponseRewriteModelCfZaiOrgGlm4_7Flash                   InstanceUpdateResponseRewriteModel = "@cf/zai-org/glm-4.7-flash"
	InstanceUpdateResponseRewriteModelCfMetaLlama3_1_8bInstructFast         InstanceUpdateResponseRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	InstanceUpdateResponseRewriteModelCfMetaLlama3_1_8bInstructFp8          InstanceUpdateResponseRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	InstanceUpdateResponseRewriteModelCfMetaLlama4Scout17b16eInstruct       InstanceUpdateResponseRewriteModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	InstanceUpdateResponseRewriteModelCfQwenQwen3_30bA3bFp8                 InstanceUpdateResponseRewriteModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	InstanceUpdateResponseRewriteModelCfDeepseekAIDeepseekR1DistillQwen32b  InstanceUpdateResponseRewriteModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	InstanceUpdateResponseRewriteModelCfMoonshotaiKimiK2Instruct            InstanceUpdateResponseRewriteModel = "@cf/moonshotai/kimi-k2-instruct"
	InstanceUpdateResponseRewriteModelCfGoogleGemma3_12bIt                  InstanceUpdateResponseRewriteModel = "@cf/google/gemma-3-12b-it"
	InstanceUpdateResponseRewriteModelCfGoogleGemma4_26bA4bIt               InstanceUpdateResponseRewriteModel = "@cf/google/gemma-4-26b-a4b-it"
	InstanceUpdateResponseRewriteModelCfMoonshotaiKimiK2_5                  InstanceUpdateResponseRewriteModel = "@cf/moonshotai/kimi-k2.5"
	InstanceUpdateResponseRewriteModelAnthropicClaude3_7Sonnet              InstanceUpdateResponseRewriteModel = "anthropic/claude-3-7-sonnet"
	InstanceUpdateResponseRewriteModelAnthropicClaudeSonnet4                InstanceUpdateResponseRewriteModel = "anthropic/claude-sonnet-4"
	InstanceUpdateResponseRewriteModelAnthropicClaudeOpus4                  InstanceUpdateResponseRewriteModel = "anthropic/claude-opus-4"
	InstanceUpdateResponseRewriteModelAnthropicClaude3_5Haiku               InstanceUpdateResponseRewriteModel = "anthropic/claude-3-5-haiku"
	InstanceUpdateResponseRewriteModelCerebrasQwen3_235bA22bInstruct        InstanceUpdateResponseRewriteModel = "cerebras/qwen-3-235b-a22b-instruct"
	InstanceUpdateResponseRewriteModelCerebrasQwen3_235bA22bThinking        InstanceUpdateResponseRewriteModel = "cerebras/qwen-3-235b-a22b-thinking"
	InstanceUpdateResponseRewriteModelCerebrasLlama3_3_70b                  InstanceUpdateResponseRewriteModel = "cerebras/llama-3.3-70b"
	InstanceUpdateResponseRewriteModelCerebrasLlama4Maverick17b128eInstruct InstanceUpdateResponseRewriteModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	InstanceUpdateResponseRewriteModelCerebrasLlama4Scout17b16eInstruct     InstanceUpdateResponseRewriteModel = "cerebras/llama-4-scout-17b-16e-instruct"
	InstanceUpdateResponseRewriteModelCerebrasGptOSs120b                    InstanceUpdateResponseRewriteModel = "cerebras/gpt-oss-120b"
	InstanceUpdateResponseRewriteModelGoogleAIStudioGemini2_5Flash          InstanceUpdateResponseRewriteModel = "google-ai-studio/gemini-2.5-flash"
	InstanceUpdateResponseRewriteModelGoogleAIStudioGemini2_5Pro            InstanceUpdateResponseRewriteModel = "google-ai-studio/gemini-2.5-pro"
	InstanceUpdateResponseRewriteModelGrokGrok4                             InstanceUpdateResponseRewriteModel = "grok/grok-4"
	InstanceUpdateResponseRewriteModelGroqLlama3_3_70bVersatile             InstanceUpdateResponseRewriteModel = "groq/llama-3.3-70b-versatile"
	InstanceUpdateResponseRewriteModelGroqLlama3_1_8bInstant                InstanceUpdateResponseRewriteModel = "groq/llama-3.1-8b-instant"
	InstanceUpdateResponseRewriteModelOpenAIGpt5                            InstanceUpdateResponseRewriteModel = "openai/gpt-5"
	InstanceUpdateResponseRewriteModelOpenAIGpt5Mini                        InstanceUpdateResponseRewriteModel = "openai/gpt-5-mini"
	InstanceUpdateResponseRewriteModelOpenAIGpt5Nano                        InstanceUpdateResponseRewriteModel = "openai/gpt-5-nano"
	InstanceUpdateResponseRewriteModelEmpty                                 InstanceUpdateResponseRewriteModel = ""
)

func (InstanceUpdateResponseRewriteModel) IsKnown

type InstanceUpdateResponseSourceParams

type InstanceUpdateResponseSourceParams struct {
	// List of path patterns to exclude. Uses micromatch glob syntax: \* matches within
	// a path segment, ** matches across path segments (e.g., /admin/** matches
	// /admin/users and /admin/settings/advanced)
	ExcludeItems []string `json:"exclude_items"`
	// List of path patterns to include. Uses micromatch glob syntax: \* matches within
	// a path segment, ** matches across path segments (e.g., /blog/** matches
	// /blog/post and /blog/2024/post)
	IncludeItems   []string                                     `json:"include_items"`
	Prefix         string                                       `json:"prefix"`
	R2Jurisdiction string                                       `json:"r2_jurisdiction"`
	WebCrawler     InstanceUpdateResponseSourceParamsWebCrawler `json:"web_crawler"`
	JSON           instanceUpdateResponseSourceParamsJSON       `json:"-"`
}

func (*InstanceUpdateResponseSourceParams) UnmarshalJSON

func (r *InstanceUpdateResponseSourceParams) UnmarshalJSON(data []byte) (err error)

type InstanceUpdateResponseSourceParamsWebCrawler

type InstanceUpdateResponseSourceParamsWebCrawler struct {
	CrawlOptions InstanceUpdateResponseSourceParamsWebCrawlerCrawlOptions `json:"crawl_options"`
	ParseOptions InstanceUpdateResponseSourceParamsWebCrawlerParseOptions `json:"parse_options"`
	ParseType    InstanceUpdateResponseSourceParamsWebCrawlerParseType    `json:"parse_type"`
	StoreOptions InstanceUpdateResponseSourceParamsWebCrawlerStoreOptions `json:"store_options"`
	JSON         instanceUpdateResponseSourceParamsWebCrawlerJSON         `json:"-"`
}

func (*InstanceUpdateResponseSourceParamsWebCrawler) UnmarshalJSON

func (r *InstanceUpdateResponseSourceParamsWebCrawler) UnmarshalJSON(data []byte) (err error)

type InstanceUpdateResponseSourceParamsWebCrawlerCrawlOptions

type InstanceUpdateResponseSourceParamsWebCrawlerCrawlOptions struct {
	Depth                float64                                                        `json:"depth"`
	IncludeExternalLinks bool                                                           `json:"include_external_links"`
	IncludeSubdomains    bool                                                           `json:"include_subdomains"`
	MaxAge               float64                                                        `json:"max_age"`
	Source               InstanceUpdateResponseSourceParamsWebCrawlerCrawlOptionsSource `json:"source"`
	JSON                 instanceUpdateResponseSourceParamsWebCrawlerCrawlOptionsJSON   `json:"-"`
}

func (*InstanceUpdateResponseSourceParamsWebCrawlerCrawlOptions) UnmarshalJSON

type InstanceUpdateResponseSourceParamsWebCrawlerCrawlOptionsSource

type InstanceUpdateResponseSourceParamsWebCrawlerCrawlOptionsSource string
const (
	InstanceUpdateResponseSourceParamsWebCrawlerCrawlOptionsSourceAll      InstanceUpdateResponseSourceParamsWebCrawlerCrawlOptionsSource = "all"
	InstanceUpdateResponseSourceParamsWebCrawlerCrawlOptionsSourceSitemaps InstanceUpdateResponseSourceParamsWebCrawlerCrawlOptionsSource = "sitemaps"
	InstanceUpdateResponseSourceParamsWebCrawlerCrawlOptionsSourceLinks    InstanceUpdateResponseSourceParamsWebCrawlerCrawlOptionsSource = "links"
)

func (InstanceUpdateResponseSourceParamsWebCrawlerCrawlOptionsSource) IsKnown

type InstanceUpdateResponseSourceParamsWebCrawlerParseOptions

type InstanceUpdateResponseSourceParamsWebCrawlerParseOptions struct {
	// List of path-to-selector mappings for extracting specific content from crawled
	// pages. Each entry pairs a URL glob pattern with a CSS selector. The first
	// matching path wins. Only the matched HTML fragment is stored and indexed. Omit
	// the field to disable content selection — empty arrays are rejected.
	ContentSelector []InstanceUpdateResponseSourceParamsWebCrawlerParseOptionsContentSelector `json:"content_selector"`
	// Up to 5 custom HTTP headers sent with each crawl request. Names must be RFC-7230
	// token characters (no spaces, colons, or control characters); values must be
	// HTAB + printable ASCII (no CR/LF).
	IncludeHeaders map[string]string `json:"include_headers"`
	IncludeImages  bool              `json:"include_images"`
	// List of specific sitemap URLs to use for crawling. Only valid when parse_type is
	// 'sitemap'.
	SpecificSitemaps    []string                                                     `json:"specific_sitemaps" format:"uri"`
	UseBrowserRendering bool                                                         `json:"use_browser_rendering"`
	JSON                instanceUpdateResponseSourceParamsWebCrawlerParseOptionsJSON `json:"-"`
}

func (*InstanceUpdateResponseSourceParamsWebCrawlerParseOptions) UnmarshalJSON

type InstanceUpdateResponseSourceParamsWebCrawlerParseOptionsContentSelector

type InstanceUpdateResponseSourceParamsWebCrawlerParseOptionsContentSelector struct {
	// Glob pattern to match against the page URL path. Uses standard glob syntax: \*
	// matches within a segment, \*\* crosses directories.
	Path string `json:"path" api:"required"`
	// CSS selector to extract content from pages matching the path pattern. Must not
	// contain disallowed characters (;, `, $, {, }, \). Must target a single element;
	// if multiple elements match, the selector is ignored and the full page is used.
	Selector string                                                                      `json:"selector" api:"required"`
	JSON     instanceUpdateResponseSourceParamsWebCrawlerParseOptionsContentSelectorJSON `json:"-"`
}

func (*InstanceUpdateResponseSourceParamsWebCrawlerParseOptionsContentSelector) UnmarshalJSON

type InstanceUpdateResponseSourceParamsWebCrawlerParseType

type InstanceUpdateResponseSourceParamsWebCrawlerParseType string
const (
	InstanceUpdateResponseSourceParamsWebCrawlerParseTypeSitemap InstanceUpdateResponseSourceParamsWebCrawlerParseType = "sitemap"
	InstanceUpdateResponseSourceParamsWebCrawlerParseTypeFeedRss InstanceUpdateResponseSourceParamsWebCrawlerParseType = "feed-rss"
	InstanceUpdateResponseSourceParamsWebCrawlerParseTypeCrawl   InstanceUpdateResponseSourceParamsWebCrawlerParseType = "crawl"
)

func (InstanceUpdateResponseSourceParamsWebCrawlerParseType) IsKnown

type InstanceUpdateResponseSourceParamsWebCrawlerStoreOptions

type InstanceUpdateResponseSourceParamsWebCrawlerStoreOptions struct {
	StorageID      string                                                       `json:"storage_id" api:"required"`
	R2Jurisdiction string                                                       `json:"r2_jurisdiction"`
	StorageType    r2.Provider                                                  `json:"storage_type"`
	JSON           instanceUpdateResponseSourceParamsWebCrawlerStoreOptionsJSON `json:"-"`
}

func (*InstanceUpdateResponseSourceParamsWebCrawlerStoreOptions) UnmarshalJSON

type InstanceUpdateResponseSyncInterval

type InstanceUpdateResponseSyncInterval float64

Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).

const (
	InstanceUpdateResponseSyncInterval900   InstanceUpdateResponseSyncInterval = 900
	InstanceUpdateResponseSyncInterval1800  InstanceUpdateResponseSyncInterval = 1800
	InstanceUpdateResponseSyncInterval3600  InstanceUpdateResponseSyncInterval = 3600
	InstanceUpdateResponseSyncInterval7200  InstanceUpdateResponseSyncInterval = 7200
	InstanceUpdateResponseSyncInterval14400 InstanceUpdateResponseSyncInterval = 14400
	InstanceUpdateResponseSyncInterval21600 InstanceUpdateResponseSyncInterval = 21600
	InstanceUpdateResponseSyncInterval43200 InstanceUpdateResponseSyncInterval = 43200
	InstanceUpdateResponseSyncInterval86400 InstanceUpdateResponseSyncInterval = 86400
)

func (InstanceUpdateResponseSyncInterval) IsKnown

type InstanceUpdateResponseType

type InstanceUpdateResponseType string
const (
	InstanceUpdateResponseTypeR2         InstanceUpdateResponseType = "r2"
	InstanceUpdateResponseTypeWebCrawler InstanceUpdateResponseType = "web-crawler"
)

func (InstanceUpdateResponseType) IsKnown

func (r InstanceUpdateResponseType) IsKnown() bool

type Member

type Member = shared.Member

This is an alias to an internal type.

type MemberPoliciesAccess

type MemberPoliciesAccess = shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroup

type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroupsMeta

type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type MemberPoliciesResourceGroup

type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsMeta

type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScope

type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope

A scope is a combination of scope objects which provides additional context.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScopeObject

type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject

A scope object represents any resource that can have actions applied against invite.

This is an alias to an internal type.

type MemberPolicy

type MemberPolicy = shared.MemberPolicy

This is an alias to an internal type.

type MemberStatus

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUser

type MemberUser = shared.MemberUser

Details of the user associated to the membership.

This is an alias to an internal type.

type NamespaceChatCompletionsParams

type NamespaceChatCompletionsParams struct {
	AccountID       param.Field[string]                                        `path:"account_id" api:"required"`
	AISearchOptions param.Field[NamespaceChatCompletionsParamsAISearchOptions] `json:"ai_search_options" api:"required"`
	Messages        param.Field[[]NamespaceChatCompletionsParamsMessage]       `json:"messages" api:"required"`
	Model           param.Field[NamespaceChatCompletionsParamsModel]           `json:"model"`
	Stream          param.Field[bool]                                          `json:"stream"`
}

func (NamespaceChatCompletionsParams) MarshalJSON

func (r NamespaceChatCompletionsParams) MarshalJSON() (data []byte, err error)

type NamespaceChatCompletionsParamsAISearchOptions

type NamespaceChatCompletionsParamsAISearchOptions struct {
	InstanceIDs  param.Field[[]string]                                                  `json:"instance_ids" api:"required"`
	Cache        param.Field[NamespaceChatCompletionsParamsAISearchOptionsCache]        `json:"cache"`
	QueryRewrite param.Field[NamespaceChatCompletionsParamsAISearchOptionsQueryRewrite] `json:"query_rewrite"`
	Reranking    param.Field[NamespaceChatCompletionsParamsAISearchOptionsReranking]    `json:"reranking"`
	Retrieval    param.Field[NamespaceChatCompletionsParamsAISearchOptionsRetrieval]    `json:"retrieval"`
}

func (NamespaceChatCompletionsParamsAISearchOptions) MarshalJSON

func (r NamespaceChatCompletionsParamsAISearchOptions) MarshalJSON() (data []byte, err error)

type NamespaceChatCompletionsParamsAISearchOptionsCache

type NamespaceChatCompletionsParamsAISearchOptionsCache struct {
	CacheThreshold param.Field[NamespaceChatCompletionsParamsAISearchOptionsCacheCacheThreshold] `json:"cache_threshold"`
	Enabled        param.Field[bool]                                                             `json:"enabled"`
}

func (NamespaceChatCompletionsParamsAISearchOptionsCache) MarshalJSON

func (r NamespaceChatCompletionsParamsAISearchOptionsCache) MarshalJSON() (data []byte, err error)

type NamespaceChatCompletionsParamsAISearchOptionsCacheCacheThreshold

type NamespaceChatCompletionsParamsAISearchOptionsCacheCacheThreshold string
const (
	NamespaceChatCompletionsParamsAISearchOptionsCacheCacheThresholdSuperStrictMatch NamespaceChatCompletionsParamsAISearchOptionsCacheCacheThreshold = "super_strict_match"
	NamespaceChatCompletionsParamsAISearchOptionsCacheCacheThresholdCloseEnough      NamespaceChatCompletionsParamsAISearchOptionsCacheCacheThreshold = "close_enough"
	NamespaceChatCompletionsParamsAISearchOptionsCacheCacheThresholdFlexibleFriend   NamespaceChatCompletionsParamsAISearchOptionsCacheCacheThreshold = "flexible_friend"
	NamespaceChatCompletionsParamsAISearchOptionsCacheCacheThresholdAnythingGoes     NamespaceChatCompletionsParamsAISearchOptionsCacheCacheThreshold = "anything_goes"
)

func (NamespaceChatCompletionsParamsAISearchOptionsCacheCacheThreshold) IsKnown

type NamespaceChatCompletionsParamsAISearchOptionsQueryRewrite

type NamespaceChatCompletionsParamsAISearchOptionsQueryRewrite struct {
	Enabled       param.Field[bool]                                                           `json:"enabled"`
	Model         param.Field[NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel] `json:"model"`
	RewritePrompt param.Field[string]                                                         `json:"rewrite_prompt"`
}

func (NamespaceChatCompletionsParamsAISearchOptionsQueryRewrite) MarshalJSON

type NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel

type NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel string
const (
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfMetaLlama3_3_70bInstructFp8Fast     NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfZaiOrgGlm4_7Flash                   NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/zai-org/glm-4.7-flash"
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfMetaLlama3_1_8bInstructFast         NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfMetaLlama3_1_8bInstructFp8          NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfMetaLlama4Scout17b16eInstruct       NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfQwenQwen3_30bA3bFp8                 NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfDeepseekAIDeepseekR1DistillQwen32b  NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfMoonshotaiKimiK2Instruct            NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/moonshotai/kimi-k2-instruct"
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfGoogleGemma3_12bIt                  NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/google/gemma-3-12b-it"
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfGoogleGemma4_26bA4bIt               NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/google/gemma-4-26b-a4b-it"
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfMoonshotaiKimiK2_5                  NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/moonshotai/kimi-k2.5"
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelAnthropicClaude3_7Sonnet              NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "anthropic/claude-3-7-sonnet"
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelAnthropicClaudeSonnet4                NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "anthropic/claude-sonnet-4"
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelAnthropicClaudeOpus4                  NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "anthropic/claude-opus-4"
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelAnthropicClaude3_5Haiku               NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "anthropic/claude-3-5-haiku"
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelCerebrasQwen3_235bA22bInstruct        NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "cerebras/qwen-3-235b-a22b-instruct"
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelCerebrasQwen3_235bA22bThinking        NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "cerebras/qwen-3-235b-a22b-thinking"
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelCerebrasLlama3_3_70b                  NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "cerebras/llama-3.3-70b"
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelCerebrasLlama4Maverick17b128eInstruct NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelCerebrasLlama4Scout17b16eInstruct     NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "cerebras/llama-4-scout-17b-16e-instruct"
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelCerebrasGptOSs120b                    NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "cerebras/gpt-oss-120b"
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelGoogleAIStudioGemini2_5Flash          NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "google-ai-studio/gemini-2.5-flash"
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelGoogleAIStudioGemini2_5Pro            NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "google-ai-studio/gemini-2.5-pro"
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelGrokGrok4                             NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "grok/grok-4"
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelGroqLlama3_3_70bVersatile             NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "groq/llama-3.3-70b-versatile"
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelGroqLlama3_1_8bInstant                NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "groq/llama-3.1-8b-instant"
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelOpenAIGpt5                            NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "openai/gpt-5"
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelOpenAIGpt5Mini                        NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "openai/gpt-5-mini"
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelOpenAIGpt5Nano                        NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "openai/gpt-5-nano"
	NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModelEmpty                                 NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel = ""
)

func (NamespaceChatCompletionsParamsAISearchOptionsQueryRewriteModel) IsKnown

type NamespaceChatCompletionsParamsAISearchOptionsReranking

type NamespaceChatCompletionsParamsAISearchOptionsReranking struct {
	Enabled        param.Field[bool]                                                        `json:"enabled"`
	MatchThreshold param.Field[float64]                                                     `json:"match_threshold"`
	Model          param.Field[NamespaceChatCompletionsParamsAISearchOptionsRerankingModel] `json:"model"`
}

func (NamespaceChatCompletionsParamsAISearchOptionsReranking) MarshalJSON

type NamespaceChatCompletionsParamsAISearchOptionsRerankingModel

type NamespaceChatCompletionsParamsAISearchOptionsRerankingModel string
const (
	NamespaceChatCompletionsParamsAISearchOptionsRerankingModelCfBaaiBgeRerankerBase NamespaceChatCompletionsParamsAISearchOptionsRerankingModel = "@cf/baai/bge-reranker-base"
	NamespaceChatCompletionsParamsAISearchOptionsRerankingModelEmpty                 NamespaceChatCompletionsParamsAISearchOptionsRerankingModel = ""
)

func (NamespaceChatCompletionsParamsAISearchOptionsRerankingModel) IsKnown

type NamespaceChatCompletionsParamsAISearchOptionsRetrieval

type NamespaceChatCompletionsParamsAISearchOptionsRetrieval struct {
	// 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.
	BoostBy          param.Field[[]NamespaceChatCompletionsParamsAISearchOptionsRetrievalBoostBy]    `json:"boost_by"`
	ContextExpansion param.Field[int64]                                                              `json:"context_expansion"`
	Filters          param.Field[map[string]interface{}]                                             `json:"filters"`
	FusionMethod     param.Field[NamespaceChatCompletionsParamsAISearchOptionsRetrievalFusionMethod] `json:"fusion_method"`
	// 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'.
	KeywordMatchMode param.Field[NamespaceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchMode] `json:"keyword_match_mode"`
	MatchThreshold   param.Field[float64]                                                                `json:"match_threshold"`
	MaxNumResults    param.Field[int64]                                                                  `json:"max_num_results"`
	RetrievalType    param.Field[NamespaceChatCompletionsParamsAISearchOptionsRetrievalRetrievalType]    `json:"retrieval_type"`
	ReturnOnFailure  param.Field[bool]                                                                   `json:"return_on_failure"`
}

func (NamespaceChatCompletionsParamsAISearchOptionsRetrieval) MarshalJSON

type NamespaceChatCompletionsParamsAISearchOptionsRetrievalBoostBy

type NamespaceChatCompletionsParamsAISearchOptionsRetrievalBoostBy struct {
	// 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.
	Field param.Field[string] `json:"field" api:"required"`
	// 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.
	Direction param.Field[NamespaceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection] `json:"direction"`
}

func (NamespaceChatCompletionsParamsAISearchOptionsRetrievalBoostBy) MarshalJSON

type NamespaceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection

type NamespaceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection string

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.

const (
	NamespaceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirectionAsc       NamespaceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection = "asc"
	NamespaceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirectionDesc      NamespaceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection = "desc"
	NamespaceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirectionExists    NamespaceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection = "exists"
	NamespaceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirectionNotExists NamespaceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection = "not_exists"
)

func (NamespaceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection) IsKnown

type NamespaceChatCompletionsParamsAISearchOptionsRetrievalFusionMethod

type NamespaceChatCompletionsParamsAISearchOptionsRetrievalFusionMethod string
const (
	NamespaceChatCompletionsParamsAISearchOptionsRetrievalFusionMethodMax NamespaceChatCompletionsParamsAISearchOptionsRetrievalFusionMethod = "max"
	NamespaceChatCompletionsParamsAISearchOptionsRetrievalFusionMethodRrf NamespaceChatCompletionsParamsAISearchOptionsRetrievalFusionMethod = "rrf"
)

func (NamespaceChatCompletionsParamsAISearchOptionsRetrievalFusionMethod) IsKnown

type NamespaceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchMode

type NamespaceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchMode string

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'.

const (
	NamespaceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchModeAnd NamespaceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchMode = "and"
	NamespaceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchModeOr  NamespaceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchMode = "or"
)

func (NamespaceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchMode) IsKnown

type NamespaceChatCompletionsParamsAISearchOptionsRetrievalRetrievalType

type NamespaceChatCompletionsParamsAISearchOptionsRetrievalRetrievalType string
const (
	NamespaceChatCompletionsParamsAISearchOptionsRetrievalRetrievalTypeVector  NamespaceChatCompletionsParamsAISearchOptionsRetrievalRetrievalType = "vector"
	NamespaceChatCompletionsParamsAISearchOptionsRetrievalRetrievalTypeKeyword NamespaceChatCompletionsParamsAISearchOptionsRetrievalRetrievalType = "keyword"
	NamespaceChatCompletionsParamsAISearchOptionsRetrievalRetrievalTypeHybrid  NamespaceChatCompletionsParamsAISearchOptionsRetrievalRetrievalType = "hybrid"
)

func (NamespaceChatCompletionsParamsAISearchOptionsRetrievalRetrievalType) IsKnown

type NamespaceChatCompletionsParamsMessage

type NamespaceChatCompletionsParamsMessage struct {
	Content     param.Field[string]                                     `json:"content" api:"required"`
	Role        param.Field[NamespaceChatCompletionsParamsMessagesRole] `json:"role" api:"required"`
	ExtraFields map[string]interface{}                                  `json:"-,extras"`
}

func (NamespaceChatCompletionsParamsMessage) MarshalJSON

func (r NamespaceChatCompletionsParamsMessage) MarshalJSON() (data []byte, err error)

type NamespaceChatCompletionsParamsMessagesRole

type NamespaceChatCompletionsParamsMessagesRole string
const (
	NamespaceChatCompletionsParamsMessagesRoleSystem    NamespaceChatCompletionsParamsMessagesRole = "system"
	NamespaceChatCompletionsParamsMessagesRoleDeveloper NamespaceChatCompletionsParamsMessagesRole = "developer"
	NamespaceChatCompletionsParamsMessagesRoleUser      NamespaceChatCompletionsParamsMessagesRole = "user"
	NamespaceChatCompletionsParamsMessagesRoleAssistant NamespaceChatCompletionsParamsMessagesRole = "assistant"
	NamespaceChatCompletionsParamsMessagesRoleTool      NamespaceChatCompletionsParamsMessagesRole = "tool"
)

func (NamespaceChatCompletionsParamsMessagesRole) IsKnown

type NamespaceChatCompletionsParamsModel

type NamespaceChatCompletionsParamsModel string
const (
	NamespaceChatCompletionsParamsModelCfMetaLlama3_3_70bInstructFp8Fast     NamespaceChatCompletionsParamsModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	NamespaceChatCompletionsParamsModelCfZaiOrgGlm4_7Flash                   NamespaceChatCompletionsParamsModel = "@cf/zai-org/glm-4.7-flash"
	NamespaceChatCompletionsParamsModelCfMetaLlama3_1_8bInstructFast         NamespaceChatCompletionsParamsModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	NamespaceChatCompletionsParamsModelCfMetaLlama3_1_8bInstructFp8          NamespaceChatCompletionsParamsModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	NamespaceChatCompletionsParamsModelCfMetaLlama4Scout17b16eInstruct       NamespaceChatCompletionsParamsModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	NamespaceChatCompletionsParamsModelCfQwenQwen3_30bA3bFp8                 NamespaceChatCompletionsParamsModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	NamespaceChatCompletionsParamsModelCfDeepseekAIDeepseekR1DistillQwen32b  NamespaceChatCompletionsParamsModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	NamespaceChatCompletionsParamsModelCfMoonshotaiKimiK2Instruct            NamespaceChatCompletionsParamsModel = "@cf/moonshotai/kimi-k2-instruct"
	NamespaceChatCompletionsParamsModelCfGoogleGemma3_12bIt                  NamespaceChatCompletionsParamsModel = "@cf/google/gemma-3-12b-it"
	NamespaceChatCompletionsParamsModelCfGoogleGemma4_26bA4bIt               NamespaceChatCompletionsParamsModel = "@cf/google/gemma-4-26b-a4b-it"
	NamespaceChatCompletionsParamsModelCfMoonshotaiKimiK2_5                  NamespaceChatCompletionsParamsModel = "@cf/moonshotai/kimi-k2.5"
	NamespaceChatCompletionsParamsModelAnthropicClaude3_7Sonnet              NamespaceChatCompletionsParamsModel = "anthropic/claude-3-7-sonnet"
	NamespaceChatCompletionsParamsModelAnthropicClaudeSonnet4                NamespaceChatCompletionsParamsModel = "anthropic/claude-sonnet-4"
	NamespaceChatCompletionsParamsModelAnthropicClaudeOpus4                  NamespaceChatCompletionsParamsModel = "anthropic/claude-opus-4"
	NamespaceChatCompletionsParamsModelAnthropicClaude3_5Haiku               NamespaceChatCompletionsParamsModel = "anthropic/claude-3-5-haiku"
	NamespaceChatCompletionsParamsModelCerebrasQwen3_235bA22bInstruct        NamespaceChatCompletionsParamsModel = "cerebras/qwen-3-235b-a22b-instruct"
	NamespaceChatCompletionsParamsModelCerebrasQwen3_235bA22bThinking        NamespaceChatCompletionsParamsModel = "cerebras/qwen-3-235b-a22b-thinking"
	NamespaceChatCompletionsParamsModelCerebrasLlama3_3_70b                  NamespaceChatCompletionsParamsModel = "cerebras/llama-3.3-70b"
	NamespaceChatCompletionsParamsModelCerebrasLlama4Maverick17b128eInstruct NamespaceChatCompletionsParamsModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	NamespaceChatCompletionsParamsModelCerebrasLlama4Scout17b16eInstruct     NamespaceChatCompletionsParamsModel = "cerebras/llama-4-scout-17b-16e-instruct"
	NamespaceChatCompletionsParamsModelCerebrasGptOSs120b                    NamespaceChatCompletionsParamsModel = "cerebras/gpt-oss-120b"
	NamespaceChatCompletionsParamsModelGoogleAIStudioGemini2_5Flash          NamespaceChatCompletionsParamsModel = "google-ai-studio/gemini-2.5-flash"
	NamespaceChatCompletionsParamsModelGoogleAIStudioGemini2_5Pro            NamespaceChatCompletionsParamsModel = "google-ai-studio/gemini-2.5-pro"
	NamespaceChatCompletionsParamsModelGrokGrok4                             NamespaceChatCompletionsParamsModel = "grok/grok-4"
	NamespaceChatCompletionsParamsModelGroqLlama3_3_70bVersatile             NamespaceChatCompletionsParamsModel = "groq/llama-3.3-70b-versatile"
	NamespaceChatCompletionsParamsModelGroqLlama3_1_8bInstant                NamespaceChatCompletionsParamsModel = "groq/llama-3.1-8b-instant"
	NamespaceChatCompletionsParamsModelOpenAIGpt5                            NamespaceChatCompletionsParamsModel = "openai/gpt-5"
	NamespaceChatCompletionsParamsModelOpenAIGpt5Mini                        NamespaceChatCompletionsParamsModel = "openai/gpt-5-mini"
	NamespaceChatCompletionsParamsModelOpenAIGpt5Nano                        NamespaceChatCompletionsParamsModel = "openai/gpt-5-nano"
	NamespaceChatCompletionsParamsModelEmpty                                 NamespaceChatCompletionsParamsModel = ""
)

func (NamespaceChatCompletionsParamsModel) IsKnown

type NamespaceChatCompletionsResponse

type NamespaceChatCompletionsResponse struct {
	Choices     []NamespaceChatCompletionsResponseChoice `json:"choices" api:"required"`
	Chunks      []NamespaceChatCompletionsResponseChunk  `json:"chunks" api:"required"`
	ID          string                                   `json:"id"`
	Errors      []NamespaceChatCompletionsResponseError  `json:"errors"`
	Model       string                                   `json:"model"`
	Object      string                                   `json:"object"`
	ExtraFields map[string]interface{}                   `json:"-" api:"extrafields"`
	JSON        namespaceChatCompletionsResponseJSON     `json:"-"`
}

func (*NamespaceChatCompletionsResponse) UnmarshalJSON

func (r *NamespaceChatCompletionsResponse) UnmarshalJSON(data []byte) (err error)

type NamespaceChatCompletionsResponseChoice

type NamespaceChatCompletionsResponseChoice struct {
	Message NamespaceChatCompletionsResponseChoicesMessage `json:"message" api:"required"`
	Index   int64                                          `json:"index"`
	JSON    namespaceChatCompletionsResponseChoiceJSON     `json:"-"`
}

func (*NamespaceChatCompletionsResponseChoice) UnmarshalJSON

func (r *NamespaceChatCompletionsResponseChoice) UnmarshalJSON(data []byte) (err error)

type NamespaceChatCompletionsResponseChoicesMessage

type NamespaceChatCompletionsResponseChoicesMessage struct {
	Content     string                                             `json:"content" api:"required,nullable"`
	Role        NamespaceChatCompletionsResponseChoicesMessageRole `json:"role" api:"required"`
	ExtraFields map[string]interface{}                             `json:"-" api:"extrafields"`
	JSON        namespaceChatCompletionsResponseChoicesMessageJSON `json:"-"`
}

func (*NamespaceChatCompletionsResponseChoicesMessage) UnmarshalJSON

func (r *NamespaceChatCompletionsResponseChoicesMessage) UnmarshalJSON(data []byte) (err error)

type NamespaceChatCompletionsResponseChoicesMessageRole

type NamespaceChatCompletionsResponseChoicesMessageRole string
const (
	NamespaceChatCompletionsResponseChoicesMessageRoleSystem    NamespaceChatCompletionsResponseChoicesMessageRole = "system"
	NamespaceChatCompletionsResponseChoicesMessageRoleDeveloper NamespaceChatCompletionsResponseChoicesMessageRole = "developer"
	NamespaceChatCompletionsResponseChoicesMessageRoleUser      NamespaceChatCompletionsResponseChoicesMessageRole = "user"
	NamespaceChatCompletionsResponseChoicesMessageRoleAssistant NamespaceChatCompletionsResponseChoicesMessageRole = "assistant"
	NamespaceChatCompletionsResponseChoicesMessageRoleTool      NamespaceChatCompletionsResponseChoicesMessageRole = "tool"
)

func (NamespaceChatCompletionsResponseChoicesMessageRole) IsKnown

type NamespaceChatCompletionsResponseChunk

type NamespaceChatCompletionsResponseChunk struct {
	ID             string                                               `json:"id" api:"required"`
	InstanceID     string                                               `json:"instance_id" api:"required"`
	Score          float64                                              `json:"score" api:"required"`
	Text           string                                               `json:"text" api:"required"`
	Type           string                                               `json:"type" api:"required"`
	Item           NamespaceChatCompletionsResponseChunksItem           `json:"item"`
	ScoringDetails NamespaceChatCompletionsResponseChunksScoringDetails `json:"scoring_details"`
	JSON           namespaceChatCompletionsResponseChunkJSON            `json:"-"`
}

func (*NamespaceChatCompletionsResponseChunk) UnmarshalJSON

func (r *NamespaceChatCompletionsResponseChunk) UnmarshalJSON(data []byte) (err error)

type NamespaceChatCompletionsResponseChunksItem

type NamespaceChatCompletionsResponseChunksItem struct {
	Key       string                                         `json:"key" api:"required"`
	Metadata  map[string]interface{}                         `json:"metadata"`
	Timestamp float64                                        `json:"timestamp"`
	JSON      namespaceChatCompletionsResponseChunksItemJSON `json:"-"`
}

func (*NamespaceChatCompletionsResponseChunksItem) UnmarshalJSON

func (r *NamespaceChatCompletionsResponseChunksItem) UnmarshalJSON(data []byte) (err error)

type NamespaceChatCompletionsResponseChunksScoringDetails

type NamespaceChatCompletionsResponseChunksScoringDetails struct {
	FusionMethod   NamespaceChatCompletionsResponseChunksScoringDetailsFusionMethod `json:"fusion_method"`
	KeywordRank    float64                                                          `json:"keyword_rank"`
	KeywordScore   float64                                                          `json:"keyword_score"`
	RerankingScore float64                                                          `json:"reranking_score"`
	VectorRank     float64                                                          `json:"vector_rank"`
	VectorScore    float64                                                          `json:"vector_score"`
	JSON           namespaceChatCompletionsResponseChunksScoringDetailsJSON         `json:"-"`
}

func (*NamespaceChatCompletionsResponseChunksScoringDetails) UnmarshalJSON

func (r *NamespaceChatCompletionsResponseChunksScoringDetails) UnmarshalJSON(data []byte) (err error)

type NamespaceChatCompletionsResponseChunksScoringDetailsFusionMethod

type NamespaceChatCompletionsResponseChunksScoringDetailsFusionMethod string
const (
	NamespaceChatCompletionsResponseChunksScoringDetailsFusionMethodRrf NamespaceChatCompletionsResponseChunksScoringDetailsFusionMethod = "rrf"
	NamespaceChatCompletionsResponseChunksScoringDetailsFusionMethodMax NamespaceChatCompletionsResponseChunksScoringDetailsFusionMethod = "max"
)

func (NamespaceChatCompletionsResponseChunksScoringDetailsFusionMethod) IsKnown

type NamespaceChatCompletionsResponseError

type NamespaceChatCompletionsResponseError struct {
	InstanceID string                                    `json:"instance_id" api:"required"`
	Message    string                                    `json:"message" api:"required"`
	JSON       namespaceChatCompletionsResponseErrorJSON `json:"-"`
}

func (*NamespaceChatCompletionsResponseError) UnmarshalJSON

func (r *NamespaceChatCompletionsResponseError) UnmarshalJSON(data []byte) (err error)

type NamespaceDeleteParams

type NamespaceDeleteParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type NamespaceDeleteResponse

type NamespaceDeleteResponse = interface{}

type NamespaceDeleteResponseEnvelope

type NamespaceDeleteResponseEnvelope struct {
	Result  NamespaceDeleteResponse                `json:"result" api:"required"`
	Success NamespaceDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    namespaceDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*NamespaceDeleteResponseEnvelope) UnmarshalJSON

func (r *NamespaceDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NamespaceDeleteResponseEnvelopeSuccess

type NamespaceDeleteResponseEnvelopeSuccess bool
const (
	NamespaceDeleteResponseEnvelopeSuccessTrue NamespaceDeleteResponseEnvelopeSuccess = true
)

func (NamespaceDeleteResponseEnvelopeSuccess) IsKnown

type NamespaceInstanceChatCompletionsParams

type NamespaceInstanceChatCompletionsParams struct {
	AccountID       param.Field[string]                                                `path:"account_id" api:"required"`
	Messages        param.Field[[]NamespaceInstanceChatCompletionsParamsMessage]       `json:"messages" api:"required"`
	AISearchOptions param.Field[NamespaceInstanceChatCompletionsParamsAISearchOptions] `json:"ai_search_options"`
	Model           param.Field[NamespaceInstanceChatCompletionsParamsModel]           `json:"model"`
	Stream          param.Field[bool]                                                  `json:"stream"`
}

func (NamespaceInstanceChatCompletionsParams) MarshalJSON

func (r NamespaceInstanceChatCompletionsParams) MarshalJSON() (data []byte, err error)

type NamespaceInstanceChatCompletionsParamsAISearchOptions

type NamespaceInstanceChatCompletionsParamsAISearchOptions struct {
	Cache        param.Field[NamespaceInstanceChatCompletionsParamsAISearchOptionsCache]        `json:"cache"`
	QueryRewrite param.Field[NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewrite] `json:"query_rewrite"`
	Reranking    param.Field[NamespaceInstanceChatCompletionsParamsAISearchOptionsReranking]    `json:"reranking"`
	Retrieval    param.Field[NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrieval]    `json:"retrieval"`
}

func (NamespaceInstanceChatCompletionsParamsAISearchOptions) MarshalJSON

type NamespaceInstanceChatCompletionsParamsAISearchOptionsCache

type NamespaceInstanceChatCompletionsParamsAISearchOptionsCache struct {
	CacheThreshold param.Field[NamespaceInstanceChatCompletionsParamsAISearchOptionsCacheCacheThreshold] `json:"cache_threshold"`
	Enabled        param.Field[bool]                                                                     `json:"enabled"`
}

func (NamespaceInstanceChatCompletionsParamsAISearchOptionsCache) MarshalJSON

type NamespaceInstanceChatCompletionsParamsAISearchOptionsCacheCacheThreshold

type NamespaceInstanceChatCompletionsParamsAISearchOptionsCacheCacheThreshold string
const (
	NamespaceInstanceChatCompletionsParamsAISearchOptionsCacheCacheThresholdSuperStrictMatch NamespaceInstanceChatCompletionsParamsAISearchOptionsCacheCacheThreshold = "super_strict_match"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsCacheCacheThresholdCloseEnough      NamespaceInstanceChatCompletionsParamsAISearchOptionsCacheCacheThreshold = "close_enough"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsCacheCacheThresholdFlexibleFriend   NamespaceInstanceChatCompletionsParamsAISearchOptionsCacheCacheThreshold = "flexible_friend"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsCacheCacheThresholdAnythingGoes     NamespaceInstanceChatCompletionsParamsAISearchOptionsCacheCacheThreshold = "anything_goes"
)

func (NamespaceInstanceChatCompletionsParamsAISearchOptionsCacheCacheThreshold) IsKnown

type NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewrite

type NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewrite struct {
	Enabled       param.Field[bool]                                                                   `json:"enabled"`
	Model         param.Field[NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel] `json:"model"`
	RewritePrompt param.Field[string]                                                                 `json:"rewrite_prompt"`
}

func (NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewrite) MarshalJSON

type NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel

type NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel string
const (
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfMetaLlama3_3_70bInstructFp8Fast     NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfZaiOrgGlm4_7Flash                   NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/zai-org/glm-4.7-flash"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfMetaLlama3_1_8bInstructFast         NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfMetaLlama3_1_8bInstructFp8          NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfMetaLlama4Scout17b16eInstruct       NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfQwenQwen3_30bA3bFp8                 NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfDeepseekAIDeepseekR1DistillQwen32b  NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfMoonshotaiKimiK2Instruct            NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/moonshotai/kimi-k2-instruct"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfGoogleGemma3_12bIt                  NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/google/gemma-3-12b-it"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfGoogleGemma4_26bA4bIt               NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/google/gemma-4-26b-a4b-it"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCfMoonshotaiKimiK2_5                  NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "@cf/moonshotai/kimi-k2.5"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelAnthropicClaude3_7Sonnet              NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "anthropic/claude-3-7-sonnet"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelAnthropicClaudeSonnet4                NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "anthropic/claude-sonnet-4"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelAnthropicClaudeOpus4                  NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "anthropic/claude-opus-4"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelAnthropicClaude3_5Haiku               NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "anthropic/claude-3-5-haiku"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCerebrasQwen3_235bA22bInstruct        NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "cerebras/qwen-3-235b-a22b-instruct"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCerebrasQwen3_235bA22bThinking        NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "cerebras/qwen-3-235b-a22b-thinking"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCerebrasLlama3_3_70b                  NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "cerebras/llama-3.3-70b"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCerebrasLlama4Maverick17b128eInstruct NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCerebrasLlama4Scout17b16eInstruct     NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "cerebras/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelCerebrasGptOSs120b                    NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "cerebras/gpt-oss-120b"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelGoogleAIStudioGemini2_5Flash          NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "google-ai-studio/gemini-2.5-flash"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelGoogleAIStudioGemini2_5Pro            NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "google-ai-studio/gemini-2.5-pro"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelGrokGrok4                             NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "grok/grok-4"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelGroqLlama3_3_70bVersatile             NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "groq/llama-3.3-70b-versatile"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelGroqLlama3_1_8bInstant                NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "groq/llama-3.1-8b-instant"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelOpenAIGpt5                            NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "openai/gpt-5"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelOpenAIGpt5Mini                        NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "openai/gpt-5-mini"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelOpenAIGpt5Nano                        NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = "openai/gpt-5-nano"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModelEmpty                                 NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel = ""
)

func (NamespaceInstanceChatCompletionsParamsAISearchOptionsQueryRewriteModel) IsKnown

type NamespaceInstanceChatCompletionsParamsAISearchOptionsReranking

type NamespaceInstanceChatCompletionsParamsAISearchOptionsReranking struct {
	Enabled        param.Field[bool]                                                                `json:"enabled"`
	MatchThreshold param.Field[float64]                                                             `json:"match_threshold"`
	Model          param.Field[NamespaceInstanceChatCompletionsParamsAISearchOptionsRerankingModel] `json:"model"`
}

func (NamespaceInstanceChatCompletionsParamsAISearchOptionsReranking) MarshalJSON

type NamespaceInstanceChatCompletionsParamsAISearchOptionsRerankingModel

type NamespaceInstanceChatCompletionsParamsAISearchOptionsRerankingModel string
const (
	NamespaceInstanceChatCompletionsParamsAISearchOptionsRerankingModelCfBaaiBgeRerankerBase NamespaceInstanceChatCompletionsParamsAISearchOptionsRerankingModel = "@cf/baai/bge-reranker-base"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsRerankingModelEmpty                 NamespaceInstanceChatCompletionsParamsAISearchOptionsRerankingModel = ""
)

func (NamespaceInstanceChatCompletionsParamsAISearchOptionsRerankingModel) IsKnown

type NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrieval

type NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrieval struct {
	// 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.
	BoostBy          param.Field[[]NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalBoostBy]    `json:"boost_by"`
	ContextExpansion param.Field[int64]                                                                      `json:"context_expansion"`
	Filters          param.Field[map[string]interface{}]                                                     `json:"filters"`
	FusionMethod     param.Field[NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalFusionMethod] `json:"fusion_method"`
	// 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'.
	KeywordMatchMode param.Field[NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchMode] `json:"keyword_match_mode"`
	MatchThreshold   param.Field[float64]                                                                        `json:"match_threshold"`
	MaxNumResults    param.Field[int64]                                                                          `json:"max_num_results"`
	RetrievalType    param.Field[NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalRetrievalType]    `json:"retrieval_type"`
	ReturnOnFailure  param.Field[bool]                                                                           `json:"return_on_failure"`
}

func (NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrieval) MarshalJSON

type NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalBoostBy

type NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalBoostBy struct {
	// 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.
	Field param.Field[string] `json:"field" api:"required"`
	// 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.
	Direction param.Field[NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection] `json:"direction"`
}

func (NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalBoostBy) MarshalJSON

type NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection

type NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection string

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.

const (
	NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirectionAsc       NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection = "asc"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirectionDesc      NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection = "desc"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirectionExists    NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection = "exists"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirectionNotExists NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection = "not_exists"
)

func (NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalBoostByDirection) IsKnown

type NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalFusionMethod

type NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalFusionMethod string
const (
	NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalFusionMethodMax NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalFusionMethod = "max"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalFusionMethodRrf NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalFusionMethod = "rrf"
)

func (NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalFusionMethod) IsKnown

type NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchMode

type NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchMode string

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'.

const (
	NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchModeAnd NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchMode = "and"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchModeOr  NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchMode = "or"
)

func (NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalKeywordMatchMode) IsKnown

type NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalRetrievalType

type NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalRetrievalType string
const (
	NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalRetrievalTypeVector  NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalRetrievalType = "vector"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalRetrievalTypeKeyword NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalRetrievalType = "keyword"
	NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalRetrievalTypeHybrid  NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalRetrievalType = "hybrid"
)

func (NamespaceInstanceChatCompletionsParamsAISearchOptionsRetrievalRetrievalType) IsKnown

type NamespaceInstanceChatCompletionsParamsMessage

type NamespaceInstanceChatCompletionsParamsMessage struct {
	Content     param.Field[string]                                             `json:"content" api:"required"`
	Role        param.Field[NamespaceInstanceChatCompletionsParamsMessagesRole] `json:"role" api:"required"`
	ExtraFields map[string]interface{}                                          `json:"-,extras"`
}

func (NamespaceInstanceChatCompletionsParamsMessage) MarshalJSON

func (r NamespaceInstanceChatCompletionsParamsMessage) MarshalJSON() (data []byte, err error)

type NamespaceInstanceChatCompletionsParamsMessagesRole

type NamespaceInstanceChatCompletionsParamsMessagesRole string
const (
	NamespaceInstanceChatCompletionsParamsMessagesRoleSystem    NamespaceInstanceChatCompletionsParamsMessagesRole = "system"
	NamespaceInstanceChatCompletionsParamsMessagesRoleDeveloper NamespaceInstanceChatCompletionsParamsMessagesRole = "developer"
	NamespaceInstanceChatCompletionsParamsMessagesRoleUser      NamespaceInstanceChatCompletionsParamsMessagesRole = "user"
	NamespaceInstanceChatCompletionsParamsMessagesRoleAssistant NamespaceInstanceChatCompletionsParamsMessagesRole = "assistant"
	NamespaceInstanceChatCompletionsParamsMessagesRoleTool      NamespaceInstanceChatCompletionsParamsMessagesRole = "tool"
)

func (NamespaceInstanceChatCompletionsParamsMessagesRole) IsKnown

type NamespaceInstanceChatCompletionsParamsModel

type NamespaceInstanceChatCompletionsParamsModel string
const (
	NamespaceInstanceChatCompletionsParamsModelCfMetaLlama3_3_70bInstructFp8Fast     NamespaceInstanceChatCompletionsParamsModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	NamespaceInstanceChatCompletionsParamsModelCfZaiOrgGlm4_7Flash                   NamespaceInstanceChatCompletionsParamsModel = "@cf/zai-org/glm-4.7-flash"
	NamespaceInstanceChatCompletionsParamsModelCfMetaLlama3_1_8bInstructFast         NamespaceInstanceChatCompletionsParamsModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	NamespaceInstanceChatCompletionsParamsModelCfMetaLlama3_1_8bInstructFp8          NamespaceInstanceChatCompletionsParamsModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	NamespaceInstanceChatCompletionsParamsModelCfMetaLlama4Scout17b16eInstruct       NamespaceInstanceChatCompletionsParamsModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceChatCompletionsParamsModelCfQwenQwen3_30bA3bFp8                 NamespaceInstanceChatCompletionsParamsModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	NamespaceInstanceChatCompletionsParamsModelCfDeepseekAIDeepseekR1DistillQwen32b  NamespaceInstanceChatCompletionsParamsModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	NamespaceInstanceChatCompletionsParamsModelCfMoonshotaiKimiK2Instruct            NamespaceInstanceChatCompletionsParamsModel = "@cf/moonshotai/kimi-k2-instruct"
	NamespaceInstanceChatCompletionsParamsModelCfGoogleGemma3_12bIt                  NamespaceInstanceChatCompletionsParamsModel = "@cf/google/gemma-3-12b-it"
	NamespaceInstanceChatCompletionsParamsModelCfGoogleGemma4_26bA4bIt               NamespaceInstanceChatCompletionsParamsModel = "@cf/google/gemma-4-26b-a4b-it"
	NamespaceInstanceChatCompletionsParamsModelCfMoonshotaiKimiK2_5                  NamespaceInstanceChatCompletionsParamsModel = "@cf/moonshotai/kimi-k2.5"
	NamespaceInstanceChatCompletionsParamsModelAnthropicClaude3_7Sonnet              NamespaceInstanceChatCompletionsParamsModel = "anthropic/claude-3-7-sonnet"
	NamespaceInstanceChatCompletionsParamsModelAnthropicClaudeSonnet4                NamespaceInstanceChatCompletionsParamsModel = "anthropic/claude-sonnet-4"
	NamespaceInstanceChatCompletionsParamsModelAnthropicClaudeOpus4                  NamespaceInstanceChatCompletionsParamsModel = "anthropic/claude-opus-4"
	NamespaceInstanceChatCompletionsParamsModelAnthropicClaude3_5Haiku               NamespaceInstanceChatCompletionsParamsModel = "anthropic/claude-3-5-haiku"
	NamespaceInstanceChatCompletionsParamsModelCerebrasQwen3_235bA22bInstruct        NamespaceInstanceChatCompletionsParamsModel = "cerebras/qwen-3-235b-a22b-instruct"
	NamespaceInstanceChatCompletionsParamsModelCerebrasQwen3_235bA22bThinking        NamespaceInstanceChatCompletionsParamsModel = "cerebras/qwen-3-235b-a22b-thinking"
	NamespaceInstanceChatCompletionsParamsModelCerebrasLlama3_3_70b                  NamespaceInstanceChatCompletionsParamsModel = "cerebras/llama-3.3-70b"
	NamespaceInstanceChatCompletionsParamsModelCerebrasLlama4Maverick17b128eInstruct NamespaceInstanceChatCompletionsParamsModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	NamespaceInstanceChatCompletionsParamsModelCerebrasLlama4Scout17b16eInstruct     NamespaceInstanceChatCompletionsParamsModel = "cerebras/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceChatCompletionsParamsModelCerebrasGptOSs120b                    NamespaceInstanceChatCompletionsParamsModel = "cerebras/gpt-oss-120b"
	NamespaceInstanceChatCompletionsParamsModelGoogleAIStudioGemini2_5Flash          NamespaceInstanceChatCompletionsParamsModel = "google-ai-studio/gemini-2.5-flash"
	NamespaceInstanceChatCompletionsParamsModelGoogleAIStudioGemini2_5Pro            NamespaceInstanceChatCompletionsParamsModel = "google-ai-studio/gemini-2.5-pro"
	NamespaceInstanceChatCompletionsParamsModelGrokGrok4                             NamespaceInstanceChatCompletionsParamsModel = "grok/grok-4"
	NamespaceInstanceChatCompletionsParamsModelGroqLlama3_3_70bVersatile             NamespaceInstanceChatCompletionsParamsModel = "groq/llama-3.3-70b-versatile"
	NamespaceInstanceChatCompletionsParamsModelGroqLlama3_1_8bInstant                NamespaceInstanceChatCompletionsParamsModel = "groq/llama-3.1-8b-instant"
	NamespaceInstanceChatCompletionsParamsModelOpenAIGpt5                            NamespaceInstanceChatCompletionsParamsModel = "openai/gpt-5"
	NamespaceInstanceChatCompletionsParamsModelOpenAIGpt5Mini                        NamespaceInstanceChatCompletionsParamsModel = "openai/gpt-5-mini"
	NamespaceInstanceChatCompletionsParamsModelOpenAIGpt5Nano                        NamespaceInstanceChatCompletionsParamsModel = "openai/gpt-5-nano"
	NamespaceInstanceChatCompletionsParamsModelEmpty                                 NamespaceInstanceChatCompletionsParamsModel = ""
)

func (NamespaceInstanceChatCompletionsParamsModel) IsKnown

type NamespaceInstanceChatCompletionsResponse

type NamespaceInstanceChatCompletionsResponse struct {
	Choices     []NamespaceInstanceChatCompletionsResponseChoice `json:"choices" api:"required"`
	Chunks      []NamespaceInstanceChatCompletionsResponseChunk  `json:"chunks" api:"required"`
	ID          string                                           `json:"id"`
	Model       string                                           `json:"model"`
	Object      string                                           `json:"object"`
	ExtraFields map[string]interface{}                           `json:"-" api:"extrafields"`
	JSON        namespaceInstanceChatCompletionsResponseJSON     `json:"-"`
}

func (*NamespaceInstanceChatCompletionsResponse) UnmarshalJSON

func (r *NamespaceInstanceChatCompletionsResponse) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceChatCompletionsResponseChoice

type NamespaceInstanceChatCompletionsResponseChoice struct {
	Message NamespaceInstanceChatCompletionsResponseChoicesMessage `json:"message" api:"required"`
	Index   int64                                                  `json:"index"`
	JSON    namespaceInstanceChatCompletionsResponseChoiceJSON     `json:"-"`
}

func (*NamespaceInstanceChatCompletionsResponseChoice) UnmarshalJSON

func (r *NamespaceInstanceChatCompletionsResponseChoice) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceChatCompletionsResponseChoicesMessage

type NamespaceInstanceChatCompletionsResponseChoicesMessage struct {
	Content     string                                                     `json:"content" api:"required,nullable"`
	Role        NamespaceInstanceChatCompletionsResponseChoicesMessageRole `json:"role" api:"required"`
	ExtraFields map[string]interface{}                                     `json:"-" api:"extrafields"`
	JSON        namespaceInstanceChatCompletionsResponseChoicesMessageJSON `json:"-"`
}

func (*NamespaceInstanceChatCompletionsResponseChoicesMessage) UnmarshalJSON

func (r *NamespaceInstanceChatCompletionsResponseChoicesMessage) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceChatCompletionsResponseChoicesMessageRole

type NamespaceInstanceChatCompletionsResponseChoicesMessageRole string
const (
	NamespaceInstanceChatCompletionsResponseChoicesMessageRoleSystem    NamespaceInstanceChatCompletionsResponseChoicesMessageRole = "system"
	NamespaceInstanceChatCompletionsResponseChoicesMessageRoleDeveloper NamespaceInstanceChatCompletionsResponseChoicesMessageRole = "developer"
	NamespaceInstanceChatCompletionsResponseChoicesMessageRoleUser      NamespaceInstanceChatCompletionsResponseChoicesMessageRole = "user"
	NamespaceInstanceChatCompletionsResponseChoicesMessageRoleAssistant NamespaceInstanceChatCompletionsResponseChoicesMessageRole = "assistant"
	NamespaceInstanceChatCompletionsResponseChoicesMessageRoleTool      NamespaceInstanceChatCompletionsResponseChoicesMessageRole = "tool"
)

func (NamespaceInstanceChatCompletionsResponseChoicesMessageRole) IsKnown

type NamespaceInstanceChatCompletionsResponseChunk

type NamespaceInstanceChatCompletionsResponseChunk struct {
	ID             string                                                       `json:"id" api:"required"`
	Score          float64                                                      `json:"score" api:"required"`
	Text           string                                                       `json:"text" api:"required"`
	Type           string                                                       `json:"type" api:"required"`
	Item           NamespaceInstanceChatCompletionsResponseChunksItem           `json:"item"`
	ScoringDetails NamespaceInstanceChatCompletionsResponseChunksScoringDetails `json:"scoring_details"`
	JSON           namespaceInstanceChatCompletionsResponseChunkJSON            `json:"-"`
}

func (*NamespaceInstanceChatCompletionsResponseChunk) UnmarshalJSON

func (r *NamespaceInstanceChatCompletionsResponseChunk) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceChatCompletionsResponseChunksItem

type NamespaceInstanceChatCompletionsResponseChunksItem struct {
	Key       string                                                 `json:"key" api:"required"`
	Metadata  map[string]interface{}                                 `json:"metadata"`
	Timestamp float64                                                `json:"timestamp"`
	JSON      namespaceInstanceChatCompletionsResponseChunksItemJSON `json:"-"`
}

func (*NamespaceInstanceChatCompletionsResponseChunksItem) UnmarshalJSON

func (r *NamespaceInstanceChatCompletionsResponseChunksItem) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceChatCompletionsResponseChunksScoringDetails

type NamespaceInstanceChatCompletionsResponseChunksScoringDetails struct {
	FusionMethod   NamespaceInstanceChatCompletionsResponseChunksScoringDetailsFusionMethod `json:"fusion_method"`
	KeywordRank    float64                                                                  `json:"keyword_rank"`
	KeywordScore   float64                                                                  `json:"keyword_score"`
	RerankingScore float64                                                                  `json:"reranking_score"`
	VectorRank     float64                                                                  `json:"vector_rank"`
	VectorScore    float64                                                                  `json:"vector_score"`
	JSON           namespaceInstanceChatCompletionsResponseChunksScoringDetailsJSON         `json:"-"`
}

func (*NamespaceInstanceChatCompletionsResponseChunksScoringDetails) UnmarshalJSON

type NamespaceInstanceChatCompletionsResponseChunksScoringDetailsFusionMethod

type NamespaceInstanceChatCompletionsResponseChunksScoringDetailsFusionMethod string
const (
	NamespaceInstanceChatCompletionsResponseChunksScoringDetailsFusionMethodRrf NamespaceInstanceChatCompletionsResponseChunksScoringDetailsFusionMethod = "rrf"
	NamespaceInstanceChatCompletionsResponseChunksScoringDetailsFusionMethodMax NamespaceInstanceChatCompletionsResponseChunksScoringDetailsFusionMethod = "max"
)

func (NamespaceInstanceChatCompletionsResponseChunksScoringDetailsFusionMethod) IsKnown

type NamespaceInstanceDeleteParams

type NamespaceInstanceDeleteParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type NamespaceInstanceDeleteResponse

type NamespaceInstanceDeleteResponse struct {
	// AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
	ID             string                                        `json:"id" api:"required"`
	CreatedAt      time.Time                                     `json:"created_at" api:"required" format:"date-time"`
	ModifiedAt     time.Time                                     `json:"modified_at" api:"required" format:"date-time"`
	AIGatewayID    string                                        `json:"ai_gateway_id" api:"nullable"`
	AISearchModel  NamespaceInstanceDeleteResponseAISearchModel  `json:"ai_search_model" api:"nullable"`
	Cache          bool                                          `json:"cache"`
	CacheThreshold NamespaceInstanceDeleteResponseCacheThreshold `json:"cache_threshold"`
	// Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600
	// (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200
	// (72h), 518400 (6d).
	CacheTTL       NamespaceInstanceDeleteResponseCacheTTL         `json:"cache_ttl"`
	ChunkOverlap   int64                                           `json:"chunk_overlap"`
	ChunkSize      int64                                           `json:"chunk_size"`
	CreatedBy      string                                          `json:"created_by" api:"nullable"`
	CustomMetadata []NamespaceInstanceDeleteResponseCustomMetadata `json:"custom_metadata"`
	EmbeddingModel NamespaceInstanceDeleteResponseEmbeddingModel   `json:"embedding_model" api:"nullable"`
	Enable         bool                                            `json:"enable"`
	EngineVersion  float64                                         `json:"engine_version"`
	FusionMethod   NamespaceInstanceDeleteResponseFusionMethod     `json:"fusion_method"`
	// Deprecated — use index_method instead.
	//
	// Deprecated: deprecated
	HybridSearchEnabled bool `json:"hybrid_search_enabled"`
	// Controls which storage backends are used during indexing. Defaults to
	// vector-only.
	IndexMethod          NamespaceInstanceDeleteResponseIndexMethod          `json:"index_method"`
	IndexingOptions      NamespaceInstanceDeleteResponseIndexingOptions      `json:"indexing_options" api:"nullable"`
	LastActivity         time.Time                                           `json:"last_activity" api:"nullable" format:"date-time"`
	MaxNumResults        int64                                               `json:"max_num_results"`
	Metadata             NamespaceInstanceDeleteResponseMetadata             `json:"metadata"`
	ModifiedBy           string                                              `json:"modified_by" api:"nullable"`
	Namespace            string                                              `json:"namespace" api:"nullable"`
	Paused               bool                                                `json:"paused"`
	PublicEndpointID     string                                              `json:"public_endpoint_id" api:"nullable"`
	PublicEndpointParams NamespaceInstanceDeleteResponsePublicEndpointParams `json:"public_endpoint_params"`
	Reranking            bool                                                `json:"reranking"`
	RerankingModel       NamespaceInstanceDeleteResponseRerankingModel       `json:"reranking_model" api:"nullable"`
	RetrievalOptions     NamespaceInstanceDeleteResponseRetrievalOptions     `json:"retrieval_options" api:"nullable"`
	RewriteModel         NamespaceInstanceDeleteResponseRewriteModel         `json:"rewrite_model" api:"nullable"`
	RewriteQuery         bool                                                `json:"rewrite_query"`
	ScoreThreshold       float64                                             `json:"score_threshold"`
	Source               string                                              `json:"source" api:"nullable"`
	SourceParams         NamespaceInstanceDeleteResponseSourceParams         `json:"source_params" api:"nullable"`
	Status               string                                              `json:"status"`
	// Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800
	// (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).
	SyncInterval NamespaceInstanceDeleteResponseSyncInterval `json:"sync_interval"`
	TokenID      string                                      `json:"token_id" format:"uuid"`
	Type         NamespaceInstanceDeleteResponseType         `json:"type" api:"nullable"`
	JSON         namespaceInstanceDeleteResponseJSON         `json:"-"`
}

func (*NamespaceInstanceDeleteResponse) UnmarshalJSON

func (r *NamespaceInstanceDeleteResponse) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceDeleteResponseAISearchModel

type NamespaceInstanceDeleteResponseAISearchModel string
const (
	NamespaceInstanceDeleteResponseAISearchModelCfMetaLlama3_3_70bInstructFp8Fast     NamespaceInstanceDeleteResponseAISearchModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	NamespaceInstanceDeleteResponseAISearchModelCfZaiOrgGlm4_7Flash                   NamespaceInstanceDeleteResponseAISearchModel = "@cf/zai-org/glm-4.7-flash"
	NamespaceInstanceDeleteResponseAISearchModelCfMetaLlama3_1_8bInstructFast         NamespaceInstanceDeleteResponseAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	NamespaceInstanceDeleteResponseAISearchModelCfMetaLlama3_1_8bInstructFp8          NamespaceInstanceDeleteResponseAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	NamespaceInstanceDeleteResponseAISearchModelCfMetaLlama4Scout17b16eInstruct       NamespaceInstanceDeleteResponseAISearchModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceDeleteResponseAISearchModelCfQwenQwen3_30bA3bFp8                 NamespaceInstanceDeleteResponseAISearchModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	NamespaceInstanceDeleteResponseAISearchModelCfDeepseekAIDeepseekR1DistillQwen32b  NamespaceInstanceDeleteResponseAISearchModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	NamespaceInstanceDeleteResponseAISearchModelCfMoonshotaiKimiK2Instruct            NamespaceInstanceDeleteResponseAISearchModel = "@cf/moonshotai/kimi-k2-instruct"
	NamespaceInstanceDeleteResponseAISearchModelCfGoogleGemma3_12bIt                  NamespaceInstanceDeleteResponseAISearchModel = "@cf/google/gemma-3-12b-it"
	NamespaceInstanceDeleteResponseAISearchModelCfGoogleGemma4_26bA4bIt               NamespaceInstanceDeleteResponseAISearchModel = "@cf/google/gemma-4-26b-a4b-it"
	NamespaceInstanceDeleteResponseAISearchModelCfMoonshotaiKimiK2_5                  NamespaceInstanceDeleteResponseAISearchModel = "@cf/moonshotai/kimi-k2.5"
	NamespaceInstanceDeleteResponseAISearchModelAnthropicClaude3_7Sonnet              NamespaceInstanceDeleteResponseAISearchModel = "anthropic/claude-3-7-sonnet"
	NamespaceInstanceDeleteResponseAISearchModelAnthropicClaudeSonnet4                NamespaceInstanceDeleteResponseAISearchModel = "anthropic/claude-sonnet-4"
	NamespaceInstanceDeleteResponseAISearchModelAnthropicClaudeOpus4                  NamespaceInstanceDeleteResponseAISearchModel = "anthropic/claude-opus-4"
	NamespaceInstanceDeleteResponseAISearchModelAnthropicClaude3_5Haiku               NamespaceInstanceDeleteResponseAISearchModel = "anthropic/claude-3-5-haiku"
	NamespaceInstanceDeleteResponseAISearchModelCerebrasQwen3_235bA22bInstruct        NamespaceInstanceDeleteResponseAISearchModel = "cerebras/qwen-3-235b-a22b-instruct"
	NamespaceInstanceDeleteResponseAISearchModelCerebrasQwen3_235bA22bThinking        NamespaceInstanceDeleteResponseAISearchModel = "cerebras/qwen-3-235b-a22b-thinking"
	NamespaceInstanceDeleteResponseAISearchModelCerebrasLlama3_3_70b                  NamespaceInstanceDeleteResponseAISearchModel = "cerebras/llama-3.3-70b"
	NamespaceInstanceDeleteResponseAISearchModelCerebrasLlama4Maverick17b128eInstruct NamespaceInstanceDeleteResponseAISearchModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	NamespaceInstanceDeleteResponseAISearchModelCerebrasLlama4Scout17b16eInstruct     NamespaceInstanceDeleteResponseAISearchModel = "cerebras/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceDeleteResponseAISearchModelCerebrasGptOSs120b                    NamespaceInstanceDeleteResponseAISearchModel = "cerebras/gpt-oss-120b"
	NamespaceInstanceDeleteResponseAISearchModelGoogleAIStudioGemini2_5Flash          NamespaceInstanceDeleteResponseAISearchModel = "google-ai-studio/gemini-2.5-flash"
	NamespaceInstanceDeleteResponseAISearchModelGoogleAIStudioGemini2_5Pro            NamespaceInstanceDeleteResponseAISearchModel = "google-ai-studio/gemini-2.5-pro"
	NamespaceInstanceDeleteResponseAISearchModelGrokGrok4                             NamespaceInstanceDeleteResponseAISearchModel = "grok/grok-4"
	NamespaceInstanceDeleteResponseAISearchModelGroqLlama3_3_70bVersatile             NamespaceInstanceDeleteResponseAISearchModel = "groq/llama-3.3-70b-versatile"
	NamespaceInstanceDeleteResponseAISearchModelGroqLlama3_1_8bInstant                NamespaceInstanceDeleteResponseAISearchModel = "groq/llama-3.1-8b-instant"
	NamespaceInstanceDeleteResponseAISearchModelOpenAIGpt5                            NamespaceInstanceDeleteResponseAISearchModel = "openai/gpt-5"
	NamespaceInstanceDeleteResponseAISearchModelOpenAIGpt5Mini                        NamespaceInstanceDeleteResponseAISearchModel = "openai/gpt-5-mini"
	NamespaceInstanceDeleteResponseAISearchModelOpenAIGpt5Nano                        NamespaceInstanceDeleteResponseAISearchModel = "openai/gpt-5-nano"
	NamespaceInstanceDeleteResponseAISearchModelEmpty                                 NamespaceInstanceDeleteResponseAISearchModel = ""
)

func (NamespaceInstanceDeleteResponseAISearchModel) IsKnown

type NamespaceInstanceDeleteResponseCacheTTL

type NamespaceInstanceDeleteResponseCacheTTL float64

Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d).

const (
	NamespaceInstanceDeleteResponseCacheTTL600    NamespaceInstanceDeleteResponseCacheTTL = 600
	NamespaceInstanceDeleteResponseCacheTTL1800   NamespaceInstanceDeleteResponseCacheTTL = 1800
	NamespaceInstanceDeleteResponseCacheTTL3600   NamespaceInstanceDeleteResponseCacheTTL = 3600
	NamespaceInstanceDeleteResponseCacheTTL7200   NamespaceInstanceDeleteResponseCacheTTL = 7200
	NamespaceInstanceDeleteResponseCacheTTL21600  NamespaceInstanceDeleteResponseCacheTTL = 21600
	NamespaceInstanceDeleteResponseCacheTTL43200  NamespaceInstanceDeleteResponseCacheTTL = 43200
	NamespaceInstanceDeleteResponseCacheTTL86400  NamespaceInstanceDeleteResponseCacheTTL = 86400
	NamespaceInstanceDeleteResponseCacheTTL172800 NamespaceInstanceDeleteResponseCacheTTL = 172800
	NamespaceInstanceDeleteResponseCacheTTL259200 NamespaceInstanceDeleteResponseCacheTTL = 259200
	NamespaceInstanceDeleteResponseCacheTTL518400 NamespaceInstanceDeleteResponseCacheTTL = 518400
)

func (NamespaceInstanceDeleteResponseCacheTTL) IsKnown

type NamespaceInstanceDeleteResponseCacheThreshold

type NamespaceInstanceDeleteResponseCacheThreshold string
const (
	NamespaceInstanceDeleteResponseCacheThresholdSuperStrictMatch NamespaceInstanceDeleteResponseCacheThreshold = "super_strict_match"
	NamespaceInstanceDeleteResponseCacheThresholdCloseEnough      NamespaceInstanceDeleteResponseCacheThreshold = "close_enough"
	NamespaceInstanceDeleteResponseCacheThresholdFlexibleFriend   NamespaceInstanceDeleteResponseCacheThreshold = "flexible_friend"
	NamespaceInstanceDeleteResponseCacheThresholdAnythingGoes     NamespaceInstanceDeleteResponseCacheThreshold = "anything_goes"
)

func (NamespaceInstanceDeleteResponseCacheThreshold) IsKnown

type NamespaceInstanceDeleteResponseCustomMetadata

type NamespaceInstanceDeleteResponseCustomMetadata struct {
	DataType  NamespaceInstanceDeleteResponseCustomMetadataDataType `json:"data_type" api:"required"`
	FieldName string                                                `json:"field_name" api:"required"`
	JSON      namespaceInstanceDeleteResponseCustomMetadataJSON     `json:"-"`
}

func (*NamespaceInstanceDeleteResponseCustomMetadata) UnmarshalJSON

func (r *NamespaceInstanceDeleteResponseCustomMetadata) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceDeleteResponseCustomMetadataDataType

type NamespaceInstanceDeleteResponseCustomMetadataDataType string
const (
	NamespaceInstanceDeleteResponseCustomMetadataDataTypeText     NamespaceInstanceDeleteResponseCustomMetadataDataType = "text"
	NamespaceInstanceDeleteResponseCustomMetadataDataTypeNumber   NamespaceInstanceDeleteResponseCustomMetadataDataType = "number"
	NamespaceInstanceDeleteResponseCustomMetadataDataTypeBoolean  NamespaceInstanceDeleteResponseCustomMetadataDataType = "boolean"
	NamespaceInstanceDeleteResponseCustomMetadataDataTypeDatetime NamespaceInstanceDeleteResponseCustomMetadataDataType = "datetime"
)

func (NamespaceInstanceDeleteResponseCustomMetadataDataType) IsKnown

type NamespaceInstanceDeleteResponseEmbeddingModel

type NamespaceInstanceDeleteResponseEmbeddingModel string
const (
	NamespaceInstanceDeleteResponseEmbeddingModelCfQwenQwen3Embedding0_6b              NamespaceInstanceDeleteResponseEmbeddingModel = "@cf/qwen/qwen3-embedding-0.6b"
	NamespaceInstanceDeleteResponseEmbeddingModelCfBaaiBgeM3                           NamespaceInstanceDeleteResponseEmbeddingModel = "@cf/baai/bge-m3"
	NamespaceInstanceDeleteResponseEmbeddingModelCfBaaiBgeLargeEnV1_5                  NamespaceInstanceDeleteResponseEmbeddingModel = "@cf/baai/bge-large-en-v1.5"
	NamespaceInstanceDeleteResponseEmbeddingModelCfGoogleEmbeddinggemma300m            NamespaceInstanceDeleteResponseEmbeddingModel = "@cf/google/embeddinggemma-300m"
	NamespaceInstanceDeleteResponseEmbeddingModelGoogleAIStudioGeminiEmbedding001      NamespaceInstanceDeleteResponseEmbeddingModel = "google-ai-studio/gemini-embedding-001"
	NamespaceInstanceDeleteResponseEmbeddingModelGoogleAIStudioGeminiEmbedding2Preview NamespaceInstanceDeleteResponseEmbeddingModel = "google-ai-studio/gemini-embedding-2-preview"
	NamespaceInstanceDeleteResponseEmbeddingModelOpenAITextEmbedding3Small             NamespaceInstanceDeleteResponseEmbeddingModel = "openai/text-embedding-3-small"
	NamespaceInstanceDeleteResponseEmbeddingModelOpenAITextEmbedding3Large             NamespaceInstanceDeleteResponseEmbeddingModel = "openai/text-embedding-3-large"
	NamespaceInstanceDeleteResponseEmbeddingModelEmpty                                 NamespaceInstanceDeleteResponseEmbeddingModel = ""
)

func (NamespaceInstanceDeleteResponseEmbeddingModel) IsKnown

type NamespaceInstanceDeleteResponseEnvelope

type NamespaceInstanceDeleteResponseEnvelope struct {
	Result  NamespaceInstanceDeleteResponse             `json:"result" api:"required"`
	Success bool                                        `json:"success" api:"required"`
	JSON    namespaceInstanceDeleteResponseEnvelopeJSON `json:"-"`
}

func (*NamespaceInstanceDeleteResponseEnvelope) UnmarshalJSON

func (r *NamespaceInstanceDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceDeleteResponseFusionMethod

type NamespaceInstanceDeleteResponseFusionMethod string
const (
	NamespaceInstanceDeleteResponseFusionMethodMax NamespaceInstanceDeleteResponseFusionMethod = "max"
	NamespaceInstanceDeleteResponseFusionMethodRrf NamespaceInstanceDeleteResponseFusionMethod = "rrf"
)

func (NamespaceInstanceDeleteResponseFusionMethod) IsKnown

type NamespaceInstanceDeleteResponseIndexMethod

type NamespaceInstanceDeleteResponseIndexMethod struct {
	// Enable keyword (BM25) storage backend.
	Keyword bool `json:"keyword" api:"required"`
	// Enable vector (embedding) storage backend.
	Vector bool                                           `json:"vector" api:"required"`
	JSON   namespaceInstanceDeleteResponseIndexMethodJSON `json:"-"`
}

Controls which storage backends are used during indexing. Defaults to vector-only.

func (*NamespaceInstanceDeleteResponseIndexMethod) UnmarshalJSON

func (r *NamespaceInstanceDeleteResponseIndexMethod) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceDeleteResponseIndexingOptions

type NamespaceInstanceDeleteResponseIndexingOptions struct {
	// Tokenizer used for keyword search indexing. porter provides word-level
	// tokenization with Porter stemming (good for natural language queries). trigram
	// enables character-level substring matching (good for partial matches, code,
	// identifiers). Changing this triggers a full re-index. Defaults to porter.
	KeywordTokenizer NamespaceInstanceDeleteResponseIndexingOptionsKeywordTokenizer `json:"keyword_tokenizer"`
	JSON             namespaceInstanceDeleteResponseIndexingOptionsJSON             `json:"-"`
}

func (*NamespaceInstanceDeleteResponseIndexingOptions) UnmarshalJSON

func (r *NamespaceInstanceDeleteResponseIndexingOptions) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceDeleteResponseIndexingOptionsKeywordTokenizer

type NamespaceInstanceDeleteResponseIndexingOptionsKeywordTokenizer string

Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter.

const (
	NamespaceInstanceDeleteResponseIndexingOptionsKeywordTokenizerPorter  NamespaceInstanceDeleteResponseIndexingOptionsKeywordTokenizer = "porter"
	NamespaceInstanceDeleteResponseIndexingOptionsKeywordTokenizerTrigram NamespaceInstanceDeleteResponseIndexingOptionsKeywordTokenizer = "trigram"
)

func (NamespaceInstanceDeleteResponseIndexingOptionsKeywordTokenizer) IsKnown

type NamespaceInstanceDeleteResponseMetadata

type NamespaceInstanceDeleteResponseMetadata struct {
	CreatedFromAISearchWizard bool                                        `json:"created_from_aisearch_wizard"`
	WorkerDomain              string                                      `json:"worker_domain"`
	JSON                      namespaceInstanceDeleteResponseMetadataJSON `json:"-"`
}

func (*NamespaceInstanceDeleteResponseMetadata) UnmarshalJSON

func (r *NamespaceInstanceDeleteResponseMetadata) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceDeleteResponsePublicEndpointParams

type NamespaceInstanceDeleteResponsePublicEndpointParams struct {
	AuthorizedHosts         []string                                                                   `json:"authorized_hosts"`
	ChatCompletionsEndpoint NamespaceInstanceDeleteResponsePublicEndpointParamsChatCompletionsEndpoint `json:"chat_completions_endpoint"`
	Enabled                 bool                                                                       `json:"enabled"`
	Mcp                     NamespaceInstanceDeleteResponsePublicEndpointParamsMcp                     `json:"mcp"`
	RateLimit               NamespaceInstanceDeleteResponsePublicEndpointParamsRateLimit               `json:"rate_limit"`
	SearchEndpoint          NamespaceInstanceDeleteResponsePublicEndpointParamsSearchEndpoint          `json:"search_endpoint"`
	JSON                    namespaceInstanceDeleteResponsePublicEndpointParamsJSON                    `json:"-"`
}

func (*NamespaceInstanceDeleteResponsePublicEndpointParams) UnmarshalJSON

func (r *NamespaceInstanceDeleteResponsePublicEndpointParams) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceDeleteResponsePublicEndpointParamsChatCompletionsEndpoint

type NamespaceInstanceDeleteResponsePublicEndpointParamsChatCompletionsEndpoint struct {
	// Disable chat completions endpoint for this public endpoint
	Disabled bool                                                                           `json:"disabled"`
	JSON     namespaceInstanceDeleteResponsePublicEndpointParamsChatCompletionsEndpointJSON `json:"-"`
}

func (*NamespaceInstanceDeleteResponsePublicEndpointParamsChatCompletionsEndpoint) UnmarshalJSON

type NamespaceInstanceDeleteResponsePublicEndpointParamsMcp

type NamespaceInstanceDeleteResponsePublicEndpointParamsMcp struct {
	Description string `json:"description"`
	// Disable MCP endpoint for this public endpoint
	Disabled bool                                                       `json:"disabled"`
	JSON     namespaceInstanceDeleteResponsePublicEndpointParamsMcpJSON `json:"-"`
}

func (*NamespaceInstanceDeleteResponsePublicEndpointParamsMcp) UnmarshalJSON

func (r *NamespaceInstanceDeleteResponsePublicEndpointParamsMcp) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceDeleteResponsePublicEndpointParamsRateLimit

type NamespaceInstanceDeleteResponsePublicEndpointParamsRateLimit struct {
	PeriodMs  int64                                                                 `json:"period_ms"`
	Requests  int64                                                                 `json:"requests"`
	Technique NamespaceInstanceDeleteResponsePublicEndpointParamsRateLimitTechnique `json:"technique"`
	JSON      namespaceInstanceDeleteResponsePublicEndpointParamsRateLimitJSON      `json:"-"`
}

func (*NamespaceInstanceDeleteResponsePublicEndpointParamsRateLimit) UnmarshalJSON

type NamespaceInstanceDeleteResponsePublicEndpointParamsRateLimitTechnique

type NamespaceInstanceDeleteResponsePublicEndpointParamsRateLimitTechnique string
const (
	NamespaceInstanceDeleteResponsePublicEndpointParamsRateLimitTechniqueFixed   NamespaceInstanceDeleteResponsePublicEndpointParamsRateLimitTechnique = "fixed"
	NamespaceInstanceDeleteResponsePublicEndpointParamsRateLimitTechniqueSliding NamespaceInstanceDeleteResponsePublicEndpointParamsRateLimitTechnique = "sliding"
)

func (NamespaceInstanceDeleteResponsePublicEndpointParamsRateLimitTechnique) IsKnown

type NamespaceInstanceDeleteResponsePublicEndpointParamsSearchEndpoint

type NamespaceInstanceDeleteResponsePublicEndpointParamsSearchEndpoint struct {
	// Disable search endpoint for this public endpoint
	Disabled bool                                                                  `json:"disabled"`
	JSON     namespaceInstanceDeleteResponsePublicEndpointParamsSearchEndpointJSON `json:"-"`
}

func (*NamespaceInstanceDeleteResponsePublicEndpointParamsSearchEndpoint) UnmarshalJSON

type NamespaceInstanceDeleteResponseRerankingModel

type NamespaceInstanceDeleteResponseRerankingModel string
const (
	NamespaceInstanceDeleteResponseRerankingModelCfBaaiBgeRerankerBase NamespaceInstanceDeleteResponseRerankingModel = "@cf/baai/bge-reranker-base"
	NamespaceInstanceDeleteResponseRerankingModelEmpty                 NamespaceInstanceDeleteResponseRerankingModel = ""
)

func (NamespaceInstanceDeleteResponseRerankingModel) IsKnown

type NamespaceInstanceDeleteResponseRetrievalOptions

type NamespaceInstanceDeleteResponseRetrievalOptions struct {
	// Metadata fields to boost search results by. Each entry specifies a metadata
	// field and an optional direction. Direction defaults to 'asc' for
	// numeric/datetime fields and 'exists' for text/boolean fields. Fields must match
	// 'timestamp' or a defined custom_metadata field.
	BoostBy []NamespaceInstanceDeleteResponseRetrievalOptionsBoostBy `json:"boost_by"`
	// 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'.
	KeywordMatchMode NamespaceInstanceDeleteResponseRetrievalOptionsKeywordMatchMode `json:"keyword_match_mode"`
	JSON             namespaceInstanceDeleteResponseRetrievalOptionsJSON             `json:"-"`
}

func (*NamespaceInstanceDeleteResponseRetrievalOptions) UnmarshalJSON

func (r *NamespaceInstanceDeleteResponseRetrievalOptions) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceDeleteResponseRetrievalOptionsBoostBy

type NamespaceInstanceDeleteResponseRetrievalOptionsBoostBy struct {
	// 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.
	Field string `json:"field" api:"required"`
	// 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.
	Direction NamespaceInstanceDeleteResponseRetrievalOptionsBoostByDirection `json:"direction"`
	JSON      namespaceInstanceDeleteResponseRetrievalOptionsBoostByJSON      `json:"-"`
}

func (*NamespaceInstanceDeleteResponseRetrievalOptionsBoostBy) UnmarshalJSON

func (r *NamespaceInstanceDeleteResponseRetrievalOptionsBoostBy) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceDeleteResponseRetrievalOptionsBoostByDirection

type NamespaceInstanceDeleteResponseRetrievalOptionsBoostByDirection string

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.

const (
	NamespaceInstanceDeleteResponseRetrievalOptionsBoostByDirectionAsc       NamespaceInstanceDeleteResponseRetrievalOptionsBoostByDirection = "asc"
	NamespaceInstanceDeleteResponseRetrievalOptionsBoostByDirectionDesc      NamespaceInstanceDeleteResponseRetrievalOptionsBoostByDirection = "desc"
	NamespaceInstanceDeleteResponseRetrievalOptionsBoostByDirectionExists    NamespaceInstanceDeleteResponseRetrievalOptionsBoostByDirection = "exists"
	NamespaceInstanceDeleteResponseRetrievalOptionsBoostByDirectionNotExists NamespaceInstanceDeleteResponseRetrievalOptionsBoostByDirection = "not_exists"
)

func (NamespaceInstanceDeleteResponseRetrievalOptionsBoostByDirection) IsKnown

type NamespaceInstanceDeleteResponseRetrievalOptionsKeywordMatchMode

type NamespaceInstanceDeleteResponseRetrievalOptionsKeywordMatchMode string

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'.

const (
	NamespaceInstanceDeleteResponseRetrievalOptionsKeywordMatchModeAnd NamespaceInstanceDeleteResponseRetrievalOptionsKeywordMatchMode = "and"
	NamespaceInstanceDeleteResponseRetrievalOptionsKeywordMatchModeOr  NamespaceInstanceDeleteResponseRetrievalOptionsKeywordMatchMode = "or"
)

func (NamespaceInstanceDeleteResponseRetrievalOptionsKeywordMatchMode) IsKnown

type NamespaceInstanceDeleteResponseRewriteModel

type NamespaceInstanceDeleteResponseRewriteModel string
const (
	NamespaceInstanceDeleteResponseRewriteModelCfMetaLlama3_3_70bInstructFp8Fast     NamespaceInstanceDeleteResponseRewriteModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	NamespaceInstanceDeleteResponseRewriteModelCfZaiOrgGlm4_7Flash                   NamespaceInstanceDeleteResponseRewriteModel = "@cf/zai-org/glm-4.7-flash"
	NamespaceInstanceDeleteResponseRewriteModelCfMetaLlama3_1_8bInstructFast         NamespaceInstanceDeleteResponseRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	NamespaceInstanceDeleteResponseRewriteModelCfMetaLlama3_1_8bInstructFp8          NamespaceInstanceDeleteResponseRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	NamespaceInstanceDeleteResponseRewriteModelCfMetaLlama4Scout17b16eInstruct       NamespaceInstanceDeleteResponseRewriteModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceDeleteResponseRewriteModelCfQwenQwen3_30bA3bFp8                 NamespaceInstanceDeleteResponseRewriteModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	NamespaceInstanceDeleteResponseRewriteModelCfDeepseekAIDeepseekR1DistillQwen32b  NamespaceInstanceDeleteResponseRewriteModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	NamespaceInstanceDeleteResponseRewriteModelCfMoonshotaiKimiK2Instruct            NamespaceInstanceDeleteResponseRewriteModel = "@cf/moonshotai/kimi-k2-instruct"
	NamespaceInstanceDeleteResponseRewriteModelCfGoogleGemma3_12bIt                  NamespaceInstanceDeleteResponseRewriteModel = "@cf/google/gemma-3-12b-it"
	NamespaceInstanceDeleteResponseRewriteModelCfGoogleGemma4_26bA4bIt               NamespaceInstanceDeleteResponseRewriteModel = "@cf/google/gemma-4-26b-a4b-it"
	NamespaceInstanceDeleteResponseRewriteModelCfMoonshotaiKimiK2_5                  NamespaceInstanceDeleteResponseRewriteModel = "@cf/moonshotai/kimi-k2.5"
	NamespaceInstanceDeleteResponseRewriteModelAnthropicClaude3_7Sonnet              NamespaceInstanceDeleteResponseRewriteModel = "anthropic/claude-3-7-sonnet"
	NamespaceInstanceDeleteResponseRewriteModelAnthropicClaudeSonnet4                NamespaceInstanceDeleteResponseRewriteModel = "anthropic/claude-sonnet-4"
	NamespaceInstanceDeleteResponseRewriteModelAnthropicClaudeOpus4                  NamespaceInstanceDeleteResponseRewriteModel = "anthropic/claude-opus-4"
	NamespaceInstanceDeleteResponseRewriteModelAnthropicClaude3_5Haiku               NamespaceInstanceDeleteResponseRewriteModel = "anthropic/claude-3-5-haiku"
	NamespaceInstanceDeleteResponseRewriteModelCerebrasQwen3_235bA22bInstruct        NamespaceInstanceDeleteResponseRewriteModel = "cerebras/qwen-3-235b-a22b-instruct"
	NamespaceInstanceDeleteResponseRewriteModelCerebrasQwen3_235bA22bThinking        NamespaceInstanceDeleteResponseRewriteModel = "cerebras/qwen-3-235b-a22b-thinking"
	NamespaceInstanceDeleteResponseRewriteModelCerebrasLlama3_3_70b                  NamespaceInstanceDeleteResponseRewriteModel = "cerebras/llama-3.3-70b"
	NamespaceInstanceDeleteResponseRewriteModelCerebrasLlama4Maverick17b128eInstruct NamespaceInstanceDeleteResponseRewriteModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	NamespaceInstanceDeleteResponseRewriteModelCerebrasLlama4Scout17b16eInstruct     NamespaceInstanceDeleteResponseRewriteModel = "cerebras/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceDeleteResponseRewriteModelCerebrasGptOSs120b                    NamespaceInstanceDeleteResponseRewriteModel = "cerebras/gpt-oss-120b"
	NamespaceInstanceDeleteResponseRewriteModelGoogleAIStudioGemini2_5Flash          NamespaceInstanceDeleteResponseRewriteModel = "google-ai-studio/gemini-2.5-flash"
	NamespaceInstanceDeleteResponseRewriteModelGoogleAIStudioGemini2_5Pro            NamespaceInstanceDeleteResponseRewriteModel = "google-ai-studio/gemini-2.5-pro"
	NamespaceInstanceDeleteResponseRewriteModelGrokGrok4                             NamespaceInstanceDeleteResponseRewriteModel = "grok/grok-4"
	NamespaceInstanceDeleteResponseRewriteModelGroqLlama3_3_70bVersatile             NamespaceInstanceDeleteResponseRewriteModel = "groq/llama-3.3-70b-versatile"
	NamespaceInstanceDeleteResponseRewriteModelGroqLlama3_1_8bInstant                NamespaceInstanceDeleteResponseRewriteModel = "groq/llama-3.1-8b-instant"
	NamespaceInstanceDeleteResponseRewriteModelOpenAIGpt5                            NamespaceInstanceDeleteResponseRewriteModel = "openai/gpt-5"
	NamespaceInstanceDeleteResponseRewriteModelOpenAIGpt5Mini                        NamespaceInstanceDeleteResponseRewriteModel = "openai/gpt-5-mini"
	NamespaceInstanceDeleteResponseRewriteModelOpenAIGpt5Nano                        NamespaceInstanceDeleteResponseRewriteModel = "openai/gpt-5-nano"
	NamespaceInstanceDeleteResponseRewriteModelEmpty                                 NamespaceInstanceDeleteResponseRewriteModel = ""
)

func (NamespaceInstanceDeleteResponseRewriteModel) IsKnown

type NamespaceInstanceDeleteResponseSourceParams

type NamespaceInstanceDeleteResponseSourceParams struct {
	// List of path patterns to exclude. Uses micromatch glob syntax: \* matches within
	// a path segment, ** matches across path segments (e.g., /admin/** matches
	// /admin/users and /admin/settings/advanced)
	ExcludeItems []string `json:"exclude_items"`
	// List of path patterns to include. Uses micromatch glob syntax: \* matches within
	// a path segment, ** matches across path segments (e.g., /blog/** matches
	// /blog/post and /blog/2024/post)
	IncludeItems   []string                                              `json:"include_items"`
	Prefix         string                                                `json:"prefix"`
	R2Jurisdiction string                                                `json:"r2_jurisdiction"`
	WebCrawler     NamespaceInstanceDeleteResponseSourceParamsWebCrawler `json:"web_crawler"`
	JSON           namespaceInstanceDeleteResponseSourceParamsJSON       `json:"-"`
}

func (*NamespaceInstanceDeleteResponseSourceParams) UnmarshalJSON

func (r *NamespaceInstanceDeleteResponseSourceParams) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceDeleteResponseSourceParamsWebCrawler

type NamespaceInstanceDeleteResponseSourceParamsWebCrawler struct {
	CrawlOptions NamespaceInstanceDeleteResponseSourceParamsWebCrawlerCrawlOptions `json:"crawl_options"`
	ParseOptions NamespaceInstanceDeleteResponseSourceParamsWebCrawlerParseOptions `json:"parse_options"`
	ParseType    NamespaceInstanceDeleteResponseSourceParamsWebCrawlerParseType    `json:"parse_type"`
	StoreOptions NamespaceInstanceDeleteResponseSourceParamsWebCrawlerStoreOptions `json:"store_options"`
	JSON         namespaceInstanceDeleteResponseSourceParamsWebCrawlerJSON         `json:"-"`
}

func (*NamespaceInstanceDeleteResponseSourceParamsWebCrawler) UnmarshalJSON

func (r *NamespaceInstanceDeleteResponseSourceParamsWebCrawler) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceDeleteResponseSourceParamsWebCrawlerCrawlOptions

type NamespaceInstanceDeleteResponseSourceParamsWebCrawlerCrawlOptions struct {
	Depth                float64                                                                 `json:"depth"`
	IncludeExternalLinks bool                                                                    `json:"include_external_links"`
	IncludeSubdomains    bool                                                                    `json:"include_subdomains"`
	MaxAge               float64                                                                 `json:"max_age"`
	Source               NamespaceInstanceDeleteResponseSourceParamsWebCrawlerCrawlOptionsSource `json:"source"`
	JSON                 namespaceInstanceDeleteResponseSourceParamsWebCrawlerCrawlOptionsJSON   `json:"-"`
}

func (*NamespaceInstanceDeleteResponseSourceParamsWebCrawlerCrawlOptions) UnmarshalJSON

type NamespaceInstanceDeleteResponseSourceParamsWebCrawlerCrawlOptionsSource

type NamespaceInstanceDeleteResponseSourceParamsWebCrawlerCrawlOptionsSource string
const (
	NamespaceInstanceDeleteResponseSourceParamsWebCrawlerCrawlOptionsSourceAll      NamespaceInstanceDeleteResponseSourceParamsWebCrawlerCrawlOptionsSource = "all"
	NamespaceInstanceDeleteResponseSourceParamsWebCrawlerCrawlOptionsSourceSitemaps NamespaceInstanceDeleteResponseSourceParamsWebCrawlerCrawlOptionsSource = "sitemaps"
	NamespaceInstanceDeleteResponseSourceParamsWebCrawlerCrawlOptionsSourceLinks    NamespaceInstanceDeleteResponseSourceParamsWebCrawlerCrawlOptionsSource = "links"
)

func (NamespaceInstanceDeleteResponseSourceParamsWebCrawlerCrawlOptionsSource) IsKnown

type NamespaceInstanceDeleteResponseSourceParamsWebCrawlerParseOptions

type NamespaceInstanceDeleteResponseSourceParamsWebCrawlerParseOptions struct {
	// List of path-to-selector mappings for extracting specific content from crawled
	// pages. Each entry pairs a URL glob pattern with a CSS selector. The first
	// matching path wins. Only the matched HTML fragment is stored and indexed. Omit
	// the field to disable content selection — empty arrays are rejected.
	ContentSelector []NamespaceInstanceDeleteResponseSourceParamsWebCrawlerParseOptionsContentSelector `json:"content_selector"`
	// Up to 5 custom HTTP headers sent with each crawl request. Names must be RFC-7230
	// token characters (no spaces, colons, or control characters); values must be
	// HTAB + printable ASCII (no CR/LF).
	IncludeHeaders map[string]string `json:"include_headers"`
	IncludeImages  bool              `json:"include_images"`
	// List of specific sitemap URLs to use for crawling. Only valid when parse_type is
	// 'sitemap'.
	SpecificSitemaps    []string                                                              `json:"specific_sitemaps" format:"uri"`
	UseBrowserRendering bool                                                                  `json:"use_browser_rendering"`
	JSON                namespaceInstanceDeleteResponseSourceParamsWebCrawlerParseOptionsJSON `json:"-"`
}

func (*NamespaceInstanceDeleteResponseSourceParamsWebCrawlerParseOptions) UnmarshalJSON

type NamespaceInstanceDeleteResponseSourceParamsWebCrawlerParseOptionsContentSelector

type NamespaceInstanceDeleteResponseSourceParamsWebCrawlerParseOptionsContentSelector struct {
	// Glob pattern to match against the page URL path. Uses standard glob syntax: \*
	// matches within a segment, \*\* crosses directories.
	Path string `json:"path" api:"required"`
	// CSS selector to extract content from pages matching the path pattern. Must not
	// contain disallowed characters (;, `, $, {, }, \). Must target a single element;
	// if multiple elements match, the selector is ignored and the full page is used.
	Selector string                                                                               `json:"selector" api:"required"`
	JSON     namespaceInstanceDeleteResponseSourceParamsWebCrawlerParseOptionsContentSelectorJSON `json:"-"`
}

func (*NamespaceInstanceDeleteResponseSourceParamsWebCrawlerParseOptionsContentSelector) UnmarshalJSON

type NamespaceInstanceDeleteResponseSourceParamsWebCrawlerParseType

type NamespaceInstanceDeleteResponseSourceParamsWebCrawlerParseType string
const (
	NamespaceInstanceDeleteResponseSourceParamsWebCrawlerParseTypeSitemap NamespaceInstanceDeleteResponseSourceParamsWebCrawlerParseType = "sitemap"
	NamespaceInstanceDeleteResponseSourceParamsWebCrawlerParseTypeFeedRss NamespaceInstanceDeleteResponseSourceParamsWebCrawlerParseType = "feed-rss"
	NamespaceInstanceDeleteResponseSourceParamsWebCrawlerParseTypeCrawl   NamespaceInstanceDeleteResponseSourceParamsWebCrawlerParseType = "crawl"
)

func (NamespaceInstanceDeleteResponseSourceParamsWebCrawlerParseType) IsKnown

type NamespaceInstanceDeleteResponseSourceParamsWebCrawlerStoreOptions

type NamespaceInstanceDeleteResponseSourceParamsWebCrawlerStoreOptions struct {
	StorageID      string                                                                `json:"storage_id" api:"required"`
	R2Jurisdiction string                                                                `json:"r2_jurisdiction"`
	StorageType    r2.Provider                                                           `json:"storage_type"`
	JSON           namespaceInstanceDeleteResponseSourceParamsWebCrawlerStoreOptionsJSON `json:"-"`
}

func (*NamespaceInstanceDeleteResponseSourceParamsWebCrawlerStoreOptions) UnmarshalJSON

type NamespaceInstanceDeleteResponseSyncInterval

type NamespaceInstanceDeleteResponseSyncInterval float64

Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).

const (
	NamespaceInstanceDeleteResponseSyncInterval900   NamespaceInstanceDeleteResponseSyncInterval = 900
	NamespaceInstanceDeleteResponseSyncInterval1800  NamespaceInstanceDeleteResponseSyncInterval = 1800
	NamespaceInstanceDeleteResponseSyncInterval3600  NamespaceInstanceDeleteResponseSyncInterval = 3600
	NamespaceInstanceDeleteResponseSyncInterval7200  NamespaceInstanceDeleteResponseSyncInterval = 7200
	NamespaceInstanceDeleteResponseSyncInterval14400 NamespaceInstanceDeleteResponseSyncInterval = 14400
	NamespaceInstanceDeleteResponseSyncInterval21600 NamespaceInstanceDeleteResponseSyncInterval = 21600
	NamespaceInstanceDeleteResponseSyncInterval43200 NamespaceInstanceDeleteResponseSyncInterval = 43200
	NamespaceInstanceDeleteResponseSyncInterval86400 NamespaceInstanceDeleteResponseSyncInterval = 86400
)

func (NamespaceInstanceDeleteResponseSyncInterval) IsKnown

type NamespaceInstanceDeleteResponseType

type NamespaceInstanceDeleteResponseType string
const (
	NamespaceInstanceDeleteResponseTypeR2         NamespaceInstanceDeleteResponseType = "r2"
	NamespaceInstanceDeleteResponseTypeWebCrawler NamespaceInstanceDeleteResponseType = "web-crawler"
)

func (NamespaceInstanceDeleteResponseType) IsKnown

type NamespaceInstanceItemChunksParams

type NamespaceInstanceItemChunksParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	Limit     param.Field[int64]  `query:"limit"`
	Offset    param.Field[int64]  `query:"offset"`
}

func (NamespaceInstanceItemChunksParams) URLQuery

func (r NamespaceInstanceItemChunksParams) URLQuery() (v url.Values)

URLQuery serializes NamespaceInstanceItemChunksParams's query parameters as `url.Values`.

type NamespaceInstanceItemChunksResponse

type NamespaceInstanceItemChunksResponse struct {
	ID        string                                  `json:"id" api:"required"`
	Item      NamespaceInstanceItemChunksResponseItem `json:"item" api:"required"`
	Text      string                                  `json:"text" api:"required"`
	EndByte   float64                                 `json:"end_byte"`
	StartByte float64                                 `json:"start_byte"`
	JSON      namespaceInstanceItemChunksResponseJSON `json:"-"`
}

func (*NamespaceInstanceItemChunksResponse) UnmarshalJSON

func (r *NamespaceInstanceItemChunksResponse) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceItemChunksResponseEnvelope

type NamespaceInstanceItemChunksResponseEnvelope struct {
	Result     []NamespaceInstanceItemChunksResponse                 `json:"result" api:"required"`
	ResultInfo NamespaceInstanceItemChunksResponseEnvelopeResultInfo `json:"result_info" api:"required"`
	Success    bool                                                  `json:"success" api:"required"`
	JSON       namespaceInstanceItemChunksResponseEnvelopeJSON       `json:"-"`
}

func (*NamespaceInstanceItemChunksResponseEnvelope) UnmarshalJSON

func (r *NamespaceInstanceItemChunksResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceItemChunksResponseEnvelopeResultInfo

type NamespaceInstanceItemChunksResponseEnvelopeResultInfo struct {
	Count  int64                                                     `json:"count" api:"required"`
	Limit  int64                                                     `json:"limit" api:"required"`
	Offset int64                                                     `json:"offset" api:"required"`
	Total  int64                                                     `json:"total" api:"required"`
	JSON   namespaceInstanceItemChunksResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*NamespaceInstanceItemChunksResponseEnvelopeResultInfo) UnmarshalJSON

func (r *NamespaceInstanceItemChunksResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceItemChunksResponseItem

type NamespaceInstanceItemChunksResponseItem struct {
	Key       string                                      `json:"key" api:"required"`
	Metadata  map[string]interface{}                      `json:"metadata"`
	Timestamp float64                                     `json:"timestamp"`
	JSON      namespaceInstanceItemChunksResponseItemJSON `json:"-"`
}

func (*NamespaceInstanceItemChunksResponseItem) UnmarshalJSON

func (r *NamespaceInstanceItemChunksResponseItem) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceItemDeleteParams

type NamespaceInstanceItemDeleteParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type NamespaceInstanceItemDeleteResponse

type NamespaceInstanceItemDeleteResponse struct {
	Key  string                                  `json:"key" api:"required"`
	JSON namespaceInstanceItemDeleteResponseJSON `json:"-"`
}

func (*NamespaceInstanceItemDeleteResponse) UnmarshalJSON

func (r *NamespaceInstanceItemDeleteResponse) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceItemDeleteResponseEnvelope

type NamespaceInstanceItemDeleteResponseEnvelope struct {
	Result  NamespaceInstanceItemDeleteResponse             `json:"result" api:"required"`
	Success bool                                            `json:"success" api:"required"`
	JSON    namespaceInstanceItemDeleteResponseEnvelopeJSON `json:"-"`
}

func (*NamespaceInstanceItemDeleteResponseEnvelope) UnmarshalJSON

func (r *NamespaceInstanceItemDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceItemDownloadParams

type NamespaceInstanceItemDownloadParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type NamespaceInstanceItemGetParams

type NamespaceInstanceItemGetParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type NamespaceInstanceItemGetResponse

type NamespaceInstanceItemGetResponse struct {
	ID          string                                     `json:"id" api:"required"`
	Checksum    string                                     `json:"checksum" api:"required"`
	ChunksCount int64                                      `json:"chunks_count" api:"required,nullable"`
	CreatedAt   time.Time                                  `json:"created_at" api:"required" format:"date-time"`
	FileSize    float64                                    `json:"file_size" api:"required,nullable"`
	Key         string                                     `json:"key" api:"required"`
	LastSeenAt  time.Time                                  `json:"last_seen_at" api:"required" format:"date-time"`
	Namespace   string                                     `json:"namespace" api:"required"`
	NextAction  NamespaceInstanceItemGetResponseNextAction `json:"next_action" api:"required,nullable"`
	// Identifies which data source this item belongs to. "builtin" for uploaded files,
	// "{type}:{source}" for external sources, null for legacy items.
	SourceID string                                 `json:"source_id" api:"required,nullable"`
	Status   NamespaceInstanceItemGetResponseStatus `json:"status" api:"required"`
	Error    string                                 `json:"error"`
	JSON     namespaceInstanceItemGetResponseJSON   `json:"-"`
}

func (*NamespaceInstanceItemGetResponse) UnmarshalJSON

func (r *NamespaceInstanceItemGetResponse) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceItemGetResponseEnvelope

type NamespaceInstanceItemGetResponseEnvelope struct {
	Result  NamespaceInstanceItemGetResponse             `json:"result" api:"required"`
	Success bool                                         `json:"success" api:"required"`
	JSON    namespaceInstanceItemGetResponseEnvelopeJSON `json:"-"`
}

func (*NamespaceInstanceItemGetResponseEnvelope) UnmarshalJSON

func (r *NamespaceInstanceItemGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceItemGetResponseNextAction

type NamespaceInstanceItemGetResponseNextAction string
const (
	NamespaceInstanceItemGetResponseNextActionIndex  NamespaceInstanceItemGetResponseNextAction = "INDEX"
	NamespaceInstanceItemGetResponseNextActionDelete NamespaceInstanceItemGetResponseNextAction = "DELETE"
)

func (NamespaceInstanceItemGetResponseNextAction) IsKnown

type NamespaceInstanceItemGetResponseStatus

type NamespaceInstanceItemGetResponseStatus string
const (
	NamespaceInstanceItemGetResponseStatusQueued    NamespaceInstanceItemGetResponseStatus = "queued"
	NamespaceInstanceItemGetResponseStatusRunning   NamespaceInstanceItemGetResponseStatus = "running"
	NamespaceInstanceItemGetResponseStatusCompleted NamespaceInstanceItemGetResponseStatus = "completed"
	NamespaceInstanceItemGetResponseStatusError     NamespaceInstanceItemGetResponseStatus = "error"
	NamespaceInstanceItemGetResponseStatusSkipped   NamespaceInstanceItemGetResponseStatus = "skipped"
	NamespaceInstanceItemGetResponseStatusOutdated  NamespaceInstanceItemGetResponseStatus = "outdated"
)

func (NamespaceInstanceItemGetResponseStatus) IsKnown

type NamespaceInstanceItemListParams

type NamespaceInstanceItemListParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Filter items by their unique ID. Returns at most one item.
	ItemID param.Field[string] `query:"item_id"`
	// JSON-encoded metadata filter using Vectorize filter syntax. Examples:
	// {"folder":"reports/"},
	// {"timestamp":{"$gte":1700000000000}}, {"folder":{"$in":["docs/","reports/"]}}
	MetadataFilter param.Field[string] `query:"metadata_filter"`
	Page           param.Field[int64]  `query:"page"`
	PerPage        param.Field[int64]  `query:"per_page"`
	Search         param.Field[string] `query:"search"`
	// Sort order for items. "status" (default) sorts by status priority then
	// last_seen_at. "modified_at" sorts by file modification time (most recent first),
	// falling back to created_at.
	SortBy param.Field[NamespaceInstanceItemListParamsSortBy] `query:"sort_by"`
	// Filter items by source_id. Use "builtin" for uploaded files, or a source
	// identifier like "web-crawler:https://example.com".
	Source param.Field[string]                                `query:"source"`
	Status param.Field[NamespaceInstanceItemListParamsStatus] `query:"status"`
}

func (NamespaceInstanceItemListParams) URLQuery

func (r NamespaceInstanceItemListParams) URLQuery() (v url.Values)

URLQuery serializes NamespaceInstanceItemListParams's query parameters as `url.Values`.

type NamespaceInstanceItemListParamsSortBy

type NamespaceInstanceItemListParamsSortBy string

Sort order for items. "status" (default) sorts by status priority then last_seen_at. "modified_at" sorts by file modification time (most recent first), falling back to created_at.

const (
	NamespaceInstanceItemListParamsSortByStatus     NamespaceInstanceItemListParamsSortBy = "status"
	NamespaceInstanceItemListParamsSortByModifiedAt NamespaceInstanceItemListParamsSortBy = "modified_at"
)

func (NamespaceInstanceItemListParamsSortBy) IsKnown

type NamespaceInstanceItemListParamsStatus

type NamespaceInstanceItemListParamsStatus string
const (
	NamespaceInstanceItemListParamsStatusQueued    NamespaceInstanceItemListParamsStatus = "queued"
	NamespaceInstanceItemListParamsStatusRunning   NamespaceInstanceItemListParamsStatus = "running"
	NamespaceInstanceItemListParamsStatusCompleted NamespaceInstanceItemListParamsStatus = "completed"
	NamespaceInstanceItemListParamsStatusError     NamespaceInstanceItemListParamsStatus = "error"
	NamespaceInstanceItemListParamsStatusSkipped   NamespaceInstanceItemListParamsStatus = "skipped"
	NamespaceInstanceItemListParamsStatusOutdated  NamespaceInstanceItemListParamsStatus = "outdated"
)

func (NamespaceInstanceItemListParamsStatus) IsKnown

type NamespaceInstanceItemListResponse

type NamespaceInstanceItemListResponse struct {
	ID          string                                      `json:"id" api:"required"`
	Checksum    string                                      `json:"checksum" api:"required"`
	ChunksCount int64                                       `json:"chunks_count" api:"required,nullable"`
	CreatedAt   time.Time                                   `json:"created_at" api:"required" format:"date-time"`
	FileSize    float64                                     `json:"file_size" api:"required,nullable"`
	Key         string                                      `json:"key" api:"required"`
	LastSeenAt  time.Time                                   `json:"last_seen_at" api:"required" format:"date-time"`
	Namespace   string                                      `json:"namespace" api:"required"`
	NextAction  NamespaceInstanceItemListResponseNextAction `json:"next_action" api:"required,nullable"`
	// Identifies which data source this item belongs to. "builtin" for uploaded files,
	// "{type}:{source}" for external sources, null for legacy items.
	SourceID string                                  `json:"source_id" api:"required,nullable"`
	Status   NamespaceInstanceItemListResponseStatus `json:"status" api:"required"`
	Error    string                                  `json:"error"`
	JSON     namespaceInstanceItemListResponseJSON   `json:"-"`
}

func (*NamespaceInstanceItemListResponse) UnmarshalJSON

func (r *NamespaceInstanceItemListResponse) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceItemListResponseNextAction

type NamespaceInstanceItemListResponseNextAction string
const (
	NamespaceInstanceItemListResponseNextActionIndex  NamespaceInstanceItemListResponseNextAction = "INDEX"
	NamespaceInstanceItemListResponseNextActionDelete NamespaceInstanceItemListResponseNextAction = "DELETE"
)

func (NamespaceInstanceItemListResponseNextAction) IsKnown

type NamespaceInstanceItemListResponseStatus

type NamespaceInstanceItemListResponseStatus string
const (
	NamespaceInstanceItemListResponseStatusQueued    NamespaceInstanceItemListResponseStatus = "queued"
	NamespaceInstanceItemListResponseStatusRunning   NamespaceInstanceItemListResponseStatus = "running"
	NamespaceInstanceItemListResponseStatusCompleted NamespaceInstanceItemListResponseStatus = "completed"
	NamespaceInstanceItemListResponseStatusError     NamespaceInstanceItemListResponseStatus = "error"
	NamespaceInstanceItemListResponseStatusSkipped   NamespaceInstanceItemListResponseStatus = "skipped"
	NamespaceInstanceItemListResponseStatusOutdated  NamespaceInstanceItemListResponseStatus = "outdated"
)

func (NamespaceInstanceItemListResponseStatus) IsKnown

type NamespaceInstanceItemLogsParams

type NamespaceInstanceItemLogsParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	Cursor    param.Field[string] `query:"cursor"`
	Limit     param.Field[int64]  `query:"limit"`
}

func (NamespaceInstanceItemLogsParams) URLQuery

func (r NamespaceInstanceItemLogsParams) URLQuery() (v url.Values)

URLQuery serializes NamespaceInstanceItemLogsParams's query parameters as `url.Values`.

type NamespaceInstanceItemLogsResponse

type NamespaceInstanceItemLogsResponse struct {
	Action           string                                `json:"action" api:"required"`
	ChunkCount       int64                                 `json:"chunkCount" api:"required,nullable"`
	ErrorType        string                                `json:"errorType" api:"required,nullable"`
	FileKey          string                                `json:"fileKey" api:"required"`
	Message          string                                `json:"message" api:"required,nullable"`
	ProcessingTimeMs int64                                 `json:"processingTimeMs" api:"required,nullable"`
	Timestamp        time.Time                             `json:"timestamp" api:"required" format:"date-time"`
	JSON             namespaceInstanceItemLogsResponseJSON `json:"-"`
}

func (*NamespaceInstanceItemLogsResponse) UnmarshalJSON

func (r *NamespaceInstanceItemLogsResponse) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceItemLogsResponseEnvelope

type NamespaceInstanceItemLogsResponseEnvelope struct {
	Result     []NamespaceInstanceItemLogsResponse                 `json:"result" api:"required"`
	ResultInfo NamespaceInstanceItemLogsResponseEnvelopeResultInfo `json:"result_info" api:"required"`
	Success    bool                                                `json:"success" api:"required"`
	JSON       namespaceInstanceItemLogsResponseEnvelopeJSON       `json:"-"`
}

func (*NamespaceInstanceItemLogsResponseEnvelope) UnmarshalJSON

func (r *NamespaceInstanceItemLogsResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceItemLogsResponseEnvelopeResultInfo

type NamespaceInstanceItemLogsResponseEnvelopeResultInfo struct {
	Count     int64                                                   `json:"count" api:"required"`
	Cursor    string                                                  `json:"cursor" api:"required,nullable"`
	PerPage   int64                                                   `json:"per_page" api:"required"`
	Truncated bool                                                    `json:"truncated" api:"required"`
	JSON      namespaceInstanceItemLogsResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*NamespaceInstanceItemLogsResponseEnvelopeResultInfo) UnmarshalJSON

func (r *NamespaceInstanceItemLogsResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceItemNewOrUpdateParams

type NamespaceInstanceItemNewOrUpdateParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Item key / filename. Must not exceed 128 characters.
	Key        param.Field[string]                                           `json:"key" api:"required"`
	NextAction param.Field[NamespaceInstanceItemNewOrUpdateParamsNextAction] `json:"next_action" api:"required"`
	// Wait for indexing to fully complete before responding. On RAGs with vector
	// indexing enabled, this additionally waits for Vectorize ingestion confirmation
	// (up to 40s) so the returned item reflects a queryable state. On timeout the item
	// is returned in `running` state and the background alarm continues polling.
	// Defaults to false.
	WaitForCompletion param.Field[bool] `json:"wait_for_completion"`
}

func (NamespaceInstanceItemNewOrUpdateParams) MarshalJSON

func (r NamespaceInstanceItemNewOrUpdateParams) MarshalJSON() (data []byte, err error)

type NamespaceInstanceItemNewOrUpdateParamsNextAction

type NamespaceInstanceItemNewOrUpdateParamsNextAction string
const (
	NamespaceInstanceItemNewOrUpdateParamsNextActionIndex NamespaceInstanceItemNewOrUpdateParamsNextAction = "INDEX"
)

func (NamespaceInstanceItemNewOrUpdateParamsNextAction) IsKnown

type NamespaceInstanceItemNewOrUpdateResponse

type NamespaceInstanceItemNewOrUpdateResponse struct {
	ID          string                                             `json:"id" api:"required"`
	Checksum    string                                             `json:"checksum" api:"required"`
	ChunksCount int64                                              `json:"chunks_count" api:"required,nullable"`
	CreatedAt   time.Time                                          `json:"created_at" api:"required" format:"date-time"`
	FileSize    float64                                            `json:"file_size" api:"required,nullable"`
	Key         string                                             `json:"key" api:"required"`
	LastSeenAt  time.Time                                          `json:"last_seen_at" api:"required" format:"date-time"`
	Namespace   string                                             `json:"namespace" api:"required"`
	NextAction  NamespaceInstanceItemNewOrUpdateResponseNextAction `json:"next_action" api:"required,nullable"`
	// Identifies which data source this item belongs to. "builtin" for uploaded files,
	// "{type}:{source}" for external sources, null for legacy items.
	SourceID string                                         `json:"source_id" api:"required,nullable"`
	Status   NamespaceInstanceItemNewOrUpdateResponseStatus `json:"status" api:"required"`
	Error    string                                         `json:"error"`
	JSON     namespaceInstanceItemNewOrUpdateResponseJSON   `json:"-"`
}

func (*NamespaceInstanceItemNewOrUpdateResponse) UnmarshalJSON

func (r *NamespaceInstanceItemNewOrUpdateResponse) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceItemNewOrUpdateResponseEnvelope

type NamespaceInstanceItemNewOrUpdateResponseEnvelope struct {
	Result  NamespaceInstanceItemNewOrUpdateResponse             `json:"result" api:"required"`
	Success bool                                                 `json:"success" api:"required"`
	JSON    namespaceInstanceItemNewOrUpdateResponseEnvelopeJSON `json:"-"`
}

func (*NamespaceInstanceItemNewOrUpdateResponseEnvelope) UnmarshalJSON

func (r *NamespaceInstanceItemNewOrUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceItemNewOrUpdateResponseNextAction

type NamespaceInstanceItemNewOrUpdateResponseNextAction string
const (
	NamespaceInstanceItemNewOrUpdateResponseNextActionIndex  NamespaceInstanceItemNewOrUpdateResponseNextAction = "INDEX"
	NamespaceInstanceItemNewOrUpdateResponseNextActionDelete NamespaceInstanceItemNewOrUpdateResponseNextAction = "DELETE"
)

func (NamespaceInstanceItemNewOrUpdateResponseNextAction) IsKnown

type NamespaceInstanceItemNewOrUpdateResponseStatus

type NamespaceInstanceItemNewOrUpdateResponseStatus string
const (
	NamespaceInstanceItemNewOrUpdateResponseStatusQueued    NamespaceInstanceItemNewOrUpdateResponseStatus = "queued"
	NamespaceInstanceItemNewOrUpdateResponseStatusRunning   NamespaceInstanceItemNewOrUpdateResponseStatus = "running"
	NamespaceInstanceItemNewOrUpdateResponseStatusCompleted NamespaceInstanceItemNewOrUpdateResponseStatus = "completed"
	NamespaceInstanceItemNewOrUpdateResponseStatusError     NamespaceInstanceItemNewOrUpdateResponseStatus = "error"
	NamespaceInstanceItemNewOrUpdateResponseStatusSkipped   NamespaceInstanceItemNewOrUpdateResponseStatus = "skipped"
	NamespaceInstanceItemNewOrUpdateResponseStatusOutdated  NamespaceInstanceItemNewOrUpdateResponseStatus = "outdated"
)

func (NamespaceInstanceItemNewOrUpdateResponseStatus) IsKnown

type NamespaceInstanceItemService

type NamespaceInstanceItemService struct {
	Options []option.RequestOption
}

NamespaceInstanceItemService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewNamespaceInstanceItemService method instead.

func NewNamespaceInstanceItemService

func NewNamespaceInstanceItemService(opts ...option.RequestOption) (r *NamespaceInstanceItemService)

NewNamespaceInstanceItemService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*NamespaceInstanceItemService) Chunks

Lists chunks for a specific item in an AI Search instance, including their text content.

func (*NamespaceInstanceItemService) Delete

Deletes a file from a managed AI Search instance and triggers a reindex.

func (*NamespaceInstanceItemService) Download

Downloads the raw file content for a specific item from the managed AI Search instance storage.

func (*NamespaceInstanceItemService) Get

Retrieves a specific indexed item from an AI Search instance.

func (*NamespaceInstanceItemService) List

Lists indexed items in an AI Search instance.

func (*NamespaceInstanceItemService) ListAutoPaging

Lists indexed items in an AI Search instance.

func (*NamespaceInstanceItemService) Logs

Lists processing logs for a specific item in an AI Search instance.

func (*NamespaceInstanceItemService) NewOrUpdate

Creates or updates an indexed item in an AI Search instance.

func (*NamespaceInstanceItemService) Sync

Syncs an item to an AI Search instance index.

func (*NamespaceInstanceItemService) Upload

Uploads a file to a managed AI Search instance via multipart/form-data (max 4MB).

type NamespaceInstanceItemSyncParams

type NamespaceInstanceItemSyncParams struct {
	AccountID  param.Field[string]                                    `path:"account_id" api:"required"`
	NextAction param.Field[NamespaceInstanceItemSyncParamsNextAction] `json:"next_action" api:"required"`
	// Wait for indexing to fully complete before responding. On RAGs with vector
	// indexing enabled, this additionally waits for Vectorize ingestion confirmation
	// (up to 40s) so the returned item reflects a queryable state. On timeout the item
	// is returned in `running` state and the background alarm continues polling.
	// Defaults to false.
	WaitForCompletion param.Field[bool] `json:"wait_for_completion"`
}

func (NamespaceInstanceItemSyncParams) MarshalJSON

func (r NamespaceInstanceItemSyncParams) MarshalJSON() (data []byte, err error)

type NamespaceInstanceItemSyncParamsNextAction

type NamespaceInstanceItemSyncParamsNextAction string
const (
	NamespaceInstanceItemSyncParamsNextActionIndex NamespaceInstanceItemSyncParamsNextAction = "INDEX"
)

func (NamespaceInstanceItemSyncParamsNextAction) IsKnown

type NamespaceInstanceItemSyncResponse

type NamespaceInstanceItemSyncResponse struct {
	ID          string                                      `json:"id" api:"required"`
	Checksum    string                                      `json:"checksum" api:"required"`
	ChunksCount int64                                       `json:"chunks_count" api:"required,nullable"`
	CreatedAt   time.Time                                   `json:"created_at" api:"required" format:"date-time"`
	FileSize    float64                                     `json:"file_size" api:"required,nullable"`
	Key         string                                      `json:"key" api:"required"`
	LastSeenAt  time.Time                                   `json:"last_seen_at" api:"required" format:"date-time"`
	Namespace   string                                      `json:"namespace" api:"required"`
	NextAction  NamespaceInstanceItemSyncResponseNextAction `json:"next_action" api:"required,nullable"`
	// Identifies which data source this item belongs to. "builtin" for uploaded files,
	// "{type}:{source}" for external sources, null for legacy items.
	SourceID string                                  `json:"source_id" api:"required,nullable"`
	Status   NamespaceInstanceItemSyncResponseStatus `json:"status" api:"required"`
	Error    string                                  `json:"error"`
	JSON     namespaceInstanceItemSyncResponseJSON   `json:"-"`
}

func (*NamespaceInstanceItemSyncResponse) UnmarshalJSON

func (r *NamespaceInstanceItemSyncResponse) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceItemSyncResponseEnvelope

type NamespaceInstanceItemSyncResponseEnvelope struct {
	Result  NamespaceInstanceItemSyncResponse             `json:"result" api:"required"`
	Success bool                                          `json:"success" api:"required"`
	JSON    namespaceInstanceItemSyncResponseEnvelopeJSON `json:"-"`
}

func (*NamespaceInstanceItemSyncResponseEnvelope) UnmarshalJSON

func (r *NamespaceInstanceItemSyncResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceItemSyncResponseNextAction

type NamespaceInstanceItemSyncResponseNextAction string
const (
	NamespaceInstanceItemSyncResponseNextActionIndex  NamespaceInstanceItemSyncResponseNextAction = "INDEX"
	NamespaceInstanceItemSyncResponseNextActionDelete NamespaceInstanceItemSyncResponseNextAction = "DELETE"
)

func (NamespaceInstanceItemSyncResponseNextAction) IsKnown

type NamespaceInstanceItemSyncResponseStatus

type NamespaceInstanceItemSyncResponseStatus string
const (
	NamespaceInstanceItemSyncResponseStatusQueued    NamespaceInstanceItemSyncResponseStatus = "queued"
	NamespaceInstanceItemSyncResponseStatusRunning   NamespaceInstanceItemSyncResponseStatus = "running"
	NamespaceInstanceItemSyncResponseStatusCompleted NamespaceInstanceItemSyncResponseStatus = "completed"
	NamespaceInstanceItemSyncResponseStatusError     NamespaceInstanceItemSyncResponseStatus = "error"
	NamespaceInstanceItemSyncResponseStatusSkipped   NamespaceInstanceItemSyncResponseStatus = "skipped"
	NamespaceInstanceItemSyncResponseStatusOutdated  NamespaceInstanceItemSyncResponseStatus = "outdated"
)

func (NamespaceInstanceItemSyncResponseStatus) IsKnown

type NamespaceInstanceItemUploadParams

type NamespaceInstanceItemUploadParams struct {
	AccountID param.Field[string]                   `path:"account_id" api:"required"`
	File      NamespaceInstanceItemUploadParamsFile `json:"file" api:"required"`
}

func (NamespaceInstanceItemUploadParams) MarshalMultipart

func (r NamespaceInstanceItemUploadParams) MarshalMultipart() (data []byte, contentType string, err error)

type NamespaceInstanceItemUploadParamsFile

type NamespaceInstanceItemUploadParamsFile struct {
	// The file to upload (max 4MB). Filename must not exceed 128 characters.
	File param.Field[io.Reader] `json:"file" api:"required" format:"binary"`
	// JSON string of custom metadata key-value pairs.
	Metadata param.Field[string] `json:"metadata"`
	// Wait for indexing to fully complete before responding. On RAGs with vector
	// indexing enabled, this additionally waits for Vectorize ingestion confirmation
	// (up to 40s) so the returned item reflects a queryable state. On timeout the item
	// is returned in `running` state and the background alarm continues polling.
	// Defaults to false.
	WaitForCompletion param.Field[bool] `json:"wait_for_completion"`
}

func (NamespaceInstanceItemUploadParamsFile) MarshalJSON

func (r NamespaceInstanceItemUploadParamsFile) MarshalJSON() (data []byte, err error)

type NamespaceInstanceItemUploadResponse

type NamespaceInstanceItemUploadResponse struct {
	ID          string                                        `json:"id" api:"required"`
	Checksum    string                                        `json:"checksum" api:"required"`
	ChunksCount int64                                         `json:"chunks_count" api:"required,nullable"`
	CreatedAt   time.Time                                     `json:"created_at" api:"required" format:"date-time"`
	FileSize    float64                                       `json:"file_size" api:"required,nullable"`
	Key         string                                        `json:"key" api:"required"`
	LastSeenAt  time.Time                                     `json:"last_seen_at" api:"required" format:"date-time"`
	Namespace   string                                        `json:"namespace" api:"required"`
	NextAction  NamespaceInstanceItemUploadResponseNextAction `json:"next_action" api:"required,nullable"`
	// Identifies which data source this item belongs to. "builtin" for uploaded files,
	// "{type}:{source}" for external sources, null for legacy items.
	SourceID string                                    `json:"source_id" api:"required,nullable"`
	Status   NamespaceInstanceItemUploadResponseStatus `json:"status" api:"required"`
	Error    string                                    `json:"error"`
	JSON     namespaceInstanceItemUploadResponseJSON   `json:"-"`
}

func (*NamespaceInstanceItemUploadResponse) UnmarshalJSON

func (r *NamespaceInstanceItemUploadResponse) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceItemUploadResponseEnvelope

type NamespaceInstanceItemUploadResponseEnvelope struct {
	Result  NamespaceInstanceItemUploadResponse             `json:"result" api:"required"`
	Success bool                                            `json:"success" api:"required"`
	JSON    namespaceInstanceItemUploadResponseEnvelopeJSON `json:"-"`
}

func (*NamespaceInstanceItemUploadResponseEnvelope) UnmarshalJSON

func (r *NamespaceInstanceItemUploadResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceItemUploadResponseNextAction

type NamespaceInstanceItemUploadResponseNextAction string
const (
	NamespaceInstanceItemUploadResponseNextActionIndex  NamespaceInstanceItemUploadResponseNextAction = "INDEX"
	NamespaceInstanceItemUploadResponseNextActionDelete NamespaceInstanceItemUploadResponseNextAction = "DELETE"
)

func (NamespaceInstanceItemUploadResponseNextAction) IsKnown

type NamespaceInstanceItemUploadResponseStatus

type NamespaceInstanceItemUploadResponseStatus string
const (
	NamespaceInstanceItemUploadResponseStatusQueued    NamespaceInstanceItemUploadResponseStatus = "queued"
	NamespaceInstanceItemUploadResponseStatusRunning   NamespaceInstanceItemUploadResponseStatus = "running"
	NamespaceInstanceItemUploadResponseStatusCompleted NamespaceInstanceItemUploadResponseStatus = "completed"
	NamespaceInstanceItemUploadResponseStatusError     NamespaceInstanceItemUploadResponseStatus = "error"
	NamespaceInstanceItemUploadResponseStatusSkipped   NamespaceInstanceItemUploadResponseStatus = "skipped"
	NamespaceInstanceItemUploadResponseStatusOutdated  NamespaceInstanceItemUploadResponseStatus = "outdated"
)

func (NamespaceInstanceItemUploadResponseStatus) IsKnown

type NamespaceInstanceJobGetParams

type NamespaceInstanceJobGetParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type NamespaceInstanceJobGetResponse

type NamespaceInstanceJobGetResponse struct {
	ID          string                                `json:"id" api:"required"`
	Source      NamespaceInstanceJobGetResponseSource `json:"source" api:"required"`
	Description string                                `json:"description"`
	EndReason   string                                `json:"end_reason"`
	EndedAt     string                                `json:"ended_at"`
	LastSeenAt  string                                `json:"last_seen_at"`
	StartedAt   string                                `json:"started_at"`
	JSON        namespaceInstanceJobGetResponseJSON   `json:"-"`
}

func (*NamespaceInstanceJobGetResponse) UnmarshalJSON

func (r *NamespaceInstanceJobGetResponse) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceJobGetResponseEnvelope

type NamespaceInstanceJobGetResponseEnvelope struct {
	Result  NamespaceInstanceJobGetResponse             `json:"result" api:"required"`
	Success bool                                        `json:"success" api:"required"`
	JSON    namespaceInstanceJobGetResponseEnvelopeJSON `json:"-"`
}

func (*NamespaceInstanceJobGetResponseEnvelope) UnmarshalJSON

func (r *NamespaceInstanceJobGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceJobGetResponseSource

type NamespaceInstanceJobGetResponseSource string
const (
	NamespaceInstanceJobGetResponseSourceUser     NamespaceInstanceJobGetResponseSource = "user"
	NamespaceInstanceJobGetResponseSourceSchedule NamespaceInstanceJobGetResponseSource = "schedule"
)

func (NamespaceInstanceJobGetResponseSource) IsKnown

type NamespaceInstanceJobListParams

type NamespaceInstanceJobListParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	Page      param.Field[int64]  `query:"page"`
	PerPage   param.Field[int64]  `query:"per_page"`
}

func (NamespaceInstanceJobListParams) URLQuery

func (r NamespaceInstanceJobListParams) URLQuery() (v url.Values)

URLQuery serializes NamespaceInstanceJobListParams's query parameters as `url.Values`.

type NamespaceInstanceJobListResponse

type NamespaceInstanceJobListResponse struct {
	ID          string                                 `json:"id" api:"required"`
	Source      NamespaceInstanceJobListResponseSource `json:"source" api:"required"`
	Description string                                 `json:"description"`
	EndReason   string                                 `json:"end_reason"`
	EndedAt     string                                 `json:"ended_at"`
	LastSeenAt  string                                 `json:"last_seen_at"`
	StartedAt   string                                 `json:"started_at"`
	JSON        namespaceInstanceJobListResponseJSON   `json:"-"`
}

func (*NamespaceInstanceJobListResponse) UnmarshalJSON

func (r *NamespaceInstanceJobListResponse) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceJobListResponseSource

type NamespaceInstanceJobListResponseSource string
const (
	NamespaceInstanceJobListResponseSourceUser     NamespaceInstanceJobListResponseSource = "user"
	NamespaceInstanceJobListResponseSourceSchedule NamespaceInstanceJobListResponseSource = "schedule"
)

func (NamespaceInstanceJobListResponseSource) IsKnown

type NamespaceInstanceJobLogsParams

type NamespaceInstanceJobLogsParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	Page      param.Field[int64]  `query:"page"`
	PerPage   param.Field[int64]  `query:"per_page"`
}

func (NamespaceInstanceJobLogsParams) URLQuery

func (r NamespaceInstanceJobLogsParams) URLQuery() (v url.Values)

URLQuery serializes NamespaceInstanceJobLogsParams's query parameters as `url.Values`.

type NamespaceInstanceJobLogsResponse

type NamespaceInstanceJobLogsResponse struct {
	ID          int64                                `json:"id" api:"required"`
	CreatedAt   float64                              `json:"created_at" api:"required"`
	Message     string                               `json:"message" api:"required"`
	MessageType int64                                `json:"message_type" api:"required"`
	JSON        namespaceInstanceJobLogsResponseJSON `json:"-"`
}

func (*NamespaceInstanceJobLogsResponse) UnmarshalJSON

func (r *NamespaceInstanceJobLogsResponse) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceJobLogsResponseEnvelope

type NamespaceInstanceJobLogsResponseEnvelope struct {
	Result     []NamespaceInstanceJobLogsResponse                 `json:"result" api:"required"`
	ResultInfo NamespaceInstanceJobLogsResponseEnvelopeResultInfo `json:"result_info" api:"required"`
	Success    bool                                               `json:"success" api:"required"`
	JSON       namespaceInstanceJobLogsResponseEnvelopeJSON       `json:"-"`
}

func (*NamespaceInstanceJobLogsResponseEnvelope) UnmarshalJSON

func (r *NamespaceInstanceJobLogsResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceJobLogsResponseEnvelopeResultInfo

type NamespaceInstanceJobLogsResponseEnvelopeResultInfo struct {
	Count      int64                                                  `json:"count" api:"required"`
	Page       int64                                                  `json:"page" api:"required"`
	PerPage    int64                                                  `json:"per_page" api:"required"`
	TotalCount int64                                                  `json:"total_count" api:"required"`
	JSON       namespaceInstanceJobLogsResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*NamespaceInstanceJobLogsResponseEnvelopeResultInfo) UnmarshalJSON

func (r *NamespaceInstanceJobLogsResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceJobNewParams

type NamespaceInstanceJobNewParams struct {
	AccountID   param.Field[string] `path:"account_id" api:"required"`
	Description param.Field[string] `json:"description"`
}

func (NamespaceInstanceJobNewParams) MarshalJSON

func (r NamespaceInstanceJobNewParams) MarshalJSON() (data []byte, err error)

type NamespaceInstanceJobNewResponse

type NamespaceInstanceJobNewResponse struct {
	ID          string                                `json:"id" api:"required"`
	Source      NamespaceInstanceJobNewResponseSource `json:"source" api:"required"`
	Description string                                `json:"description"`
	EndReason   string                                `json:"end_reason"`
	EndedAt     string                                `json:"ended_at"`
	LastSeenAt  string                                `json:"last_seen_at"`
	StartedAt   string                                `json:"started_at"`
	JSON        namespaceInstanceJobNewResponseJSON   `json:"-"`
}

func (*NamespaceInstanceJobNewResponse) UnmarshalJSON

func (r *NamespaceInstanceJobNewResponse) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceJobNewResponseEnvelope

type NamespaceInstanceJobNewResponseEnvelope struct {
	Result  NamespaceInstanceJobNewResponse             `json:"result" api:"required"`
	Success bool                                        `json:"success" api:"required"`
	JSON    namespaceInstanceJobNewResponseEnvelopeJSON `json:"-"`
}

func (*NamespaceInstanceJobNewResponseEnvelope) UnmarshalJSON

func (r *NamespaceInstanceJobNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceJobNewResponseSource

type NamespaceInstanceJobNewResponseSource string
const (
	NamespaceInstanceJobNewResponseSourceUser     NamespaceInstanceJobNewResponseSource = "user"
	NamespaceInstanceJobNewResponseSourceSchedule NamespaceInstanceJobNewResponseSource = "schedule"
)

func (NamespaceInstanceJobNewResponseSource) IsKnown

type NamespaceInstanceJobService

type NamespaceInstanceJobService struct {
	Options []option.RequestOption
}

NamespaceInstanceJobService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewNamespaceInstanceJobService method instead.

func NewNamespaceInstanceJobService

func NewNamespaceInstanceJobService(opts ...option.RequestOption) (r *NamespaceInstanceJobService)

NewNamespaceInstanceJobService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*NamespaceInstanceJobService) Get

Retrieves details for a specific AI Search indexing job.

func (*NamespaceInstanceJobService) List

Lists indexing jobs for an AI Search instance.

func (*NamespaceInstanceJobService) ListAutoPaging

Lists indexing jobs for an AI Search instance.

func (*NamespaceInstanceJobService) Logs

Lists log entries for an AI Search indexing job.

func (*NamespaceInstanceJobService) New

Creates a new indexing job for an AI Search instance.

func (*NamespaceInstanceJobService) Update

Updates the status of an AI Search indexing job.

type NamespaceInstanceJobUpdateParams

type NamespaceInstanceJobUpdateParams struct {
	AccountID param.Field[string]                                 `path:"account_id" api:"required"`
	Action    param.Field[NamespaceInstanceJobUpdateParamsAction] `json:"action" api:"required"`
}

func (NamespaceInstanceJobUpdateParams) MarshalJSON

func (r NamespaceInstanceJobUpdateParams) MarshalJSON() (data []byte, err error)

type NamespaceInstanceJobUpdateParamsAction

type NamespaceInstanceJobUpdateParamsAction string
const (
	NamespaceInstanceJobUpdateParamsActionCancel NamespaceInstanceJobUpdateParamsAction = "cancel"
)

func (NamespaceInstanceJobUpdateParamsAction) IsKnown

type NamespaceInstanceJobUpdateResponse

type NamespaceInstanceJobUpdateResponse struct {
	ID          string                                   `json:"id" api:"required"`
	Source      NamespaceInstanceJobUpdateResponseSource `json:"source" api:"required"`
	Description string                                   `json:"description"`
	EndReason   string                                   `json:"end_reason"`
	EndedAt     string                                   `json:"ended_at"`
	LastSeenAt  string                                   `json:"last_seen_at"`
	StartedAt   string                                   `json:"started_at"`
	JSON        namespaceInstanceJobUpdateResponseJSON   `json:"-"`
}

func (*NamespaceInstanceJobUpdateResponse) UnmarshalJSON

func (r *NamespaceInstanceJobUpdateResponse) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceJobUpdateResponseEnvelope

type NamespaceInstanceJobUpdateResponseEnvelope struct {
	Result  NamespaceInstanceJobUpdateResponse             `json:"result" api:"required"`
	Success bool                                           `json:"success" api:"required"`
	JSON    namespaceInstanceJobUpdateResponseEnvelopeJSON `json:"-"`
}

func (*NamespaceInstanceJobUpdateResponseEnvelope) UnmarshalJSON

func (r *NamespaceInstanceJobUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceJobUpdateResponseSource

type NamespaceInstanceJobUpdateResponseSource string
const (
	NamespaceInstanceJobUpdateResponseSourceUser     NamespaceInstanceJobUpdateResponseSource = "user"
	NamespaceInstanceJobUpdateResponseSourceSchedule NamespaceInstanceJobUpdateResponseSource = "schedule"
)

func (NamespaceInstanceJobUpdateResponseSource) IsKnown

type NamespaceInstanceListParams

type NamespaceInstanceListParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Filter by namespace.
	Namespace param.Field[string] `query:"namespace"`
	// Field to order results by.
	OrderBy param.Field[NamespaceInstanceListParamsOrderBy] `query:"order_by"`
	// Order direction.
	OrderByDirection param.Field[NamespaceInstanceListParamsOrderByDirection] `query:"order_by_direction"`
	// Page number (1-indexed).
	Page param.Field[int64] `query:"page"`
	// Number of results per page.
	PerPage param.Field[int64] `query:"per_page"`
	// Filter instances whose id contains this string (case-insensitive).
	Search param.Field[string] `query:"search"`
}

func (NamespaceInstanceListParams) URLQuery

func (r NamespaceInstanceListParams) URLQuery() (v url.Values)

URLQuery serializes NamespaceInstanceListParams's query parameters as `url.Values`.

type NamespaceInstanceListParamsOrderBy

type NamespaceInstanceListParamsOrderBy string

Field to order results by.

const (
	NamespaceInstanceListParamsOrderByCreatedAt NamespaceInstanceListParamsOrderBy = "created_at"
)

func (NamespaceInstanceListParamsOrderBy) IsKnown

type NamespaceInstanceListParamsOrderByDirection

type NamespaceInstanceListParamsOrderByDirection string

Order direction.

const (
	NamespaceInstanceListParamsOrderByDirectionAsc  NamespaceInstanceListParamsOrderByDirection = "asc"
	NamespaceInstanceListParamsOrderByDirectionDesc NamespaceInstanceListParamsOrderByDirection = "desc"
)

func (NamespaceInstanceListParamsOrderByDirection) IsKnown

type NamespaceInstanceListResponse

type NamespaceInstanceListResponse struct {
	// AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
	ID             string                                      `json:"id" api:"required"`
	CreatedAt      time.Time                                   `json:"created_at" api:"required" format:"date-time"`
	ModifiedAt     time.Time                                   `json:"modified_at" api:"required" format:"date-time"`
	AIGatewayID    string                                      `json:"ai_gateway_id" api:"nullable"`
	AISearchModel  NamespaceInstanceListResponseAISearchModel  `json:"ai_search_model" api:"nullable"`
	Cache          bool                                        `json:"cache"`
	CacheThreshold NamespaceInstanceListResponseCacheThreshold `json:"cache_threshold"`
	// Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600
	// (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200
	// (72h), 518400 (6d).
	CacheTTL       NamespaceInstanceListResponseCacheTTL         `json:"cache_ttl"`
	ChunkOverlap   int64                                         `json:"chunk_overlap"`
	ChunkSize      int64                                         `json:"chunk_size"`
	CreatedBy      string                                        `json:"created_by" api:"nullable"`
	CustomMetadata []NamespaceInstanceListResponseCustomMetadata `json:"custom_metadata"`
	EmbeddingModel NamespaceInstanceListResponseEmbeddingModel   `json:"embedding_model" api:"nullable"`
	Enable         bool                                          `json:"enable"`
	EngineVersion  float64                                       `json:"engine_version"`
	FusionMethod   NamespaceInstanceListResponseFusionMethod     `json:"fusion_method"`
	// Deprecated — use index_method instead.
	//
	// Deprecated: deprecated
	HybridSearchEnabled bool `json:"hybrid_search_enabled"`
	// Controls which storage backends are used during indexing. Defaults to
	// vector-only.
	IndexMethod          NamespaceInstanceListResponseIndexMethod          `json:"index_method"`
	IndexingOptions      NamespaceInstanceListResponseIndexingOptions      `json:"indexing_options" api:"nullable"`
	LastActivity         time.Time                                         `json:"last_activity" api:"nullable" format:"date-time"`
	MaxNumResults        int64                                             `json:"max_num_results"`
	Metadata             NamespaceInstanceListResponseMetadata             `json:"metadata"`
	ModifiedBy           string                                            `json:"modified_by" api:"nullable"`
	Namespace            string                                            `json:"namespace" api:"nullable"`
	Paused               bool                                              `json:"paused"`
	PublicEndpointID     string                                            `json:"public_endpoint_id" api:"nullable"`
	PublicEndpointParams NamespaceInstanceListResponsePublicEndpointParams `json:"public_endpoint_params"`
	Reranking            bool                                              `json:"reranking"`
	RerankingModel       NamespaceInstanceListResponseRerankingModel       `json:"reranking_model" api:"nullable"`
	RetrievalOptions     NamespaceInstanceListResponseRetrievalOptions     `json:"retrieval_options" api:"nullable"`
	RewriteModel         NamespaceInstanceListResponseRewriteModel         `json:"rewrite_model" api:"nullable"`
	RewriteQuery         bool                                              `json:"rewrite_query"`
	ScoreThreshold       float64                                           `json:"score_threshold"`
	Source               string                                            `json:"source" api:"nullable"`
	SourceParams         NamespaceInstanceListResponseSourceParams         `json:"source_params" api:"nullable"`
	Status               string                                            `json:"status"`
	// Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800
	// (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).
	SyncInterval NamespaceInstanceListResponseSyncInterval `json:"sync_interval"`
	TokenID      string                                    `json:"token_id" format:"uuid"`
	Type         NamespaceInstanceListResponseType         `json:"type" api:"nullable"`
	JSON         namespaceInstanceListResponseJSON         `json:"-"`
}

func (*NamespaceInstanceListResponse) UnmarshalJSON

func (r *NamespaceInstanceListResponse) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceListResponseAISearchModel

type NamespaceInstanceListResponseAISearchModel string
const (
	NamespaceInstanceListResponseAISearchModelCfMetaLlama3_3_70bInstructFp8Fast     NamespaceInstanceListResponseAISearchModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	NamespaceInstanceListResponseAISearchModelCfZaiOrgGlm4_7Flash                   NamespaceInstanceListResponseAISearchModel = "@cf/zai-org/glm-4.7-flash"
	NamespaceInstanceListResponseAISearchModelCfMetaLlama3_1_8bInstructFast         NamespaceInstanceListResponseAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	NamespaceInstanceListResponseAISearchModelCfMetaLlama3_1_8bInstructFp8          NamespaceInstanceListResponseAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	NamespaceInstanceListResponseAISearchModelCfMetaLlama4Scout17b16eInstruct       NamespaceInstanceListResponseAISearchModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceListResponseAISearchModelCfQwenQwen3_30bA3bFp8                 NamespaceInstanceListResponseAISearchModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	NamespaceInstanceListResponseAISearchModelCfDeepseekAIDeepseekR1DistillQwen32b  NamespaceInstanceListResponseAISearchModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	NamespaceInstanceListResponseAISearchModelCfMoonshotaiKimiK2Instruct            NamespaceInstanceListResponseAISearchModel = "@cf/moonshotai/kimi-k2-instruct"
	NamespaceInstanceListResponseAISearchModelCfGoogleGemma3_12bIt                  NamespaceInstanceListResponseAISearchModel = "@cf/google/gemma-3-12b-it"
	NamespaceInstanceListResponseAISearchModelCfGoogleGemma4_26bA4bIt               NamespaceInstanceListResponseAISearchModel = "@cf/google/gemma-4-26b-a4b-it"
	NamespaceInstanceListResponseAISearchModelCfMoonshotaiKimiK2_5                  NamespaceInstanceListResponseAISearchModel = "@cf/moonshotai/kimi-k2.5"
	NamespaceInstanceListResponseAISearchModelAnthropicClaude3_7Sonnet              NamespaceInstanceListResponseAISearchModel = "anthropic/claude-3-7-sonnet"
	NamespaceInstanceListResponseAISearchModelAnthropicClaudeSonnet4                NamespaceInstanceListResponseAISearchModel = "anthropic/claude-sonnet-4"
	NamespaceInstanceListResponseAISearchModelAnthropicClaudeOpus4                  NamespaceInstanceListResponseAISearchModel = "anthropic/claude-opus-4"
	NamespaceInstanceListResponseAISearchModelAnthropicClaude3_5Haiku               NamespaceInstanceListResponseAISearchModel = "anthropic/claude-3-5-haiku"
	NamespaceInstanceListResponseAISearchModelCerebrasQwen3_235bA22bInstruct        NamespaceInstanceListResponseAISearchModel = "cerebras/qwen-3-235b-a22b-instruct"
	NamespaceInstanceListResponseAISearchModelCerebrasQwen3_235bA22bThinking        NamespaceInstanceListResponseAISearchModel = "cerebras/qwen-3-235b-a22b-thinking"
	NamespaceInstanceListResponseAISearchModelCerebrasLlama3_3_70b                  NamespaceInstanceListResponseAISearchModel = "cerebras/llama-3.3-70b"
	NamespaceInstanceListResponseAISearchModelCerebrasLlama4Maverick17b128eInstruct NamespaceInstanceListResponseAISearchModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	NamespaceInstanceListResponseAISearchModelCerebrasLlama4Scout17b16eInstruct     NamespaceInstanceListResponseAISearchModel = "cerebras/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceListResponseAISearchModelCerebrasGptOSs120b                    NamespaceInstanceListResponseAISearchModel = "cerebras/gpt-oss-120b"
	NamespaceInstanceListResponseAISearchModelGoogleAIStudioGemini2_5Flash          NamespaceInstanceListResponseAISearchModel = "google-ai-studio/gemini-2.5-flash"
	NamespaceInstanceListResponseAISearchModelGoogleAIStudioGemini2_5Pro            NamespaceInstanceListResponseAISearchModel = "google-ai-studio/gemini-2.5-pro"
	NamespaceInstanceListResponseAISearchModelGrokGrok4                             NamespaceInstanceListResponseAISearchModel = "grok/grok-4"
	NamespaceInstanceListResponseAISearchModelGroqLlama3_3_70bVersatile             NamespaceInstanceListResponseAISearchModel = "groq/llama-3.3-70b-versatile"
	NamespaceInstanceListResponseAISearchModelGroqLlama3_1_8bInstant                NamespaceInstanceListResponseAISearchModel = "groq/llama-3.1-8b-instant"
	NamespaceInstanceListResponseAISearchModelOpenAIGpt5                            NamespaceInstanceListResponseAISearchModel = "openai/gpt-5"
	NamespaceInstanceListResponseAISearchModelOpenAIGpt5Mini                        NamespaceInstanceListResponseAISearchModel = "openai/gpt-5-mini"
	NamespaceInstanceListResponseAISearchModelOpenAIGpt5Nano                        NamespaceInstanceListResponseAISearchModel = "openai/gpt-5-nano"
	NamespaceInstanceListResponseAISearchModelEmpty                                 NamespaceInstanceListResponseAISearchModel = ""
)

func (NamespaceInstanceListResponseAISearchModel) IsKnown

type NamespaceInstanceListResponseCacheTTL

type NamespaceInstanceListResponseCacheTTL float64

Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d).

const (
	NamespaceInstanceListResponseCacheTTL600    NamespaceInstanceListResponseCacheTTL = 600
	NamespaceInstanceListResponseCacheTTL1800   NamespaceInstanceListResponseCacheTTL = 1800
	NamespaceInstanceListResponseCacheTTL3600   NamespaceInstanceListResponseCacheTTL = 3600
	NamespaceInstanceListResponseCacheTTL7200   NamespaceInstanceListResponseCacheTTL = 7200
	NamespaceInstanceListResponseCacheTTL21600  NamespaceInstanceListResponseCacheTTL = 21600
	NamespaceInstanceListResponseCacheTTL43200  NamespaceInstanceListResponseCacheTTL = 43200
	NamespaceInstanceListResponseCacheTTL86400  NamespaceInstanceListResponseCacheTTL = 86400
	NamespaceInstanceListResponseCacheTTL172800 NamespaceInstanceListResponseCacheTTL = 172800
	NamespaceInstanceListResponseCacheTTL259200 NamespaceInstanceListResponseCacheTTL = 259200
	NamespaceInstanceListResponseCacheTTL518400 NamespaceInstanceListResponseCacheTTL = 518400
)

func (NamespaceInstanceListResponseCacheTTL) IsKnown

type NamespaceInstanceListResponseCacheThreshold

type NamespaceInstanceListResponseCacheThreshold string
const (
	NamespaceInstanceListResponseCacheThresholdSuperStrictMatch NamespaceInstanceListResponseCacheThreshold = "super_strict_match"
	NamespaceInstanceListResponseCacheThresholdCloseEnough      NamespaceInstanceListResponseCacheThreshold = "close_enough"
	NamespaceInstanceListResponseCacheThresholdFlexibleFriend   NamespaceInstanceListResponseCacheThreshold = "flexible_friend"
	NamespaceInstanceListResponseCacheThresholdAnythingGoes     NamespaceInstanceListResponseCacheThreshold = "anything_goes"
)

func (NamespaceInstanceListResponseCacheThreshold) IsKnown

type NamespaceInstanceListResponseCustomMetadata

type NamespaceInstanceListResponseCustomMetadata struct {
	DataType  NamespaceInstanceListResponseCustomMetadataDataType `json:"data_type" api:"required"`
	FieldName string                                              `json:"field_name" api:"required"`
	JSON      namespaceInstanceListResponseCustomMetadataJSON     `json:"-"`
}

func (*NamespaceInstanceListResponseCustomMetadata) UnmarshalJSON

func (r *NamespaceInstanceListResponseCustomMetadata) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceListResponseCustomMetadataDataType

type NamespaceInstanceListResponseCustomMetadataDataType string
const (
	NamespaceInstanceListResponseCustomMetadataDataTypeText     NamespaceInstanceListResponseCustomMetadataDataType = "text"
	NamespaceInstanceListResponseCustomMetadataDataTypeNumber   NamespaceInstanceListResponseCustomMetadataDataType = "number"
	NamespaceInstanceListResponseCustomMetadataDataTypeBoolean  NamespaceInstanceListResponseCustomMetadataDataType = "boolean"
	NamespaceInstanceListResponseCustomMetadataDataTypeDatetime NamespaceInstanceListResponseCustomMetadataDataType = "datetime"
)

func (NamespaceInstanceListResponseCustomMetadataDataType) IsKnown

type NamespaceInstanceListResponseEmbeddingModel

type NamespaceInstanceListResponseEmbeddingModel string
const (
	NamespaceInstanceListResponseEmbeddingModelCfQwenQwen3Embedding0_6b              NamespaceInstanceListResponseEmbeddingModel = "@cf/qwen/qwen3-embedding-0.6b"
	NamespaceInstanceListResponseEmbeddingModelCfBaaiBgeM3                           NamespaceInstanceListResponseEmbeddingModel = "@cf/baai/bge-m3"
	NamespaceInstanceListResponseEmbeddingModelCfBaaiBgeLargeEnV1_5                  NamespaceInstanceListResponseEmbeddingModel = "@cf/baai/bge-large-en-v1.5"
	NamespaceInstanceListResponseEmbeddingModelCfGoogleEmbeddinggemma300m            NamespaceInstanceListResponseEmbeddingModel = "@cf/google/embeddinggemma-300m"
	NamespaceInstanceListResponseEmbeddingModelGoogleAIStudioGeminiEmbedding001      NamespaceInstanceListResponseEmbeddingModel = "google-ai-studio/gemini-embedding-001"
	NamespaceInstanceListResponseEmbeddingModelGoogleAIStudioGeminiEmbedding2Preview NamespaceInstanceListResponseEmbeddingModel = "google-ai-studio/gemini-embedding-2-preview"
	NamespaceInstanceListResponseEmbeddingModelOpenAITextEmbedding3Small             NamespaceInstanceListResponseEmbeddingModel = "openai/text-embedding-3-small"
	NamespaceInstanceListResponseEmbeddingModelOpenAITextEmbedding3Large             NamespaceInstanceListResponseEmbeddingModel = "openai/text-embedding-3-large"
	NamespaceInstanceListResponseEmbeddingModelEmpty                                 NamespaceInstanceListResponseEmbeddingModel = ""
)

func (NamespaceInstanceListResponseEmbeddingModel) IsKnown

type NamespaceInstanceListResponseFusionMethod

type NamespaceInstanceListResponseFusionMethod string
const (
	NamespaceInstanceListResponseFusionMethodMax NamespaceInstanceListResponseFusionMethod = "max"
	NamespaceInstanceListResponseFusionMethodRrf NamespaceInstanceListResponseFusionMethod = "rrf"
)

func (NamespaceInstanceListResponseFusionMethod) IsKnown

type NamespaceInstanceListResponseIndexMethod

type NamespaceInstanceListResponseIndexMethod struct {
	// Enable keyword (BM25) storage backend.
	Keyword bool `json:"keyword" api:"required"`
	// Enable vector (embedding) storage backend.
	Vector bool                                         `json:"vector" api:"required"`
	JSON   namespaceInstanceListResponseIndexMethodJSON `json:"-"`
}

Controls which storage backends are used during indexing. Defaults to vector-only.

func (*NamespaceInstanceListResponseIndexMethod) UnmarshalJSON

func (r *NamespaceInstanceListResponseIndexMethod) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceListResponseIndexingOptions

type NamespaceInstanceListResponseIndexingOptions struct {
	// Tokenizer used for keyword search indexing. porter provides word-level
	// tokenization with Porter stemming (good for natural language queries). trigram
	// enables character-level substring matching (good for partial matches, code,
	// identifiers). Changing this triggers a full re-index. Defaults to porter.
	KeywordTokenizer NamespaceInstanceListResponseIndexingOptionsKeywordTokenizer `json:"keyword_tokenizer"`
	JSON             namespaceInstanceListResponseIndexingOptionsJSON             `json:"-"`
}

func (*NamespaceInstanceListResponseIndexingOptions) UnmarshalJSON

func (r *NamespaceInstanceListResponseIndexingOptions) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceListResponseIndexingOptionsKeywordTokenizer

type NamespaceInstanceListResponseIndexingOptionsKeywordTokenizer string

Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter.

const (
	NamespaceInstanceListResponseIndexingOptionsKeywordTokenizerPorter  NamespaceInstanceListResponseIndexingOptionsKeywordTokenizer = "porter"
	NamespaceInstanceListResponseIndexingOptionsKeywordTokenizerTrigram NamespaceInstanceListResponseIndexingOptionsKeywordTokenizer = "trigram"
)

func (NamespaceInstanceListResponseIndexingOptionsKeywordTokenizer) IsKnown

type NamespaceInstanceListResponseMetadata

type NamespaceInstanceListResponseMetadata struct {
	CreatedFromAISearchWizard bool                                      `json:"created_from_aisearch_wizard"`
	WorkerDomain              string                                    `json:"worker_domain"`
	JSON                      namespaceInstanceListResponseMetadataJSON `json:"-"`
}

func (*NamespaceInstanceListResponseMetadata) UnmarshalJSON

func (r *NamespaceInstanceListResponseMetadata) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceListResponsePublicEndpointParams

type NamespaceInstanceListResponsePublicEndpointParams struct {
	AuthorizedHosts         []string                                                                 `json:"authorized_hosts"`
	ChatCompletionsEndpoint NamespaceInstanceListResponsePublicEndpointParamsChatCompletionsEndpoint `json:"chat_completions_endpoint"`
	Enabled                 bool                                                                     `json:"enabled"`
	Mcp                     NamespaceInstanceListResponsePublicEndpointParamsMcp                     `json:"mcp"`
	RateLimit               NamespaceInstanceListResponsePublicEndpointParamsRateLimit               `json:"rate_limit"`
	SearchEndpoint          NamespaceInstanceListResponsePublicEndpointParamsSearchEndpoint          `json:"search_endpoint"`
	JSON                    namespaceInstanceListResponsePublicEndpointParamsJSON                    `json:"-"`
}

func (*NamespaceInstanceListResponsePublicEndpointParams) UnmarshalJSON

func (r *NamespaceInstanceListResponsePublicEndpointParams) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceListResponsePublicEndpointParamsChatCompletionsEndpoint

type NamespaceInstanceListResponsePublicEndpointParamsChatCompletionsEndpoint struct {
	// Disable chat completions endpoint for this public endpoint
	Disabled bool                                                                         `json:"disabled"`
	JSON     namespaceInstanceListResponsePublicEndpointParamsChatCompletionsEndpointJSON `json:"-"`
}

func (*NamespaceInstanceListResponsePublicEndpointParamsChatCompletionsEndpoint) UnmarshalJSON

type NamespaceInstanceListResponsePublicEndpointParamsMcp

type NamespaceInstanceListResponsePublicEndpointParamsMcp struct {
	Description string `json:"description"`
	// Disable MCP endpoint for this public endpoint
	Disabled bool                                                     `json:"disabled"`
	JSON     namespaceInstanceListResponsePublicEndpointParamsMcpJSON `json:"-"`
}

func (*NamespaceInstanceListResponsePublicEndpointParamsMcp) UnmarshalJSON

func (r *NamespaceInstanceListResponsePublicEndpointParamsMcp) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceListResponsePublicEndpointParamsRateLimit

type NamespaceInstanceListResponsePublicEndpointParamsRateLimit struct {
	PeriodMs  int64                                                               `json:"period_ms"`
	Requests  int64                                                               `json:"requests"`
	Technique NamespaceInstanceListResponsePublicEndpointParamsRateLimitTechnique `json:"technique"`
	JSON      namespaceInstanceListResponsePublicEndpointParamsRateLimitJSON      `json:"-"`
}

func (*NamespaceInstanceListResponsePublicEndpointParamsRateLimit) UnmarshalJSON

type NamespaceInstanceListResponsePublicEndpointParamsRateLimitTechnique

type NamespaceInstanceListResponsePublicEndpointParamsRateLimitTechnique string
const (
	NamespaceInstanceListResponsePublicEndpointParamsRateLimitTechniqueFixed   NamespaceInstanceListResponsePublicEndpointParamsRateLimitTechnique = "fixed"
	NamespaceInstanceListResponsePublicEndpointParamsRateLimitTechniqueSliding NamespaceInstanceListResponsePublicEndpointParamsRateLimitTechnique = "sliding"
)

func (NamespaceInstanceListResponsePublicEndpointParamsRateLimitTechnique) IsKnown

type NamespaceInstanceListResponsePublicEndpointParamsSearchEndpoint

type NamespaceInstanceListResponsePublicEndpointParamsSearchEndpoint struct {
	// Disable search endpoint for this public endpoint
	Disabled bool                                                                `json:"disabled"`
	JSON     namespaceInstanceListResponsePublicEndpointParamsSearchEndpointJSON `json:"-"`
}

func (*NamespaceInstanceListResponsePublicEndpointParamsSearchEndpoint) UnmarshalJSON

type NamespaceInstanceListResponseRerankingModel

type NamespaceInstanceListResponseRerankingModel string
const (
	NamespaceInstanceListResponseRerankingModelCfBaaiBgeRerankerBase NamespaceInstanceListResponseRerankingModel = "@cf/baai/bge-reranker-base"
	NamespaceInstanceListResponseRerankingModelEmpty                 NamespaceInstanceListResponseRerankingModel = ""
)

func (NamespaceInstanceListResponseRerankingModel) IsKnown

type NamespaceInstanceListResponseRetrievalOptions

type NamespaceInstanceListResponseRetrievalOptions struct {
	// Metadata fields to boost search results by. Each entry specifies a metadata
	// field and an optional direction. Direction defaults to 'asc' for
	// numeric/datetime fields and 'exists' for text/boolean fields. Fields must match
	// 'timestamp' or a defined custom_metadata field.
	BoostBy []NamespaceInstanceListResponseRetrievalOptionsBoostBy `json:"boost_by"`
	// 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'.
	KeywordMatchMode NamespaceInstanceListResponseRetrievalOptionsKeywordMatchMode `json:"keyword_match_mode"`
	JSON             namespaceInstanceListResponseRetrievalOptionsJSON             `json:"-"`
}

func (*NamespaceInstanceListResponseRetrievalOptions) UnmarshalJSON

func (r *NamespaceInstanceListResponseRetrievalOptions) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceListResponseRetrievalOptionsBoostBy

type NamespaceInstanceListResponseRetrievalOptionsBoostBy struct {
	// 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.
	Field string `json:"field" api:"required"`
	// 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.
	Direction NamespaceInstanceListResponseRetrievalOptionsBoostByDirection `json:"direction"`
	JSON      namespaceInstanceListResponseRetrievalOptionsBoostByJSON      `json:"-"`
}

func (*NamespaceInstanceListResponseRetrievalOptionsBoostBy) UnmarshalJSON

func (r *NamespaceInstanceListResponseRetrievalOptionsBoostBy) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceListResponseRetrievalOptionsBoostByDirection

type NamespaceInstanceListResponseRetrievalOptionsBoostByDirection string

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.

const (
	NamespaceInstanceListResponseRetrievalOptionsBoostByDirectionAsc       NamespaceInstanceListResponseRetrievalOptionsBoostByDirection = "asc"
	NamespaceInstanceListResponseRetrievalOptionsBoostByDirectionDesc      NamespaceInstanceListResponseRetrievalOptionsBoostByDirection = "desc"
	NamespaceInstanceListResponseRetrievalOptionsBoostByDirectionExists    NamespaceInstanceListResponseRetrievalOptionsBoostByDirection = "exists"
	NamespaceInstanceListResponseRetrievalOptionsBoostByDirectionNotExists NamespaceInstanceListResponseRetrievalOptionsBoostByDirection = "not_exists"
)

func (NamespaceInstanceListResponseRetrievalOptionsBoostByDirection) IsKnown

type NamespaceInstanceListResponseRetrievalOptionsKeywordMatchMode

type NamespaceInstanceListResponseRetrievalOptionsKeywordMatchMode string

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'.

const (
	NamespaceInstanceListResponseRetrievalOptionsKeywordMatchModeAnd NamespaceInstanceListResponseRetrievalOptionsKeywordMatchMode = "and"
	NamespaceInstanceListResponseRetrievalOptionsKeywordMatchModeOr  NamespaceInstanceListResponseRetrievalOptionsKeywordMatchMode = "or"
)

func (NamespaceInstanceListResponseRetrievalOptionsKeywordMatchMode) IsKnown

type NamespaceInstanceListResponseRewriteModel

type NamespaceInstanceListResponseRewriteModel string
const (
	NamespaceInstanceListResponseRewriteModelCfMetaLlama3_3_70bInstructFp8Fast     NamespaceInstanceListResponseRewriteModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	NamespaceInstanceListResponseRewriteModelCfZaiOrgGlm4_7Flash                   NamespaceInstanceListResponseRewriteModel = "@cf/zai-org/glm-4.7-flash"
	NamespaceInstanceListResponseRewriteModelCfMetaLlama3_1_8bInstructFast         NamespaceInstanceListResponseRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	NamespaceInstanceListResponseRewriteModelCfMetaLlama3_1_8bInstructFp8          NamespaceInstanceListResponseRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	NamespaceInstanceListResponseRewriteModelCfMetaLlama4Scout17b16eInstruct       NamespaceInstanceListResponseRewriteModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceListResponseRewriteModelCfQwenQwen3_30bA3bFp8                 NamespaceInstanceListResponseRewriteModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	NamespaceInstanceListResponseRewriteModelCfDeepseekAIDeepseekR1DistillQwen32b  NamespaceInstanceListResponseRewriteModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	NamespaceInstanceListResponseRewriteModelCfMoonshotaiKimiK2Instruct            NamespaceInstanceListResponseRewriteModel = "@cf/moonshotai/kimi-k2-instruct"
	NamespaceInstanceListResponseRewriteModelCfGoogleGemma3_12bIt                  NamespaceInstanceListResponseRewriteModel = "@cf/google/gemma-3-12b-it"
	NamespaceInstanceListResponseRewriteModelCfGoogleGemma4_26bA4bIt               NamespaceInstanceListResponseRewriteModel = "@cf/google/gemma-4-26b-a4b-it"
	NamespaceInstanceListResponseRewriteModelCfMoonshotaiKimiK2_5                  NamespaceInstanceListResponseRewriteModel = "@cf/moonshotai/kimi-k2.5"
	NamespaceInstanceListResponseRewriteModelAnthropicClaude3_7Sonnet              NamespaceInstanceListResponseRewriteModel = "anthropic/claude-3-7-sonnet"
	NamespaceInstanceListResponseRewriteModelAnthropicClaudeSonnet4                NamespaceInstanceListResponseRewriteModel = "anthropic/claude-sonnet-4"
	NamespaceInstanceListResponseRewriteModelAnthropicClaudeOpus4                  NamespaceInstanceListResponseRewriteModel = "anthropic/claude-opus-4"
	NamespaceInstanceListResponseRewriteModelAnthropicClaude3_5Haiku               NamespaceInstanceListResponseRewriteModel = "anthropic/claude-3-5-haiku"
	NamespaceInstanceListResponseRewriteModelCerebrasQwen3_235bA22bInstruct        NamespaceInstanceListResponseRewriteModel = "cerebras/qwen-3-235b-a22b-instruct"
	NamespaceInstanceListResponseRewriteModelCerebrasQwen3_235bA22bThinking        NamespaceInstanceListResponseRewriteModel = "cerebras/qwen-3-235b-a22b-thinking"
	NamespaceInstanceListResponseRewriteModelCerebrasLlama3_3_70b                  NamespaceInstanceListResponseRewriteModel = "cerebras/llama-3.3-70b"
	NamespaceInstanceListResponseRewriteModelCerebrasLlama4Maverick17b128eInstruct NamespaceInstanceListResponseRewriteModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	NamespaceInstanceListResponseRewriteModelCerebrasLlama4Scout17b16eInstruct     NamespaceInstanceListResponseRewriteModel = "cerebras/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceListResponseRewriteModelCerebrasGptOSs120b                    NamespaceInstanceListResponseRewriteModel = "cerebras/gpt-oss-120b"
	NamespaceInstanceListResponseRewriteModelGoogleAIStudioGemini2_5Flash          NamespaceInstanceListResponseRewriteModel = "google-ai-studio/gemini-2.5-flash"
	NamespaceInstanceListResponseRewriteModelGoogleAIStudioGemini2_5Pro            NamespaceInstanceListResponseRewriteModel = "google-ai-studio/gemini-2.5-pro"
	NamespaceInstanceListResponseRewriteModelGrokGrok4                             NamespaceInstanceListResponseRewriteModel = "grok/grok-4"
	NamespaceInstanceListResponseRewriteModelGroqLlama3_3_70bVersatile             NamespaceInstanceListResponseRewriteModel = "groq/llama-3.3-70b-versatile"
	NamespaceInstanceListResponseRewriteModelGroqLlama3_1_8bInstant                NamespaceInstanceListResponseRewriteModel = "groq/llama-3.1-8b-instant"
	NamespaceInstanceListResponseRewriteModelOpenAIGpt5                            NamespaceInstanceListResponseRewriteModel = "openai/gpt-5"
	NamespaceInstanceListResponseRewriteModelOpenAIGpt5Mini                        NamespaceInstanceListResponseRewriteModel = "openai/gpt-5-mini"
	NamespaceInstanceListResponseRewriteModelOpenAIGpt5Nano                        NamespaceInstanceListResponseRewriteModel = "openai/gpt-5-nano"
	NamespaceInstanceListResponseRewriteModelEmpty                                 NamespaceInstanceListResponseRewriteModel = ""
)

func (NamespaceInstanceListResponseRewriteModel) IsKnown

type NamespaceInstanceListResponseSourceParams

type NamespaceInstanceListResponseSourceParams struct {
	// List of path patterns to exclude. Uses micromatch glob syntax: \* matches within
	// a path segment, ** matches across path segments (e.g., /admin/** matches
	// /admin/users and /admin/settings/advanced)
	ExcludeItems []string `json:"exclude_items"`
	// List of path patterns to include. Uses micromatch glob syntax: \* matches within
	// a path segment, ** matches across path segments (e.g., /blog/** matches
	// /blog/post and /blog/2024/post)
	IncludeItems   []string                                            `json:"include_items"`
	Prefix         string                                              `json:"prefix"`
	R2Jurisdiction string                                              `json:"r2_jurisdiction"`
	WebCrawler     NamespaceInstanceListResponseSourceParamsWebCrawler `json:"web_crawler"`
	JSON           namespaceInstanceListResponseSourceParamsJSON       `json:"-"`
}

func (*NamespaceInstanceListResponseSourceParams) UnmarshalJSON

func (r *NamespaceInstanceListResponseSourceParams) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceListResponseSourceParamsWebCrawler

type NamespaceInstanceListResponseSourceParamsWebCrawler struct {
	CrawlOptions NamespaceInstanceListResponseSourceParamsWebCrawlerCrawlOptions `json:"crawl_options"`
	ParseOptions NamespaceInstanceListResponseSourceParamsWebCrawlerParseOptions `json:"parse_options"`
	ParseType    NamespaceInstanceListResponseSourceParamsWebCrawlerParseType    `json:"parse_type"`
	StoreOptions NamespaceInstanceListResponseSourceParamsWebCrawlerStoreOptions `json:"store_options"`
	JSON         namespaceInstanceListResponseSourceParamsWebCrawlerJSON         `json:"-"`
}

func (*NamespaceInstanceListResponseSourceParamsWebCrawler) UnmarshalJSON

func (r *NamespaceInstanceListResponseSourceParamsWebCrawler) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceListResponseSourceParamsWebCrawlerCrawlOptions

type NamespaceInstanceListResponseSourceParamsWebCrawlerCrawlOptions struct {
	Depth                float64                                                               `json:"depth"`
	IncludeExternalLinks bool                                                                  `json:"include_external_links"`
	IncludeSubdomains    bool                                                                  `json:"include_subdomains"`
	MaxAge               float64                                                               `json:"max_age"`
	Source               NamespaceInstanceListResponseSourceParamsWebCrawlerCrawlOptionsSource `json:"source"`
	JSON                 namespaceInstanceListResponseSourceParamsWebCrawlerCrawlOptionsJSON   `json:"-"`
}

func (*NamespaceInstanceListResponseSourceParamsWebCrawlerCrawlOptions) UnmarshalJSON

type NamespaceInstanceListResponseSourceParamsWebCrawlerCrawlOptionsSource

type NamespaceInstanceListResponseSourceParamsWebCrawlerCrawlOptionsSource string
const (
	NamespaceInstanceListResponseSourceParamsWebCrawlerCrawlOptionsSourceAll      NamespaceInstanceListResponseSourceParamsWebCrawlerCrawlOptionsSource = "all"
	NamespaceInstanceListResponseSourceParamsWebCrawlerCrawlOptionsSourceSitemaps NamespaceInstanceListResponseSourceParamsWebCrawlerCrawlOptionsSource = "sitemaps"
	NamespaceInstanceListResponseSourceParamsWebCrawlerCrawlOptionsSourceLinks    NamespaceInstanceListResponseSourceParamsWebCrawlerCrawlOptionsSource = "links"
)

func (NamespaceInstanceListResponseSourceParamsWebCrawlerCrawlOptionsSource) IsKnown

type NamespaceInstanceListResponseSourceParamsWebCrawlerParseOptions

type NamespaceInstanceListResponseSourceParamsWebCrawlerParseOptions struct {
	// List of path-to-selector mappings for extracting specific content from crawled
	// pages. Each entry pairs a URL glob pattern with a CSS selector. The first
	// matching path wins. Only the matched HTML fragment is stored and indexed. Omit
	// the field to disable content selection — empty arrays are rejected.
	ContentSelector []NamespaceInstanceListResponseSourceParamsWebCrawlerParseOptionsContentSelector `json:"content_selector"`
	// Up to 5 custom HTTP headers sent with each crawl request. Names must be RFC-7230
	// token characters (no spaces, colons, or control characters); values must be
	// HTAB + printable ASCII (no CR/LF).
	IncludeHeaders map[string]string `json:"include_headers"`
	IncludeImages  bool              `json:"include_images"`
	// List of specific sitemap URLs to use for crawling. Only valid when parse_type is
	// 'sitemap'.
	SpecificSitemaps    []string                                                            `json:"specific_sitemaps" format:"uri"`
	UseBrowserRendering bool                                                                `json:"use_browser_rendering"`
	JSON                namespaceInstanceListResponseSourceParamsWebCrawlerParseOptionsJSON `json:"-"`
}

func (*NamespaceInstanceListResponseSourceParamsWebCrawlerParseOptions) UnmarshalJSON

type NamespaceInstanceListResponseSourceParamsWebCrawlerParseOptionsContentSelector

type NamespaceInstanceListResponseSourceParamsWebCrawlerParseOptionsContentSelector struct {
	// Glob pattern to match against the page URL path. Uses standard glob syntax: \*
	// matches within a segment, \*\* crosses directories.
	Path string `json:"path" api:"required"`
	// CSS selector to extract content from pages matching the path pattern. Must not
	// contain disallowed characters (;, `, $, {, }, \). Must target a single element;
	// if multiple elements match, the selector is ignored and the full page is used.
	Selector string                                                                             `json:"selector" api:"required"`
	JSON     namespaceInstanceListResponseSourceParamsWebCrawlerParseOptionsContentSelectorJSON `json:"-"`
}

func (*NamespaceInstanceListResponseSourceParamsWebCrawlerParseOptionsContentSelector) UnmarshalJSON

type NamespaceInstanceListResponseSourceParamsWebCrawlerParseType

type NamespaceInstanceListResponseSourceParamsWebCrawlerParseType string
const (
	NamespaceInstanceListResponseSourceParamsWebCrawlerParseTypeSitemap NamespaceInstanceListResponseSourceParamsWebCrawlerParseType = "sitemap"
	NamespaceInstanceListResponseSourceParamsWebCrawlerParseTypeFeedRss NamespaceInstanceListResponseSourceParamsWebCrawlerParseType = "feed-rss"
	NamespaceInstanceListResponseSourceParamsWebCrawlerParseTypeCrawl   NamespaceInstanceListResponseSourceParamsWebCrawlerParseType = "crawl"
)

func (NamespaceInstanceListResponseSourceParamsWebCrawlerParseType) IsKnown

type NamespaceInstanceListResponseSourceParamsWebCrawlerStoreOptions

type NamespaceInstanceListResponseSourceParamsWebCrawlerStoreOptions struct {
	StorageID      string                                                              `json:"storage_id" api:"required"`
	R2Jurisdiction string                                                              `json:"r2_jurisdiction"`
	StorageType    r2.Provider                                                         `json:"storage_type"`
	JSON           namespaceInstanceListResponseSourceParamsWebCrawlerStoreOptionsJSON `json:"-"`
}

func (*NamespaceInstanceListResponseSourceParamsWebCrawlerStoreOptions) UnmarshalJSON

type NamespaceInstanceListResponseSyncInterval

type NamespaceInstanceListResponseSyncInterval float64

Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).

const (
	NamespaceInstanceListResponseSyncInterval900   NamespaceInstanceListResponseSyncInterval = 900
	NamespaceInstanceListResponseSyncInterval1800  NamespaceInstanceListResponseSyncInterval = 1800
	NamespaceInstanceListResponseSyncInterval3600  NamespaceInstanceListResponseSyncInterval = 3600
	NamespaceInstanceListResponseSyncInterval7200  NamespaceInstanceListResponseSyncInterval = 7200
	NamespaceInstanceListResponseSyncInterval14400 NamespaceInstanceListResponseSyncInterval = 14400
	NamespaceInstanceListResponseSyncInterval21600 NamespaceInstanceListResponseSyncInterval = 21600
	NamespaceInstanceListResponseSyncInterval43200 NamespaceInstanceListResponseSyncInterval = 43200
	NamespaceInstanceListResponseSyncInterval86400 NamespaceInstanceListResponseSyncInterval = 86400
)

func (NamespaceInstanceListResponseSyncInterval) IsKnown

type NamespaceInstanceListResponseType

type NamespaceInstanceListResponseType string
const (
	NamespaceInstanceListResponseTypeR2         NamespaceInstanceListResponseType = "r2"
	NamespaceInstanceListResponseTypeWebCrawler NamespaceInstanceListResponseType = "web-crawler"
)

func (NamespaceInstanceListResponseType) IsKnown

type NamespaceInstanceNewParams

type NamespaceInstanceNewParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
	ID             param.Field[string]                                   `json:"id" api:"required"`
	AIGatewayID    param.Field[string]                                   `json:"ai_gateway_id"`
	AISearchModel  param.Field[NamespaceInstanceNewParamsAISearchModel]  `json:"ai_search_model"`
	Cache          param.Field[bool]                                     `json:"cache"`
	CacheThreshold param.Field[NamespaceInstanceNewParamsCacheThreshold] `json:"cache_threshold"`
	// Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600
	// (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200
	// (72h), 518400 (6d).
	CacheTTL       param.Field[NamespaceInstanceNewParamsCacheTTL]         `json:"cache_ttl"`
	Chunk          param.Field[bool]                                       `json:"chunk"`
	ChunkOverlap   param.Field[int64]                                      `json:"chunk_overlap"`
	ChunkSize      param.Field[int64]                                      `json:"chunk_size"`
	CustomMetadata param.Field[[]NamespaceInstanceNewParamsCustomMetadata] `json:"custom_metadata"`
	EmbeddingModel param.Field[NamespaceInstanceNewParamsEmbeddingModel]   `json:"embedding_model"`
	FusionMethod   param.Field[NamespaceInstanceNewParamsFusionMethod]     `json:"fusion_method"`
	// Deprecated — use index_method instead.
	HybridSearchEnabled param.Field[bool] `json:"hybrid_search_enabled"`
	// Controls which storage backends are used during indexing. Defaults to
	// vector-only.
	IndexMethod          param.Field[NamespaceInstanceNewParamsIndexMethod]          `json:"index_method"`
	IndexingOptions      param.Field[NamespaceInstanceNewParamsIndexingOptions]      `json:"indexing_options"`
	MaxNumResults        param.Field[int64]                                          `json:"max_num_results"`
	Metadata             param.Field[NamespaceInstanceNewParamsMetadata]             `json:"metadata"`
	PublicEndpointParams param.Field[NamespaceInstanceNewParamsPublicEndpointParams] `json:"public_endpoint_params"`
	Reranking            param.Field[bool]                                           `json:"reranking"`
	RerankingModel       param.Field[NamespaceInstanceNewParamsRerankingModel]       `json:"reranking_model"`
	RetrievalOptions     param.Field[NamespaceInstanceNewParamsRetrievalOptions]     `json:"retrieval_options"`
	RewriteModel         param.Field[NamespaceInstanceNewParamsRewriteModel]         `json:"rewrite_model"`
	RewriteQuery         param.Field[bool]                                           `json:"rewrite_query"`
	ScoreThreshold       param.Field[float64]                                        `json:"score_threshold"`
	Source               param.Field[string]                                         `json:"source"`
	SourceParams         param.Field[NamespaceInstanceNewParamsSourceParams]         `json:"source_params"`
	// Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800
	// (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).
	SyncInterval param.Field[NamespaceInstanceNewParamsSyncInterval] `json:"sync_interval"`
	TokenID      param.Field[string]                                 `json:"token_id" format:"uuid"`
	Type         param.Field[NamespaceInstanceNewParamsType]         `json:"type"`
}

func (NamespaceInstanceNewParams) MarshalJSON

func (r NamespaceInstanceNewParams) MarshalJSON() (data []byte, err error)

type NamespaceInstanceNewParamsAISearchModel

type NamespaceInstanceNewParamsAISearchModel string
const (
	NamespaceInstanceNewParamsAISearchModelCfMetaLlama3_3_70bInstructFp8Fast     NamespaceInstanceNewParamsAISearchModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	NamespaceInstanceNewParamsAISearchModelCfZaiOrgGlm4_7Flash                   NamespaceInstanceNewParamsAISearchModel = "@cf/zai-org/glm-4.7-flash"
	NamespaceInstanceNewParamsAISearchModelCfMetaLlama3_1_8bInstructFast         NamespaceInstanceNewParamsAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	NamespaceInstanceNewParamsAISearchModelCfMetaLlama3_1_8bInstructFp8          NamespaceInstanceNewParamsAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	NamespaceInstanceNewParamsAISearchModelCfMetaLlama4Scout17b16eInstruct       NamespaceInstanceNewParamsAISearchModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceNewParamsAISearchModelCfQwenQwen3_30bA3bFp8                 NamespaceInstanceNewParamsAISearchModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	NamespaceInstanceNewParamsAISearchModelCfDeepseekAIDeepseekR1DistillQwen32b  NamespaceInstanceNewParamsAISearchModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	NamespaceInstanceNewParamsAISearchModelCfMoonshotaiKimiK2Instruct            NamespaceInstanceNewParamsAISearchModel = "@cf/moonshotai/kimi-k2-instruct"
	NamespaceInstanceNewParamsAISearchModelCfGoogleGemma3_12bIt                  NamespaceInstanceNewParamsAISearchModel = "@cf/google/gemma-3-12b-it"
	NamespaceInstanceNewParamsAISearchModelCfGoogleGemma4_26bA4bIt               NamespaceInstanceNewParamsAISearchModel = "@cf/google/gemma-4-26b-a4b-it"
	NamespaceInstanceNewParamsAISearchModelCfMoonshotaiKimiK2_5                  NamespaceInstanceNewParamsAISearchModel = "@cf/moonshotai/kimi-k2.5"
	NamespaceInstanceNewParamsAISearchModelAnthropicClaude3_7Sonnet              NamespaceInstanceNewParamsAISearchModel = "anthropic/claude-3-7-sonnet"
	NamespaceInstanceNewParamsAISearchModelAnthropicClaudeSonnet4                NamespaceInstanceNewParamsAISearchModel = "anthropic/claude-sonnet-4"
	NamespaceInstanceNewParamsAISearchModelAnthropicClaudeOpus4                  NamespaceInstanceNewParamsAISearchModel = "anthropic/claude-opus-4"
	NamespaceInstanceNewParamsAISearchModelAnthropicClaude3_5Haiku               NamespaceInstanceNewParamsAISearchModel = "anthropic/claude-3-5-haiku"
	NamespaceInstanceNewParamsAISearchModelCerebrasQwen3_235bA22bInstruct        NamespaceInstanceNewParamsAISearchModel = "cerebras/qwen-3-235b-a22b-instruct"
	NamespaceInstanceNewParamsAISearchModelCerebrasQwen3_235bA22bThinking        NamespaceInstanceNewParamsAISearchModel = "cerebras/qwen-3-235b-a22b-thinking"
	NamespaceInstanceNewParamsAISearchModelCerebrasLlama3_3_70b                  NamespaceInstanceNewParamsAISearchModel = "cerebras/llama-3.3-70b"
	NamespaceInstanceNewParamsAISearchModelCerebrasLlama4Maverick17b128eInstruct NamespaceInstanceNewParamsAISearchModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	NamespaceInstanceNewParamsAISearchModelCerebrasLlama4Scout17b16eInstruct     NamespaceInstanceNewParamsAISearchModel = "cerebras/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceNewParamsAISearchModelCerebrasGptOSs120b                    NamespaceInstanceNewParamsAISearchModel = "cerebras/gpt-oss-120b"
	NamespaceInstanceNewParamsAISearchModelGoogleAIStudioGemini2_5Flash          NamespaceInstanceNewParamsAISearchModel = "google-ai-studio/gemini-2.5-flash"
	NamespaceInstanceNewParamsAISearchModelGoogleAIStudioGemini2_5Pro            NamespaceInstanceNewParamsAISearchModel = "google-ai-studio/gemini-2.5-pro"
	NamespaceInstanceNewParamsAISearchModelGrokGrok4                             NamespaceInstanceNewParamsAISearchModel = "grok/grok-4"
	NamespaceInstanceNewParamsAISearchModelGroqLlama3_3_70bVersatile             NamespaceInstanceNewParamsAISearchModel = "groq/llama-3.3-70b-versatile"
	NamespaceInstanceNewParamsAISearchModelGroqLlama3_1_8bInstant                NamespaceInstanceNewParamsAISearchModel = "groq/llama-3.1-8b-instant"
	NamespaceInstanceNewParamsAISearchModelOpenAIGpt5                            NamespaceInstanceNewParamsAISearchModel = "openai/gpt-5"
	NamespaceInstanceNewParamsAISearchModelOpenAIGpt5Mini                        NamespaceInstanceNewParamsAISearchModel = "openai/gpt-5-mini"
	NamespaceInstanceNewParamsAISearchModelOpenAIGpt5Nano                        NamespaceInstanceNewParamsAISearchModel = "openai/gpt-5-nano"
	NamespaceInstanceNewParamsAISearchModelEmpty                                 NamespaceInstanceNewParamsAISearchModel = ""
)

func (NamespaceInstanceNewParamsAISearchModel) IsKnown

type NamespaceInstanceNewParamsCacheTTL

type NamespaceInstanceNewParamsCacheTTL float64

Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d).

const (
	NamespaceInstanceNewParamsCacheTTL600    NamespaceInstanceNewParamsCacheTTL = 600
	NamespaceInstanceNewParamsCacheTTL1800   NamespaceInstanceNewParamsCacheTTL = 1800
	NamespaceInstanceNewParamsCacheTTL3600   NamespaceInstanceNewParamsCacheTTL = 3600
	NamespaceInstanceNewParamsCacheTTL7200   NamespaceInstanceNewParamsCacheTTL = 7200
	NamespaceInstanceNewParamsCacheTTL21600  NamespaceInstanceNewParamsCacheTTL = 21600
	NamespaceInstanceNewParamsCacheTTL43200  NamespaceInstanceNewParamsCacheTTL = 43200
	NamespaceInstanceNewParamsCacheTTL86400  NamespaceInstanceNewParamsCacheTTL = 86400
	NamespaceInstanceNewParamsCacheTTL172800 NamespaceInstanceNewParamsCacheTTL = 172800
	NamespaceInstanceNewParamsCacheTTL259200 NamespaceInstanceNewParamsCacheTTL = 259200
	NamespaceInstanceNewParamsCacheTTL518400 NamespaceInstanceNewParamsCacheTTL = 518400
)

func (NamespaceInstanceNewParamsCacheTTL) IsKnown

type NamespaceInstanceNewParamsCacheThreshold

type NamespaceInstanceNewParamsCacheThreshold string
const (
	NamespaceInstanceNewParamsCacheThresholdSuperStrictMatch NamespaceInstanceNewParamsCacheThreshold = "super_strict_match"
	NamespaceInstanceNewParamsCacheThresholdCloseEnough      NamespaceInstanceNewParamsCacheThreshold = "close_enough"
	NamespaceInstanceNewParamsCacheThresholdFlexibleFriend   NamespaceInstanceNewParamsCacheThreshold = "flexible_friend"
	NamespaceInstanceNewParamsCacheThresholdAnythingGoes     NamespaceInstanceNewParamsCacheThreshold = "anything_goes"
)

func (NamespaceInstanceNewParamsCacheThreshold) IsKnown

type NamespaceInstanceNewParamsCustomMetadata

type NamespaceInstanceNewParamsCustomMetadata struct {
	DataType  param.Field[NamespaceInstanceNewParamsCustomMetadataDataType] `json:"data_type" api:"required"`
	FieldName param.Field[string]                                           `json:"field_name" api:"required"`
}

func (NamespaceInstanceNewParamsCustomMetadata) MarshalJSON

func (r NamespaceInstanceNewParamsCustomMetadata) MarshalJSON() (data []byte, err error)

type NamespaceInstanceNewParamsCustomMetadataDataType

type NamespaceInstanceNewParamsCustomMetadataDataType string
const (
	NamespaceInstanceNewParamsCustomMetadataDataTypeText     NamespaceInstanceNewParamsCustomMetadataDataType = "text"
	NamespaceInstanceNewParamsCustomMetadataDataTypeNumber   NamespaceInstanceNewParamsCustomMetadataDataType = "number"
	NamespaceInstanceNewParamsCustomMetadataDataTypeBoolean  NamespaceInstanceNewParamsCustomMetadataDataType = "boolean"
	NamespaceInstanceNewParamsCustomMetadataDataTypeDatetime NamespaceInstanceNewParamsCustomMetadataDataType = "datetime"
)

func (NamespaceInstanceNewParamsCustomMetadataDataType) IsKnown

type NamespaceInstanceNewParamsEmbeddingModel

type NamespaceInstanceNewParamsEmbeddingModel string
const (
	NamespaceInstanceNewParamsEmbeddingModelCfQwenQwen3Embedding0_6b              NamespaceInstanceNewParamsEmbeddingModel = "@cf/qwen/qwen3-embedding-0.6b"
	NamespaceInstanceNewParamsEmbeddingModelCfBaaiBgeM3                           NamespaceInstanceNewParamsEmbeddingModel = "@cf/baai/bge-m3"
	NamespaceInstanceNewParamsEmbeddingModelCfBaaiBgeLargeEnV1_5                  NamespaceInstanceNewParamsEmbeddingModel = "@cf/baai/bge-large-en-v1.5"
	NamespaceInstanceNewParamsEmbeddingModelCfGoogleEmbeddinggemma300m            NamespaceInstanceNewParamsEmbeddingModel = "@cf/google/embeddinggemma-300m"
	NamespaceInstanceNewParamsEmbeddingModelGoogleAIStudioGeminiEmbedding001      NamespaceInstanceNewParamsEmbeddingModel = "google-ai-studio/gemini-embedding-001"
	NamespaceInstanceNewParamsEmbeddingModelGoogleAIStudioGeminiEmbedding2Preview NamespaceInstanceNewParamsEmbeddingModel = "google-ai-studio/gemini-embedding-2-preview"
	NamespaceInstanceNewParamsEmbeddingModelOpenAITextEmbedding3Small             NamespaceInstanceNewParamsEmbeddingModel = "openai/text-embedding-3-small"
	NamespaceInstanceNewParamsEmbeddingModelOpenAITextEmbedding3Large             NamespaceInstanceNewParamsEmbeddingModel = "openai/text-embedding-3-large"
	NamespaceInstanceNewParamsEmbeddingModelEmpty                                 NamespaceInstanceNewParamsEmbeddingModel = ""
)

func (NamespaceInstanceNewParamsEmbeddingModel) IsKnown

type NamespaceInstanceNewParamsFusionMethod

type NamespaceInstanceNewParamsFusionMethod string
const (
	NamespaceInstanceNewParamsFusionMethodMax NamespaceInstanceNewParamsFusionMethod = "max"
	NamespaceInstanceNewParamsFusionMethodRrf NamespaceInstanceNewParamsFusionMethod = "rrf"
)

func (NamespaceInstanceNewParamsFusionMethod) IsKnown

type NamespaceInstanceNewParamsIndexMethod

type NamespaceInstanceNewParamsIndexMethod struct {
	// Enable keyword (BM25) storage backend.
	Keyword param.Field[bool] `json:"keyword" api:"required"`
	// Enable vector (embedding) storage backend.
	Vector param.Field[bool] `json:"vector" api:"required"`
}

Controls which storage backends are used during indexing. Defaults to vector-only.

func (NamespaceInstanceNewParamsIndexMethod) MarshalJSON

func (r NamespaceInstanceNewParamsIndexMethod) MarshalJSON() (data []byte, err error)

type NamespaceInstanceNewParamsIndexingOptions

type NamespaceInstanceNewParamsIndexingOptions struct {
	// Tokenizer used for keyword search indexing. porter provides word-level
	// tokenization with Porter stemming (good for natural language queries). trigram
	// enables character-level substring matching (good for partial matches, code,
	// identifiers). Changing this triggers a full re-index. Defaults to porter.
	KeywordTokenizer param.Field[NamespaceInstanceNewParamsIndexingOptionsKeywordTokenizer] `json:"keyword_tokenizer"`
}

func (NamespaceInstanceNewParamsIndexingOptions) MarshalJSON

func (r NamespaceInstanceNewParamsIndexingOptions) MarshalJSON() (data []byte, err error)

type NamespaceInstanceNewParamsIndexingOptionsKeywordTokenizer

type NamespaceInstanceNewParamsIndexingOptionsKeywordTokenizer string

Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter.

const (
	NamespaceInstanceNewParamsIndexingOptionsKeywordTokenizerPorter  NamespaceInstanceNewParamsIndexingOptionsKeywordTokenizer = "porter"
	NamespaceInstanceNewParamsIndexingOptionsKeywordTokenizerTrigram NamespaceInstanceNewParamsIndexingOptionsKeywordTokenizer = "trigram"
)

func (NamespaceInstanceNewParamsIndexingOptionsKeywordTokenizer) IsKnown

type NamespaceInstanceNewParamsMetadata

type NamespaceInstanceNewParamsMetadata struct {
	CreatedFromAISearchWizard param.Field[bool]   `json:"created_from_aisearch_wizard"`
	WorkerDomain              param.Field[string] `json:"worker_domain"`
}

func (NamespaceInstanceNewParamsMetadata) MarshalJSON

func (r NamespaceInstanceNewParamsMetadata) MarshalJSON() (data []byte, err error)

type NamespaceInstanceNewParamsPublicEndpointParams

type NamespaceInstanceNewParamsPublicEndpointParams struct {
	AuthorizedHosts         param.Field[[]string]                                                              `json:"authorized_hosts"`
	ChatCompletionsEndpoint param.Field[NamespaceInstanceNewParamsPublicEndpointParamsChatCompletionsEndpoint] `json:"chat_completions_endpoint"`
	Enabled                 param.Field[bool]                                                                  `json:"enabled"`
	Mcp                     param.Field[NamespaceInstanceNewParamsPublicEndpointParamsMcp]                     `json:"mcp"`
	RateLimit               param.Field[NamespaceInstanceNewParamsPublicEndpointParamsRateLimit]               `json:"rate_limit"`
	SearchEndpoint          param.Field[NamespaceInstanceNewParamsPublicEndpointParamsSearchEndpoint]          `json:"search_endpoint"`
}

func (NamespaceInstanceNewParamsPublicEndpointParams) MarshalJSON

func (r NamespaceInstanceNewParamsPublicEndpointParams) MarshalJSON() (data []byte, err error)

type NamespaceInstanceNewParamsPublicEndpointParamsChatCompletionsEndpoint

type NamespaceInstanceNewParamsPublicEndpointParamsChatCompletionsEndpoint struct {
	// Disable chat completions endpoint for this public endpoint
	Disabled param.Field[bool] `json:"disabled"`
}

func (NamespaceInstanceNewParamsPublicEndpointParamsChatCompletionsEndpoint) MarshalJSON

type NamespaceInstanceNewParamsPublicEndpointParamsMcp

type NamespaceInstanceNewParamsPublicEndpointParamsMcp struct {
	Description param.Field[string] `json:"description"`
	// Disable MCP endpoint for this public endpoint
	Disabled param.Field[bool] `json:"disabled"`
}

func (NamespaceInstanceNewParamsPublicEndpointParamsMcp) MarshalJSON

func (r NamespaceInstanceNewParamsPublicEndpointParamsMcp) MarshalJSON() (data []byte, err error)

type NamespaceInstanceNewParamsPublicEndpointParamsRateLimit

type NamespaceInstanceNewParamsPublicEndpointParamsRateLimit struct {
	PeriodMs  param.Field[int64]                                                            `json:"period_ms"`
	Requests  param.Field[int64]                                                            `json:"requests"`
	Technique param.Field[NamespaceInstanceNewParamsPublicEndpointParamsRateLimitTechnique] `json:"technique"`
}

func (NamespaceInstanceNewParamsPublicEndpointParamsRateLimit) MarshalJSON

type NamespaceInstanceNewParamsPublicEndpointParamsRateLimitTechnique

type NamespaceInstanceNewParamsPublicEndpointParamsRateLimitTechnique string
const (
	NamespaceInstanceNewParamsPublicEndpointParamsRateLimitTechniqueFixed   NamespaceInstanceNewParamsPublicEndpointParamsRateLimitTechnique = "fixed"
	NamespaceInstanceNewParamsPublicEndpointParamsRateLimitTechniqueSliding NamespaceInstanceNewParamsPublicEndpointParamsRateLimitTechnique = "sliding"
)

func (NamespaceInstanceNewParamsPublicEndpointParamsRateLimitTechnique) IsKnown

type NamespaceInstanceNewParamsPublicEndpointParamsSearchEndpoint

type NamespaceInstanceNewParamsPublicEndpointParamsSearchEndpoint struct {
	// Disable search endpoint for this public endpoint
	Disabled param.Field[bool] `json:"disabled"`
}

func (NamespaceInstanceNewParamsPublicEndpointParamsSearchEndpoint) MarshalJSON

type NamespaceInstanceNewParamsRerankingModel

type NamespaceInstanceNewParamsRerankingModel string
const (
	NamespaceInstanceNewParamsRerankingModelCfBaaiBgeRerankerBase NamespaceInstanceNewParamsRerankingModel = "@cf/baai/bge-reranker-base"
	NamespaceInstanceNewParamsRerankingModelEmpty                 NamespaceInstanceNewParamsRerankingModel = ""
)

func (NamespaceInstanceNewParamsRerankingModel) IsKnown

type NamespaceInstanceNewParamsRetrievalOptions

type NamespaceInstanceNewParamsRetrievalOptions struct {
	// Metadata fields to boost search results by. Each entry specifies a metadata
	// field and an optional direction. Direction defaults to 'asc' for
	// numeric/datetime fields and 'exists' for text/boolean fields. Fields must match
	// 'timestamp' or a defined custom_metadata field.
	BoostBy param.Field[[]NamespaceInstanceNewParamsRetrievalOptionsBoostBy] `json:"boost_by"`
	// 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'.
	KeywordMatchMode param.Field[NamespaceInstanceNewParamsRetrievalOptionsKeywordMatchMode] `json:"keyword_match_mode"`
}

func (NamespaceInstanceNewParamsRetrievalOptions) MarshalJSON

func (r NamespaceInstanceNewParamsRetrievalOptions) MarshalJSON() (data []byte, err error)

type NamespaceInstanceNewParamsRetrievalOptionsBoostBy

type NamespaceInstanceNewParamsRetrievalOptionsBoostBy struct {
	// 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.
	Field param.Field[string] `json:"field" api:"required"`
	// 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.
	Direction param.Field[NamespaceInstanceNewParamsRetrievalOptionsBoostByDirection] `json:"direction"`
}

func (NamespaceInstanceNewParamsRetrievalOptionsBoostBy) MarshalJSON

func (r NamespaceInstanceNewParamsRetrievalOptionsBoostBy) MarshalJSON() (data []byte, err error)

type NamespaceInstanceNewParamsRetrievalOptionsBoostByDirection

type NamespaceInstanceNewParamsRetrievalOptionsBoostByDirection string

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.

const (
	NamespaceInstanceNewParamsRetrievalOptionsBoostByDirectionAsc       NamespaceInstanceNewParamsRetrievalOptionsBoostByDirection = "asc"
	NamespaceInstanceNewParamsRetrievalOptionsBoostByDirectionDesc      NamespaceInstanceNewParamsRetrievalOptionsBoostByDirection = "desc"
	NamespaceInstanceNewParamsRetrievalOptionsBoostByDirectionExists    NamespaceInstanceNewParamsRetrievalOptionsBoostByDirection = "exists"
	NamespaceInstanceNewParamsRetrievalOptionsBoostByDirectionNotExists NamespaceInstanceNewParamsRetrievalOptionsBoostByDirection = "not_exists"
)

func (NamespaceInstanceNewParamsRetrievalOptionsBoostByDirection) IsKnown

type NamespaceInstanceNewParamsRetrievalOptionsKeywordMatchMode

type NamespaceInstanceNewParamsRetrievalOptionsKeywordMatchMode string

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'.

const (
	NamespaceInstanceNewParamsRetrievalOptionsKeywordMatchModeAnd NamespaceInstanceNewParamsRetrievalOptionsKeywordMatchMode = "and"
	NamespaceInstanceNewParamsRetrievalOptionsKeywordMatchModeOr  NamespaceInstanceNewParamsRetrievalOptionsKeywordMatchMode = "or"
)

func (NamespaceInstanceNewParamsRetrievalOptionsKeywordMatchMode) IsKnown

type NamespaceInstanceNewParamsRewriteModel

type NamespaceInstanceNewParamsRewriteModel string
const (
	NamespaceInstanceNewParamsRewriteModelCfMetaLlama3_3_70bInstructFp8Fast     NamespaceInstanceNewParamsRewriteModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	NamespaceInstanceNewParamsRewriteModelCfZaiOrgGlm4_7Flash                   NamespaceInstanceNewParamsRewriteModel = "@cf/zai-org/glm-4.7-flash"
	NamespaceInstanceNewParamsRewriteModelCfMetaLlama3_1_8bInstructFast         NamespaceInstanceNewParamsRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	NamespaceInstanceNewParamsRewriteModelCfMetaLlama3_1_8bInstructFp8          NamespaceInstanceNewParamsRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	NamespaceInstanceNewParamsRewriteModelCfMetaLlama4Scout17b16eInstruct       NamespaceInstanceNewParamsRewriteModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceNewParamsRewriteModelCfQwenQwen3_30bA3bFp8                 NamespaceInstanceNewParamsRewriteModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	NamespaceInstanceNewParamsRewriteModelCfDeepseekAIDeepseekR1DistillQwen32b  NamespaceInstanceNewParamsRewriteModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	NamespaceInstanceNewParamsRewriteModelCfMoonshotaiKimiK2Instruct            NamespaceInstanceNewParamsRewriteModel = "@cf/moonshotai/kimi-k2-instruct"
	NamespaceInstanceNewParamsRewriteModelCfGoogleGemma3_12bIt                  NamespaceInstanceNewParamsRewriteModel = "@cf/google/gemma-3-12b-it"
	NamespaceInstanceNewParamsRewriteModelCfGoogleGemma4_26bA4bIt               NamespaceInstanceNewParamsRewriteModel = "@cf/google/gemma-4-26b-a4b-it"
	NamespaceInstanceNewParamsRewriteModelCfMoonshotaiKimiK2_5                  NamespaceInstanceNewParamsRewriteModel = "@cf/moonshotai/kimi-k2.5"
	NamespaceInstanceNewParamsRewriteModelAnthropicClaude3_7Sonnet              NamespaceInstanceNewParamsRewriteModel = "anthropic/claude-3-7-sonnet"
	NamespaceInstanceNewParamsRewriteModelAnthropicClaudeSonnet4                NamespaceInstanceNewParamsRewriteModel = "anthropic/claude-sonnet-4"
	NamespaceInstanceNewParamsRewriteModelAnthropicClaudeOpus4                  NamespaceInstanceNewParamsRewriteModel = "anthropic/claude-opus-4"
	NamespaceInstanceNewParamsRewriteModelAnthropicClaude3_5Haiku               NamespaceInstanceNewParamsRewriteModel = "anthropic/claude-3-5-haiku"
	NamespaceInstanceNewParamsRewriteModelCerebrasQwen3_235bA22bInstruct        NamespaceInstanceNewParamsRewriteModel = "cerebras/qwen-3-235b-a22b-instruct"
	NamespaceInstanceNewParamsRewriteModelCerebrasQwen3_235bA22bThinking        NamespaceInstanceNewParamsRewriteModel = "cerebras/qwen-3-235b-a22b-thinking"
	NamespaceInstanceNewParamsRewriteModelCerebrasLlama3_3_70b                  NamespaceInstanceNewParamsRewriteModel = "cerebras/llama-3.3-70b"
	NamespaceInstanceNewParamsRewriteModelCerebrasLlama4Maverick17b128eInstruct NamespaceInstanceNewParamsRewriteModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	NamespaceInstanceNewParamsRewriteModelCerebrasLlama4Scout17b16eInstruct     NamespaceInstanceNewParamsRewriteModel = "cerebras/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceNewParamsRewriteModelCerebrasGptOSs120b                    NamespaceInstanceNewParamsRewriteModel = "cerebras/gpt-oss-120b"
	NamespaceInstanceNewParamsRewriteModelGoogleAIStudioGemini2_5Flash          NamespaceInstanceNewParamsRewriteModel = "google-ai-studio/gemini-2.5-flash"
	NamespaceInstanceNewParamsRewriteModelGoogleAIStudioGemini2_5Pro            NamespaceInstanceNewParamsRewriteModel = "google-ai-studio/gemini-2.5-pro"
	NamespaceInstanceNewParamsRewriteModelGrokGrok4                             NamespaceInstanceNewParamsRewriteModel = "grok/grok-4"
	NamespaceInstanceNewParamsRewriteModelGroqLlama3_3_70bVersatile             NamespaceInstanceNewParamsRewriteModel = "groq/llama-3.3-70b-versatile"
	NamespaceInstanceNewParamsRewriteModelGroqLlama3_1_8bInstant                NamespaceInstanceNewParamsRewriteModel = "groq/llama-3.1-8b-instant"
	NamespaceInstanceNewParamsRewriteModelOpenAIGpt5                            NamespaceInstanceNewParamsRewriteModel = "openai/gpt-5"
	NamespaceInstanceNewParamsRewriteModelOpenAIGpt5Mini                        NamespaceInstanceNewParamsRewriteModel = "openai/gpt-5-mini"
	NamespaceInstanceNewParamsRewriteModelOpenAIGpt5Nano                        NamespaceInstanceNewParamsRewriteModel = "openai/gpt-5-nano"
	NamespaceInstanceNewParamsRewriteModelEmpty                                 NamespaceInstanceNewParamsRewriteModel = ""
)

func (NamespaceInstanceNewParamsRewriteModel) IsKnown

type NamespaceInstanceNewParamsSourceParams

type NamespaceInstanceNewParamsSourceParams struct {
	// List of path patterns to exclude. Uses micromatch glob syntax: \* matches within
	// a path segment, ** matches across path segments (e.g., /admin/** matches
	// /admin/users and /admin/settings/advanced)
	ExcludeItems param.Field[[]string] `json:"exclude_items"`
	// List of path patterns to include. Uses micromatch glob syntax: \* matches within
	// a path segment, ** matches across path segments (e.g., /blog/** matches
	// /blog/post and /blog/2024/post)
	IncludeItems   param.Field[[]string]                                         `json:"include_items"`
	Prefix         param.Field[string]                                           `json:"prefix"`
	R2Jurisdiction param.Field[string]                                           `json:"r2_jurisdiction"`
	WebCrawler     param.Field[NamespaceInstanceNewParamsSourceParamsWebCrawler] `json:"web_crawler"`
}

func (NamespaceInstanceNewParamsSourceParams) MarshalJSON

func (r NamespaceInstanceNewParamsSourceParams) MarshalJSON() (data []byte, err error)

type NamespaceInstanceNewParamsSourceParamsWebCrawler

type NamespaceInstanceNewParamsSourceParamsWebCrawler struct {
	CrawlOptions param.Field[NamespaceInstanceNewParamsSourceParamsWebCrawlerCrawlOptions] `json:"crawl_options"`
	ParseOptions param.Field[NamespaceInstanceNewParamsSourceParamsWebCrawlerParseOptions] `json:"parse_options"`
	ParseType    param.Field[NamespaceInstanceNewParamsSourceParamsWebCrawlerParseType]    `json:"parse_type"`
	StoreOptions param.Field[NamespaceInstanceNewParamsSourceParamsWebCrawlerStoreOptions] `json:"store_options"`
}

func (NamespaceInstanceNewParamsSourceParamsWebCrawler) MarshalJSON

func (r NamespaceInstanceNewParamsSourceParamsWebCrawler) MarshalJSON() (data []byte, err error)

type NamespaceInstanceNewParamsSourceParamsWebCrawlerCrawlOptions

type NamespaceInstanceNewParamsSourceParamsWebCrawlerCrawlOptions struct {
	Depth                param.Field[float64]                                                            `json:"depth"`
	IncludeExternalLinks param.Field[bool]                                                               `json:"include_external_links"`
	IncludeSubdomains    param.Field[bool]                                                               `json:"include_subdomains"`
	MaxAge               param.Field[float64]                                                            `json:"max_age"`
	Source               param.Field[NamespaceInstanceNewParamsSourceParamsWebCrawlerCrawlOptionsSource] `json:"source"`
}

func (NamespaceInstanceNewParamsSourceParamsWebCrawlerCrawlOptions) MarshalJSON

type NamespaceInstanceNewParamsSourceParamsWebCrawlerCrawlOptionsSource

type NamespaceInstanceNewParamsSourceParamsWebCrawlerCrawlOptionsSource string
const (
	NamespaceInstanceNewParamsSourceParamsWebCrawlerCrawlOptionsSourceAll      NamespaceInstanceNewParamsSourceParamsWebCrawlerCrawlOptionsSource = "all"
	NamespaceInstanceNewParamsSourceParamsWebCrawlerCrawlOptionsSourceSitemaps NamespaceInstanceNewParamsSourceParamsWebCrawlerCrawlOptionsSource = "sitemaps"
	NamespaceInstanceNewParamsSourceParamsWebCrawlerCrawlOptionsSourceLinks    NamespaceInstanceNewParamsSourceParamsWebCrawlerCrawlOptionsSource = "links"
)

func (NamespaceInstanceNewParamsSourceParamsWebCrawlerCrawlOptionsSource) IsKnown

type NamespaceInstanceNewParamsSourceParamsWebCrawlerParseOptions

type NamespaceInstanceNewParamsSourceParamsWebCrawlerParseOptions struct {
	// List of path-to-selector mappings for extracting specific content from crawled
	// pages. Each entry pairs a URL glob pattern with a CSS selector. The first
	// matching path wins. Only the matched HTML fragment is stored and indexed. Omit
	// the field to disable content selection — empty arrays are rejected.
	ContentSelector param.Field[[]NamespaceInstanceNewParamsSourceParamsWebCrawlerParseOptionsContentSelector] `json:"content_selector"`
	// Up to 5 custom HTTP headers sent with each crawl request. Names must be RFC-7230
	// token characters (no spaces, colons, or control characters); values must be
	// HTAB + printable ASCII (no CR/LF).
	IncludeHeaders param.Field[map[string]string] `json:"include_headers"`
	IncludeImages  param.Field[bool]              `json:"include_images"`
	// List of specific sitemap URLs to use for crawling. Only valid when parse_type is
	// 'sitemap'.
	SpecificSitemaps    param.Field[[]string] `json:"specific_sitemaps" format:"uri"`
	UseBrowserRendering param.Field[bool]     `json:"use_browser_rendering"`
}

func (NamespaceInstanceNewParamsSourceParamsWebCrawlerParseOptions) MarshalJSON

type NamespaceInstanceNewParamsSourceParamsWebCrawlerParseOptionsContentSelector

type NamespaceInstanceNewParamsSourceParamsWebCrawlerParseOptionsContentSelector struct {
	// Glob pattern to match against the page URL path. Uses standard glob syntax: \*
	// matches within a segment, \*\* crosses directories.
	Path param.Field[string] `json:"path" api:"required"`
	// CSS selector to extract content from pages matching the path pattern. Must not
	// contain disallowed characters (;, `, $, {, }, \). Must target a single element;
	// if multiple elements match, the selector is ignored and the full page is used.
	Selector param.Field[string] `json:"selector" api:"required"`
}

func (NamespaceInstanceNewParamsSourceParamsWebCrawlerParseOptionsContentSelector) MarshalJSON

type NamespaceInstanceNewParamsSourceParamsWebCrawlerParseType

type NamespaceInstanceNewParamsSourceParamsWebCrawlerParseType string
const (
	NamespaceInstanceNewParamsSourceParamsWebCrawlerParseTypeSitemap NamespaceInstanceNewParamsSourceParamsWebCrawlerParseType = "sitemap"
	NamespaceInstanceNewParamsSourceParamsWebCrawlerParseTypeFeedRss NamespaceInstanceNewParamsSourceParamsWebCrawlerParseType = "feed-rss"
	NamespaceInstanceNewParamsSourceParamsWebCrawlerParseTypeCrawl   NamespaceInstanceNewParamsSourceParamsWebCrawlerParseType = "crawl"
)

func (NamespaceInstanceNewParamsSourceParamsWebCrawlerParseType) IsKnown

type NamespaceInstanceNewParamsSourceParamsWebCrawlerStoreOptions

type NamespaceInstanceNewParamsSourceParamsWebCrawlerStoreOptions struct {
	StorageID      param.Field[string]      `json:"storage_id" api:"required"`
	R2Jurisdiction param.Field[string]      `json:"r2_jurisdiction"`
	StorageType    param.Field[r2.Provider] `json:"storage_type"`
}

func (NamespaceInstanceNewParamsSourceParamsWebCrawlerStoreOptions) MarshalJSON

type NamespaceInstanceNewParamsSyncInterval

type NamespaceInstanceNewParamsSyncInterval float64

Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).

const (
	NamespaceInstanceNewParamsSyncInterval900   NamespaceInstanceNewParamsSyncInterval = 900
	NamespaceInstanceNewParamsSyncInterval1800  NamespaceInstanceNewParamsSyncInterval = 1800
	NamespaceInstanceNewParamsSyncInterval3600  NamespaceInstanceNewParamsSyncInterval = 3600
	NamespaceInstanceNewParamsSyncInterval7200  NamespaceInstanceNewParamsSyncInterval = 7200
	NamespaceInstanceNewParamsSyncInterval14400 NamespaceInstanceNewParamsSyncInterval = 14400
	NamespaceInstanceNewParamsSyncInterval21600 NamespaceInstanceNewParamsSyncInterval = 21600
	NamespaceInstanceNewParamsSyncInterval43200 NamespaceInstanceNewParamsSyncInterval = 43200
	NamespaceInstanceNewParamsSyncInterval86400 NamespaceInstanceNewParamsSyncInterval = 86400
)

func (NamespaceInstanceNewParamsSyncInterval) IsKnown

type NamespaceInstanceNewParamsType

type NamespaceInstanceNewParamsType string
const (
	NamespaceInstanceNewParamsTypeR2         NamespaceInstanceNewParamsType = "r2"
	NamespaceInstanceNewParamsTypeWebCrawler NamespaceInstanceNewParamsType = "web-crawler"
)

func (NamespaceInstanceNewParamsType) IsKnown

type NamespaceInstanceNewResponse

type NamespaceInstanceNewResponse struct {
	// AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
	ID             string                                     `json:"id" api:"required"`
	CreatedAt      time.Time                                  `json:"created_at" api:"required" format:"date-time"`
	ModifiedAt     time.Time                                  `json:"modified_at" api:"required" format:"date-time"`
	AIGatewayID    string                                     `json:"ai_gateway_id" api:"nullable"`
	AISearchModel  NamespaceInstanceNewResponseAISearchModel  `json:"ai_search_model" api:"nullable"`
	Cache          bool                                       `json:"cache"`
	CacheThreshold NamespaceInstanceNewResponseCacheThreshold `json:"cache_threshold"`
	// Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600
	// (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200
	// (72h), 518400 (6d).
	CacheTTL       NamespaceInstanceNewResponseCacheTTL         `json:"cache_ttl"`
	ChunkOverlap   int64                                        `json:"chunk_overlap"`
	ChunkSize      int64                                        `json:"chunk_size"`
	CreatedBy      string                                       `json:"created_by" api:"nullable"`
	CustomMetadata []NamespaceInstanceNewResponseCustomMetadata `json:"custom_metadata"`
	EmbeddingModel NamespaceInstanceNewResponseEmbeddingModel   `json:"embedding_model" api:"nullable"`
	Enable         bool                                         `json:"enable"`
	EngineVersion  float64                                      `json:"engine_version"`
	FusionMethod   NamespaceInstanceNewResponseFusionMethod     `json:"fusion_method"`
	// Deprecated — use index_method instead.
	//
	// Deprecated: deprecated
	HybridSearchEnabled bool `json:"hybrid_search_enabled"`
	// Controls which storage backends are used during indexing. Defaults to
	// vector-only.
	IndexMethod          NamespaceInstanceNewResponseIndexMethod          `json:"index_method"`
	IndexingOptions      NamespaceInstanceNewResponseIndexingOptions      `json:"indexing_options" api:"nullable"`
	LastActivity         time.Time                                        `json:"last_activity" api:"nullable" format:"date-time"`
	MaxNumResults        int64                                            `json:"max_num_results"`
	Metadata             NamespaceInstanceNewResponseMetadata             `json:"metadata"`
	ModifiedBy           string                                           `json:"modified_by" api:"nullable"`
	Namespace            string                                           `json:"namespace" api:"nullable"`
	Paused               bool                                             `json:"paused"`
	PublicEndpointID     string                                           `json:"public_endpoint_id" api:"nullable"`
	PublicEndpointParams NamespaceInstanceNewResponsePublicEndpointParams `json:"public_endpoint_params"`
	Reranking            bool                                             `json:"reranking"`
	RerankingModel       NamespaceInstanceNewResponseRerankingModel       `json:"reranking_model" api:"nullable"`
	RetrievalOptions     NamespaceInstanceNewResponseRetrievalOptions     `json:"retrieval_options" api:"nullable"`
	RewriteModel         NamespaceInstanceNewResponseRewriteModel         `json:"rewrite_model" api:"nullable"`
	RewriteQuery         bool                                             `json:"rewrite_query"`
	ScoreThreshold       float64                                          `json:"score_threshold"`
	Source               string                                           `json:"source" api:"nullable"`
	SourceParams         NamespaceInstanceNewResponseSourceParams         `json:"source_params" api:"nullable"`
	Status               string                                           `json:"status"`
	// Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800
	// (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).
	SyncInterval NamespaceInstanceNewResponseSyncInterval `json:"sync_interval"`
	TokenID      string                                   `json:"token_id" format:"uuid"`
	Type         NamespaceInstanceNewResponseType         `json:"type" api:"nullable"`
	JSON         namespaceInstanceNewResponseJSON         `json:"-"`
}

func (*NamespaceInstanceNewResponse) UnmarshalJSON

func (r *NamespaceInstanceNewResponse) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceNewResponseAISearchModel

type NamespaceInstanceNewResponseAISearchModel string
const (
	NamespaceInstanceNewResponseAISearchModelCfMetaLlama3_3_70bInstructFp8Fast     NamespaceInstanceNewResponseAISearchModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	NamespaceInstanceNewResponseAISearchModelCfZaiOrgGlm4_7Flash                   NamespaceInstanceNewResponseAISearchModel = "@cf/zai-org/glm-4.7-flash"
	NamespaceInstanceNewResponseAISearchModelCfMetaLlama3_1_8bInstructFast         NamespaceInstanceNewResponseAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	NamespaceInstanceNewResponseAISearchModelCfMetaLlama3_1_8bInstructFp8          NamespaceInstanceNewResponseAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	NamespaceInstanceNewResponseAISearchModelCfMetaLlama4Scout17b16eInstruct       NamespaceInstanceNewResponseAISearchModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceNewResponseAISearchModelCfQwenQwen3_30bA3bFp8                 NamespaceInstanceNewResponseAISearchModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	NamespaceInstanceNewResponseAISearchModelCfDeepseekAIDeepseekR1DistillQwen32b  NamespaceInstanceNewResponseAISearchModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	NamespaceInstanceNewResponseAISearchModelCfMoonshotaiKimiK2Instruct            NamespaceInstanceNewResponseAISearchModel = "@cf/moonshotai/kimi-k2-instruct"
	NamespaceInstanceNewResponseAISearchModelCfGoogleGemma3_12bIt                  NamespaceInstanceNewResponseAISearchModel = "@cf/google/gemma-3-12b-it"
	NamespaceInstanceNewResponseAISearchModelCfGoogleGemma4_26bA4bIt               NamespaceInstanceNewResponseAISearchModel = "@cf/google/gemma-4-26b-a4b-it"
	NamespaceInstanceNewResponseAISearchModelCfMoonshotaiKimiK2_5                  NamespaceInstanceNewResponseAISearchModel = "@cf/moonshotai/kimi-k2.5"
	NamespaceInstanceNewResponseAISearchModelAnthropicClaude3_7Sonnet              NamespaceInstanceNewResponseAISearchModel = "anthropic/claude-3-7-sonnet"
	NamespaceInstanceNewResponseAISearchModelAnthropicClaudeSonnet4                NamespaceInstanceNewResponseAISearchModel = "anthropic/claude-sonnet-4"
	NamespaceInstanceNewResponseAISearchModelAnthropicClaudeOpus4                  NamespaceInstanceNewResponseAISearchModel = "anthropic/claude-opus-4"
	NamespaceInstanceNewResponseAISearchModelAnthropicClaude3_5Haiku               NamespaceInstanceNewResponseAISearchModel = "anthropic/claude-3-5-haiku"
	NamespaceInstanceNewResponseAISearchModelCerebrasQwen3_235bA22bInstruct        NamespaceInstanceNewResponseAISearchModel = "cerebras/qwen-3-235b-a22b-instruct"
	NamespaceInstanceNewResponseAISearchModelCerebrasQwen3_235bA22bThinking        NamespaceInstanceNewResponseAISearchModel = "cerebras/qwen-3-235b-a22b-thinking"
	NamespaceInstanceNewResponseAISearchModelCerebrasLlama3_3_70b                  NamespaceInstanceNewResponseAISearchModel = "cerebras/llama-3.3-70b"
	NamespaceInstanceNewResponseAISearchModelCerebrasLlama4Maverick17b128eInstruct NamespaceInstanceNewResponseAISearchModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	NamespaceInstanceNewResponseAISearchModelCerebrasLlama4Scout17b16eInstruct     NamespaceInstanceNewResponseAISearchModel = "cerebras/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceNewResponseAISearchModelCerebrasGptOSs120b                    NamespaceInstanceNewResponseAISearchModel = "cerebras/gpt-oss-120b"
	NamespaceInstanceNewResponseAISearchModelGoogleAIStudioGemini2_5Flash          NamespaceInstanceNewResponseAISearchModel = "google-ai-studio/gemini-2.5-flash"
	NamespaceInstanceNewResponseAISearchModelGoogleAIStudioGemini2_5Pro            NamespaceInstanceNewResponseAISearchModel = "google-ai-studio/gemini-2.5-pro"
	NamespaceInstanceNewResponseAISearchModelGrokGrok4                             NamespaceInstanceNewResponseAISearchModel = "grok/grok-4"
	NamespaceInstanceNewResponseAISearchModelGroqLlama3_3_70bVersatile             NamespaceInstanceNewResponseAISearchModel = "groq/llama-3.3-70b-versatile"
	NamespaceInstanceNewResponseAISearchModelGroqLlama3_1_8bInstant                NamespaceInstanceNewResponseAISearchModel = "groq/llama-3.1-8b-instant"
	NamespaceInstanceNewResponseAISearchModelOpenAIGpt5                            NamespaceInstanceNewResponseAISearchModel = "openai/gpt-5"
	NamespaceInstanceNewResponseAISearchModelOpenAIGpt5Mini                        NamespaceInstanceNewResponseAISearchModel = "openai/gpt-5-mini"
	NamespaceInstanceNewResponseAISearchModelOpenAIGpt5Nano                        NamespaceInstanceNewResponseAISearchModel = "openai/gpt-5-nano"
	NamespaceInstanceNewResponseAISearchModelEmpty                                 NamespaceInstanceNewResponseAISearchModel = ""
)

func (NamespaceInstanceNewResponseAISearchModel) IsKnown

type NamespaceInstanceNewResponseCacheTTL

type NamespaceInstanceNewResponseCacheTTL float64

Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d).

const (
	NamespaceInstanceNewResponseCacheTTL600    NamespaceInstanceNewResponseCacheTTL = 600
	NamespaceInstanceNewResponseCacheTTL1800   NamespaceInstanceNewResponseCacheTTL = 1800
	NamespaceInstanceNewResponseCacheTTL3600   NamespaceInstanceNewResponseCacheTTL = 3600
	NamespaceInstanceNewResponseCacheTTL7200   NamespaceInstanceNewResponseCacheTTL = 7200
	NamespaceInstanceNewResponseCacheTTL21600  NamespaceInstanceNewResponseCacheTTL = 21600
	NamespaceInstanceNewResponseCacheTTL43200  NamespaceInstanceNewResponseCacheTTL = 43200
	NamespaceInstanceNewResponseCacheTTL86400  NamespaceInstanceNewResponseCacheTTL = 86400
	NamespaceInstanceNewResponseCacheTTL172800 NamespaceInstanceNewResponseCacheTTL = 172800
	NamespaceInstanceNewResponseCacheTTL259200 NamespaceInstanceNewResponseCacheTTL = 259200
	NamespaceInstanceNewResponseCacheTTL518400 NamespaceInstanceNewResponseCacheTTL = 518400
)

func (NamespaceInstanceNewResponseCacheTTL) IsKnown

type NamespaceInstanceNewResponseCacheThreshold

type NamespaceInstanceNewResponseCacheThreshold string
const (
	NamespaceInstanceNewResponseCacheThresholdSuperStrictMatch NamespaceInstanceNewResponseCacheThreshold = "super_strict_match"
	NamespaceInstanceNewResponseCacheThresholdCloseEnough      NamespaceInstanceNewResponseCacheThreshold = "close_enough"
	NamespaceInstanceNewResponseCacheThresholdFlexibleFriend   NamespaceInstanceNewResponseCacheThreshold = "flexible_friend"
	NamespaceInstanceNewResponseCacheThresholdAnythingGoes     NamespaceInstanceNewResponseCacheThreshold = "anything_goes"
)

func (NamespaceInstanceNewResponseCacheThreshold) IsKnown

type NamespaceInstanceNewResponseCustomMetadata

type NamespaceInstanceNewResponseCustomMetadata struct {
	DataType  NamespaceInstanceNewResponseCustomMetadataDataType `json:"data_type" api:"required"`
	FieldName string                                             `json:"field_name" api:"required"`
	JSON      namespaceInstanceNewResponseCustomMetadataJSON     `json:"-"`
}

func (*NamespaceInstanceNewResponseCustomMetadata) UnmarshalJSON

func (r *NamespaceInstanceNewResponseCustomMetadata) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceNewResponseCustomMetadataDataType

type NamespaceInstanceNewResponseCustomMetadataDataType string
const (
	NamespaceInstanceNewResponseCustomMetadataDataTypeText     NamespaceInstanceNewResponseCustomMetadataDataType = "text"
	NamespaceInstanceNewResponseCustomMetadataDataTypeNumber   NamespaceInstanceNewResponseCustomMetadataDataType = "number"
	NamespaceInstanceNewResponseCustomMetadataDataTypeBoolean  NamespaceInstanceNewResponseCustomMetadataDataType = "boolean"
	NamespaceInstanceNewResponseCustomMetadataDataTypeDatetime NamespaceInstanceNewResponseCustomMetadataDataType = "datetime"
)

func (NamespaceInstanceNewResponseCustomMetadataDataType) IsKnown

type NamespaceInstanceNewResponseEmbeddingModel

type NamespaceInstanceNewResponseEmbeddingModel string
const (
	NamespaceInstanceNewResponseEmbeddingModelCfQwenQwen3Embedding0_6b              NamespaceInstanceNewResponseEmbeddingModel = "@cf/qwen/qwen3-embedding-0.6b"
	NamespaceInstanceNewResponseEmbeddingModelCfBaaiBgeM3                           NamespaceInstanceNewResponseEmbeddingModel = "@cf/baai/bge-m3"
	NamespaceInstanceNewResponseEmbeddingModelCfBaaiBgeLargeEnV1_5                  NamespaceInstanceNewResponseEmbeddingModel = "@cf/baai/bge-large-en-v1.5"
	NamespaceInstanceNewResponseEmbeddingModelCfGoogleEmbeddinggemma300m            NamespaceInstanceNewResponseEmbeddingModel = "@cf/google/embeddinggemma-300m"
	NamespaceInstanceNewResponseEmbeddingModelGoogleAIStudioGeminiEmbedding001      NamespaceInstanceNewResponseEmbeddingModel = "google-ai-studio/gemini-embedding-001"
	NamespaceInstanceNewResponseEmbeddingModelGoogleAIStudioGeminiEmbedding2Preview NamespaceInstanceNewResponseEmbeddingModel = "google-ai-studio/gemini-embedding-2-preview"
	NamespaceInstanceNewResponseEmbeddingModelOpenAITextEmbedding3Small             NamespaceInstanceNewResponseEmbeddingModel = "openai/text-embedding-3-small"
	NamespaceInstanceNewResponseEmbeddingModelOpenAITextEmbedding3Large             NamespaceInstanceNewResponseEmbeddingModel = "openai/text-embedding-3-large"
	NamespaceInstanceNewResponseEmbeddingModelEmpty                                 NamespaceInstanceNewResponseEmbeddingModel = ""
)

func (NamespaceInstanceNewResponseEmbeddingModel) IsKnown

type NamespaceInstanceNewResponseEnvelope

type NamespaceInstanceNewResponseEnvelope struct {
	Result  NamespaceInstanceNewResponse             `json:"result" api:"required"`
	Success bool                                     `json:"success" api:"required"`
	JSON    namespaceInstanceNewResponseEnvelopeJSON `json:"-"`
}

func (*NamespaceInstanceNewResponseEnvelope) UnmarshalJSON

func (r *NamespaceInstanceNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceNewResponseFusionMethod

type NamespaceInstanceNewResponseFusionMethod string
const (
	NamespaceInstanceNewResponseFusionMethodMax NamespaceInstanceNewResponseFusionMethod = "max"
	NamespaceInstanceNewResponseFusionMethodRrf NamespaceInstanceNewResponseFusionMethod = "rrf"
)

func (NamespaceInstanceNewResponseFusionMethod) IsKnown

type NamespaceInstanceNewResponseIndexMethod

type NamespaceInstanceNewResponseIndexMethod struct {
	// Enable keyword (BM25) storage backend.
	Keyword bool `json:"keyword" api:"required"`
	// Enable vector (embedding) storage backend.
	Vector bool                                        `json:"vector" api:"required"`
	JSON   namespaceInstanceNewResponseIndexMethodJSON `json:"-"`
}

Controls which storage backends are used during indexing. Defaults to vector-only.

func (*NamespaceInstanceNewResponseIndexMethod) UnmarshalJSON

func (r *NamespaceInstanceNewResponseIndexMethod) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceNewResponseIndexingOptions

type NamespaceInstanceNewResponseIndexingOptions struct {
	// Tokenizer used for keyword search indexing. porter provides word-level
	// tokenization with Porter stemming (good for natural language queries). trigram
	// enables character-level substring matching (good for partial matches, code,
	// identifiers). Changing this triggers a full re-index. Defaults to porter.
	KeywordTokenizer NamespaceInstanceNewResponseIndexingOptionsKeywordTokenizer `json:"keyword_tokenizer"`
	JSON             namespaceInstanceNewResponseIndexingOptionsJSON             `json:"-"`
}

func (*NamespaceInstanceNewResponseIndexingOptions) UnmarshalJSON

func (r *NamespaceInstanceNewResponseIndexingOptions) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceNewResponseIndexingOptionsKeywordTokenizer

type NamespaceInstanceNewResponseIndexingOptionsKeywordTokenizer string

Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter.

const (
	NamespaceInstanceNewResponseIndexingOptionsKeywordTokenizerPorter  NamespaceInstanceNewResponseIndexingOptionsKeywordTokenizer = "porter"
	NamespaceInstanceNewResponseIndexingOptionsKeywordTokenizerTrigram NamespaceInstanceNewResponseIndexingOptionsKeywordTokenizer = "trigram"
)

func (NamespaceInstanceNewResponseIndexingOptionsKeywordTokenizer) IsKnown

type NamespaceInstanceNewResponseMetadata

type NamespaceInstanceNewResponseMetadata struct {
	CreatedFromAISearchWizard bool                                     `json:"created_from_aisearch_wizard"`
	WorkerDomain              string                                   `json:"worker_domain"`
	JSON                      namespaceInstanceNewResponseMetadataJSON `json:"-"`
}

func (*NamespaceInstanceNewResponseMetadata) UnmarshalJSON

func (r *NamespaceInstanceNewResponseMetadata) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceNewResponsePublicEndpointParams

type NamespaceInstanceNewResponsePublicEndpointParams struct {
	AuthorizedHosts         []string                                                                `json:"authorized_hosts"`
	ChatCompletionsEndpoint NamespaceInstanceNewResponsePublicEndpointParamsChatCompletionsEndpoint `json:"chat_completions_endpoint"`
	Enabled                 bool                                                                    `json:"enabled"`
	Mcp                     NamespaceInstanceNewResponsePublicEndpointParamsMcp                     `json:"mcp"`
	RateLimit               NamespaceInstanceNewResponsePublicEndpointParamsRateLimit               `json:"rate_limit"`
	SearchEndpoint          NamespaceInstanceNewResponsePublicEndpointParamsSearchEndpoint          `json:"search_endpoint"`
	JSON                    namespaceInstanceNewResponsePublicEndpointParamsJSON                    `json:"-"`
}

func (*NamespaceInstanceNewResponsePublicEndpointParams) UnmarshalJSON

func (r *NamespaceInstanceNewResponsePublicEndpointParams) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceNewResponsePublicEndpointParamsChatCompletionsEndpoint

type NamespaceInstanceNewResponsePublicEndpointParamsChatCompletionsEndpoint struct {
	// Disable chat completions endpoint for this public endpoint
	Disabled bool                                                                        `json:"disabled"`
	JSON     namespaceInstanceNewResponsePublicEndpointParamsChatCompletionsEndpointJSON `json:"-"`
}

func (*NamespaceInstanceNewResponsePublicEndpointParamsChatCompletionsEndpoint) UnmarshalJSON

type NamespaceInstanceNewResponsePublicEndpointParamsMcp

type NamespaceInstanceNewResponsePublicEndpointParamsMcp struct {
	Description string `json:"description"`
	// Disable MCP endpoint for this public endpoint
	Disabled bool                                                    `json:"disabled"`
	JSON     namespaceInstanceNewResponsePublicEndpointParamsMcpJSON `json:"-"`
}

func (*NamespaceInstanceNewResponsePublicEndpointParamsMcp) UnmarshalJSON

func (r *NamespaceInstanceNewResponsePublicEndpointParamsMcp) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceNewResponsePublicEndpointParamsRateLimit

type NamespaceInstanceNewResponsePublicEndpointParamsRateLimit struct {
	PeriodMs  int64                                                              `json:"period_ms"`
	Requests  int64                                                              `json:"requests"`
	Technique NamespaceInstanceNewResponsePublicEndpointParamsRateLimitTechnique `json:"technique"`
	JSON      namespaceInstanceNewResponsePublicEndpointParamsRateLimitJSON      `json:"-"`
}

func (*NamespaceInstanceNewResponsePublicEndpointParamsRateLimit) UnmarshalJSON

type NamespaceInstanceNewResponsePublicEndpointParamsRateLimitTechnique

type NamespaceInstanceNewResponsePublicEndpointParamsRateLimitTechnique string
const (
	NamespaceInstanceNewResponsePublicEndpointParamsRateLimitTechniqueFixed   NamespaceInstanceNewResponsePublicEndpointParamsRateLimitTechnique = "fixed"
	NamespaceInstanceNewResponsePublicEndpointParamsRateLimitTechniqueSliding NamespaceInstanceNewResponsePublicEndpointParamsRateLimitTechnique = "sliding"
)

func (NamespaceInstanceNewResponsePublicEndpointParamsRateLimitTechnique) IsKnown

type NamespaceInstanceNewResponsePublicEndpointParamsSearchEndpoint

type NamespaceInstanceNewResponsePublicEndpointParamsSearchEndpoint struct {
	// Disable search endpoint for this public endpoint
	Disabled bool                                                               `json:"disabled"`
	JSON     namespaceInstanceNewResponsePublicEndpointParamsSearchEndpointJSON `json:"-"`
}

func (*NamespaceInstanceNewResponsePublicEndpointParamsSearchEndpoint) UnmarshalJSON

type NamespaceInstanceNewResponseRerankingModel

type NamespaceInstanceNewResponseRerankingModel string
const (
	NamespaceInstanceNewResponseRerankingModelCfBaaiBgeRerankerBase NamespaceInstanceNewResponseRerankingModel = "@cf/baai/bge-reranker-base"
	NamespaceInstanceNewResponseRerankingModelEmpty                 NamespaceInstanceNewResponseRerankingModel = ""
)

func (NamespaceInstanceNewResponseRerankingModel) IsKnown

type NamespaceInstanceNewResponseRetrievalOptions

type NamespaceInstanceNewResponseRetrievalOptions struct {
	// Metadata fields to boost search results by. Each entry specifies a metadata
	// field and an optional direction. Direction defaults to 'asc' for
	// numeric/datetime fields and 'exists' for text/boolean fields. Fields must match
	// 'timestamp' or a defined custom_metadata field.
	BoostBy []NamespaceInstanceNewResponseRetrievalOptionsBoostBy `json:"boost_by"`
	// 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'.
	KeywordMatchMode NamespaceInstanceNewResponseRetrievalOptionsKeywordMatchMode `json:"keyword_match_mode"`
	JSON             namespaceInstanceNewResponseRetrievalOptionsJSON             `json:"-"`
}

func (*NamespaceInstanceNewResponseRetrievalOptions) UnmarshalJSON

func (r *NamespaceInstanceNewResponseRetrievalOptions) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceNewResponseRetrievalOptionsBoostBy

type NamespaceInstanceNewResponseRetrievalOptionsBoostBy struct {
	// 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.
	Field string `json:"field" api:"required"`
	// 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.
	Direction NamespaceInstanceNewResponseRetrievalOptionsBoostByDirection `json:"direction"`
	JSON      namespaceInstanceNewResponseRetrievalOptionsBoostByJSON      `json:"-"`
}

func (*NamespaceInstanceNewResponseRetrievalOptionsBoostBy) UnmarshalJSON

func (r *NamespaceInstanceNewResponseRetrievalOptionsBoostBy) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceNewResponseRetrievalOptionsBoostByDirection

type NamespaceInstanceNewResponseRetrievalOptionsBoostByDirection string

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.

const (
	NamespaceInstanceNewResponseRetrievalOptionsBoostByDirectionAsc       NamespaceInstanceNewResponseRetrievalOptionsBoostByDirection = "asc"
	NamespaceInstanceNewResponseRetrievalOptionsBoostByDirectionDesc      NamespaceInstanceNewResponseRetrievalOptionsBoostByDirection = "desc"
	NamespaceInstanceNewResponseRetrievalOptionsBoostByDirectionExists    NamespaceInstanceNewResponseRetrievalOptionsBoostByDirection = "exists"
	NamespaceInstanceNewResponseRetrievalOptionsBoostByDirectionNotExists NamespaceInstanceNewResponseRetrievalOptionsBoostByDirection = "not_exists"
)

func (NamespaceInstanceNewResponseRetrievalOptionsBoostByDirection) IsKnown

type NamespaceInstanceNewResponseRetrievalOptionsKeywordMatchMode

type NamespaceInstanceNewResponseRetrievalOptionsKeywordMatchMode string

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'.

const (
	NamespaceInstanceNewResponseRetrievalOptionsKeywordMatchModeAnd NamespaceInstanceNewResponseRetrievalOptionsKeywordMatchMode = "and"
	NamespaceInstanceNewResponseRetrievalOptionsKeywordMatchModeOr  NamespaceInstanceNewResponseRetrievalOptionsKeywordMatchMode = "or"
)

func (NamespaceInstanceNewResponseRetrievalOptionsKeywordMatchMode) IsKnown

type NamespaceInstanceNewResponseRewriteModel

type NamespaceInstanceNewResponseRewriteModel string
const (
	NamespaceInstanceNewResponseRewriteModelCfMetaLlama3_3_70bInstructFp8Fast     NamespaceInstanceNewResponseRewriteModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	NamespaceInstanceNewResponseRewriteModelCfZaiOrgGlm4_7Flash                   NamespaceInstanceNewResponseRewriteModel = "@cf/zai-org/glm-4.7-flash"
	NamespaceInstanceNewResponseRewriteModelCfMetaLlama3_1_8bInstructFast         NamespaceInstanceNewResponseRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	NamespaceInstanceNewResponseRewriteModelCfMetaLlama3_1_8bInstructFp8          NamespaceInstanceNewResponseRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	NamespaceInstanceNewResponseRewriteModelCfMetaLlama4Scout17b16eInstruct       NamespaceInstanceNewResponseRewriteModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceNewResponseRewriteModelCfQwenQwen3_30bA3bFp8                 NamespaceInstanceNewResponseRewriteModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	NamespaceInstanceNewResponseRewriteModelCfDeepseekAIDeepseekR1DistillQwen32b  NamespaceInstanceNewResponseRewriteModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	NamespaceInstanceNewResponseRewriteModelCfMoonshotaiKimiK2Instruct            NamespaceInstanceNewResponseRewriteModel = "@cf/moonshotai/kimi-k2-instruct"
	NamespaceInstanceNewResponseRewriteModelCfGoogleGemma3_12bIt                  NamespaceInstanceNewResponseRewriteModel = "@cf/google/gemma-3-12b-it"
	NamespaceInstanceNewResponseRewriteModelCfGoogleGemma4_26bA4bIt               NamespaceInstanceNewResponseRewriteModel = "@cf/google/gemma-4-26b-a4b-it"
	NamespaceInstanceNewResponseRewriteModelCfMoonshotaiKimiK2_5                  NamespaceInstanceNewResponseRewriteModel = "@cf/moonshotai/kimi-k2.5"
	NamespaceInstanceNewResponseRewriteModelAnthropicClaude3_7Sonnet              NamespaceInstanceNewResponseRewriteModel = "anthropic/claude-3-7-sonnet"
	NamespaceInstanceNewResponseRewriteModelAnthropicClaudeSonnet4                NamespaceInstanceNewResponseRewriteModel = "anthropic/claude-sonnet-4"
	NamespaceInstanceNewResponseRewriteModelAnthropicClaudeOpus4                  NamespaceInstanceNewResponseRewriteModel = "anthropic/claude-opus-4"
	NamespaceInstanceNewResponseRewriteModelAnthropicClaude3_5Haiku               NamespaceInstanceNewResponseRewriteModel = "anthropic/claude-3-5-haiku"
	NamespaceInstanceNewResponseRewriteModelCerebrasQwen3_235bA22bInstruct        NamespaceInstanceNewResponseRewriteModel = "cerebras/qwen-3-235b-a22b-instruct"
	NamespaceInstanceNewResponseRewriteModelCerebrasQwen3_235bA22bThinking        NamespaceInstanceNewResponseRewriteModel = "cerebras/qwen-3-235b-a22b-thinking"
	NamespaceInstanceNewResponseRewriteModelCerebrasLlama3_3_70b                  NamespaceInstanceNewResponseRewriteModel = "cerebras/llama-3.3-70b"
	NamespaceInstanceNewResponseRewriteModelCerebrasLlama4Maverick17b128eInstruct NamespaceInstanceNewResponseRewriteModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	NamespaceInstanceNewResponseRewriteModelCerebrasLlama4Scout17b16eInstruct     NamespaceInstanceNewResponseRewriteModel = "cerebras/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceNewResponseRewriteModelCerebrasGptOSs120b                    NamespaceInstanceNewResponseRewriteModel = "cerebras/gpt-oss-120b"
	NamespaceInstanceNewResponseRewriteModelGoogleAIStudioGemini2_5Flash          NamespaceInstanceNewResponseRewriteModel = "google-ai-studio/gemini-2.5-flash"
	NamespaceInstanceNewResponseRewriteModelGoogleAIStudioGemini2_5Pro            NamespaceInstanceNewResponseRewriteModel = "google-ai-studio/gemini-2.5-pro"
	NamespaceInstanceNewResponseRewriteModelGrokGrok4                             NamespaceInstanceNewResponseRewriteModel = "grok/grok-4"
	NamespaceInstanceNewResponseRewriteModelGroqLlama3_3_70bVersatile             NamespaceInstanceNewResponseRewriteModel = "groq/llama-3.3-70b-versatile"
	NamespaceInstanceNewResponseRewriteModelGroqLlama3_1_8bInstant                NamespaceInstanceNewResponseRewriteModel = "groq/llama-3.1-8b-instant"
	NamespaceInstanceNewResponseRewriteModelOpenAIGpt5                            NamespaceInstanceNewResponseRewriteModel = "openai/gpt-5"
	NamespaceInstanceNewResponseRewriteModelOpenAIGpt5Mini                        NamespaceInstanceNewResponseRewriteModel = "openai/gpt-5-mini"
	NamespaceInstanceNewResponseRewriteModelOpenAIGpt5Nano                        NamespaceInstanceNewResponseRewriteModel = "openai/gpt-5-nano"
	NamespaceInstanceNewResponseRewriteModelEmpty                                 NamespaceInstanceNewResponseRewriteModel = ""
)

func (NamespaceInstanceNewResponseRewriteModel) IsKnown

type NamespaceInstanceNewResponseSourceParams

type NamespaceInstanceNewResponseSourceParams struct {
	// List of path patterns to exclude. Uses micromatch glob syntax: \* matches within
	// a path segment, ** matches across path segments (e.g., /admin/** matches
	// /admin/users and /admin/settings/advanced)
	ExcludeItems []string `json:"exclude_items"`
	// List of path patterns to include. Uses micromatch glob syntax: \* matches within
	// a path segment, ** matches across path segments (e.g., /blog/** matches
	// /blog/post and /blog/2024/post)
	IncludeItems   []string                                           `json:"include_items"`
	Prefix         string                                             `json:"prefix"`
	R2Jurisdiction string                                             `json:"r2_jurisdiction"`
	WebCrawler     NamespaceInstanceNewResponseSourceParamsWebCrawler `json:"web_crawler"`
	JSON           namespaceInstanceNewResponseSourceParamsJSON       `json:"-"`
}

func (*NamespaceInstanceNewResponseSourceParams) UnmarshalJSON

func (r *NamespaceInstanceNewResponseSourceParams) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceNewResponseSourceParamsWebCrawler

type NamespaceInstanceNewResponseSourceParamsWebCrawler struct {
	CrawlOptions NamespaceInstanceNewResponseSourceParamsWebCrawlerCrawlOptions `json:"crawl_options"`
	ParseOptions NamespaceInstanceNewResponseSourceParamsWebCrawlerParseOptions `json:"parse_options"`
	ParseType    NamespaceInstanceNewResponseSourceParamsWebCrawlerParseType    `json:"parse_type"`
	StoreOptions NamespaceInstanceNewResponseSourceParamsWebCrawlerStoreOptions `json:"store_options"`
	JSON         namespaceInstanceNewResponseSourceParamsWebCrawlerJSON         `json:"-"`
}

func (*NamespaceInstanceNewResponseSourceParamsWebCrawler) UnmarshalJSON

func (r *NamespaceInstanceNewResponseSourceParamsWebCrawler) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceNewResponseSourceParamsWebCrawlerCrawlOptions

type NamespaceInstanceNewResponseSourceParamsWebCrawlerCrawlOptions struct {
	Depth                float64                                                              `json:"depth"`
	IncludeExternalLinks bool                                                                 `json:"include_external_links"`
	IncludeSubdomains    bool                                                                 `json:"include_subdomains"`
	MaxAge               float64                                                              `json:"max_age"`
	Source               NamespaceInstanceNewResponseSourceParamsWebCrawlerCrawlOptionsSource `json:"source"`
	JSON                 namespaceInstanceNewResponseSourceParamsWebCrawlerCrawlOptionsJSON   `json:"-"`
}

func (*NamespaceInstanceNewResponseSourceParamsWebCrawlerCrawlOptions) UnmarshalJSON

type NamespaceInstanceNewResponseSourceParamsWebCrawlerCrawlOptionsSource

type NamespaceInstanceNewResponseSourceParamsWebCrawlerCrawlOptionsSource string
const (
	NamespaceInstanceNewResponseSourceParamsWebCrawlerCrawlOptionsSourceAll      NamespaceInstanceNewResponseSourceParamsWebCrawlerCrawlOptionsSource = "all"
	NamespaceInstanceNewResponseSourceParamsWebCrawlerCrawlOptionsSourceSitemaps NamespaceInstanceNewResponseSourceParamsWebCrawlerCrawlOptionsSource = "sitemaps"
	NamespaceInstanceNewResponseSourceParamsWebCrawlerCrawlOptionsSourceLinks    NamespaceInstanceNewResponseSourceParamsWebCrawlerCrawlOptionsSource = "links"
)

func (NamespaceInstanceNewResponseSourceParamsWebCrawlerCrawlOptionsSource) IsKnown

type NamespaceInstanceNewResponseSourceParamsWebCrawlerParseOptions

type NamespaceInstanceNewResponseSourceParamsWebCrawlerParseOptions struct {
	// List of path-to-selector mappings for extracting specific content from crawled
	// pages. Each entry pairs a URL glob pattern with a CSS selector. The first
	// matching path wins. Only the matched HTML fragment is stored and indexed. Omit
	// the field to disable content selection — empty arrays are rejected.
	ContentSelector []NamespaceInstanceNewResponseSourceParamsWebCrawlerParseOptionsContentSelector `json:"content_selector"`
	// Up to 5 custom HTTP headers sent with each crawl request. Names must be RFC-7230
	// token characters (no spaces, colons, or control characters); values must be
	// HTAB + printable ASCII (no CR/LF).
	IncludeHeaders map[string]string `json:"include_headers"`
	IncludeImages  bool              `json:"include_images"`
	// List of specific sitemap URLs to use for crawling. Only valid when parse_type is
	// 'sitemap'.
	SpecificSitemaps    []string                                                           `json:"specific_sitemaps" format:"uri"`
	UseBrowserRendering bool                                                               `json:"use_browser_rendering"`
	JSON                namespaceInstanceNewResponseSourceParamsWebCrawlerParseOptionsJSON `json:"-"`
}

func (*NamespaceInstanceNewResponseSourceParamsWebCrawlerParseOptions) UnmarshalJSON

type NamespaceInstanceNewResponseSourceParamsWebCrawlerParseOptionsContentSelector

type NamespaceInstanceNewResponseSourceParamsWebCrawlerParseOptionsContentSelector struct {
	// Glob pattern to match against the page URL path. Uses standard glob syntax: \*
	// matches within a segment, \*\* crosses directories.
	Path string `json:"path" api:"required"`
	// CSS selector to extract content from pages matching the path pattern. Must not
	// contain disallowed characters (;, `, $, {, }, \). Must target a single element;
	// if multiple elements match, the selector is ignored and the full page is used.
	Selector string                                                                            `json:"selector" api:"required"`
	JSON     namespaceInstanceNewResponseSourceParamsWebCrawlerParseOptionsContentSelectorJSON `json:"-"`
}

func (*NamespaceInstanceNewResponseSourceParamsWebCrawlerParseOptionsContentSelector) UnmarshalJSON

type NamespaceInstanceNewResponseSourceParamsWebCrawlerParseType

type NamespaceInstanceNewResponseSourceParamsWebCrawlerParseType string
const (
	NamespaceInstanceNewResponseSourceParamsWebCrawlerParseTypeSitemap NamespaceInstanceNewResponseSourceParamsWebCrawlerParseType = "sitemap"
	NamespaceInstanceNewResponseSourceParamsWebCrawlerParseTypeFeedRss NamespaceInstanceNewResponseSourceParamsWebCrawlerParseType = "feed-rss"
	NamespaceInstanceNewResponseSourceParamsWebCrawlerParseTypeCrawl   NamespaceInstanceNewResponseSourceParamsWebCrawlerParseType = "crawl"
)

func (NamespaceInstanceNewResponseSourceParamsWebCrawlerParseType) IsKnown

type NamespaceInstanceNewResponseSourceParamsWebCrawlerStoreOptions

type NamespaceInstanceNewResponseSourceParamsWebCrawlerStoreOptions struct {
	StorageID      string                                                             `json:"storage_id" api:"required"`
	R2Jurisdiction string                                                             `json:"r2_jurisdiction"`
	StorageType    r2.Provider                                                        `json:"storage_type"`
	JSON           namespaceInstanceNewResponseSourceParamsWebCrawlerStoreOptionsJSON `json:"-"`
}

func (*NamespaceInstanceNewResponseSourceParamsWebCrawlerStoreOptions) UnmarshalJSON

type NamespaceInstanceNewResponseSyncInterval

type NamespaceInstanceNewResponseSyncInterval float64

Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).

const (
	NamespaceInstanceNewResponseSyncInterval900   NamespaceInstanceNewResponseSyncInterval = 900
	NamespaceInstanceNewResponseSyncInterval1800  NamespaceInstanceNewResponseSyncInterval = 1800
	NamespaceInstanceNewResponseSyncInterval3600  NamespaceInstanceNewResponseSyncInterval = 3600
	NamespaceInstanceNewResponseSyncInterval7200  NamespaceInstanceNewResponseSyncInterval = 7200
	NamespaceInstanceNewResponseSyncInterval14400 NamespaceInstanceNewResponseSyncInterval = 14400
	NamespaceInstanceNewResponseSyncInterval21600 NamespaceInstanceNewResponseSyncInterval = 21600
	NamespaceInstanceNewResponseSyncInterval43200 NamespaceInstanceNewResponseSyncInterval = 43200
	NamespaceInstanceNewResponseSyncInterval86400 NamespaceInstanceNewResponseSyncInterval = 86400
)

func (NamespaceInstanceNewResponseSyncInterval) IsKnown

type NamespaceInstanceNewResponseType

type NamespaceInstanceNewResponseType string
const (
	NamespaceInstanceNewResponseTypeR2         NamespaceInstanceNewResponseType = "r2"
	NamespaceInstanceNewResponseTypeWebCrawler NamespaceInstanceNewResponseType = "web-crawler"
)

func (NamespaceInstanceNewResponseType) IsKnown

type NamespaceInstanceReadParams

type NamespaceInstanceReadParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type NamespaceInstanceReadResponse

type NamespaceInstanceReadResponse struct {
	// AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
	ID             string                                      `json:"id" api:"required"`
	CreatedAt      time.Time                                   `json:"created_at" api:"required" format:"date-time"`
	ModifiedAt     time.Time                                   `json:"modified_at" api:"required" format:"date-time"`
	AIGatewayID    string                                      `json:"ai_gateway_id" api:"nullable"`
	AISearchModel  NamespaceInstanceReadResponseAISearchModel  `json:"ai_search_model" api:"nullable"`
	Cache          bool                                        `json:"cache"`
	CacheThreshold NamespaceInstanceReadResponseCacheThreshold `json:"cache_threshold"`
	// Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600
	// (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200
	// (72h), 518400 (6d).
	CacheTTL       NamespaceInstanceReadResponseCacheTTL         `json:"cache_ttl"`
	ChunkOverlap   int64                                         `json:"chunk_overlap"`
	ChunkSize      int64                                         `json:"chunk_size"`
	CreatedBy      string                                        `json:"created_by" api:"nullable"`
	CustomMetadata []NamespaceInstanceReadResponseCustomMetadata `json:"custom_metadata"`
	EmbeddingModel NamespaceInstanceReadResponseEmbeddingModel   `json:"embedding_model" api:"nullable"`
	Enable         bool                                          `json:"enable"`
	EngineVersion  float64                                       `json:"engine_version"`
	FusionMethod   NamespaceInstanceReadResponseFusionMethod     `json:"fusion_method"`
	// Deprecated — use index_method instead.
	//
	// Deprecated: deprecated
	HybridSearchEnabled bool `json:"hybrid_search_enabled"`
	// Controls which storage backends are used during indexing. Defaults to
	// vector-only.
	IndexMethod          NamespaceInstanceReadResponseIndexMethod          `json:"index_method"`
	IndexingOptions      NamespaceInstanceReadResponseIndexingOptions      `json:"indexing_options" api:"nullable"`
	LastActivity         time.Time                                         `json:"last_activity" api:"nullable" format:"date-time"`
	MaxNumResults        int64                                             `json:"max_num_results"`
	Metadata             NamespaceInstanceReadResponseMetadata             `json:"metadata"`
	ModifiedBy           string                                            `json:"modified_by" api:"nullable"`
	Namespace            string                                            `json:"namespace" api:"nullable"`
	Paused               bool                                              `json:"paused"`
	PublicEndpointID     string                                            `json:"public_endpoint_id" api:"nullable"`
	PublicEndpointParams NamespaceInstanceReadResponsePublicEndpointParams `json:"public_endpoint_params"`
	Reranking            bool                                              `json:"reranking"`
	RerankingModel       NamespaceInstanceReadResponseRerankingModel       `json:"reranking_model" api:"nullable"`
	RetrievalOptions     NamespaceInstanceReadResponseRetrievalOptions     `json:"retrieval_options" api:"nullable"`
	RewriteModel         NamespaceInstanceReadResponseRewriteModel         `json:"rewrite_model" api:"nullable"`
	RewriteQuery         bool                                              `json:"rewrite_query"`
	ScoreThreshold       float64                                           `json:"score_threshold"`
	Source               string                                            `json:"source" api:"nullable"`
	SourceParams         NamespaceInstanceReadResponseSourceParams         `json:"source_params" api:"nullable"`
	Status               string                                            `json:"status"`
	// Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800
	// (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).
	SyncInterval NamespaceInstanceReadResponseSyncInterval `json:"sync_interval"`
	TokenID      string                                    `json:"token_id" format:"uuid"`
	Type         NamespaceInstanceReadResponseType         `json:"type" api:"nullable"`
	JSON         namespaceInstanceReadResponseJSON         `json:"-"`
}

func (*NamespaceInstanceReadResponse) UnmarshalJSON

func (r *NamespaceInstanceReadResponse) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceReadResponseAISearchModel

type NamespaceInstanceReadResponseAISearchModel string
const (
	NamespaceInstanceReadResponseAISearchModelCfMetaLlama3_3_70bInstructFp8Fast     NamespaceInstanceReadResponseAISearchModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	NamespaceInstanceReadResponseAISearchModelCfZaiOrgGlm4_7Flash                   NamespaceInstanceReadResponseAISearchModel = "@cf/zai-org/glm-4.7-flash"
	NamespaceInstanceReadResponseAISearchModelCfMetaLlama3_1_8bInstructFast         NamespaceInstanceReadResponseAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	NamespaceInstanceReadResponseAISearchModelCfMetaLlama3_1_8bInstructFp8          NamespaceInstanceReadResponseAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	NamespaceInstanceReadResponseAISearchModelCfMetaLlama4Scout17b16eInstruct       NamespaceInstanceReadResponseAISearchModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceReadResponseAISearchModelCfQwenQwen3_30bA3bFp8                 NamespaceInstanceReadResponseAISearchModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	NamespaceInstanceReadResponseAISearchModelCfDeepseekAIDeepseekR1DistillQwen32b  NamespaceInstanceReadResponseAISearchModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	NamespaceInstanceReadResponseAISearchModelCfMoonshotaiKimiK2Instruct            NamespaceInstanceReadResponseAISearchModel = "@cf/moonshotai/kimi-k2-instruct"
	NamespaceInstanceReadResponseAISearchModelCfGoogleGemma3_12bIt                  NamespaceInstanceReadResponseAISearchModel = "@cf/google/gemma-3-12b-it"
	NamespaceInstanceReadResponseAISearchModelCfGoogleGemma4_26bA4bIt               NamespaceInstanceReadResponseAISearchModel = "@cf/google/gemma-4-26b-a4b-it"
	NamespaceInstanceReadResponseAISearchModelCfMoonshotaiKimiK2_5                  NamespaceInstanceReadResponseAISearchModel = "@cf/moonshotai/kimi-k2.5"
	NamespaceInstanceReadResponseAISearchModelAnthropicClaude3_7Sonnet              NamespaceInstanceReadResponseAISearchModel = "anthropic/claude-3-7-sonnet"
	NamespaceInstanceReadResponseAISearchModelAnthropicClaudeSonnet4                NamespaceInstanceReadResponseAISearchModel = "anthropic/claude-sonnet-4"
	NamespaceInstanceReadResponseAISearchModelAnthropicClaudeOpus4                  NamespaceInstanceReadResponseAISearchModel = "anthropic/claude-opus-4"
	NamespaceInstanceReadResponseAISearchModelAnthropicClaude3_5Haiku               NamespaceInstanceReadResponseAISearchModel = "anthropic/claude-3-5-haiku"
	NamespaceInstanceReadResponseAISearchModelCerebrasQwen3_235bA22bInstruct        NamespaceInstanceReadResponseAISearchModel = "cerebras/qwen-3-235b-a22b-instruct"
	NamespaceInstanceReadResponseAISearchModelCerebrasQwen3_235bA22bThinking        NamespaceInstanceReadResponseAISearchModel = "cerebras/qwen-3-235b-a22b-thinking"
	NamespaceInstanceReadResponseAISearchModelCerebrasLlama3_3_70b                  NamespaceInstanceReadResponseAISearchModel = "cerebras/llama-3.3-70b"
	NamespaceInstanceReadResponseAISearchModelCerebrasLlama4Maverick17b128eInstruct NamespaceInstanceReadResponseAISearchModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	NamespaceInstanceReadResponseAISearchModelCerebrasLlama4Scout17b16eInstruct     NamespaceInstanceReadResponseAISearchModel = "cerebras/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceReadResponseAISearchModelCerebrasGptOSs120b                    NamespaceInstanceReadResponseAISearchModel = "cerebras/gpt-oss-120b"
	NamespaceInstanceReadResponseAISearchModelGoogleAIStudioGemini2_5Flash          NamespaceInstanceReadResponseAISearchModel = "google-ai-studio/gemini-2.5-flash"
	NamespaceInstanceReadResponseAISearchModelGoogleAIStudioGemini2_5Pro            NamespaceInstanceReadResponseAISearchModel = "google-ai-studio/gemini-2.5-pro"
	NamespaceInstanceReadResponseAISearchModelGrokGrok4                             NamespaceInstanceReadResponseAISearchModel = "grok/grok-4"
	NamespaceInstanceReadResponseAISearchModelGroqLlama3_3_70bVersatile             NamespaceInstanceReadResponseAISearchModel = "groq/llama-3.3-70b-versatile"
	NamespaceInstanceReadResponseAISearchModelGroqLlama3_1_8bInstant                NamespaceInstanceReadResponseAISearchModel = "groq/llama-3.1-8b-instant"
	NamespaceInstanceReadResponseAISearchModelOpenAIGpt5                            NamespaceInstanceReadResponseAISearchModel = "openai/gpt-5"
	NamespaceInstanceReadResponseAISearchModelOpenAIGpt5Mini                        NamespaceInstanceReadResponseAISearchModel = "openai/gpt-5-mini"
	NamespaceInstanceReadResponseAISearchModelOpenAIGpt5Nano                        NamespaceInstanceReadResponseAISearchModel = "openai/gpt-5-nano"
	NamespaceInstanceReadResponseAISearchModelEmpty                                 NamespaceInstanceReadResponseAISearchModel = ""
)

func (NamespaceInstanceReadResponseAISearchModel) IsKnown

type NamespaceInstanceReadResponseCacheTTL

type NamespaceInstanceReadResponseCacheTTL float64

Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d).

const (
	NamespaceInstanceReadResponseCacheTTL600    NamespaceInstanceReadResponseCacheTTL = 600
	NamespaceInstanceReadResponseCacheTTL1800   NamespaceInstanceReadResponseCacheTTL = 1800
	NamespaceInstanceReadResponseCacheTTL3600   NamespaceInstanceReadResponseCacheTTL = 3600
	NamespaceInstanceReadResponseCacheTTL7200   NamespaceInstanceReadResponseCacheTTL = 7200
	NamespaceInstanceReadResponseCacheTTL21600  NamespaceInstanceReadResponseCacheTTL = 21600
	NamespaceInstanceReadResponseCacheTTL43200  NamespaceInstanceReadResponseCacheTTL = 43200
	NamespaceInstanceReadResponseCacheTTL86400  NamespaceInstanceReadResponseCacheTTL = 86400
	NamespaceInstanceReadResponseCacheTTL172800 NamespaceInstanceReadResponseCacheTTL = 172800
	NamespaceInstanceReadResponseCacheTTL259200 NamespaceInstanceReadResponseCacheTTL = 259200
	NamespaceInstanceReadResponseCacheTTL518400 NamespaceInstanceReadResponseCacheTTL = 518400
)

func (NamespaceInstanceReadResponseCacheTTL) IsKnown

type NamespaceInstanceReadResponseCacheThreshold

type NamespaceInstanceReadResponseCacheThreshold string
const (
	NamespaceInstanceReadResponseCacheThresholdSuperStrictMatch NamespaceInstanceReadResponseCacheThreshold = "super_strict_match"
	NamespaceInstanceReadResponseCacheThresholdCloseEnough      NamespaceInstanceReadResponseCacheThreshold = "close_enough"
	NamespaceInstanceReadResponseCacheThresholdFlexibleFriend   NamespaceInstanceReadResponseCacheThreshold = "flexible_friend"
	NamespaceInstanceReadResponseCacheThresholdAnythingGoes     NamespaceInstanceReadResponseCacheThreshold = "anything_goes"
)

func (NamespaceInstanceReadResponseCacheThreshold) IsKnown

type NamespaceInstanceReadResponseCustomMetadata

type NamespaceInstanceReadResponseCustomMetadata struct {
	DataType  NamespaceInstanceReadResponseCustomMetadataDataType `json:"data_type" api:"required"`
	FieldName string                                              `json:"field_name" api:"required"`
	JSON      namespaceInstanceReadResponseCustomMetadataJSON     `json:"-"`
}

func (*NamespaceInstanceReadResponseCustomMetadata) UnmarshalJSON

func (r *NamespaceInstanceReadResponseCustomMetadata) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceReadResponseCustomMetadataDataType

type NamespaceInstanceReadResponseCustomMetadataDataType string
const (
	NamespaceInstanceReadResponseCustomMetadataDataTypeText     NamespaceInstanceReadResponseCustomMetadataDataType = "text"
	NamespaceInstanceReadResponseCustomMetadataDataTypeNumber   NamespaceInstanceReadResponseCustomMetadataDataType = "number"
	NamespaceInstanceReadResponseCustomMetadataDataTypeBoolean  NamespaceInstanceReadResponseCustomMetadataDataType = "boolean"
	NamespaceInstanceReadResponseCustomMetadataDataTypeDatetime NamespaceInstanceReadResponseCustomMetadataDataType = "datetime"
)

func (NamespaceInstanceReadResponseCustomMetadataDataType) IsKnown

type NamespaceInstanceReadResponseEmbeddingModel

type NamespaceInstanceReadResponseEmbeddingModel string
const (
	NamespaceInstanceReadResponseEmbeddingModelCfQwenQwen3Embedding0_6b              NamespaceInstanceReadResponseEmbeddingModel = "@cf/qwen/qwen3-embedding-0.6b"
	NamespaceInstanceReadResponseEmbeddingModelCfBaaiBgeM3                           NamespaceInstanceReadResponseEmbeddingModel = "@cf/baai/bge-m3"
	NamespaceInstanceReadResponseEmbeddingModelCfBaaiBgeLargeEnV1_5                  NamespaceInstanceReadResponseEmbeddingModel = "@cf/baai/bge-large-en-v1.5"
	NamespaceInstanceReadResponseEmbeddingModelCfGoogleEmbeddinggemma300m            NamespaceInstanceReadResponseEmbeddingModel = "@cf/google/embeddinggemma-300m"
	NamespaceInstanceReadResponseEmbeddingModelGoogleAIStudioGeminiEmbedding001      NamespaceInstanceReadResponseEmbeddingModel = "google-ai-studio/gemini-embedding-001"
	NamespaceInstanceReadResponseEmbeddingModelGoogleAIStudioGeminiEmbedding2Preview NamespaceInstanceReadResponseEmbeddingModel = "google-ai-studio/gemini-embedding-2-preview"
	NamespaceInstanceReadResponseEmbeddingModelOpenAITextEmbedding3Small             NamespaceInstanceReadResponseEmbeddingModel = "openai/text-embedding-3-small"
	NamespaceInstanceReadResponseEmbeddingModelOpenAITextEmbedding3Large             NamespaceInstanceReadResponseEmbeddingModel = "openai/text-embedding-3-large"
	NamespaceInstanceReadResponseEmbeddingModelEmpty                                 NamespaceInstanceReadResponseEmbeddingModel = ""
)

func (NamespaceInstanceReadResponseEmbeddingModel) IsKnown

type NamespaceInstanceReadResponseEnvelope

type NamespaceInstanceReadResponseEnvelope struct {
	Result  NamespaceInstanceReadResponse             `json:"result" api:"required"`
	Success bool                                      `json:"success" api:"required"`
	JSON    namespaceInstanceReadResponseEnvelopeJSON `json:"-"`
}

func (*NamespaceInstanceReadResponseEnvelope) UnmarshalJSON

func (r *NamespaceInstanceReadResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceReadResponseFusionMethod

type NamespaceInstanceReadResponseFusionMethod string
const (
	NamespaceInstanceReadResponseFusionMethodMax NamespaceInstanceReadResponseFusionMethod = "max"
	NamespaceInstanceReadResponseFusionMethodRrf NamespaceInstanceReadResponseFusionMethod = "rrf"
)

func (NamespaceInstanceReadResponseFusionMethod) IsKnown

type NamespaceInstanceReadResponseIndexMethod

type NamespaceInstanceReadResponseIndexMethod struct {
	// Enable keyword (BM25) storage backend.
	Keyword bool `json:"keyword" api:"required"`
	// Enable vector (embedding) storage backend.
	Vector bool                                         `json:"vector" api:"required"`
	JSON   namespaceInstanceReadResponseIndexMethodJSON `json:"-"`
}

Controls which storage backends are used during indexing. Defaults to vector-only.

func (*NamespaceInstanceReadResponseIndexMethod) UnmarshalJSON

func (r *NamespaceInstanceReadResponseIndexMethod) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceReadResponseIndexingOptions

type NamespaceInstanceReadResponseIndexingOptions struct {
	// Tokenizer used for keyword search indexing. porter provides word-level
	// tokenization with Porter stemming (good for natural language queries). trigram
	// enables character-level substring matching (good for partial matches, code,
	// identifiers). Changing this triggers a full re-index. Defaults to porter.
	KeywordTokenizer NamespaceInstanceReadResponseIndexingOptionsKeywordTokenizer `json:"keyword_tokenizer"`
	JSON             namespaceInstanceReadResponseIndexingOptionsJSON             `json:"-"`
}

func (*NamespaceInstanceReadResponseIndexingOptions) UnmarshalJSON

func (r *NamespaceInstanceReadResponseIndexingOptions) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceReadResponseIndexingOptionsKeywordTokenizer

type NamespaceInstanceReadResponseIndexingOptionsKeywordTokenizer string

Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter.

const (
	NamespaceInstanceReadResponseIndexingOptionsKeywordTokenizerPorter  NamespaceInstanceReadResponseIndexingOptionsKeywordTokenizer = "porter"
	NamespaceInstanceReadResponseIndexingOptionsKeywordTokenizerTrigram NamespaceInstanceReadResponseIndexingOptionsKeywordTokenizer = "trigram"
)

func (NamespaceInstanceReadResponseIndexingOptionsKeywordTokenizer) IsKnown

type NamespaceInstanceReadResponseMetadata

type NamespaceInstanceReadResponseMetadata struct {
	CreatedFromAISearchWizard bool                                      `json:"created_from_aisearch_wizard"`
	WorkerDomain              string                                    `json:"worker_domain"`
	JSON                      namespaceInstanceReadResponseMetadataJSON `json:"-"`
}

func (*NamespaceInstanceReadResponseMetadata) UnmarshalJSON

func (r *NamespaceInstanceReadResponseMetadata) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceReadResponsePublicEndpointParams

type NamespaceInstanceReadResponsePublicEndpointParams struct {
	AuthorizedHosts         []string                                                                 `json:"authorized_hosts"`
	ChatCompletionsEndpoint NamespaceInstanceReadResponsePublicEndpointParamsChatCompletionsEndpoint `json:"chat_completions_endpoint"`
	Enabled                 bool                                                                     `json:"enabled"`
	Mcp                     NamespaceInstanceReadResponsePublicEndpointParamsMcp                     `json:"mcp"`
	RateLimit               NamespaceInstanceReadResponsePublicEndpointParamsRateLimit               `json:"rate_limit"`
	SearchEndpoint          NamespaceInstanceReadResponsePublicEndpointParamsSearchEndpoint          `json:"search_endpoint"`
	JSON                    namespaceInstanceReadResponsePublicEndpointParamsJSON                    `json:"-"`
}

func (*NamespaceInstanceReadResponsePublicEndpointParams) UnmarshalJSON

func (r *NamespaceInstanceReadResponsePublicEndpointParams) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceReadResponsePublicEndpointParamsChatCompletionsEndpoint

type NamespaceInstanceReadResponsePublicEndpointParamsChatCompletionsEndpoint struct {
	// Disable chat completions endpoint for this public endpoint
	Disabled bool                                                                         `json:"disabled"`
	JSON     namespaceInstanceReadResponsePublicEndpointParamsChatCompletionsEndpointJSON `json:"-"`
}

func (*NamespaceInstanceReadResponsePublicEndpointParamsChatCompletionsEndpoint) UnmarshalJSON

type NamespaceInstanceReadResponsePublicEndpointParamsMcp

type NamespaceInstanceReadResponsePublicEndpointParamsMcp struct {
	Description string `json:"description"`
	// Disable MCP endpoint for this public endpoint
	Disabled bool                                                     `json:"disabled"`
	JSON     namespaceInstanceReadResponsePublicEndpointParamsMcpJSON `json:"-"`
}

func (*NamespaceInstanceReadResponsePublicEndpointParamsMcp) UnmarshalJSON

func (r *NamespaceInstanceReadResponsePublicEndpointParamsMcp) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceReadResponsePublicEndpointParamsRateLimit

type NamespaceInstanceReadResponsePublicEndpointParamsRateLimit struct {
	PeriodMs  int64                                                               `json:"period_ms"`
	Requests  int64                                                               `json:"requests"`
	Technique NamespaceInstanceReadResponsePublicEndpointParamsRateLimitTechnique `json:"technique"`
	JSON      namespaceInstanceReadResponsePublicEndpointParamsRateLimitJSON      `json:"-"`
}

func (*NamespaceInstanceReadResponsePublicEndpointParamsRateLimit) UnmarshalJSON

type NamespaceInstanceReadResponsePublicEndpointParamsRateLimitTechnique

type NamespaceInstanceReadResponsePublicEndpointParamsRateLimitTechnique string
const (
	NamespaceInstanceReadResponsePublicEndpointParamsRateLimitTechniqueFixed   NamespaceInstanceReadResponsePublicEndpointParamsRateLimitTechnique = "fixed"
	NamespaceInstanceReadResponsePublicEndpointParamsRateLimitTechniqueSliding NamespaceInstanceReadResponsePublicEndpointParamsRateLimitTechnique = "sliding"
)

func (NamespaceInstanceReadResponsePublicEndpointParamsRateLimitTechnique) IsKnown

type NamespaceInstanceReadResponsePublicEndpointParamsSearchEndpoint

type NamespaceInstanceReadResponsePublicEndpointParamsSearchEndpoint struct {
	// Disable search endpoint for this public endpoint
	Disabled bool                                                                `json:"disabled"`
	JSON     namespaceInstanceReadResponsePublicEndpointParamsSearchEndpointJSON `json:"-"`
}

func (*NamespaceInstanceReadResponsePublicEndpointParamsSearchEndpoint) UnmarshalJSON

type NamespaceInstanceReadResponseRerankingModel

type NamespaceInstanceReadResponseRerankingModel string
const (
	NamespaceInstanceReadResponseRerankingModelCfBaaiBgeRerankerBase NamespaceInstanceReadResponseRerankingModel = "@cf/baai/bge-reranker-base"
	NamespaceInstanceReadResponseRerankingModelEmpty                 NamespaceInstanceReadResponseRerankingModel = ""
)

func (NamespaceInstanceReadResponseRerankingModel) IsKnown

type NamespaceInstanceReadResponseRetrievalOptions

type NamespaceInstanceReadResponseRetrievalOptions struct {
	// Metadata fields to boost search results by. Each entry specifies a metadata
	// field and an optional direction. Direction defaults to 'asc' for
	// numeric/datetime fields and 'exists' for text/boolean fields. Fields must match
	// 'timestamp' or a defined custom_metadata field.
	BoostBy []NamespaceInstanceReadResponseRetrievalOptionsBoostBy `json:"boost_by"`
	// 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'.
	KeywordMatchMode NamespaceInstanceReadResponseRetrievalOptionsKeywordMatchMode `json:"keyword_match_mode"`
	JSON             namespaceInstanceReadResponseRetrievalOptionsJSON             `json:"-"`
}

func (*NamespaceInstanceReadResponseRetrievalOptions) UnmarshalJSON

func (r *NamespaceInstanceReadResponseRetrievalOptions) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceReadResponseRetrievalOptionsBoostBy

type NamespaceInstanceReadResponseRetrievalOptionsBoostBy struct {
	// 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.
	Field string `json:"field" api:"required"`
	// 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.
	Direction NamespaceInstanceReadResponseRetrievalOptionsBoostByDirection `json:"direction"`
	JSON      namespaceInstanceReadResponseRetrievalOptionsBoostByJSON      `json:"-"`
}

func (*NamespaceInstanceReadResponseRetrievalOptionsBoostBy) UnmarshalJSON

func (r *NamespaceInstanceReadResponseRetrievalOptionsBoostBy) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceReadResponseRetrievalOptionsBoostByDirection

type NamespaceInstanceReadResponseRetrievalOptionsBoostByDirection string

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.

const (
	NamespaceInstanceReadResponseRetrievalOptionsBoostByDirectionAsc       NamespaceInstanceReadResponseRetrievalOptionsBoostByDirection = "asc"
	NamespaceInstanceReadResponseRetrievalOptionsBoostByDirectionDesc      NamespaceInstanceReadResponseRetrievalOptionsBoostByDirection = "desc"
	NamespaceInstanceReadResponseRetrievalOptionsBoostByDirectionExists    NamespaceInstanceReadResponseRetrievalOptionsBoostByDirection = "exists"
	NamespaceInstanceReadResponseRetrievalOptionsBoostByDirectionNotExists NamespaceInstanceReadResponseRetrievalOptionsBoostByDirection = "not_exists"
)

func (NamespaceInstanceReadResponseRetrievalOptionsBoostByDirection) IsKnown

type NamespaceInstanceReadResponseRetrievalOptionsKeywordMatchMode

type NamespaceInstanceReadResponseRetrievalOptionsKeywordMatchMode string

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'.

const (
	NamespaceInstanceReadResponseRetrievalOptionsKeywordMatchModeAnd NamespaceInstanceReadResponseRetrievalOptionsKeywordMatchMode = "and"
	NamespaceInstanceReadResponseRetrievalOptionsKeywordMatchModeOr  NamespaceInstanceReadResponseRetrievalOptionsKeywordMatchMode = "or"
)

func (NamespaceInstanceReadResponseRetrievalOptionsKeywordMatchMode) IsKnown

type NamespaceInstanceReadResponseRewriteModel

type NamespaceInstanceReadResponseRewriteModel string
const (
	NamespaceInstanceReadResponseRewriteModelCfMetaLlama3_3_70bInstructFp8Fast     NamespaceInstanceReadResponseRewriteModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	NamespaceInstanceReadResponseRewriteModelCfZaiOrgGlm4_7Flash                   NamespaceInstanceReadResponseRewriteModel = "@cf/zai-org/glm-4.7-flash"
	NamespaceInstanceReadResponseRewriteModelCfMetaLlama3_1_8bInstructFast         NamespaceInstanceReadResponseRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	NamespaceInstanceReadResponseRewriteModelCfMetaLlama3_1_8bInstructFp8          NamespaceInstanceReadResponseRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	NamespaceInstanceReadResponseRewriteModelCfMetaLlama4Scout17b16eInstruct       NamespaceInstanceReadResponseRewriteModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceReadResponseRewriteModelCfQwenQwen3_30bA3bFp8                 NamespaceInstanceReadResponseRewriteModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	NamespaceInstanceReadResponseRewriteModelCfDeepseekAIDeepseekR1DistillQwen32b  NamespaceInstanceReadResponseRewriteModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	NamespaceInstanceReadResponseRewriteModelCfMoonshotaiKimiK2Instruct            NamespaceInstanceReadResponseRewriteModel = "@cf/moonshotai/kimi-k2-instruct"
	NamespaceInstanceReadResponseRewriteModelCfGoogleGemma3_12bIt                  NamespaceInstanceReadResponseRewriteModel = "@cf/google/gemma-3-12b-it"
	NamespaceInstanceReadResponseRewriteModelCfGoogleGemma4_26bA4bIt               NamespaceInstanceReadResponseRewriteModel = "@cf/google/gemma-4-26b-a4b-it"
	NamespaceInstanceReadResponseRewriteModelCfMoonshotaiKimiK2_5                  NamespaceInstanceReadResponseRewriteModel = "@cf/moonshotai/kimi-k2.5"
	NamespaceInstanceReadResponseRewriteModelAnthropicClaude3_7Sonnet              NamespaceInstanceReadResponseRewriteModel = "anthropic/claude-3-7-sonnet"
	NamespaceInstanceReadResponseRewriteModelAnthropicClaudeSonnet4                NamespaceInstanceReadResponseRewriteModel = "anthropic/claude-sonnet-4"
	NamespaceInstanceReadResponseRewriteModelAnthropicClaudeOpus4                  NamespaceInstanceReadResponseRewriteModel = "anthropic/claude-opus-4"
	NamespaceInstanceReadResponseRewriteModelAnthropicClaude3_5Haiku               NamespaceInstanceReadResponseRewriteModel = "anthropic/claude-3-5-haiku"
	NamespaceInstanceReadResponseRewriteModelCerebrasQwen3_235bA22bInstruct        NamespaceInstanceReadResponseRewriteModel = "cerebras/qwen-3-235b-a22b-instruct"
	NamespaceInstanceReadResponseRewriteModelCerebrasQwen3_235bA22bThinking        NamespaceInstanceReadResponseRewriteModel = "cerebras/qwen-3-235b-a22b-thinking"
	NamespaceInstanceReadResponseRewriteModelCerebrasLlama3_3_70b                  NamespaceInstanceReadResponseRewriteModel = "cerebras/llama-3.3-70b"
	NamespaceInstanceReadResponseRewriteModelCerebrasLlama4Maverick17b128eInstruct NamespaceInstanceReadResponseRewriteModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	NamespaceInstanceReadResponseRewriteModelCerebrasLlama4Scout17b16eInstruct     NamespaceInstanceReadResponseRewriteModel = "cerebras/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceReadResponseRewriteModelCerebrasGptOSs120b                    NamespaceInstanceReadResponseRewriteModel = "cerebras/gpt-oss-120b"
	NamespaceInstanceReadResponseRewriteModelGoogleAIStudioGemini2_5Flash          NamespaceInstanceReadResponseRewriteModel = "google-ai-studio/gemini-2.5-flash"
	NamespaceInstanceReadResponseRewriteModelGoogleAIStudioGemini2_5Pro            NamespaceInstanceReadResponseRewriteModel = "google-ai-studio/gemini-2.5-pro"
	NamespaceInstanceReadResponseRewriteModelGrokGrok4                             NamespaceInstanceReadResponseRewriteModel = "grok/grok-4"
	NamespaceInstanceReadResponseRewriteModelGroqLlama3_3_70bVersatile             NamespaceInstanceReadResponseRewriteModel = "groq/llama-3.3-70b-versatile"
	NamespaceInstanceReadResponseRewriteModelGroqLlama3_1_8bInstant                NamespaceInstanceReadResponseRewriteModel = "groq/llama-3.1-8b-instant"
	NamespaceInstanceReadResponseRewriteModelOpenAIGpt5                            NamespaceInstanceReadResponseRewriteModel = "openai/gpt-5"
	NamespaceInstanceReadResponseRewriteModelOpenAIGpt5Mini                        NamespaceInstanceReadResponseRewriteModel = "openai/gpt-5-mini"
	NamespaceInstanceReadResponseRewriteModelOpenAIGpt5Nano                        NamespaceInstanceReadResponseRewriteModel = "openai/gpt-5-nano"
	NamespaceInstanceReadResponseRewriteModelEmpty                                 NamespaceInstanceReadResponseRewriteModel = ""
)

func (NamespaceInstanceReadResponseRewriteModel) IsKnown

type NamespaceInstanceReadResponseSourceParams

type NamespaceInstanceReadResponseSourceParams struct {
	// List of path patterns to exclude. Uses micromatch glob syntax: \* matches within
	// a path segment, ** matches across path segments (e.g., /admin/** matches
	// /admin/users and /admin/settings/advanced)
	ExcludeItems []string `json:"exclude_items"`
	// List of path patterns to include. Uses micromatch glob syntax: \* matches within
	// a path segment, ** matches across path segments (e.g., /blog/** matches
	// /blog/post and /blog/2024/post)
	IncludeItems   []string                                            `json:"include_items"`
	Prefix         string                                              `json:"prefix"`
	R2Jurisdiction string                                              `json:"r2_jurisdiction"`
	WebCrawler     NamespaceInstanceReadResponseSourceParamsWebCrawler `json:"web_crawler"`
	JSON           namespaceInstanceReadResponseSourceParamsJSON       `json:"-"`
}

func (*NamespaceInstanceReadResponseSourceParams) UnmarshalJSON

func (r *NamespaceInstanceReadResponseSourceParams) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceReadResponseSourceParamsWebCrawler

type NamespaceInstanceReadResponseSourceParamsWebCrawler struct {
	CrawlOptions NamespaceInstanceReadResponseSourceParamsWebCrawlerCrawlOptions `json:"crawl_options"`
	ParseOptions NamespaceInstanceReadResponseSourceParamsWebCrawlerParseOptions `json:"parse_options"`
	ParseType    NamespaceInstanceReadResponseSourceParamsWebCrawlerParseType    `json:"parse_type"`
	StoreOptions NamespaceInstanceReadResponseSourceParamsWebCrawlerStoreOptions `json:"store_options"`
	JSON         namespaceInstanceReadResponseSourceParamsWebCrawlerJSON         `json:"-"`
}

func (*NamespaceInstanceReadResponseSourceParamsWebCrawler) UnmarshalJSON

func (r *NamespaceInstanceReadResponseSourceParamsWebCrawler) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceReadResponseSourceParamsWebCrawlerCrawlOptions

type NamespaceInstanceReadResponseSourceParamsWebCrawlerCrawlOptions struct {
	Depth                float64                                                               `json:"depth"`
	IncludeExternalLinks bool                                                                  `json:"include_external_links"`
	IncludeSubdomains    bool                                                                  `json:"include_subdomains"`
	MaxAge               float64                                                               `json:"max_age"`
	Source               NamespaceInstanceReadResponseSourceParamsWebCrawlerCrawlOptionsSource `json:"source"`
	JSON                 namespaceInstanceReadResponseSourceParamsWebCrawlerCrawlOptionsJSON   `json:"-"`
}

func (*NamespaceInstanceReadResponseSourceParamsWebCrawlerCrawlOptions) UnmarshalJSON

type NamespaceInstanceReadResponseSourceParamsWebCrawlerCrawlOptionsSource

type NamespaceInstanceReadResponseSourceParamsWebCrawlerCrawlOptionsSource string
const (
	NamespaceInstanceReadResponseSourceParamsWebCrawlerCrawlOptionsSourceAll      NamespaceInstanceReadResponseSourceParamsWebCrawlerCrawlOptionsSource = "all"
	NamespaceInstanceReadResponseSourceParamsWebCrawlerCrawlOptionsSourceSitemaps NamespaceInstanceReadResponseSourceParamsWebCrawlerCrawlOptionsSource = "sitemaps"
	NamespaceInstanceReadResponseSourceParamsWebCrawlerCrawlOptionsSourceLinks    NamespaceInstanceReadResponseSourceParamsWebCrawlerCrawlOptionsSource = "links"
)

func (NamespaceInstanceReadResponseSourceParamsWebCrawlerCrawlOptionsSource) IsKnown

type NamespaceInstanceReadResponseSourceParamsWebCrawlerParseOptions

type NamespaceInstanceReadResponseSourceParamsWebCrawlerParseOptions struct {
	// List of path-to-selector mappings for extracting specific content from crawled
	// pages. Each entry pairs a URL glob pattern with a CSS selector. The first
	// matching path wins. Only the matched HTML fragment is stored and indexed. Omit
	// the field to disable content selection — empty arrays are rejected.
	ContentSelector []NamespaceInstanceReadResponseSourceParamsWebCrawlerParseOptionsContentSelector `json:"content_selector"`
	// Up to 5 custom HTTP headers sent with each crawl request. Names must be RFC-7230
	// token characters (no spaces, colons, or control characters); values must be
	// HTAB + printable ASCII (no CR/LF).
	IncludeHeaders map[string]string `json:"include_headers"`
	IncludeImages  bool              `json:"include_images"`
	// List of specific sitemap URLs to use for crawling. Only valid when parse_type is
	// 'sitemap'.
	SpecificSitemaps    []string                                                            `json:"specific_sitemaps" format:"uri"`
	UseBrowserRendering bool                                                                `json:"use_browser_rendering"`
	JSON                namespaceInstanceReadResponseSourceParamsWebCrawlerParseOptionsJSON `json:"-"`
}

func (*NamespaceInstanceReadResponseSourceParamsWebCrawlerParseOptions) UnmarshalJSON

type NamespaceInstanceReadResponseSourceParamsWebCrawlerParseOptionsContentSelector

type NamespaceInstanceReadResponseSourceParamsWebCrawlerParseOptionsContentSelector struct {
	// Glob pattern to match against the page URL path. Uses standard glob syntax: \*
	// matches within a segment, \*\* crosses directories.
	Path string `json:"path" api:"required"`
	// CSS selector to extract content from pages matching the path pattern. Must not
	// contain disallowed characters (;, `, $, {, }, \). Must target a single element;
	// if multiple elements match, the selector is ignored and the full page is used.
	Selector string                                                                             `json:"selector" api:"required"`
	JSON     namespaceInstanceReadResponseSourceParamsWebCrawlerParseOptionsContentSelectorJSON `json:"-"`
}

func (*NamespaceInstanceReadResponseSourceParamsWebCrawlerParseOptionsContentSelector) UnmarshalJSON

type NamespaceInstanceReadResponseSourceParamsWebCrawlerParseType

type NamespaceInstanceReadResponseSourceParamsWebCrawlerParseType string
const (
	NamespaceInstanceReadResponseSourceParamsWebCrawlerParseTypeSitemap NamespaceInstanceReadResponseSourceParamsWebCrawlerParseType = "sitemap"
	NamespaceInstanceReadResponseSourceParamsWebCrawlerParseTypeFeedRss NamespaceInstanceReadResponseSourceParamsWebCrawlerParseType = "feed-rss"
	NamespaceInstanceReadResponseSourceParamsWebCrawlerParseTypeCrawl   NamespaceInstanceReadResponseSourceParamsWebCrawlerParseType = "crawl"
)

func (NamespaceInstanceReadResponseSourceParamsWebCrawlerParseType) IsKnown

type NamespaceInstanceReadResponseSourceParamsWebCrawlerStoreOptions

type NamespaceInstanceReadResponseSourceParamsWebCrawlerStoreOptions struct {
	StorageID      string                                                              `json:"storage_id" api:"required"`
	R2Jurisdiction string                                                              `json:"r2_jurisdiction"`
	StorageType    r2.Provider                                                         `json:"storage_type"`
	JSON           namespaceInstanceReadResponseSourceParamsWebCrawlerStoreOptionsJSON `json:"-"`
}

func (*NamespaceInstanceReadResponseSourceParamsWebCrawlerStoreOptions) UnmarshalJSON

type NamespaceInstanceReadResponseSyncInterval

type NamespaceInstanceReadResponseSyncInterval float64

Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).

const (
	NamespaceInstanceReadResponseSyncInterval900   NamespaceInstanceReadResponseSyncInterval = 900
	NamespaceInstanceReadResponseSyncInterval1800  NamespaceInstanceReadResponseSyncInterval = 1800
	NamespaceInstanceReadResponseSyncInterval3600  NamespaceInstanceReadResponseSyncInterval = 3600
	NamespaceInstanceReadResponseSyncInterval7200  NamespaceInstanceReadResponseSyncInterval = 7200
	NamespaceInstanceReadResponseSyncInterval14400 NamespaceInstanceReadResponseSyncInterval = 14400
	NamespaceInstanceReadResponseSyncInterval21600 NamespaceInstanceReadResponseSyncInterval = 21600
	NamespaceInstanceReadResponseSyncInterval43200 NamespaceInstanceReadResponseSyncInterval = 43200
	NamespaceInstanceReadResponseSyncInterval86400 NamespaceInstanceReadResponseSyncInterval = 86400
)

func (NamespaceInstanceReadResponseSyncInterval) IsKnown

type NamespaceInstanceReadResponseType

type NamespaceInstanceReadResponseType string
const (
	NamespaceInstanceReadResponseTypeR2         NamespaceInstanceReadResponseType = "r2"
	NamespaceInstanceReadResponseTypeWebCrawler NamespaceInstanceReadResponseType = "web-crawler"
)

func (NamespaceInstanceReadResponseType) IsKnown

type NamespaceInstanceSearchParams

type NamespaceInstanceSearchParams struct {
	AccountID       param.Field[string]                                       `path:"account_id" api:"required"`
	AISearchOptions param.Field[NamespaceInstanceSearchParamsAISearchOptions] `json:"ai_search_options"`
	Messages        param.Field[[]NamespaceInstanceSearchParamsMessage]       `json:"messages"`
	// A simple text query string. Alternative to 'messages' — provide either this or
	// 'messages', not both.
	Query param.Field[string] `json:"query"`
}

func (NamespaceInstanceSearchParams) MarshalJSON

func (r NamespaceInstanceSearchParams) MarshalJSON() (data []byte, err error)

type NamespaceInstanceSearchParamsAISearchOptions

type NamespaceInstanceSearchParamsAISearchOptions struct {
	Cache        param.Field[NamespaceInstanceSearchParamsAISearchOptionsCache]        `json:"cache"`
	QueryRewrite param.Field[NamespaceInstanceSearchParamsAISearchOptionsQueryRewrite] `json:"query_rewrite"`
	Reranking    param.Field[NamespaceInstanceSearchParamsAISearchOptionsReranking]    `json:"reranking"`
	Retrieval    param.Field[NamespaceInstanceSearchParamsAISearchOptionsRetrieval]    `json:"retrieval"`
}

func (NamespaceInstanceSearchParamsAISearchOptions) MarshalJSON

func (r NamespaceInstanceSearchParamsAISearchOptions) MarshalJSON() (data []byte, err error)

type NamespaceInstanceSearchParamsAISearchOptionsCache

type NamespaceInstanceSearchParamsAISearchOptionsCache struct {
	CacheThreshold param.Field[NamespaceInstanceSearchParamsAISearchOptionsCacheCacheThreshold] `json:"cache_threshold"`
	Enabled        param.Field[bool]                                                            `json:"enabled"`
}

func (NamespaceInstanceSearchParamsAISearchOptionsCache) MarshalJSON

func (r NamespaceInstanceSearchParamsAISearchOptionsCache) MarshalJSON() (data []byte, err error)

type NamespaceInstanceSearchParamsAISearchOptionsCacheCacheThreshold

type NamespaceInstanceSearchParamsAISearchOptionsCacheCacheThreshold string
const (
	NamespaceInstanceSearchParamsAISearchOptionsCacheCacheThresholdSuperStrictMatch NamespaceInstanceSearchParamsAISearchOptionsCacheCacheThreshold = "super_strict_match"
	NamespaceInstanceSearchParamsAISearchOptionsCacheCacheThresholdCloseEnough      NamespaceInstanceSearchParamsAISearchOptionsCacheCacheThreshold = "close_enough"
	NamespaceInstanceSearchParamsAISearchOptionsCacheCacheThresholdFlexibleFriend   NamespaceInstanceSearchParamsAISearchOptionsCacheCacheThreshold = "flexible_friend"
	NamespaceInstanceSearchParamsAISearchOptionsCacheCacheThresholdAnythingGoes     NamespaceInstanceSearchParamsAISearchOptionsCacheCacheThreshold = "anything_goes"
)

func (NamespaceInstanceSearchParamsAISearchOptionsCacheCacheThreshold) IsKnown

type NamespaceInstanceSearchParamsAISearchOptionsQueryRewrite

type NamespaceInstanceSearchParamsAISearchOptionsQueryRewrite struct {
	Enabled       param.Field[bool]                                                          `json:"enabled"`
	Model         param.Field[NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel] `json:"model"`
	RewritePrompt param.Field[string]                                                        `json:"rewrite_prompt"`
}

func (NamespaceInstanceSearchParamsAISearchOptionsQueryRewrite) MarshalJSON

type NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel

type NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel string
const (
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelCfMetaLlama3_3_70bInstructFp8Fast     NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelCfZaiOrgGlm4_7Flash                   NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/zai-org/glm-4.7-flash"
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelCfMetaLlama3_1_8bInstructFast         NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelCfMetaLlama3_1_8bInstructFp8          NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelCfMetaLlama4Scout17b16eInstruct       NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelCfQwenQwen3_30bA3bFp8                 NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelCfDeepseekAIDeepseekR1DistillQwen32b  NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelCfMoonshotaiKimiK2Instruct            NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/moonshotai/kimi-k2-instruct"
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelCfGoogleGemma3_12bIt                  NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/google/gemma-3-12b-it"
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelCfGoogleGemma4_26bA4bIt               NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/google/gemma-4-26b-a4b-it"
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelCfMoonshotaiKimiK2_5                  NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/moonshotai/kimi-k2.5"
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelAnthropicClaude3_7Sonnet              NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = "anthropic/claude-3-7-sonnet"
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelAnthropicClaudeSonnet4                NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = "anthropic/claude-sonnet-4"
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelAnthropicClaudeOpus4                  NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = "anthropic/claude-opus-4"
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelAnthropicClaude3_5Haiku               NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = "anthropic/claude-3-5-haiku"
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelCerebrasQwen3_235bA22bInstruct        NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = "cerebras/qwen-3-235b-a22b-instruct"
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelCerebrasQwen3_235bA22bThinking        NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = "cerebras/qwen-3-235b-a22b-thinking"
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelCerebrasLlama3_3_70b                  NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = "cerebras/llama-3.3-70b"
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelCerebrasLlama4Maverick17b128eInstruct NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelCerebrasLlama4Scout17b16eInstruct     NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = "cerebras/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelCerebrasGptOSs120b                    NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = "cerebras/gpt-oss-120b"
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelGoogleAIStudioGemini2_5Flash          NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = "google-ai-studio/gemini-2.5-flash"
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelGoogleAIStudioGemini2_5Pro            NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = "google-ai-studio/gemini-2.5-pro"
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelGrokGrok4                             NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = "grok/grok-4"
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelGroqLlama3_3_70bVersatile             NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = "groq/llama-3.3-70b-versatile"
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelGroqLlama3_1_8bInstant                NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = "groq/llama-3.1-8b-instant"
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelOpenAIGpt5                            NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = "openai/gpt-5"
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelOpenAIGpt5Mini                        NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = "openai/gpt-5-mini"
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelOpenAIGpt5Nano                        NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = "openai/gpt-5-nano"
	NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModelEmpty                                 NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel = ""
)

func (NamespaceInstanceSearchParamsAISearchOptionsQueryRewriteModel) IsKnown

type NamespaceInstanceSearchParamsAISearchOptionsReranking

type NamespaceInstanceSearchParamsAISearchOptionsReranking struct {
	Enabled        param.Field[bool]                                                       `json:"enabled"`
	MatchThreshold param.Field[float64]                                                    `json:"match_threshold"`
	Model          param.Field[NamespaceInstanceSearchParamsAISearchOptionsRerankingModel] `json:"model"`
}

func (NamespaceInstanceSearchParamsAISearchOptionsReranking) MarshalJSON

type NamespaceInstanceSearchParamsAISearchOptionsRerankingModel

type NamespaceInstanceSearchParamsAISearchOptionsRerankingModel string
const (
	NamespaceInstanceSearchParamsAISearchOptionsRerankingModelCfBaaiBgeRerankerBase NamespaceInstanceSearchParamsAISearchOptionsRerankingModel = "@cf/baai/bge-reranker-base"
	NamespaceInstanceSearchParamsAISearchOptionsRerankingModelEmpty                 NamespaceInstanceSearchParamsAISearchOptionsRerankingModel = ""
)

func (NamespaceInstanceSearchParamsAISearchOptionsRerankingModel) IsKnown

type NamespaceInstanceSearchParamsAISearchOptionsRetrieval

type NamespaceInstanceSearchParamsAISearchOptionsRetrieval struct {
	// 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.
	BoostBy          param.Field[[]NamespaceInstanceSearchParamsAISearchOptionsRetrievalBoostBy]    `json:"boost_by"`
	ContextExpansion param.Field[int64]                                                             `json:"context_expansion"`
	Filters          param.Field[map[string]interface{}]                                            `json:"filters"`
	FusionMethod     param.Field[NamespaceInstanceSearchParamsAISearchOptionsRetrievalFusionMethod] `json:"fusion_method"`
	// 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'.
	KeywordMatchMode param.Field[NamespaceInstanceSearchParamsAISearchOptionsRetrievalKeywordMatchMode] `json:"keyword_match_mode"`
	MatchThreshold   param.Field[float64]                                                               `json:"match_threshold"`
	MaxNumResults    param.Field[int64]                                                                 `json:"max_num_results"`
	RetrievalType    param.Field[NamespaceInstanceSearchParamsAISearchOptionsRetrievalRetrievalType]    `json:"retrieval_type"`
	ReturnOnFailure  param.Field[bool]                                                                  `json:"return_on_failure"`
}

func (NamespaceInstanceSearchParamsAISearchOptionsRetrieval) MarshalJSON

type NamespaceInstanceSearchParamsAISearchOptionsRetrievalBoostBy

type NamespaceInstanceSearchParamsAISearchOptionsRetrievalBoostBy struct {
	// 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.
	Field param.Field[string] `json:"field" api:"required"`
	// 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.
	Direction param.Field[NamespaceInstanceSearchParamsAISearchOptionsRetrievalBoostByDirection] `json:"direction"`
}

func (NamespaceInstanceSearchParamsAISearchOptionsRetrievalBoostBy) MarshalJSON

type NamespaceInstanceSearchParamsAISearchOptionsRetrievalBoostByDirection

type NamespaceInstanceSearchParamsAISearchOptionsRetrievalBoostByDirection string

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.

const (
	NamespaceInstanceSearchParamsAISearchOptionsRetrievalBoostByDirectionAsc       NamespaceInstanceSearchParamsAISearchOptionsRetrievalBoostByDirection = "asc"
	NamespaceInstanceSearchParamsAISearchOptionsRetrievalBoostByDirectionDesc      NamespaceInstanceSearchParamsAISearchOptionsRetrievalBoostByDirection = "desc"
	NamespaceInstanceSearchParamsAISearchOptionsRetrievalBoostByDirectionExists    NamespaceInstanceSearchParamsAISearchOptionsRetrievalBoostByDirection = "exists"
	NamespaceInstanceSearchParamsAISearchOptionsRetrievalBoostByDirectionNotExists NamespaceInstanceSearchParamsAISearchOptionsRetrievalBoostByDirection = "not_exists"
)

func (NamespaceInstanceSearchParamsAISearchOptionsRetrievalBoostByDirection) IsKnown

type NamespaceInstanceSearchParamsAISearchOptionsRetrievalFusionMethod

type NamespaceInstanceSearchParamsAISearchOptionsRetrievalFusionMethod string
const (
	NamespaceInstanceSearchParamsAISearchOptionsRetrievalFusionMethodMax NamespaceInstanceSearchParamsAISearchOptionsRetrievalFusionMethod = "max"
	NamespaceInstanceSearchParamsAISearchOptionsRetrievalFusionMethodRrf NamespaceInstanceSearchParamsAISearchOptionsRetrievalFusionMethod = "rrf"
)

func (NamespaceInstanceSearchParamsAISearchOptionsRetrievalFusionMethod) IsKnown

type NamespaceInstanceSearchParamsAISearchOptionsRetrievalKeywordMatchMode

type NamespaceInstanceSearchParamsAISearchOptionsRetrievalKeywordMatchMode string

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'.

const (
	NamespaceInstanceSearchParamsAISearchOptionsRetrievalKeywordMatchModeAnd NamespaceInstanceSearchParamsAISearchOptionsRetrievalKeywordMatchMode = "and"
	NamespaceInstanceSearchParamsAISearchOptionsRetrievalKeywordMatchModeOr  NamespaceInstanceSearchParamsAISearchOptionsRetrievalKeywordMatchMode = "or"
)

func (NamespaceInstanceSearchParamsAISearchOptionsRetrievalKeywordMatchMode) IsKnown

type NamespaceInstanceSearchParamsAISearchOptionsRetrievalRetrievalType

type NamespaceInstanceSearchParamsAISearchOptionsRetrievalRetrievalType string
const (
	NamespaceInstanceSearchParamsAISearchOptionsRetrievalRetrievalTypeVector  NamespaceInstanceSearchParamsAISearchOptionsRetrievalRetrievalType = "vector"
	NamespaceInstanceSearchParamsAISearchOptionsRetrievalRetrievalTypeKeyword NamespaceInstanceSearchParamsAISearchOptionsRetrievalRetrievalType = "keyword"
	NamespaceInstanceSearchParamsAISearchOptionsRetrievalRetrievalTypeHybrid  NamespaceInstanceSearchParamsAISearchOptionsRetrievalRetrievalType = "hybrid"
)

func (NamespaceInstanceSearchParamsAISearchOptionsRetrievalRetrievalType) IsKnown

type NamespaceInstanceSearchParamsMessage

type NamespaceInstanceSearchParamsMessage struct {
	Content     param.Field[string]                                    `json:"content" api:"required"`
	Role        param.Field[NamespaceInstanceSearchParamsMessagesRole] `json:"role" api:"required"`
	ExtraFields map[string]interface{}                                 `json:"-,extras"`
}

func (NamespaceInstanceSearchParamsMessage) MarshalJSON

func (r NamespaceInstanceSearchParamsMessage) MarshalJSON() (data []byte, err error)

type NamespaceInstanceSearchParamsMessagesRole

type NamespaceInstanceSearchParamsMessagesRole string
const (
	NamespaceInstanceSearchParamsMessagesRoleSystem    NamespaceInstanceSearchParamsMessagesRole = "system"
	NamespaceInstanceSearchParamsMessagesRoleDeveloper NamespaceInstanceSearchParamsMessagesRole = "developer"
	NamespaceInstanceSearchParamsMessagesRoleUser      NamespaceInstanceSearchParamsMessagesRole = "user"
	NamespaceInstanceSearchParamsMessagesRoleAssistant NamespaceInstanceSearchParamsMessagesRole = "assistant"
	NamespaceInstanceSearchParamsMessagesRoleTool      NamespaceInstanceSearchParamsMessagesRole = "tool"
)

func (NamespaceInstanceSearchParamsMessagesRole) IsKnown

type NamespaceInstanceSearchResponse

type NamespaceInstanceSearchResponse struct {
	Chunks      []NamespaceInstanceSearchResponseChunk `json:"chunks" api:"required"`
	SearchQuery string                                 `json:"search_query" api:"required"`
	JSON        namespaceInstanceSearchResponseJSON    `json:"-"`
}

func (*NamespaceInstanceSearchResponse) UnmarshalJSON

func (r *NamespaceInstanceSearchResponse) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceSearchResponseChunk

type NamespaceInstanceSearchResponseChunk struct {
	ID             string                                              `json:"id" api:"required"`
	Score          float64                                             `json:"score" api:"required"`
	Text           string                                              `json:"text" api:"required"`
	Type           string                                              `json:"type" api:"required"`
	Item           NamespaceInstanceSearchResponseChunksItem           `json:"item"`
	ScoringDetails NamespaceInstanceSearchResponseChunksScoringDetails `json:"scoring_details"`
	JSON           namespaceInstanceSearchResponseChunkJSON            `json:"-"`
}

func (*NamespaceInstanceSearchResponseChunk) UnmarshalJSON

func (r *NamespaceInstanceSearchResponseChunk) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceSearchResponseChunksItem

type NamespaceInstanceSearchResponseChunksItem struct {
	Key       string                                        `json:"key" api:"required"`
	Metadata  map[string]interface{}                        `json:"metadata"`
	Timestamp float64                                       `json:"timestamp"`
	JSON      namespaceInstanceSearchResponseChunksItemJSON `json:"-"`
}

func (*NamespaceInstanceSearchResponseChunksItem) UnmarshalJSON

func (r *NamespaceInstanceSearchResponseChunksItem) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceSearchResponseChunksScoringDetails

type NamespaceInstanceSearchResponseChunksScoringDetails struct {
	FusionMethod   NamespaceInstanceSearchResponseChunksScoringDetailsFusionMethod `json:"fusion_method"`
	KeywordRank    float64                                                         `json:"keyword_rank"`
	KeywordScore   float64                                                         `json:"keyword_score"`
	RerankingScore float64                                                         `json:"reranking_score"`
	VectorRank     float64                                                         `json:"vector_rank"`
	VectorScore    float64                                                         `json:"vector_score"`
	JSON           namespaceInstanceSearchResponseChunksScoringDetailsJSON         `json:"-"`
}

func (*NamespaceInstanceSearchResponseChunksScoringDetails) UnmarshalJSON

func (r *NamespaceInstanceSearchResponseChunksScoringDetails) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceSearchResponseChunksScoringDetailsFusionMethod

type NamespaceInstanceSearchResponseChunksScoringDetailsFusionMethod string
const (
	NamespaceInstanceSearchResponseChunksScoringDetailsFusionMethodRrf NamespaceInstanceSearchResponseChunksScoringDetailsFusionMethod = "rrf"
	NamespaceInstanceSearchResponseChunksScoringDetailsFusionMethodMax NamespaceInstanceSearchResponseChunksScoringDetailsFusionMethod = "max"
)

func (NamespaceInstanceSearchResponseChunksScoringDetailsFusionMethod) IsKnown

type NamespaceInstanceSearchResponseEnvelope

type NamespaceInstanceSearchResponseEnvelope struct {
	Result  NamespaceInstanceSearchResponse             `json:"result" api:"required"`
	Success bool                                        `json:"success" api:"required"`
	JSON    namespaceInstanceSearchResponseEnvelopeJSON `json:"-"`
}

func (*NamespaceInstanceSearchResponseEnvelope) UnmarshalJSON

func (r *NamespaceInstanceSearchResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceService

type NamespaceInstanceService struct {
	Options []option.RequestOption
	Jobs    *NamespaceInstanceJobService
	Items   *NamespaceInstanceItemService
}

NamespaceInstanceService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewNamespaceInstanceService method instead.

func NewNamespaceInstanceService

func NewNamespaceInstanceService(opts ...option.RequestOption) (r *NamespaceInstanceService)

NewNamespaceInstanceService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*NamespaceInstanceService) ChatCompletions

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

func (*NamespaceInstanceService) Delete

Delete instance.

func (*NamespaceInstanceService) List

List instances.

func (*NamespaceInstanceService) ListAutoPaging

List instances.

func (*NamespaceInstanceService) New

Create a new instance.

func (*NamespaceInstanceService) Read

Read instance.

func (*NamespaceInstanceService) Search

Executes a semantic search query against an AI Search instance to find relevant indexed content.

func (*NamespaceInstanceService) Stats

Retrieves usage statistics for AI Search instances.

func (*NamespaceInstanceService) Update

Update instance.

type NamespaceInstanceStatsParams

type NamespaceInstanceStatsParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type NamespaceInstanceStatsResponse

type NamespaceInstanceStatsResponse struct {
	Completed int64 `json:"completed"`
	// True when status counts are unavailable (e.g. legacy stats query exceeded D1
	// statement-size limit). Counts are omitted in this case.
	Degraded bool `json:"degraded"`
	// Engine-specific metadata. Present only for managed (v3) instances.
	Engine            NamespaceInstanceStatsResponseEngine `json:"engine"`
	Error             int64                                `json:"error"`
	FileEmbedErrors   map[string]interface{}               `json:"file_embed_errors"`
	IndexSourceErrors map[string]interface{}               `json:"index_source_errors"`
	LastActivity      time.Time                            `json:"last_activity" format:"date-time"`
	Outdated          int64                                `json:"outdated"`
	Queued            int64                                `json:"queued"`
	Running           int64                                `json:"running"`
	Skipped           int64                                `json:"skipped"`
	JSON              namespaceInstanceStatsResponseJSON   `json:"-"`
}

func (*NamespaceInstanceStatsResponse) UnmarshalJSON

func (r *NamespaceInstanceStatsResponse) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceStatsResponseEngine

type NamespaceInstanceStatsResponseEngine struct {
	// R2 bucket storage usage in bytes.
	R2 NamespaceInstanceStatsResponseEngineR2 `json:"r2"`
	// Vectorize index metadata (dimensions, vector count).
	Vectorize NamespaceInstanceStatsResponseEngineVectorize `json:"vectorize"`
	JSON      namespaceInstanceStatsResponseEngineJSON      `json:"-"`
}

Engine-specific metadata. Present only for managed (v3) instances.

func (*NamespaceInstanceStatsResponseEngine) UnmarshalJSON

func (r *NamespaceInstanceStatsResponseEngine) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceStatsResponseEngineR2

type NamespaceInstanceStatsResponseEngineR2 struct {
	MetadataSizeBytes int64                                      `json:"metadataSizeBytes" api:"required"`
	ObjectCount       int64                                      `json:"objectCount" api:"required"`
	PayloadSizeBytes  int64                                      `json:"payloadSizeBytes" api:"required"`
	JSON              namespaceInstanceStatsResponseEngineR2JSON `json:"-"`
}

R2 bucket storage usage in bytes.

func (*NamespaceInstanceStatsResponseEngineR2) UnmarshalJSON

func (r *NamespaceInstanceStatsResponseEngineR2) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceStatsResponseEngineVectorize

type NamespaceInstanceStatsResponseEngineVectorize struct {
	Dimensions   int64                                             `json:"dimensions" api:"required"`
	VectorsCount int64                                             `json:"vectorsCount" api:"required"`
	JSON         namespaceInstanceStatsResponseEngineVectorizeJSON `json:"-"`
}

Vectorize index metadata (dimensions, vector count).

func (*NamespaceInstanceStatsResponseEngineVectorize) UnmarshalJSON

func (r *NamespaceInstanceStatsResponseEngineVectorize) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceStatsResponseEnvelope

type NamespaceInstanceStatsResponseEnvelope struct {
	Result  NamespaceInstanceStatsResponse             `json:"result" api:"required"`
	Success bool                                       `json:"success" api:"required"`
	JSON    namespaceInstanceStatsResponseEnvelopeJSON `json:"-"`
}

func (*NamespaceInstanceStatsResponseEnvelope) UnmarshalJSON

func (r *NamespaceInstanceStatsResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceUpdateParams

type NamespaceInstanceUpdateParams struct {
	AccountID      param.Field[string]                                      `path:"account_id" api:"required"`
	AIGatewayID    param.Field[string]                                      `json:"ai_gateway_id"`
	AISearchModel  param.Field[NamespaceInstanceUpdateParamsAISearchModel]  `json:"ai_search_model"`
	Cache          param.Field[bool]                                        `json:"cache"`
	CacheThreshold param.Field[NamespaceInstanceUpdateParamsCacheThreshold] `json:"cache_threshold"`
	// Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600
	// (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200
	// (72h), 518400 (6d).
	CacheTTL       param.Field[NamespaceInstanceUpdateParamsCacheTTL]         `json:"cache_ttl"`
	Chunk          param.Field[bool]                                          `json:"chunk"`
	ChunkOverlap   param.Field[int64]                                         `json:"chunk_overlap"`
	ChunkSize      param.Field[int64]                                         `json:"chunk_size"`
	CustomMetadata param.Field[[]NamespaceInstanceUpdateParamsCustomMetadata] `json:"custom_metadata"`
	EmbeddingModel param.Field[NamespaceInstanceUpdateParamsEmbeddingModel]   `json:"embedding_model"`
	FusionMethod   param.Field[NamespaceInstanceUpdateParamsFusionMethod]     `json:"fusion_method"`
	// Controls which storage backends are used during indexing. Defaults to
	// vector-only.
	IndexMethod          param.Field[NamespaceInstanceUpdateParamsIndexMethod]          `json:"index_method"`
	IndexingOptions      param.Field[NamespaceInstanceUpdateParamsIndexingOptions]      `json:"indexing_options"`
	MaxNumResults        param.Field[int64]                                             `json:"max_num_results"`
	Metadata             param.Field[NamespaceInstanceUpdateParamsMetadata]             `json:"metadata"`
	Paused               param.Field[bool]                                              `json:"paused"`
	PublicEndpointParams param.Field[NamespaceInstanceUpdateParamsPublicEndpointParams] `json:"public_endpoint_params"`
	Reranking            param.Field[bool]                                              `json:"reranking"`
	RerankingModel       param.Field[NamespaceInstanceUpdateParamsRerankingModel]       `json:"reranking_model"`
	RetrievalOptions     param.Field[NamespaceInstanceUpdateParamsRetrievalOptions]     `json:"retrieval_options"`
	RewriteModel         param.Field[NamespaceInstanceUpdateParamsRewriteModel]         `json:"rewrite_model"`
	RewriteQuery         param.Field[bool]                                              `json:"rewrite_query"`
	ScoreThreshold       param.Field[float64]                                           `json:"score_threshold"`
	SourceParams         param.Field[NamespaceInstanceUpdateParamsSourceParams]         `json:"source_params"`
	Summarization        param.Field[bool]                                              `json:"summarization"`
	SummarizationModel   param.Field[NamespaceInstanceUpdateParamsSummarizationModel]   `json:"summarization_model"`
	// Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800
	// (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).
	SyncInterval                   param.Field[NamespaceInstanceUpdateParamsSyncInterval] `json:"sync_interval"`
	SystemPromptAISearch           param.Field[string]                                    `json:"system_prompt_ai_search"`
	SystemPromptIndexSummarization param.Field[string]                                    `json:"system_prompt_index_summarization"`
	SystemPromptRewriteQuery       param.Field[string]                                    `json:"system_prompt_rewrite_query"`
	TokenID                        param.Field[string]                                    `json:"token_id" format:"uuid"`
}

func (NamespaceInstanceUpdateParams) MarshalJSON

func (r NamespaceInstanceUpdateParams) MarshalJSON() (data []byte, err error)

type NamespaceInstanceUpdateParamsAISearchModel

type NamespaceInstanceUpdateParamsAISearchModel string
const (
	NamespaceInstanceUpdateParamsAISearchModelCfMetaLlama3_3_70bInstructFp8Fast     NamespaceInstanceUpdateParamsAISearchModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	NamespaceInstanceUpdateParamsAISearchModelCfZaiOrgGlm4_7Flash                   NamespaceInstanceUpdateParamsAISearchModel = "@cf/zai-org/glm-4.7-flash"
	NamespaceInstanceUpdateParamsAISearchModelCfMetaLlama3_1_8bInstructFast         NamespaceInstanceUpdateParamsAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	NamespaceInstanceUpdateParamsAISearchModelCfMetaLlama3_1_8bInstructFp8          NamespaceInstanceUpdateParamsAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	NamespaceInstanceUpdateParamsAISearchModelCfMetaLlama4Scout17b16eInstruct       NamespaceInstanceUpdateParamsAISearchModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceUpdateParamsAISearchModelCfQwenQwen3_30bA3bFp8                 NamespaceInstanceUpdateParamsAISearchModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	NamespaceInstanceUpdateParamsAISearchModelCfDeepseekAIDeepseekR1DistillQwen32b  NamespaceInstanceUpdateParamsAISearchModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	NamespaceInstanceUpdateParamsAISearchModelCfMoonshotaiKimiK2Instruct            NamespaceInstanceUpdateParamsAISearchModel = "@cf/moonshotai/kimi-k2-instruct"
	NamespaceInstanceUpdateParamsAISearchModelCfGoogleGemma3_12bIt                  NamespaceInstanceUpdateParamsAISearchModel = "@cf/google/gemma-3-12b-it"
	NamespaceInstanceUpdateParamsAISearchModelCfGoogleGemma4_26bA4bIt               NamespaceInstanceUpdateParamsAISearchModel = "@cf/google/gemma-4-26b-a4b-it"
	NamespaceInstanceUpdateParamsAISearchModelCfMoonshotaiKimiK2_5                  NamespaceInstanceUpdateParamsAISearchModel = "@cf/moonshotai/kimi-k2.5"
	NamespaceInstanceUpdateParamsAISearchModelAnthropicClaude3_7Sonnet              NamespaceInstanceUpdateParamsAISearchModel = "anthropic/claude-3-7-sonnet"
	NamespaceInstanceUpdateParamsAISearchModelAnthropicClaudeSonnet4                NamespaceInstanceUpdateParamsAISearchModel = "anthropic/claude-sonnet-4"
	NamespaceInstanceUpdateParamsAISearchModelAnthropicClaudeOpus4                  NamespaceInstanceUpdateParamsAISearchModel = "anthropic/claude-opus-4"
	NamespaceInstanceUpdateParamsAISearchModelAnthropicClaude3_5Haiku               NamespaceInstanceUpdateParamsAISearchModel = "anthropic/claude-3-5-haiku"
	NamespaceInstanceUpdateParamsAISearchModelCerebrasQwen3_235bA22bInstruct        NamespaceInstanceUpdateParamsAISearchModel = "cerebras/qwen-3-235b-a22b-instruct"
	NamespaceInstanceUpdateParamsAISearchModelCerebrasQwen3_235bA22bThinking        NamespaceInstanceUpdateParamsAISearchModel = "cerebras/qwen-3-235b-a22b-thinking"
	NamespaceInstanceUpdateParamsAISearchModelCerebrasLlama3_3_70b                  NamespaceInstanceUpdateParamsAISearchModel = "cerebras/llama-3.3-70b"
	NamespaceInstanceUpdateParamsAISearchModelCerebrasLlama4Maverick17b128eInstruct NamespaceInstanceUpdateParamsAISearchModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	NamespaceInstanceUpdateParamsAISearchModelCerebrasLlama4Scout17b16eInstruct     NamespaceInstanceUpdateParamsAISearchModel = "cerebras/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceUpdateParamsAISearchModelCerebrasGptOSs120b                    NamespaceInstanceUpdateParamsAISearchModel = "cerebras/gpt-oss-120b"
	NamespaceInstanceUpdateParamsAISearchModelGoogleAIStudioGemini2_5Flash          NamespaceInstanceUpdateParamsAISearchModel = "google-ai-studio/gemini-2.5-flash"
	NamespaceInstanceUpdateParamsAISearchModelGoogleAIStudioGemini2_5Pro            NamespaceInstanceUpdateParamsAISearchModel = "google-ai-studio/gemini-2.5-pro"
	NamespaceInstanceUpdateParamsAISearchModelGrokGrok4                             NamespaceInstanceUpdateParamsAISearchModel = "grok/grok-4"
	NamespaceInstanceUpdateParamsAISearchModelGroqLlama3_3_70bVersatile             NamespaceInstanceUpdateParamsAISearchModel = "groq/llama-3.3-70b-versatile"
	NamespaceInstanceUpdateParamsAISearchModelGroqLlama3_1_8bInstant                NamespaceInstanceUpdateParamsAISearchModel = "groq/llama-3.1-8b-instant"
	NamespaceInstanceUpdateParamsAISearchModelOpenAIGpt5                            NamespaceInstanceUpdateParamsAISearchModel = "openai/gpt-5"
	NamespaceInstanceUpdateParamsAISearchModelOpenAIGpt5Mini                        NamespaceInstanceUpdateParamsAISearchModel = "openai/gpt-5-mini"
	NamespaceInstanceUpdateParamsAISearchModelOpenAIGpt5Nano                        NamespaceInstanceUpdateParamsAISearchModel = "openai/gpt-5-nano"
	NamespaceInstanceUpdateParamsAISearchModelEmpty                                 NamespaceInstanceUpdateParamsAISearchModel = ""
)

func (NamespaceInstanceUpdateParamsAISearchModel) IsKnown

type NamespaceInstanceUpdateParamsCacheTTL

type NamespaceInstanceUpdateParamsCacheTTL float64

Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d).

const (
	NamespaceInstanceUpdateParamsCacheTTL600    NamespaceInstanceUpdateParamsCacheTTL = 600
	NamespaceInstanceUpdateParamsCacheTTL1800   NamespaceInstanceUpdateParamsCacheTTL = 1800
	NamespaceInstanceUpdateParamsCacheTTL3600   NamespaceInstanceUpdateParamsCacheTTL = 3600
	NamespaceInstanceUpdateParamsCacheTTL7200   NamespaceInstanceUpdateParamsCacheTTL = 7200
	NamespaceInstanceUpdateParamsCacheTTL21600  NamespaceInstanceUpdateParamsCacheTTL = 21600
	NamespaceInstanceUpdateParamsCacheTTL43200  NamespaceInstanceUpdateParamsCacheTTL = 43200
	NamespaceInstanceUpdateParamsCacheTTL86400  NamespaceInstanceUpdateParamsCacheTTL = 86400
	NamespaceInstanceUpdateParamsCacheTTL172800 NamespaceInstanceUpdateParamsCacheTTL = 172800
	NamespaceInstanceUpdateParamsCacheTTL259200 NamespaceInstanceUpdateParamsCacheTTL = 259200
	NamespaceInstanceUpdateParamsCacheTTL518400 NamespaceInstanceUpdateParamsCacheTTL = 518400
)

func (NamespaceInstanceUpdateParamsCacheTTL) IsKnown

type NamespaceInstanceUpdateParamsCacheThreshold

type NamespaceInstanceUpdateParamsCacheThreshold string
const (
	NamespaceInstanceUpdateParamsCacheThresholdSuperStrictMatch NamespaceInstanceUpdateParamsCacheThreshold = "super_strict_match"
	NamespaceInstanceUpdateParamsCacheThresholdCloseEnough      NamespaceInstanceUpdateParamsCacheThreshold = "close_enough"
	NamespaceInstanceUpdateParamsCacheThresholdFlexibleFriend   NamespaceInstanceUpdateParamsCacheThreshold = "flexible_friend"
	NamespaceInstanceUpdateParamsCacheThresholdAnythingGoes     NamespaceInstanceUpdateParamsCacheThreshold = "anything_goes"
)

func (NamespaceInstanceUpdateParamsCacheThreshold) IsKnown

type NamespaceInstanceUpdateParamsCustomMetadata

type NamespaceInstanceUpdateParamsCustomMetadata struct {
	DataType  param.Field[NamespaceInstanceUpdateParamsCustomMetadataDataType] `json:"data_type" api:"required"`
	FieldName param.Field[string]                                              `json:"field_name" api:"required"`
}

func (NamespaceInstanceUpdateParamsCustomMetadata) MarshalJSON

func (r NamespaceInstanceUpdateParamsCustomMetadata) MarshalJSON() (data []byte, err error)

type NamespaceInstanceUpdateParamsCustomMetadataDataType

type NamespaceInstanceUpdateParamsCustomMetadataDataType string
const (
	NamespaceInstanceUpdateParamsCustomMetadataDataTypeText     NamespaceInstanceUpdateParamsCustomMetadataDataType = "text"
	NamespaceInstanceUpdateParamsCustomMetadataDataTypeNumber   NamespaceInstanceUpdateParamsCustomMetadataDataType = "number"
	NamespaceInstanceUpdateParamsCustomMetadataDataTypeBoolean  NamespaceInstanceUpdateParamsCustomMetadataDataType = "boolean"
	NamespaceInstanceUpdateParamsCustomMetadataDataTypeDatetime NamespaceInstanceUpdateParamsCustomMetadataDataType = "datetime"
)

func (NamespaceInstanceUpdateParamsCustomMetadataDataType) IsKnown

type NamespaceInstanceUpdateParamsEmbeddingModel

type NamespaceInstanceUpdateParamsEmbeddingModel string
const (
	NamespaceInstanceUpdateParamsEmbeddingModelCfQwenQwen3Embedding0_6b              NamespaceInstanceUpdateParamsEmbeddingModel = "@cf/qwen/qwen3-embedding-0.6b"
	NamespaceInstanceUpdateParamsEmbeddingModelCfBaaiBgeM3                           NamespaceInstanceUpdateParamsEmbeddingModel = "@cf/baai/bge-m3"
	NamespaceInstanceUpdateParamsEmbeddingModelCfBaaiBgeLargeEnV1_5                  NamespaceInstanceUpdateParamsEmbeddingModel = "@cf/baai/bge-large-en-v1.5"
	NamespaceInstanceUpdateParamsEmbeddingModelCfGoogleEmbeddinggemma300m            NamespaceInstanceUpdateParamsEmbeddingModel = "@cf/google/embeddinggemma-300m"
	NamespaceInstanceUpdateParamsEmbeddingModelGoogleAIStudioGeminiEmbedding001      NamespaceInstanceUpdateParamsEmbeddingModel = "google-ai-studio/gemini-embedding-001"
	NamespaceInstanceUpdateParamsEmbeddingModelGoogleAIStudioGeminiEmbedding2Preview NamespaceInstanceUpdateParamsEmbeddingModel = "google-ai-studio/gemini-embedding-2-preview"
	NamespaceInstanceUpdateParamsEmbeddingModelOpenAITextEmbedding3Small             NamespaceInstanceUpdateParamsEmbeddingModel = "openai/text-embedding-3-small"
	NamespaceInstanceUpdateParamsEmbeddingModelOpenAITextEmbedding3Large             NamespaceInstanceUpdateParamsEmbeddingModel = "openai/text-embedding-3-large"
	NamespaceInstanceUpdateParamsEmbeddingModelEmpty                                 NamespaceInstanceUpdateParamsEmbeddingModel = ""
)

func (NamespaceInstanceUpdateParamsEmbeddingModel) IsKnown

type NamespaceInstanceUpdateParamsFusionMethod

type NamespaceInstanceUpdateParamsFusionMethod string
const (
	NamespaceInstanceUpdateParamsFusionMethodMax NamespaceInstanceUpdateParamsFusionMethod = "max"
	NamespaceInstanceUpdateParamsFusionMethodRrf NamespaceInstanceUpdateParamsFusionMethod = "rrf"
)

func (NamespaceInstanceUpdateParamsFusionMethod) IsKnown

type NamespaceInstanceUpdateParamsIndexMethod

type NamespaceInstanceUpdateParamsIndexMethod struct {
	// Enable keyword (BM25) storage backend.
	Keyword param.Field[bool] `json:"keyword" api:"required"`
	// Enable vector (embedding) storage backend.
	Vector param.Field[bool] `json:"vector" api:"required"`
}

Controls which storage backends are used during indexing. Defaults to vector-only.

func (NamespaceInstanceUpdateParamsIndexMethod) MarshalJSON

func (r NamespaceInstanceUpdateParamsIndexMethod) MarshalJSON() (data []byte, err error)

type NamespaceInstanceUpdateParamsIndexingOptions

type NamespaceInstanceUpdateParamsIndexingOptions struct {
	// Tokenizer used for keyword search indexing. porter provides word-level
	// tokenization with Porter stemming (good for natural language queries). trigram
	// enables character-level substring matching (good for partial matches, code,
	// identifiers). Changing this triggers a full re-index. Defaults to porter.
	KeywordTokenizer param.Field[NamespaceInstanceUpdateParamsIndexingOptionsKeywordTokenizer] `json:"keyword_tokenizer"`
}

func (NamespaceInstanceUpdateParamsIndexingOptions) MarshalJSON

func (r NamespaceInstanceUpdateParamsIndexingOptions) MarshalJSON() (data []byte, err error)

type NamespaceInstanceUpdateParamsIndexingOptionsKeywordTokenizer

type NamespaceInstanceUpdateParamsIndexingOptionsKeywordTokenizer string

Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter.

const (
	NamespaceInstanceUpdateParamsIndexingOptionsKeywordTokenizerPorter  NamespaceInstanceUpdateParamsIndexingOptionsKeywordTokenizer = "porter"
	NamespaceInstanceUpdateParamsIndexingOptionsKeywordTokenizerTrigram NamespaceInstanceUpdateParamsIndexingOptionsKeywordTokenizer = "trigram"
)

func (NamespaceInstanceUpdateParamsIndexingOptionsKeywordTokenizer) IsKnown

type NamespaceInstanceUpdateParamsMetadata

type NamespaceInstanceUpdateParamsMetadata struct {
	CreatedFromAISearchWizard param.Field[bool]   `json:"created_from_aisearch_wizard"`
	WorkerDomain              param.Field[string] `json:"worker_domain"`
}

func (NamespaceInstanceUpdateParamsMetadata) MarshalJSON

func (r NamespaceInstanceUpdateParamsMetadata) MarshalJSON() (data []byte, err error)

type NamespaceInstanceUpdateParamsPublicEndpointParams

type NamespaceInstanceUpdateParamsPublicEndpointParams struct {
	AuthorizedHosts         param.Field[[]string]                                                                 `json:"authorized_hosts"`
	ChatCompletionsEndpoint param.Field[NamespaceInstanceUpdateParamsPublicEndpointParamsChatCompletionsEndpoint] `json:"chat_completions_endpoint"`
	Enabled                 param.Field[bool]                                                                     `json:"enabled"`
	Mcp                     param.Field[NamespaceInstanceUpdateParamsPublicEndpointParamsMcp]                     `json:"mcp"`
	RateLimit               param.Field[NamespaceInstanceUpdateParamsPublicEndpointParamsRateLimit]               `json:"rate_limit"`
	SearchEndpoint          param.Field[NamespaceInstanceUpdateParamsPublicEndpointParamsSearchEndpoint]          `json:"search_endpoint"`
}

func (NamespaceInstanceUpdateParamsPublicEndpointParams) MarshalJSON

func (r NamespaceInstanceUpdateParamsPublicEndpointParams) MarshalJSON() (data []byte, err error)

type NamespaceInstanceUpdateParamsPublicEndpointParamsChatCompletionsEndpoint

type NamespaceInstanceUpdateParamsPublicEndpointParamsChatCompletionsEndpoint struct {
	// Disable chat completions endpoint for this public endpoint
	Disabled param.Field[bool] `json:"disabled"`
}

func (NamespaceInstanceUpdateParamsPublicEndpointParamsChatCompletionsEndpoint) MarshalJSON

type NamespaceInstanceUpdateParamsPublicEndpointParamsMcp

type NamespaceInstanceUpdateParamsPublicEndpointParamsMcp struct {
	Description param.Field[string] `json:"description"`
	// Disable MCP endpoint for this public endpoint
	Disabled param.Field[bool] `json:"disabled"`
}

func (NamespaceInstanceUpdateParamsPublicEndpointParamsMcp) MarshalJSON

func (r NamespaceInstanceUpdateParamsPublicEndpointParamsMcp) MarshalJSON() (data []byte, err error)

type NamespaceInstanceUpdateParamsPublicEndpointParamsRateLimit

type NamespaceInstanceUpdateParamsPublicEndpointParamsRateLimit struct {
	PeriodMs  param.Field[int64]                                                               `json:"period_ms"`
	Requests  param.Field[int64]                                                               `json:"requests"`
	Technique param.Field[NamespaceInstanceUpdateParamsPublicEndpointParamsRateLimitTechnique] `json:"technique"`
}

func (NamespaceInstanceUpdateParamsPublicEndpointParamsRateLimit) MarshalJSON

type NamespaceInstanceUpdateParamsPublicEndpointParamsRateLimitTechnique

type NamespaceInstanceUpdateParamsPublicEndpointParamsRateLimitTechnique string
const (
	NamespaceInstanceUpdateParamsPublicEndpointParamsRateLimitTechniqueFixed   NamespaceInstanceUpdateParamsPublicEndpointParamsRateLimitTechnique = "fixed"
	NamespaceInstanceUpdateParamsPublicEndpointParamsRateLimitTechniqueSliding NamespaceInstanceUpdateParamsPublicEndpointParamsRateLimitTechnique = "sliding"
)

func (NamespaceInstanceUpdateParamsPublicEndpointParamsRateLimitTechnique) IsKnown

type NamespaceInstanceUpdateParamsPublicEndpointParamsSearchEndpoint

type NamespaceInstanceUpdateParamsPublicEndpointParamsSearchEndpoint struct {
	// Disable search endpoint for this public endpoint
	Disabled param.Field[bool] `json:"disabled"`
}

func (NamespaceInstanceUpdateParamsPublicEndpointParamsSearchEndpoint) MarshalJSON

type NamespaceInstanceUpdateParamsRerankingModel

type NamespaceInstanceUpdateParamsRerankingModel string
const (
	NamespaceInstanceUpdateParamsRerankingModelCfBaaiBgeRerankerBase NamespaceInstanceUpdateParamsRerankingModel = "@cf/baai/bge-reranker-base"
	NamespaceInstanceUpdateParamsRerankingModelEmpty                 NamespaceInstanceUpdateParamsRerankingModel = ""
)

func (NamespaceInstanceUpdateParamsRerankingModel) IsKnown

type NamespaceInstanceUpdateParamsRetrievalOptions

type NamespaceInstanceUpdateParamsRetrievalOptions struct {
	// Metadata fields to boost search results by. Each entry specifies a metadata
	// field and an optional direction. Direction defaults to 'asc' for
	// numeric/datetime fields and 'exists' for text/boolean fields. Fields must match
	// 'timestamp' or a defined custom_metadata field.
	BoostBy param.Field[[]NamespaceInstanceUpdateParamsRetrievalOptionsBoostBy] `json:"boost_by"`
	// 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'.
	KeywordMatchMode param.Field[NamespaceInstanceUpdateParamsRetrievalOptionsKeywordMatchMode] `json:"keyword_match_mode"`
}

func (NamespaceInstanceUpdateParamsRetrievalOptions) MarshalJSON

func (r NamespaceInstanceUpdateParamsRetrievalOptions) MarshalJSON() (data []byte, err error)

type NamespaceInstanceUpdateParamsRetrievalOptionsBoostBy

type NamespaceInstanceUpdateParamsRetrievalOptionsBoostBy struct {
	// 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.
	Field param.Field[string] `json:"field" api:"required"`
	// 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.
	Direction param.Field[NamespaceInstanceUpdateParamsRetrievalOptionsBoostByDirection] `json:"direction"`
}

func (NamespaceInstanceUpdateParamsRetrievalOptionsBoostBy) MarshalJSON

func (r NamespaceInstanceUpdateParamsRetrievalOptionsBoostBy) MarshalJSON() (data []byte, err error)

type NamespaceInstanceUpdateParamsRetrievalOptionsBoostByDirection

type NamespaceInstanceUpdateParamsRetrievalOptionsBoostByDirection string

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.

const (
	NamespaceInstanceUpdateParamsRetrievalOptionsBoostByDirectionAsc       NamespaceInstanceUpdateParamsRetrievalOptionsBoostByDirection = "asc"
	NamespaceInstanceUpdateParamsRetrievalOptionsBoostByDirectionDesc      NamespaceInstanceUpdateParamsRetrievalOptionsBoostByDirection = "desc"
	NamespaceInstanceUpdateParamsRetrievalOptionsBoostByDirectionExists    NamespaceInstanceUpdateParamsRetrievalOptionsBoostByDirection = "exists"
	NamespaceInstanceUpdateParamsRetrievalOptionsBoostByDirectionNotExists NamespaceInstanceUpdateParamsRetrievalOptionsBoostByDirection = "not_exists"
)

func (NamespaceInstanceUpdateParamsRetrievalOptionsBoostByDirection) IsKnown

type NamespaceInstanceUpdateParamsRetrievalOptionsKeywordMatchMode

type NamespaceInstanceUpdateParamsRetrievalOptionsKeywordMatchMode string

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'.

const (
	NamespaceInstanceUpdateParamsRetrievalOptionsKeywordMatchModeAnd NamespaceInstanceUpdateParamsRetrievalOptionsKeywordMatchMode = "and"
	NamespaceInstanceUpdateParamsRetrievalOptionsKeywordMatchModeOr  NamespaceInstanceUpdateParamsRetrievalOptionsKeywordMatchMode = "or"
)

func (NamespaceInstanceUpdateParamsRetrievalOptionsKeywordMatchMode) IsKnown

type NamespaceInstanceUpdateParamsRewriteModel

type NamespaceInstanceUpdateParamsRewriteModel string
const (
	NamespaceInstanceUpdateParamsRewriteModelCfMetaLlama3_3_70bInstructFp8Fast     NamespaceInstanceUpdateParamsRewriteModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	NamespaceInstanceUpdateParamsRewriteModelCfZaiOrgGlm4_7Flash                   NamespaceInstanceUpdateParamsRewriteModel = "@cf/zai-org/glm-4.7-flash"
	NamespaceInstanceUpdateParamsRewriteModelCfMetaLlama3_1_8bInstructFast         NamespaceInstanceUpdateParamsRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	NamespaceInstanceUpdateParamsRewriteModelCfMetaLlama3_1_8bInstructFp8          NamespaceInstanceUpdateParamsRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	NamespaceInstanceUpdateParamsRewriteModelCfMetaLlama4Scout17b16eInstruct       NamespaceInstanceUpdateParamsRewriteModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceUpdateParamsRewriteModelCfQwenQwen3_30bA3bFp8                 NamespaceInstanceUpdateParamsRewriteModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	NamespaceInstanceUpdateParamsRewriteModelCfDeepseekAIDeepseekR1DistillQwen32b  NamespaceInstanceUpdateParamsRewriteModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	NamespaceInstanceUpdateParamsRewriteModelCfMoonshotaiKimiK2Instruct            NamespaceInstanceUpdateParamsRewriteModel = "@cf/moonshotai/kimi-k2-instruct"
	NamespaceInstanceUpdateParamsRewriteModelCfGoogleGemma3_12bIt                  NamespaceInstanceUpdateParamsRewriteModel = "@cf/google/gemma-3-12b-it"
	NamespaceInstanceUpdateParamsRewriteModelCfGoogleGemma4_26bA4bIt               NamespaceInstanceUpdateParamsRewriteModel = "@cf/google/gemma-4-26b-a4b-it"
	NamespaceInstanceUpdateParamsRewriteModelCfMoonshotaiKimiK2_5                  NamespaceInstanceUpdateParamsRewriteModel = "@cf/moonshotai/kimi-k2.5"
	NamespaceInstanceUpdateParamsRewriteModelAnthropicClaude3_7Sonnet              NamespaceInstanceUpdateParamsRewriteModel = "anthropic/claude-3-7-sonnet"
	NamespaceInstanceUpdateParamsRewriteModelAnthropicClaudeSonnet4                NamespaceInstanceUpdateParamsRewriteModel = "anthropic/claude-sonnet-4"
	NamespaceInstanceUpdateParamsRewriteModelAnthropicClaudeOpus4                  NamespaceInstanceUpdateParamsRewriteModel = "anthropic/claude-opus-4"
	NamespaceInstanceUpdateParamsRewriteModelAnthropicClaude3_5Haiku               NamespaceInstanceUpdateParamsRewriteModel = "anthropic/claude-3-5-haiku"
	NamespaceInstanceUpdateParamsRewriteModelCerebrasQwen3_235bA22bInstruct        NamespaceInstanceUpdateParamsRewriteModel = "cerebras/qwen-3-235b-a22b-instruct"
	NamespaceInstanceUpdateParamsRewriteModelCerebrasQwen3_235bA22bThinking        NamespaceInstanceUpdateParamsRewriteModel = "cerebras/qwen-3-235b-a22b-thinking"
	NamespaceInstanceUpdateParamsRewriteModelCerebrasLlama3_3_70b                  NamespaceInstanceUpdateParamsRewriteModel = "cerebras/llama-3.3-70b"
	NamespaceInstanceUpdateParamsRewriteModelCerebrasLlama4Maverick17b128eInstruct NamespaceInstanceUpdateParamsRewriteModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	NamespaceInstanceUpdateParamsRewriteModelCerebrasLlama4Scout17b16eInstruct     NamespaceInstanceUpdateParamsRewriteModel = "cerebras/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceUpdateParamsRewriteModelCerebrasGptOSs120b                    NamespaceInstanceUpdateParamsRewriteModel = "cerebras/gpt-oss-120b"
	NamespaceInstanceUpdateParamsRewriteModelGoogleAIStudioGemini2_5Flash          NamespaceInstanceUpdateParamsRewriteModel = "google-ai-studio/gemini-2.5-flash"
	NamespaceInstanceUpdateParamsRewriteModelGoogleAIStudioGemini2_5Pro            NamespaceInstanceUpdateParamsRewriteModel = "google-ai-studio/gemini-2.5-pro"
	NamespaceInstanceUpdateParamsRewriteModelGrokGrok4                             NamespaceInstanceUpdateParamsRewriteModel = "grok/grok-4"
	NamespaceInstanceUpdateParamsRewriteModelGroqLlama3_3_70bVersatile             NamespaceInstanceUpdateParamsRewriteModel = "groq/llama-3.3-70b-versatile"
	NamespaceInstanceUpdateParamsRewriteModelGroqLlama3_1_8bInstant                NamespaceInstanceUpdateParamsRewriteModel = "groq/llama-3.1-8b-instant"
	NamespaceInstanceUpdateParamsRewriteModelOpenAIGpt5                            NamespaceInstanceUpdateParamsRewriteModel = "openai/gpt-5"
	NamespaceInstanceUpdateParamsRewriteModelOpenAIGpt5Mini                        NamespaceInstanceUpdateParamsRewriteModel = "openai/gpt-5-mini"
	NamespaceInstanceUpdateParamsRewriteModelOpenAIGpt5Nano                        NamespaceInstanceUpdateParamsRewriteModel = "openai/gpt-5-nano"
	NamespaceInstanceUpdateParamsRewriteModelEmpty                                 NamespaceInstanceUpdateParamsRewriteModel = ""
)

func (NamespaceInstanceUpdateParamsRewriteModel) IsKnown

type NamespaceInstanceUpdateParamsSourceParams

type NamespaceInstanceUpdateParamsSourceParams struct {
	// List of path patterns to exclude. Uses micromatch glob syntax: \* matches within
	// a path segment, ** matches across path segments (e.g., /admin/** matches
	// /admin/users and /admin/settings/advanced)
	ExcludeItems param.Field[[]string] `json:"exclude_items"`
	// List of path patterns to include. Uses micromatch glob syntax: \* matches within
	// a path segment, ** matches across path segments (e.g., /blog/** matches
	// /blog/post and /blog/2024/post)
	IncludeItems   param.Field[[]string]                                            `json:"include_items"`
	Prefix         param.Field[string]                                              `json:"prefix"`
	R2Jurisdiction param.Field[string]                                              `json:"r2_jurisdiction"`
	WebCrawler     param.Field[NamespaceInstanceUpdateParamsSourceParamsWebCrawler] `json:"web_crawler"`
}

func (NamespaceInstanceUpdateParamsSourceParams) MarshalJSON

func (r NamespaceInstanceUpdateParamsSourceParams) MarshalJSON() (data []byte, err error)

type NamespaceInstanceUpdateParamsSourceParamsWebCrawler

type NamespaceInstanceUpdateParamsSourceParamsWebCrawler struct {
	CrawlOptions param.Field[NamespaceInstanceUpdateParamsSourceParamsWebCrawlerCrawlOptions] `json:"crawl_options"`
	ParseOptions param.Field[NamespaceInstanceUpdateParamsSourceParamsWebCrawlerParseOptions] `json:"parse_options"`
	ParseType    param.Field[NamespaceInstanceUpdateParamsSourceParamsWebCrawlerParseType]    `json:"parse_type"`
	StoreOptions param.Field[NamespaceInstanceUpdateParamsSourceParamsWebCrawlerStoreOptions] `json:"store_options"`
}

func (NamespaceInstanceUpdateParamsSourceParamsWebCrawler) MarshalJSON

func (r NamespaceInstanceUpdateParamsSourceParamsWebCrawler) MarshalJSON() (data []byte, err error)

type NamespaceInstanceUpdateParamsSourceParamsWebCrawlerCrawlOptions

type NamespaceInstanceUpdateParamsSourceParamsWebCrawlerCrawlOptions struct {
	Depth                param.Field[float64]                                                               `json:"depth"`
	IncludeExternalLinks param.Field[bool]                                                                  `json:"include_external_links"`
	IncludeSubdomains    param.Field[bool]                                                                  `json:"include_subdomains"`
	MaxAge               param.Field[float64]                                                               `json:"max_age"`
	Source               param.Field[NamespaceInstanceUpdateParamsSourceParamsWebCrawlerCrawlOptionsSource] `json:"source"`
}

func (NamespaceInstanceUpdateParamsSourceParamsWebCrawlerCrawlOptions) MarshalJSON

type NamespaceInstanceUpdateParamsSourceParamsWebCrawlerCrawlOptionsSource

type NamespaceInstanceUpdateParamsSourceParamsWebCrawlerCrawlOptionsSource string
const (
	NamespaceInstanceUpdateParamsSourceParamsWebCrawlerCrawlOptionsSourceAll      NamespaceInstanceUpdateParamsSourceParamsWebCrawlerCrawlOptionsSource = "all"
	NamespaceInstanceUpdateParamsSourceParamsWebCrawlerCrawlOptionsSourceSitemaps NamespaceInstanceUpdateParamsSourceParamsWebCrawlerCrawlOptionsSource = "sitemaps"
	NamespaceInstanceUpdateParamsSourceParamsWebCrawlerCrawlOptionsSourceLinks    NamespaceInstanceUpdateParamsSourceParamsWebCrawlerCrawlOptionsSource = "links"
)

func (NamespaceInstanceUpdateParamsSourceParamsWebCrawlerCrawlOptionsSource) IsKnown

type NamespaceInstanceUpdateParamsSourceParamsWebCrawlerParseOptions

type NamespaceInstanceUpdateParamsSourceParamsWebCrawlerParseOptions struct {
	// List of path-to-selector mappings for extracting specific content from crawled
	// pages. Each entry pairs a URL glob pattern with a CSS selector. The first
	// matching path wins. Only the matched HTML fragment is stored and indexed. Omit
	// the field to disable content selection — empty arrays are rejected.
	ContentSelector param.Field[[]NamespaceInstanceUpdateParamsSourceParamsWebCrawlerParseOptionsContentSelector] `json:"content_selector"`
	// Up to 5 custom HTTP headers sent with each crawl request. Names must be RFC-7230
	// token characters (no spaces, colons, or control characters); values must be
	// HTAB + printable ASCII (no CR/LF).
	IncludeHeaders param.Field[map[string]string] `json:"include_headers"`
	IncludeImages  param.Field[bool]              `json:"include_images"`
	// List of specific sitemap URLs to use for crawling. Only valid when parse_type is
	// 'sitemap'.
	SpecificSitemaps    param.Field[[]string] `json:"specific_sitemaps" format:"uri"`
	UseBrowserRendering param.Field[bool]     `json:"use_browser_rendering"`
}

func (NamespaceInstanceUpdateParamsSourceParamsWebCrawlerParseOptions) MarshalJSON

type NamespaceInstanceUpdateParamsSourceParamsWebCrawlerParseOptionsContentSelector

type NamespaceInstanceUpdateParamsSourceParamsWebCrawlerParseOptionsContentSelector struct {
	// Glob pattern to match against the page URL path. Uses standard glob syntax: \*
	// matches within a segment, \*\* crosses directories.
	Path param.Field[string] `json:"path" api:"required"`
	// CSS selector to extract content from pages matching the path pattern. Must not
	// contain disallowed characters (;, `, $, {, }, \). Must target a single element;
	// if multiple elements match, the selector is ignored and the full page is used.
	Selector param.Field[string] `json:"selector" api:"required"`
}

func (NamespaceInstanceUpdateParamsSourceParamsWebCrawlerParseOptionsContentSelector) MarshalJSON

type NamespaceInstanceUpdateParamsSourceParamsWebCrawlerParseType

type NamespaceInstanceUpdateParamsSourceParamsWebCrawlerParseType string
const (
	NamespaceInstanceUpdateParamsSourceParamsWebCrawlerParseTypeSitemap NamespaceInstanceUpdateParamsSourceParamsWebCrawlerParseType = "sitemap"
	NamespaceInstanceUpdateParamsSourceParamsWebCrawlerParseTypeFeedRss NamespaceInstanceUpdateParamsSourceParamsWebCrawlerParseType = "feed-rss"
	NamespaceInstanceUpdateParamsSourceParamsWebCrawlerParseTypeCrawl   NamespaceInstanceUpdateParamsSourceParamsWebCrawlerParseType = "crawl"
)

func (NamespaceInstanceUpdateParamsSourceParamsWebCrawlerParseType) IsKnown

type NamespaceInstanceUpdateParamsSourceParamsWebCrawlerStoreOptions

type NamespaceInstanceUpdateParamsSourceParamsWebCrawlerStoreOptions struct {
	StorageID      param.Field[string]      `json:"storage_id" api:"required"`
	R2Jurisdiction param.Field[string]      `json:"r2_jurisdiction"`
	StorageType    param.Field[r2.Provider] `json:"storage_type"`
}

func (NamespaceInstanceUpdateParamsSourceParamsWebCrawlerStoreOptions) MarshalJSON

type NamespaceInstanceUpdateParamsSummarizationModel

type NamespaceInstanceUpdateParamsSummarizationModel string
const (
	NamespaceInstanceUpdateParamsSummarizationModelCfMetaLlama3_3_70bInstructFp8Fast     NamespaceInstanceUpdateParamsSummarizationModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	NamespaceInstanceUpdateParamsSummarizationModelCfZaiOrgGlm4_7Flash                   NamespaceInstanceUpdateParamsSummarizationModel = "@cf/zai-org/glm-4.7-flash"
	NamespaceInstanceUpdateParamsSummarizationModelCfMetaLlama3_1_8bInstructFast         NamespaceInstanceUpdateParamsSummarizationModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	NamespaceInstanceUpdateParamsSummarizationModelCfMetaLlama3_1_8bInstructFp8          NamespaceInstanceUpdateParamsSummarizationModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	NamespaceInstanceUpdateParamsSummarizationModelCfMetaLlama4Scout17b16eInstruct       NamespaceInstanceUpdateParamsSummarizationModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceUpdateParamsSummarizationModelCfQwenQwen3_30bA3bFp8                 NamespaceInstanceUpdateParamsSummarizationModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	NamespaceInstanceUpdateParamsSummarizationModelCfDeepseekAIDeepseekR1DistillQwen32b  NamespaceInstanceUpdateParamsSummarizationModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	NamespaceInstanceUpdateParamsSummarizationModelCfMoonshotaiKimiK2Instruct            NamespaceInstanceUpdateParamsSummarizationModel = "@cf/moonshotai/kimi-k2-instruct"
	NamespaceInstanceUpdateParamsSummarizationModelCfGoogleGemma3_12bIt                  NamespaceInstanceUpdateParamsSummarizationModel = "@cf/google/gemma-3-12b-it"
	NamespaceInstanceUpdateParamsSummarizationModelCfGoogleGemma4_26bA4bIt               NamespaceInstanceUpdateParamsSummarizationModel = "@cf/google/gemma-4-26b-a4b-it"
	NamespaceInstanceUpdateParamsSummarizationModelCfMoonshotaiKimiK2_5                  NamespaceInstanceUpdateParamsSummarizationModel = "@cf/moonshotai/kimi-k2.5"
	NamespaceInstanceUpdateParamsSummarizationModelAnthropicClaude3_7Sonnet              NamespaceInstanceUpdateParamsSummarizationModel = "anthropic/claude-3-7-sonnet"
	NamespaceInstanceUpdateParamsSummarizationModelAnthropicClaudeSonnet4                NamespaceInstanceUpdateParamsSummarizationModel = "anthropic/claude-sonnet-4"
	NamespaceInstanceUpdateParamsSummarizationModelAnthropicClaudeOpus4                  NamespaceInstanceUpdateParamsSummarizationModel = "anthropic/claude-opus-4"
	NamespaceInstanceUpdateParamsSummarizationModelAnthropicClaude3_5Haiku               NamespaceInstanceUpdateParamsSummarizationModel = "anthropic/claude-3-5-haiku"
	NamespaceInstanceUpdateParamsSummarizationModelCerebrasQwen3_235bA22bInstruct        NamespaceInstanceUpdateParamsSummarizationModel = "cerebras/qwen-3-235b-a22b-instruct"
	NamespaceInstanceUpdateParamsSummarizationModelCerebrasQwen3_235bA22bThinking        NamespaceInstanceUpdateParamsSummarizationModel = "cerebras/qwen-3-235b-a22b-thinking"
	NamespaceInstanceUpdateParamsSummarizationModelCerebrasLlama3_3_70b                  NamespaceInstanceUpdateParamsSummarizationModel = "cerebras/llama-3.3-70b"
	NamespaceInstanceUpdateParamsSummarizationModelCerebrasLlama4Maverick17b128eInstruct NamespaceInstanceUpdateParamsSummarizationModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	NamespaceInstanceUpdateParamsSummarizationModelCerebrasLlama4Scout17b16eInstruct     NamespaceInstanceUpdateParamsSummarizationModel = "cerebras/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceUpdateParamsSummarizationModelCerebrasGptOSs120b                    NamespaceInstanceUpdateParamsSummarizationModel = "cerebras/gpt-oss-120b"
	NamespaceInstanceUpdateParamsSummarizationModelGoogleAIStudioGemini2_5Flash          NamespaceInstanceUpdateParamsSummarizationModel = "google-ai-studio/gemini-2.5-flash"
	NamespaceInstanceUpdateParamsSummarizationModelGoogleAIStudioGemini2_5Pro            NamespaceInstanceUpdateParamsSummarizationModel = "google-ai-studio/gemini-2.5-pro"
	NamespaceInstanceUpdateParamsSummarizationModelGrokGrok4                             NamespaceInstanceUpdateParamsSummarizationModel = "grok/grok-4"
	NamespaceInstanceUpdateParamsSummarizationModelGroqLlama3_3_70bVersatile             NamespaceInstanceUpdateParamsSummarizationModel = "groq/llama-3.3-70b-versatile"
	NamespaceInstanceUpdateParamsSummarizationModelGroqLlama3_1_8bInstant                NamespaceInstanceUpdateParamsSummarizationModel = "groq/llama-3.1-8b-instant"
	NamespaceInstanceUpdateParamsSummarizationModelOpenAIGpt5                            NamespaceInstanceUpdateParamsSummarizationModel = "openai/gpt-5"
	NamespaceInstanceUpdateParamsSummarizationModelOpenAIGpt5Mini                        NamespaceInstanceUpdateParamsSummarizationModel = "openai/gpt-5-mini"
	NamespaceInstanceUpdateParamsSummarizationModelOpenAIGpt5Nano                        NamespaceInstanceUpdateParamsSummarizationModel = "openai/gpt-5-nano"
	NamespaceInstanceUpdateParamsSummarizationModelEmpty                                 NamespaceInstanceUpdateParamsSummarizationModel = ""
)

func (NamespaceInstanceUpdateParamsSummarizationModel) IsKnown

type NamespaceInstanceUpdateParamsSyncInterval

type NamespaceInstanceUpdateParamsSyncInterval float64

Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).

const (
	NamespaceInstanceUpdateParamsSyncInterval900   NamespaceInstanceUpdateParamsSyncInterval = 900
	NamespaceInstanceUpdateParamsSyncInterval1800  NamespaceInstanceUpdateParamsSyncInterval = 1800
	NamespaceInstanceUpdateParamsSyncInterval3600  NamespaceInstanceUpdateParamsSyncInterval = 3600
	NamespaceInstanceUpdateParamsSyncInterval7200  NamespaceInstanceUpdateParamsSyncInterval = 7200
	NamespaceInstanceUpdateParamsSyncInterval14400 NamespaceInstanceUpdateParamsSyncInterval = 14400
	NamespaceInstanceUpdateParamsSyncInterval21600 NamespaceInstanceUpdateParamsSyncInterval = 21600
	NamespaceInstanceUpdateParamsSyncInterval43200 NamespaceInstanceUpdateParamsSyncInterval = 43200
	NamespaceInstanceUpdateParamsSyncInterval86400 NamespaceInstanceUpdateParamsSyncInterval = 86400
)

func (NamespaceInstanceUpdateParamsSyncInterval) IsKnown

type NamespaceInstanceUpdateResponse

type NamespaceInstanceUpdateResponse struct {
	// AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
	ID             string                                        `json:"id" api:"required"`
	CreatedAt      time.Time                                     `json:"created_at" api:"required" format:"date-time"`
	ModifiedAt     time.Time                                     `json:"modified_at" api:"required" format:"date-time"`
	AIGatewayID    string                                        `json:"ai_gateway_id" api:"nullable"`
	AISearchModel  NamespaceInstanceUpdateResponseAISearchModel  `json:"ai_search_model" api:"nullable"`
	Cache          bool                                          `json:"cache"`
	CacheThreshold NamespaceInstanceUpdateResponseCacheThreshold `json:"cache_threshold"`
	// Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600
	// (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200
	// (72h), 518400 (6d).
	CacheTTL       NamespaceInstanceUpdateResponseCacheTTL         `json:"cache_ttl"`
	ChunkOverlap   int64                                           `json:"chunk_overlap"`
	ChunkSize      int64                                           `json:"chunk_size"`
	CreatedBy      string                                          `json:"created_by" api:"nullable"`
	CustomMetadata []NamespaceInstanceUpdateResponseCustomMetadata `json:"custom_metadata"`
	EmbeddingModel NamespaceInstanceUpdateResponseEmbeddingModel   `json:"embedding_model" api:"nullable"`
	Enable         bool                                            `json:"enable"`
	EngineVersion  float64                                         `json:"engine_version"`
	FusionMethod   NamespaceInstanceUpdateResponseFusionMethod     `json:"fusion_method"`
	// Deprecated — use index_method instead.
	//
	// Deprecated: deprecated
	HybridSearchEnabled bool `json:"hybrid_search_enabled"`
	// Controls which storage backends are used during indexing. Defaults to
	// vector-only.
	IndexMethod          NamespaceInstanceUpdateResponseIndexMethod          `json:"index_method"`
	IndexingOptions      NamespaceInstanceUpdateResponseIndexingOptions      `json:"indexing_options" api:"nullable"`
	LastActivity         time.Time                                           `json:"last_activity" api:"nullable" format:"date-time"`
	MaxNumResults        int64                                               `json:"max_num_results"`
	Metadata             NamespaceInstanceUpdateResponseMetadata             `json:"metadata"`
	ModifiedBy           string                                              `json:"modified_by" api:"nullable"`
	Namespace            string                                              `json:"namespace" api:"nullable"`
	Paused               bool                                                `json:"paused"`
	PublicEndpointID     string                                              `json:"public_endpoint_id" api:"nullable"`
	PublicEndpointParams NamespaceInstanceUpdateResponsePublicEndpointParams `json:"public_endpoint_params"`
	Reranking            bool                                                `json:"reranking"`
	RerankingModel       NamespaceInstanceUpdateResponseRerankingModel       `json:"reranking_model" api:"nullable"`
	RetrievalOptions     NamespaceInstanceUpdateResponseRetrievalOptions     `json:"retrieval_options" api:"nullable"`
	RewriteModel         NamespaceInstanceUpdateResponseRewriteModel         `json:"rewrite_model" api:"nullable"`
	RewriteQuery         bool                                                `json:"rewrite_query"`
	ScoreThreshold       float64                                             `json:"score_threshold"`
	Source               string                                              `json:"source" api:"nullable"`
	SourceParams         NamespaceInstanceUpdateResponseSourceParams         `json:"source_params" api:"nullable"`
	Status               string                                              `json:"status"`
	// Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800
	// (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).
	SyncInterval NamespaceInstanceUpdateResponseSyncInterval `json:"sync_interval"`
	TokenID      string                                      `json:"token_id" format:"uuid"`
	Type         NamespaceInstanceUpdateResponseType         `json:"type" api:"nullable"`
	JSON         namespaceInstanceUpdateResponseJSON         `json:"-"`
}

func (*NamespaceInstanceUpdateResponse) UnmarshalJSON

func (r *NamespaceInstanceUpdateResponse) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceUpdateResponseAISearchModel

type NamespaceInstanceUpdateResponseAISearchModel string
const (
	NamespaceInstanceUpdateResponseAISearchModelCfMetaLlama3_3_70bInstructFp8Fast     NamespaceInstanceUpdateResponseAISearchModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	NamespaceInstanceUpdateResponseAISearchModelCfZaiOrgGlm4_7Flash                   NamespaceInstanceUpdateResponseAISearchModel = "@cf/zai-org/glm-4.7-flash"
	NamespaceInstanceUpdateResponseAISearchModelCfMetaLlama3_1_8bInstructFast         NamespaceInstanceUpdateResponseAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	NamespaceInstanceUpdateResponseAISearchModelCfMetaLlama3_1_8bInstructFp8          NamespaceInstanceUpdateResponseAISearchModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	NamespaceInstanceUpdateResponseAISearchModelCfMetaLlama4Scout17b16eInstruct       NamespaceInstanceUpdateResponseAISearchModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceUpdateResponseAISearchModelCfQwenQwen3_30bA3bFp8                 NamespaceInstanceUpdateResponseAISearchModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	NamespaceInstanceUpdateResponseAISearchModelCfDeepseekAIDeepseekR1DistillQwen32b  NamespaceInstanceUpdateResponseAISearchModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	NamespaceInstanceUpdateResponseAISearchModelCfMoonshotaiKimiK2Instruct            NamespaceInstanceUpdateResponseAISearchModel = "@cf/moonshotai/kimi-k2-instruct"
	NamespaceInstanceUpdateResponseAISearchModelCfGoogleGemma3_12bIt                  NamespaceInstanceUpdateResponseAISearchModel = "@cf/google/gemma-3-12b-it"
	NamespaceInstanceUpdateResponseAISearchModelCfGoogleGemma4_26bA4bIt               NamespaceInstanceUpdateResponseAISearchModel = "@cf/google/gemma-4-26b-a4b-it"
	NamespaceInstanceUpdateResponseAISearchModelCfMoonshotaiKimiK2_5                  NamespaceInstanceUpdateResponseAISearchModel = "@cf/moonshotai/kimi-k2.5"
	NamespaceInstanceUpdateResponseAISearchModelAnthropicClaude3_7Sonnet              NamespaceInstanceUpdateResponseAISearchModel = "anthropic/claude-3-7-sonnet"
	NamespaceInstanceUpdateResponseAISearchModelAnthropicClaudeSonnet4                NamespaceInstanceUpdateResponseAISearchModel = "anthropic/claude-sonnet-4"
	NamespaceInstanceUpdateResponseAISearchModelAnthropicClaudeOpus4                  NamespaceInstanceUpdateResponseAISearchModel = "anthropic/claude-opus-4"
	NamespaceInstanceUpdateResponseAISearchModelAnthropicClaude3_5Haiku               NamespaceInstanceUpdateResponseAISearchModel = "anthropic/claude-3-5-haiku"
	NamespaceInstanceUpdateResponseAISearchModelCerebrasQwen3_235bA22bInstruct        NamespaceInstanceUpdateResponseAISearchModel = "cerebras/qwen-3-235b-a22b-instruct"
	NamespaceInstanceUpdateResponseAISearchModelCerebrasQwen3_235bA22bThinking        NamespaceInstanceUpdateResponseAISearchModel = "cerebras/qwen-3-235b-a22b-thinking"
	NamespaceInstanceUpdateResponseAISearchModelCerebrasLlama3_3_70b                  NamespaceInstanceUpdateResponseAISearchModel = "cerebras/llama-3.3-70b"
	NamespaceInstanceUpdateResponseAISearchModelCerebrasLlama4Maverick17b128eInstruct NamespaceInstanceUpdateResponseAISearchModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	NamespaceInstanceUpdateResponseAISearchModelCerebrasLlama4Scout17b16eInstruct     NamespaceInstanceUpdateResponseAISearchModel = "cerebras/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceUpdateResponseAISearchModelCerebrasGptOSs120b                    NamespaceInstanceUpdateResponseAISearchModel = "cerebras/gpt-oss-120b"
	NamespaceInstanceUpdateResponseAISearchModelGoogleAIStudioGemini2_5Flash          NamespaceInstanceUpdateResponseAISearchModel = "google-ai-studio/gemini-2.5-flash"
	NamespaceInstanceUpdateResponseAISearchModelGoogleAIStudioGemini2_5Pro            NamespaceInstanceUpdateResponseAISearchModel = "google-ai-studio/gemini-2.5-pro"
	NamespaceInstanceUpdateResponseAISearchModelGrokGrok4                             NamespaceInstanceUpdateResponseAISearchModel = "grok/grok-4"
	NamespaceInstanceUpdateResponseAISearchModelGroqLlama3_3_70bVersatile             NamespaceInstanceUpdateResponseAISearchModel = "groq/llama-3.3-70b-versatile"
	NamespaceInstanceUpdateResponseAISearchModelGroqLlama3_1_8bInstant                NamespaceInstanceUpdateResponseAISearchModel = "groq/llama-3.1-8b-instant"
	NamespaceInstanceUpdateResponseAISearchModelOpenAIGpt5                            NamespaceInstanceUpdateResponseAISearchModel = "openai/gpt-5"
	NamespaceInstanceUpdateResponseAISearchModelOpenAIGpt5Mini                        NamespaceInstanceUpdateResponseAISearchModel = "openai/gpt-5-mini"
	NamespaceInstanceUpdateResponseAISearchModelOpenAIGpt5Nano                        NamespaceInstanceUpdateResponseAISearchModel = "openai/gpt-5-nano"
	NamespaceInstanceUpdateResponseAISearchModelEmpty                                 NamespaceInstanceUpdateResponseAISearchModel = ""
)

func (NamespaceInstanceUpdateResponseAISearchModel) IsKnown

type NamespaceInstanceUpdateResponseCacheTTL

type NamespaceInstanceUpdateResponseCacheTTL float64

Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d).

const (
	NamespaceInstanceUpdateResponseCacheTTL600    NamespaceInstanceUpdateResponseCacheTTL = 600
	NamespaceInstanceUpdateResponseCacheTTL1800   NamespaceInstanceUpdateResponseCacheTTL = 1800
	NamespaceInstanceUpdateResponseCacheTTL3600   NamespaceInstanceUpdateResponseCacheTTL = 3600
	NamespaceInstanceUpdateResponseCacheTTL7200   NamespaceInstanceUpdateResponseCacheTTL = 7200
	NamespaceInstanceUpdateResponseCacheTTL21600  NamespaceInstanceUpdateResponseCacheTTL = 21600
	NamespaceInstanceUpdateResponseCacheTTL43200  NamespaceInstanceUpdateResponseCacheTTL = 43200
	NamespaceInstanceUpdateResponseCacheTTL86400  NamespaceInstanceUpdateResponseCacheTTL = 86400
	NamespaceInstanceUpdateResponseCacheTTL172800 NamespaceInstanceUpdateResponseCacheTTL = 172800
	NamespaceInstanceUpdateResponseCacheTTL259200 NamespaceInstanceUpdateResponseCacheTTL = 259200
	NamespaceInstanceUpdateResponseCacheTTL518400 NamespaceInstanceUpdateResponseCacheTTL = 518400
)

func (NamespaceInstanceUpdateResponseCacheTTL) IsKnown

type NamespaceInstanceUpdateResponseCacheThreshold

type NamespaceInstanceUpdateResponseCacheThreshold string
const (
	NamespaceInstanceUpdateResponseCacheThresholdSuperStrictMatch NamespaceInstanceUpdateResponseCacheThreshold = "super_strict_match"
	NamespaceInstanceUpdateResponseCacheThresholdCloseEnough      NamespaceInstanceUpdateResponseCacheThreshold = "close_enough"
	NamespaceInstanceUpdateResponseCacheThresholdFlexibleFriend   NamespaceInstanceUpdateResponseCacheThreshold = "flexible_friend"
	NamespaceInstanceUpdateResponseCacheThresholdAnythingGoes     NamespaceInstanceUpdateResponseCacheThreshold = "anything_goes"
)

func (NamespaceInstanceUpdateResponseCacheThreshold) IsKnown

type NamespaceInstanceUpdateResponseCustomMetadata

type NamespaceInstanceUpdateResponseCustomMetadata struct {
	DataType  NamespaceInstanceUpdateResponseCustomMetadataDataType `json:"data_type" api:"required"`
	FieldName string                                                `json:"field_name" api:"required"`
	JSON      namespaceInstanceUpdateResponseCustomMetadataJSON     `json:"-"`
}

func (*NamespaceInstanceUpdateResponseCustomMetadata) UnmarshalJSON

func (r *NamespaceInstanceUpdateResponseCustomMetadata) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceUpdateResponseCustomMetadataDataType

type NamespaceInstanceUpdateResponseCustomMetadataDataType string
const (
	NamespaceInstanceUpdateResponseCustomMetadataDataTypeText     NamespaceInstanceUpdateResponseCustomMetadataDataType = "text"
	NamespaceInstanceUpdateResponseCustomMetadataDataTypeNumber   NamespaceInstanceUpdateResponseCustomMetadataDataType = "number"
	NamespaceInstanceUpdateResponseCustomMetadataDataTypeBoolean  NamespaceInstanceUpdateResponseCustomMetadataDataType = "boolean"
	NamespaceInstanceUpdateResponseCustomMetadataDataTypeDatetime NamespaceInstanceUpdateResponseCustomMetadataDataType = "datetime"
)

func (NamespaceInstanceUpdateResponseCustomMetadataDataType) IsKnown

type NamespaceInstanceUpdateResponseEmbeddingModel

type NamespaceInstanceUpdateResponseEmbeddingModel string
const (
	NamespaceInstanceUpdateResponseEmbeddingModelCfQwenQwen3Embedding0_6b              NamespaceInstanceUpdateResponseEmbeddingModel = "@cf/qwen/qwen3-embedding-0.6b"
	NamespaceInstanceUpdateResponseEmbeddingModelCfBaaiBgeM3                           NamespaceInstanceUpdateResponseEmbeddingModel = "@cf/baai/bge-m3"
	NamespaceInstanceUpdateResponseEmbeddingModelCfBaaiBgeLargeEnV1_5                  NamespaceInstanceUpdateResponseEmbeddingModel = "@cf/baai/bge-large-en-v1.5"
	NamespaceInstanceUpdateResponseEmbeddingModelCfGoogleEmbeddinggemma300m            NamespaceInstanceUpdateResponseEmbeddingModel = "@cf/google/embeddinggemma-300m"
	NamespaceInstanceUpdateResponseEmbeddingModelGoogleAIStudioGeminiEmbedding001      NamespaceInstanceUpdateResponseEmbeddingModel = "google-ai-studio/gemini-embedding-001"
	NamespaceInstanceUpdateResponseEmbeddingModelGoogleAIStudioGeminiEmbedding2Preview NamespaceInstanceUpdateResponseEmbeddingModel = "google-ai-studio/gemini-embedding-2-preview"
	NamespaceInstanceUpdateResponseEmbeddingModelOpenAITextEmbedding3Small             NamespaceInstanceUpdateResponseEmbeddingModel = "openai/text-embedding-3-small"
	NamespaceInstanceUpdateResponseEmbeddingModelOpenAITextEmbedding3Large             NamespaceInstanceUpdateResponseEmbeddingModel = "openai/text-embedding-3-large"
	NamespaceInstanceUpdateResponseEmbeddingModelEmpty                                 NamespaceInstanceUpdateResponseEmbeddingModel = ""
)

func (NamespaceInstanceUpdateResponseEmbeddingModel) IsKnown

type NamespaceInstanceUpdateResponseEnvelope

type NamespaceInstanceUpdateResponseEnvelope struct {
	Result  NamespaceInstanceUpdateResponse             `json:"result" api:"required"`
	Success bool                                        `json:"success" api:"required"`
	JSON    namespaceInstanceUpdateResponseEnvelopeJSON `json:"-"`
}

func (*NamespaceInstanceUpdateResponseEnvelope) UnmarshalJSON

func (r *NamespaceInstanceUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceUpdateResponseFusionMethod

type NamespaceInstanceUpdateResponseFusionMethod string
const (
	NamespaceInstanceUpdateResponseFusionMethodMax NamespaceInstanceUpdateResponseFusionMethod = "max"
	NamespaceInstanceUpdateResponseFusionMethodRrf NamespaceInstanceUpdateResponseFusionMethod = "rrf"
)

func (NamespaceInstanceUpdateResponseFusionMethod) IsKnown

type NamespaceInstanceUpdateResponseIndexMethod

type NamespaceInstanceUpdateResponseIndexMethod struct {
	// Enable keyword (BM25) storage backend.
	Keyword bool `json:"keyword" api:"required"`
	// Enable vector (embedding) storage backend.
	Vector bool                                           `json:"vector" api:"required"`
	JSON   namespaceInstanceUpdateResponseIndexMethodJSON `json:"-"`
}

Controls which storage backends are used during indexing. Defaults to vector-only.

func (*NamespaceInstanceUpdateResponseIndexMethod) UnmarshalJSON

func (r *NamespaceInstanceUpdateResponseIndexMethod) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceUpdateResponseIndexingOptions

type NamespaceInstanceUpdateResponseIndexingOptions struct {
	// Tokenizer used for keyword search indexing. porter provides word-level
	// tokenization with Porter stemming (good for natural language queries). trigram
	// enables character-level substring matching (good for partial matches, code,
	// identifiers). Changing this triggers a full re-index. Defaults to porter.
	KeywordTokenizer NamespaceInstanceUpdateResponseIndexingOptionsKeywordTokenizer `json:"keyword_tokenizer"`
	JSON             namespaceInstanceUpdateResponseIndexingOptionsJSON             `json:"-"`
}

func (*NamespaceInstanceUpdateResponseIndexingOptions) UnmarshalJSON

func (r *NamespaceInstanceUpdateResponseIndexingOptions) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceUpdateResponseIndexingOptionsKeywordTokenizer

type NamespaceInstanceUpdateResponseIndexingOptionsKeywordTokenizer string

Tokenizer used for keyword search indexing. porter provides word-level tokenization with Porter stemming (good for natural language queries). trigram enables character-level substring matching (good for partial matches, code, identifiers). Changing this triggers a full re-index. Defaults to porter.

const (
	NamespaceInstanceUpdateResponseIndexingOptionsKeywordTokenizerPorter  NamespaceInstanceUpdateResponseIndexingOptionsKeywordTokenizer = "porter"
	NamespaceInstanceUpdateResponseIndexingOptionsKeywordTokenizerTrigram NamespaceInstanceUpdateResponseIndexingOptionsKeywordTokenizer = "trigram"
)

func (NamespaceInstanceUpdateResponseIndexingOptionsKeywordTokenizer) IsKnown

type NamespaceInstanceUpdateResponseMetadata

type NamespaceInstanceUpdateResponseMetadata struct {
	CreatedFromAISearchWizard bool                                        `json:"created_from_aisearch_wizard"`
	WorkerDomain              string                                      `json:"worker_domain"`
	JSON                      namespaceInstanceUpdateResponseMetadataJSON `json:"-"`
}

func (*NamespaceInstanceUpdateResponseMetadata) UnmarshalJSON

func (r *NamespaceInstanceUpdateResponseMetadata) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceUpdateResponsePublicEndpointParams

type NamespaceInstanceUpdateResponsePublicEndpointParams struct {
	AuthorizedHosts         []string                                                                   `json:"authorized_hosts"`
	ChatCompletionsEndpoint NamespaceInstanceUpdateResponsePublicEndpointParamsChatCompletionsEndpoint `json:"chat_completions_endpoint"`
	Enabled                 bool                                                                       `json:"enabled"`
	Mcp                     NamespaceInstanceUpdateResponsePublicEndpointParamsMcp                     `json:"mcp"`
	RateLimit               NamespaceInstanceUpdateResponsePublicEndpointParamsRateLimit               `json:"rate_limit"`
	SearchEndpoint          NamespaceInstanceUpdateResponsePublicEndpointParamsSearchEndpoint          `json:"search_endpoint"`
	JSON                    namespaceInstanceUpdateResponsePublicEndpointParamsJSON                    `json:"-"`
}

func (*NamespaceInstanceUpdateResponsePublicEndpointParams) UnmarshalJSON

func (r *NamespaceInstanceUpdateResponsePublicEndpointParams) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceUpdateResponsePublicEndpointParamsChatCompletionsEndpoint

type NamespaceInstanceUpdateResponsePublicEndpointParamsChatCompletionsEndpoint struct {
	// Disable chat completions endpoint for this public endpoint
	Disabled bool                                                                           `json:"disabled"`
	JSON     namespaceInstanceUpdateResponsePublicEndpointParamsChatCompletionsEndpointJSON `json:"-"`
}

func (*NamespaceInstanceUpdateResponsePublicEndpointParamsChatCompletionsEndpoint) UnmarshalJSON

type NamespaceInstanceUpdateResponsePublicEndpointParamsMcp

type NamespaceInstanceUpdateResponsePublicEndpointParamsMcp struct {
	Description string `json:"description"`
	// Disable MCP endpoint for this public endpoint
	Disabled bool                                                       `json:"disabled"`
	JSON     namespaceInstanceUpdateResponsePublicEndpointParamsMcpJSON `json:"-"`
}

func (*NamespaceInstanceUpdateResponsePublicEndpointParamsMcp) UnmarshalJSON

func (r *NamespaceInstanceUpdateResponsePublicEndpointParamsMcp) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceUpdateResponsePublicEndpointParamsRateLimit

type NamespaceInstanceUpdateResponsePublicEndpointParamsRateLimit struct {
	PeriodMs  int64                                                                 `json:"period_ms"`
	Requests  int64                                                                 `json:"requests"`
	Technique NamespaceInstanceUpdateResponsePublicEndpointParamsRateLimitTechnique `json:"technique"`
	JSON      namespaceInstanceUpdateResponsePublicEndpointParamsRateLimitJSON      `json:"-"`
}

func (*NamespaceInstanceUpdateResponsePublicEndpointParamsRateLimit) UnmarshalJSON

type NamespaceInstanceUpdateResponsePublicEndpointParamsRateLimitTechnique

type NamespaceInstanceUpdateResponsePublicEndpointParamsRateLimitTechnique string
const (
	NamespaceInstanceUpdateResponsePublicEndpointParamsRateLimitTechniqueFixed   NamespaceInstanceUpdateResponsePublicEndpointParamsRateLimitTechnique = "fixed"
	NamespaceInstanceUpdateResponsePublicEndpointParamsRateLimitTechniqueSliding NamespaceInstanceUpdateResponsePublicEndpointParamsRateLimitTechnique = "sliding"
)

func (NamespaceInstanceUpdateResponsePublicEndpointParamsRateLimitTechnique) IsKnown

type NamespaceInstanceUpdateResponsePublicEndpointParamsSearchEndpoint

type NamespaceInstanceUpdateResponsePublicEndpointParamsSearchEndpoint struct {
	// Disable search endpoint for this public endpoint
	Disabled bool                                                                  `json:"disabled"`
	JSON     namespaceInstanceUpdateResponsePublicEndpointParamsSearchEndpointJSON `json:"-"`
}

func (*NamespaceInstanceUpdateResponsePublicEndpointParamsSearchEndpoint) UnmarshalJSON

type NamespaceInstanceUpdateResponseRerankingModel

type NamespaceInstanceUpdateResponseRerankingModel string
const (
	NamespaceInstanceUpdateResponseRerankingModelCfBaaiBgeRerankerBase NamespaceInstanceUpdateResponseRerankingModel = "@cf/baai/bge-reranker-base"
	NamespaceInstanceUpdateResponseRerankingModelEmpty                 NamespaceInstanceUpdateResponseRerankingModel = ""
)

func (NamespaceInstanceUpdateResponseRerankingModel) IsKnown

type NamespaceInstanceUpdateResponseRetrievalOptions

type NamespaceInstanceUpdateResponseRetrievalOptions struct {
	// Metadata fields to boost search results by. Each entry specifies a metadata
	// field and an optional direction. Direction defaults to 'asc' for
	// numeric/datetime fields and 'exists' for text/boolean fields. Fields must match
	// 'timestamp' or a defined custom_metadata field.
	BoostBy []NamespaceInstanceUpdateResponseRetrievalOptionsBoostBy `json:"boost_by"`
	// 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'.
	KeywordMatchMode NamespaceInstanceUpdateResponseRetrievalOptionsKeywordMatchMode `json:"keyword_match_mode"`
	JSON             namespaceInstanceUpdateResponseRetrievalOptionsJSON             `json:"-"`
}

func (*NamespaceInstanceUpdateResponseRetrievalOptions) UnmarshalJSON

func (r *NamespaceInstanceUpdateResponseRetrievalOptions) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceUpdateResponseRetrievalOptionsBoostBy

type NamespaceInstanceUpdateResponseRetrievalOptionsBoostBy struct {
	// 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.
	Field string `json:"field" api:"required"`
	// 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.
	Direction NamespaceInstanceUpdateResponseRetrievalOptionsBoostByDirection `json:"direction"`
	JSON      namespaceInstanceUpdateResponseRetrievalOptionsBoostByJSON      `json:"-"`
}

func (*NamespaceInstanceUpdateResponseRetrievalOptionsBoostBy) UnmarshalJSON

func (r *NamespaceInstanceUpdateResponseRetrievalOptionsBoostBy) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceUpdateResponseRetrievalOptionsBoostByDirection

type NamespaceInstanceUpdateResponseRetrievalOptionsBoostByDirection string

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.

const (
	NamespaceInstanceUpdateResponseRetrievalOptionsBoostByDirectionAsc       NamespaceInstanceUpdateResponseRetrievalOptionsBoostByDirection = "asc"
	NamespaceInstanceUpdateResponseRetrievalOptionsBoostByDirectionDesc      NamespaceInstanceUpdateResponseRetrievalOptionsBoostByDirection = "desc"
	NamespaceInstanceUpdateResponseRetrievalOptionsBoostByDirectionExists    NamespaceInstanceUpdateResponseRetrievalOptionsBoostByDirection = "exists"
	NamespaceInstanceUpdateResponseRetrievalOptionsBoostByDirectionNotExists NamespaceInstanceUpdateResponseRetrievalOptionsBoostByDirection = "not_exists"
)

func (NamespaceInstanceUpdateResponseRetrievalOptionsBoostByDirection) IsKnown

type NamespaceInstanceUpdateResponseRetrievalOptionsKeywordMatchMode

type NamespaceInstanceUpdateResponseRetrievalOptionsKeywordMatchMode string

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'.

const (
	NamespaceInstanceUpdateResponseRetrievalOptionsKeywordMatchModeAnd NamespaceInstanceUpdateResponseRetrievalOptionsKeywordMatchMode = "and"
	NamespaceInstanceUpdateResponseRetrievalOptionsKeywordMatchModeOr  NamespaceInstanceUpdateResponseRetrievalOptionsKeywordMatchMode = "or"
)

func (NamespaceInstanceUpdateResponseRetrievalOptionsKeywordMatchMode) IsKnown

type NamespaceInstanceUpdateResponseRewriteModel

type NamespaceInstanceUpdateResponseRewriteModel string
const (
	NamespaceInstanceUpdateResponseRewriteModelCfMetaLlama3_3_70bInstructFp8Fast     NamespaceInstanceUpdateResponseRewriteModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	NamespaceInstanceUpdateResponseRewriteModelCfZaiOrgGlm4_7Flash                   NamespaceInstanceUpdateResponseRewriteModel = "@cf/zai-org/glm-4.7-flash"
	NamespaceInstanceUpdateResponseRewriteModelCfMetaLlama3_1_8bInstructFast         NamespaceInstanceUpdateResponseRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	NamespaceInstanceUpdateResponseRewriteModelCfMetaLlama3_1_8bInstructFp8          NamespaceInstanceUpdateResponseRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	NamespaceInstanceUpdateResponseRewriteModelCfMetaLlama4Scout17b16eInstruct       NamespaceInstanceUpdateResponseRewriteModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceUpdateResponseRewriteModelCfQwenQwen3_30bA3bFp8                 NamespaceInstanceUpdateResponseRewriteModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	NamespaceInstanceUpdateResponseRewriteModelCfDeepseekAIDeepseekR1DistillQwen32b  NamespaceInstanceUpdateResponseRewriteModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	NamespaceInstanceUpdateResponseRewriteModelCfMoonshotaiKimiK2Instruct            NamespaceInstanceUpdateResponseRewriteModel = "@cf/moonshotai/kimi-k2-instruct"
	NamespaceInstanceUpdateResponseRewriteModelCfGoogleGemma3_12bIt                  NamespaceInstanceUpdateResponseRewriteModel = "@cf/google/gemma-3-12b-it"
	NamespaceInstanceUpdateResponseRewriteModelCfGoogleGemma4_26bA4bIt               NamespaceInstanceUpdateResponseRewriteModel = "@cf/google/gemma-4-26b-a4b-it"
	NamespaceInstanceUpdateResponseRewriteModelCfMoonshotaiKimiK2_5                  NamespaceInstanceUpdateResponseRewriteModel = "@cf/moonshotai/kimi-k2.5"
	NamespaceInstanceUpdateResponseRewriteModelAnthropicClaude3_7Sonnet              NamespaceInstanceUpdateResponseRewriteModel = "anthropic/claude-3-7-sonnet"
	NamespaceInstanceUpdateResponseRewriteModelAnthropicClaudeSonnet4                NamespaceInstanceUpdateResponseRewriteModel = "anthropic/claude-sonnet-4"
	NamespaceInstanceUpdateResponseRewriteModelAnthropicClaudeOpus4                  NamespaceInstanceUpdateResponseRewriteModel = "anthropic/claude-opus-4"
	NamespaceInstanceUpdateResponseRewriteModelAnthropicClaude3_5Haiku               NamespaceInstanceUpdateResponseRewriteModel = "anthropic/claude-3-5-haiku"
	NamespaceInstanceUpdateResponseRewriteModelCerebrasQwen3_235bA22bInstruct        NamespaceInstanceUpdateResponseRewriteModel = "cerebras/qwen-3-235b-a22b-instruct"
	NamespaceInstanceUpdateResponseRewriteModelCerebrasQwen3_235bA22bThinking        NamespaceInstanceUpdateResponseRewriteModel = "cerebras/qwen-3-235b-a22b-thinking"
	NamespaceInstanceUpdateResponseRewriteModelCerebrasLlama3_3_70b                  NamespaceInstanceUpdateResponseRewriteModel = "cerebras/llama-3.3-70b"
	NamespaceInstanceUpdateResponseRewriteModelCerebrasLlama4Maverick17b128eInstruct NamespaceInstanceUpdateResponseRewriteModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	NamespaceInstanceUpdateResponseRewriteModelCerebrasLlama4Scout17b16eInstruct     NamespaceInstanceUpdateResponseRewriteModel = "cerebras/llama-4-scout-17b-16e-instruct"
	NamespaceInstanceUpdateResponseRewriteModelCerebrasGptOSs120b                    NamespaceInstanceUpdateResponseRewriteModel = "cerebras/gpt-oss-120b"
	NamespaceInstanceUpdateResponseRewriteModelGoogleAIStudioGemini2_5Flash          NamespaceInstanceUpdateResponseRewriteModel = "google-ai-studio/gemini-2.5-flash"
	NamespaceInstanceUpdateResponseRewriteModelGoogleAIStudioGemini2_5Pro            NamespaceInstanceUpdateResponseRewriteModel = "google-ai-studio/gemini-2.5-pro"
	NamespaceInstanceUpdateResponseRewriteModelGrokGrok4                             NamespaceInstanceUpdateResponseRewriteModel = "grok/grok-4"
	NamespaceInstanceUpdateResponseRewriteModelGroqLlama3_3_70bVersatile             NamespaceInstanceUpdateResponseRewriteModel = "groq/llama-3.3-70b-versatile"
	NamespaceInstanceUpdateResponseRewriteModelGroqLlama3_1_8bInstant                NamespaceInstanceUpdateResponseRewriteModel = "groq/llama-3.1-8b-instant"
	NamespaceInstanceUpdateResponseRewriteModelOpenAIGpt5                            NamespaceInstanceUpdateResponseRewriteModel = "openai/gpt-5"
	NamespaceInstanceUpdateResponseRewriteModelOpenAIGpt5Mini                        NamespaceInstanceUpdateResponseRewriteModel = "openai/gpt-5-mini"
	NamespaceInstanceUpdateResponseRewriteModelOpenAIGpt5Nano                        NamespaceInstanceUpdateResponseRewriteModel = "openai/gpt-5-nano"
	NamespaceInstanceUpdateResponseRewriteModelEmpty                                 NamespaceInstanceUpdateResponseRewriteModel = ""
)

func (NamespaceInstanceUpdateResponseRewriteModel) IsKnown

type NamespaceInstanceUpdateResponseSourceParams

type NamespaceInstanceUpdateResponseSourceParams struct {
	// List of path patterns to exclude. Uses micromatch glob syntax: \* matches within
	// a path segment, ** matches across path segments (e.g., /admin/** matches
	// /admin/users and /admin/settings/advanced)
	ExcludeItems []string `json:"exclude_items"`
	// List of path patterns to include. Uses micromatch glob syntax: \* matches within
	// a path segment, ** matches across path segments (e.g., /blog/** matches
	// /blog/post and /blog/2024/post)
	IncludeItems   []string                                              `json:"include_items"`
	Prefix         string                                                `json:"prefix"`
	R2Jurisdiction string                                                `json:"r2_jurisdiction"`
	WebCrawler     NamespaceInstanceUpdateResponseSourceParamsWebCrawler `json:"web_crawler"`
	JSON           namespaceInstanceUpdateResponseSourceParamsJSON       `json:"-"`
}

func (*NamespaceInstanceUpdateResponseSourceParams) UnmarshalJSON

func (r *NamespaceInstanceUpdateResponseSourceParams) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceUpdateResponseSourceParamsWebCrawler

type NamespaceInstanceUpdateResponseSourceParamsWebCrawler struct {
	CrawlOptions NamespaceInstanceUpdateResponseSourceParamsWebCrawlerCrawlOptions `json:"crawl_options"`
	ParseOptions NamespaceInstanceUpdateResponseSourceParamsWebCrawlerParseOptions `json:"parse_options"`
	ParseType    NamespaceInstanceUpdateResponseSourceParamsWebCrawlerParseType    `json:"parse_type"`
	StoreOptions NamespaceInstanceUpdateResponseSourceParamsWebCrawlerStoreOptions `json:"store_options"`
	JSON         namespaceInstanceUpdateResponseSourceParamsWebCrawlerJSON         `json:"-"`
}

func (*NamespaceInstanceUpdateResponseSourceParamsWebCrawler) UnmarshalJSON

func (r *NamespaceInstanceUpdateResponseSourceParamsWebCrawler) UnmarshalJSON(data []byte) (err error)

type NamespaceInstanceUpdateResponseSourceParamsWebCrawlerCrawlOptions

type NamespaceInstanceUpdateResponseSourceParamsWebCrawlerCrawlOptions struct {
	Depth                float64                                                                 `json:"depth"`
	IncludeExternalLinks bool                                                                    `json:"include_external_links"`
	IncludeSubdomains    bool                                                                    `json:"include_subdomains"`
	MaxAge               float64                                                                 `json:"max_age"`
	Source               NamespaceInstanceUpdateResponseSourceParamsWebCrawlerCrawlOptionsSource `json:"source"`
	JSON                 namespaceInstanceUpdateResponseSourceParamsWebCrawlerCrawlOptionsJSON   `json:"-"`
}

func (*NamespaceInstanceUpdateResponseSourceParamsWebCrawlerCrawlOptions) UnmarshalJSON

type NamespaceInstanceUpdateResponseSourceParamsWebCrawlerCrawlOptionsSource

type NamespaceInstanceUpdateResponseSourceParamsWebCrawlerCrawlOptionsSource string
const (
	NamespaceInstanceUpdateResponseSourceParamsWebCrawlerCrawlOptionsSourceAll      NamespaceInstanceUpdateResponseSourceParamsWebCrawlerCrawlOptionsSource = "all"
	NamespaceInstanceUpdateResponseSourceParamsWebCrawlerCrawlOptionsSourceSitemaps NamespaceInstanceUpdateResponseSourceParamsWebCrawlerCrawlOptionsSource = "sitemaps"
	NamespaceInstanceUpdateResponseSourceParamsWebCrawlerCrawlOptionsSourceLinks    NamespaceInstanceUpdateResponseSourceParamsWebCrawlerCrawlOptionsSource = "links"
)

func (NamespaceInstanceUpdateResponseSourceParamsWebCrawlerCrawlOptionsSource) IsKnown

type NamespaceInstanceUpdateResponseSourceParamsWebCrawlerParseOptions

type NamespaceInstanceUpdateResponseSourceParamsWebCrawlerParseOptions struct {
	// List of path-to-selector mappings for extracting specific content from crawled
	// pages. Each entry pairs a URL glob pattern with a CSS selector. The first
	// matching path wins. Only the matched HTML fragment is stored and indexed. Omit
	// the field to disable content selection — empty arrays are rejected.
	ContentSelector []NamespaceInstanceUpdateResponseSourceParamsWebCrawlerParseOptionsContentSelector `json:"content_selector"`
	// Up to 5 custom HTTP headers sent with each crawl request. Names must be RFC-7230
	// token characters (no spaces, colons, or control characters); values must be
	// HTAB + printable ASCII (no CR/LF).
	IncludeHeaders map[string]string `json:"include_headers"`
	IncludeImages  bool              `json:"include_images"`
	// List of specific sitemap URLs to use for crawling. Only valid when parse_type is
	// 'sitemap'.
	SpecificSitemaps    []string                                                              `json:"specific_sitemaps" format:"uri"`
	UseBrowserRendering bool                                                                  `json:"use_browser_rendering"`
	JSON                namespaceInstanceUpdateResponseSourceParamsWebCrawlerParseOptionsJSON `json:"-"`
}

func (*NamespaceInstanceUpdateResponseSourceParamsWebCrawlerParseOptions) UnmarshalJSON

type NamespaceInstanceUpdateResponseSourceParamsWebCrawlerParseOptionsContentSelector

type NamespaceInstanceUpdateResponseSourceParamsWebCrawlerParseOptionsContentSelector struct {
	// Glob pattern to match against the page URL path. Uses standard glob syntax: \*
	// matches within a segment, \*\* crosses directories.
	Path string `json:"path" api:"required"`
	// CSS selector to extract content from pages matching the path pattern. Must not
	// contain disallowed characters (;, `, $, {, }, \). Must target a single element;
	// if multiple elements match, the selector is ignored and the full page is used.
	Selector string                                                                               `json:"selector" api:"required"`
	JSON     namespaceInstanceUpdateResponseSourceParamsWebCrawlerParseOptionsContentSelectorJSON `json:"-"`
}

func (*NamespaceInstanceUpdateResponseSourceParamsWebCrawlerParseOptionsContentSelector) UnmarshalJSON

type NamespaceInstanceUpdateResponseSourceParamsWebCrawlerParseType

type NamespaceInstanceUpdateResponseSourceParamsWebCrawlerParseType string
const (
	NamespaceInstanceUpdateResponseSourceParamsWebCrawlerParseTypeSitemap NamespaceInstanceUpdateResponseSourceParamsWebCrawlerParseType = "sitemap"
	NamespaceInstanceUpdateResponseSourceParamsWebCrawlerParseTypeFeedRss NamespaceInstanceUpdateResponseSourceParamsWebCrawlerParseType = "feed-rss"
	NamespaceInstanceUpdateResponseSourceParamsWebCrawlerParseTypeCrawl   NamespaceInstanceUpdateResponseSourceParamsWebCrawlerParseType = "crawl"
)

func (NamespaceInstanceUpdateResponseSourceParamsWebCrawlerParseType) IsKnown

type NamespaceInstanceUpdateResponseSourceParamsWebCrawlerStoreOptions

type NamespaceInstanceUpdateResponseSourceParamsWebCrawlerStoreOptions struct {
	StorageID      string                                                                `json:"storage_id" api:"required"`
	R2Jurisdiction string                                                                `json:"r2_jurisdiction"`
	StorageType    r2.Provider                                                           `json:"storage_type"`
	JSON           namespaceInstanceUpdateResponseSourceParamsWebCrawlerStoreOptionsJSON `json:"-"`
}

func (*NamespaceInstanceUpdateResponseSourceParamsWebCrawlerStoreOptions) UnmarshalJSON

type NamespaceInstanceUpdateResponseSyncInterval

type NamespaceInstanceUpdateResponseSyncInterval float64

Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h).

const (
	NamespaceInstanceUpdateResponseSyncInterval900   NamespaceInstanceUpdateResponseSyncInterval = 900
	NamespaceInstanceUpdateResponseSyncInterval1800  NamespaceInstanceUpdateResponseSyncInterval = 1800
	NamespaceInstanceUpdateResponseSyncInterval3600  NamespaceInstanceUpdateResponseSyncInterval = 3600
	NamespaceInstanceUpdateResponseSyncInterval7200  NamespaceInstanceUpdateResponseSyncInterval = 7200
	NamespaceInstanceUpdateResponseSyncInterval14400 NamespaceInstanceUpdateResponseSyncInterval = 14400
	NamespaceInstanceUpdateResponseSyncInterval21600 NamespaceInstanceUpdateResponseSyncInterval = 21600
	NamespaceInstanceUpdateResponseSyncInterval43200 NamespaceInstanceUpdateResponseSyncInterval = 43200
	NamespaceInstanceUpdateResponseSyncInterval86400 NamespaceInstanceUpdateResponseSyncInterval = 86400
)

func (NamespaceInstanceUpdateResponseSyncInterval) IsKnown

type NamespaceInstanceUpdateResponseType

type NamespaceInstanceUpdateResponseType string
const (
	NamespaceInstanceUpdateResponseTypeR2         NamespaceInstanceUpdateResponseType = "r2"
	NamespaceInstanceUpdateResponseTypeWebCrawler NamespaceInstanceUpdateResponseType = "web-crawler"
)

func (NamespaceInstanceUpdateResponseType) IsKnown

type NamespaceListParams

type NamespaceListParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Page number (1-indexed).
	Page param.Field[int64] `query:"page"`
	// Number of results per page.
	PerPage param.Field[int64] `query:"per_page"`
	// Filter namespaces whose name or description contains this string
	// (case-insensitive).
	Search param.Field[string] `query:"search"`
}

func (NamespaceListParams) URLQuery

func (r NamespaceListParams) URLQuery() (v url.Values)

URLQuery serializes NamespaceListParams's query parameters as `url.Values`.

type NamespaceListResponse

type NamespaceListResponse struct {
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	Name      string    `json:"name" api:"required"`
	// Optional description for the namespace. Max 256 characters.
	Description string                    `json:"description" api:"nullable"`
	JSON        namespaceListResponseJSON `json:"-"`
}

func (*NamespaceListResponse) UnmarshalJSON

func (r *NamespaceListResponse) UnmarshalJSON(data []byte) (err error)

type NamespaceNewParams

type NamespaceNewParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	Name      param.Field[string] `json:"name" api:"required"`
	// Optional description for the namespace. Max 256 characters.
	Description param.Field[string] `json:"description"`
}

func (NamespaceNewParams) MarshalJSON

func (r NamespaceNewParams) MarshalJSON() (data []byte, err error)

type NamespaceNewResponse

type NamespaceNewResponse struct {
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	Name      string    `json:"name" api:"required"`
	// Optional description for the namespace. Max 256 characters.
	Description string                   `json:"description" api:"nullable"`
	JSON        namespaceNewResponseJSON `json:"-"`
}

func (*NamespaceNewResponse) UnmarshalJSON

func (r *NamespaceNewResponse) UnmarshalJSON(data []byte) (err error)

type NamespaceNewResponseEnvelope

type NamespaceNewResponseEnvelope struct {
	Result  NamespaceNewResponse                `json:"result" api:"required"`
	Success NamespaceNewResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    namespaceNewResponseEnvelopeJSON    `json:"-"`
}

func (*NamespaceNewResponseEnvelope) UnmarshalJSON

func (r *NamespaceNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NamespaceNewResponseEnvelopeSuccess

type NamespaceNewResponseEnvelopeSuccess bool
const (
	NamespaceNewResponseEnvelopeSuccessTrue NamespaceNewResponseEnvelopeSuccess = true
)

func (NamespaceNewResponseEnvelopeSuccess) IsKnown

type NamespaceReadParams

type NamespaceReadParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type NamespaceReadResponse

type NamespaceReadResponse struct {
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	Name      string    `json:"name" api:"required"`
	// Optional description for the namespace. Max 256 characters.
	Description string                    `json:"description" api:"nullable"`
	JSON        namespaceReadResponseJSON `json:"-"`
}

func (*NamespaceReadResponse) UnmarshalJSON

func (r *NamespaceReadResponse) UnmarshalJSON(data []byte) (err error)

type NamespaceReadResponseEnvelope

type NamespaceReadResponseEnvelope struct {
	Result  NamespaceReadResponse                `json:"result" api:"required"`
	Success NamespaceReadResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    namespaceReadResponseEnvelopeJSON    `json:"-"`
}

func (*NamespaceReadResponseEnvelope) UnmarshalJSON

func (r *NamespaceReadResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NamespaceReadResponseEnvelopeSuccess

type NamespaceReadResponseEnvelopeSuccess bool
const (
	NamespaceReadResponseEnvelopeSuccessTrue NamespaceReadResponseEnvelopeSuccess = true
)

func (NamespaceReadResponseEnvelopeSuccess) IsKnown

type NamespaceSearchParams

type NamespaceSearchParams struct {
	AccountID       param.Field[string]                               `path:"account_id" api:"required"`
	AISearchOptions param.Field[NamespaceSearchParamsAISearchOptions] `json:"ai_search_options" api:"required"`
	Messages        param.Field[[]NamespaceSearchParamsMessage]       `json:"messages"`
	// A simple text query string. Alternative to 'messages' — provide either this or
	// 'messages', not both.
	Query param.Field[string] `json:"query"`
}

func (NamespaceSearchParams) MarshalJSON

func (r NamespaceSearchParams) MarshalJSON() (data []byte, err error)

type NamespaceSearchParamsAISearchOptions

type NamespaceSearchParamsAISearchOptions struct {
	InstanceIDs  param.Field[[]string]                                         `json:"instance_ids" api:"required"`
	Cache        param.Field[NamespaceSearchParamsAISearchOptionsCache]        `json:"cache"`
	QueryRewrite param.Field[NamespaceSearchParamsAISearchOptionsQueryRewrite] `json:"query_rewrite"`
	Reranking    param.Field[NamespaceSearchParamsAISearchOptionsReranking]    `json:"reranking"`
	Retrieval    param.Field[NamespaceSearchParamsAISearchOptionsRetrieval]    `json:"retrieval"`
}

func (NamespaceSearchParamsAISearchOptions) MarshalJSON

func (r NamespaceSearchParamsAISearchOptions) MarshalJSON() (data []byte, err error)

type NamespaceSearchParamsAISearchOptionsCache

type NamespaceSearchParamsAISearchOptionsCache struct {
	CacheThreshold param.Field[NamespaceSearchParamsAISearchOptionsCacheCacheThreshold] `json:"cache_threshold"`
	Enabled        param.Field[bool]                                                    `json:"enabled"`
}

func (NamespaceSearchParamsAISearchOptionsCache) MarshalJSON

func (r NamespaceSearchParamsAISearchOptionsCache) MarshalJSON() (data []byte, err error)

type NamespaceSearchParamsAISearchOptionsCacheCacheThreshold

type NamespaceSearchParamsAISearchOptionsCacheCacheThreshold string
const (
	NamespaceSearchParamsAISearchOptionsCacheCacheThresholdSuperStrictMatch NamespaceSearchParamsAISearchOptionsCacheCacheThreshold = "super_strict_match"
	NamespaceSearchParamsAISearchOptionsCacheCacheThresholdCloseEnough      NamespaceSearchParamsAISearchOptionsCacheCacheThreshold = "close_enough"
	NamespaceSearchParamsAISearchOptionsCacheCacheThresholdFlexibleFriend   NamespaceSearchParamsAISearchOptionsCacheCacheThreshold = "flexible_friend"
	NamespaceSearchParamsAISearchOptionsCacheCacheThresholdAnythingGoes     NamespaceSearchParamsAISearchOptionsCacheCacheThreshold = "anything_goes"
)

func (NamespaceSearchParamsAISearchOptionsCacheCacheThreshold) IsKnown

type NamespaceSearchParamsAISearchOptionsQueryRewrite

type NamespaceSearchParamsAISearchOptionsQueryRewrite struct {
	Enabled       param.Field[bool]                                                  `json:"enabled"`
	Model         param.Field[NamespaceSearchParamsAISearchOptionsQueryRewriteModel] `json:"model"`
	RewritePrompt param.Field[string]                                                `json:"rewrite_prompt"`
}

func (NamespaceSearchParamsAISearchOptionsQueryRewrite) MarshalJSON

func (r NamespaceSearchParamsAISearchOptionsQueryRewrite) MarshalJSON() (data []byte, err error)

type NamespaceSearchParamsAISearchOptionsQueryRewriteModel

type NamespaceSearchParamsAISearchOptionsQueryRewriteModel string
const (
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelCfMetaLlama3_3_70bInstructFp8Fast     NamespaceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/meta/llama-3.3-70b-instruct-fp8-fast"
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelCfZaiOrgGlm4_7Flash                   NamespaceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/zai-org/glm-4.7-flash"
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelCfMetaLlama3_1_8bInstructFast         NamespaceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fast"
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelCfMetaLlama3_1_8bInstructFp8          NamespaceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/meta/llama-3.1-8b-instruct-fp8"
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelCfMetaLlama4Scout17b16eInstruct       NamespaceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/meta/llama-4-scout-17b-16e-instruct"
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelCfQwenQwen3_30bA3bFp8                 NamespaceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/qwen/qwen3-30b-a3b-fp8"
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelCfDeepseekAIDeepseekR1DistillQwen32b  NamespaceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b"
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelCfMoonshotaiKimiK2Instruct            NamespaceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/moonshotai/kimi-k2-instruct"
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelCfGoogleGemma3_12bIt                  NamespaceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/google/gemma-3-12b-it"
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelCfGoogleGemma4_26bA4bIt               NamespaceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/google/gemma-4-26b-a4b-it"
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelCfMoonshotaiKimiK2_5                  NamespaceSearchParamsAISearchOptionsQueryRewriteModel = "@cf/moonshotai/kimi-k2.5"
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelAnthropicClaude3_7Sonnet              NamespaceSearchParamsAISearchOptionsQueryRewriteModel = "anthropic/claude-3-7-sonnet"
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelAnthropicClaudeSonnet4                NamespaceSearchParamsAISearchOptionsQueryRewriteModel = "anthropic/claude-sonnet-4"
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelAnthropicClaudeOpus4                  NamespaceSearchParamsAISearchOptionsQueryRewriteModel = "anthropic/claude-opus-4"
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelAnthropicClaude3_5Haiku               NamespaceSearchParamsAISearchOptionsQueryRewriteModel = "anthropic/claude-3-5-haiku"
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelCerebrasQwen3_235bA22bInstruct        NamespaceSearchParamsAISearchOptionsQueryRewriteModel = "cerebras/qwen-3-235b-a22b-instruct"
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelCerebrasQwen3_235bA22bThinking        NamespaceSearchParamsAISearchOptionsQueryRewriteModel = "cerebras/qwen-3-235b-a22b-thinking"
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelCerebrasLlama3_3_70b                  NamespaceSearchParamsAISearchOptionsQueryRewriteModel = "cerebras/llama-3.3-70b"
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelCerebrasLlama4Maverick17b128eInstruct NamespaceSearchParamsAISearchOptionsQueryRewriteModel = "cerebras/llama-4-maverick-17b-128e-instruct"
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelCerebrasLlama4Scout17b16eInstruct     NamespaceSearchParamsAISearchOptionsQueryRewriteModel = "cerebras/llama-4-scout-17b-16e-instruct"
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelCerebrasGptOSs120b                    NamespaceSearchParamsAISearchOptionsQueryRewriteModel = "cerebras/gpt-oss-120b"
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelGoogleAIStudioGemini2_5Flash          NamespaceSearchParamsAISearchOptionsQueryRewriteModel = "google-ai-studio/gemini-2.5-flash"
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelGoogleAIStudioGemini2_5Pro            NamespaceSearchParamsAISearchOptionsQueryRewriteModel = "google-ai-studio/gemini-2.5-pro"
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelGrokGrok4                             NamespaceSearchParamsAISearchOptionsQueryRewriteModel = "grok/grok-4"
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelGroqLlama3_3_70bVersatile             NamespaceSearchParamsAISearchOptionsQueryRewriteModel = "groq/llama-3.3-70b-versatile"
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelGroqLlama3_1_8bInstant                NamespaceSearchParamsAISearchOptionsQueryRewriteModel = "groq/llama-3.1-8b-instant"
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelOpenAIGpt5                            NamespaceSearchParamsAISearchOptionsQueryRewriteModel = "openai/gpt-5"
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelOpenAIGpt5Mini                        NamespaceSearchParamsAISearchOptionsQueryRewriteModel = "openai/gpt-5-mini"
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelOpenAIGpt5Nano                        NamespaceSearchParamsAISearchOptionsQueryRewriteModel = "openai/gpt-5-nano"
	NamespaceSearchParamsAISearchOptionsQueryRewriteModelEmpty                                 NamespaceSearchParamsAISearchOptionsQueryRewriteModel = ""
)

func (NamespaceSearchParamsAISearchOptionsQueryRewriteModel) IsKnown

type NamespaceSearchParamsAISearchOptionsReranking

type NamespaceSearchParamsAISearchOptionsReranking struct {
	Enabled        param.Field[bool]                                               `json:"enabled"`
	MatchThreshold param.Field[float64]                                            `json:"match_threshold"`
	Model          param.Field[NamespaceSearchParamsAISearchOptionsRerankingModel] `json:"model"`
}

func (NamespaceSearchParamsAISearchOptionsReranking) MarshalJSON

func (r NamespaceSearchParamsAISearchOptionsReranking) MarshalJSON() (data []byte, err error)

type NamespaceSearchParamsAISearchOptionsRerankingModel

type NamespaceSearchParamsAISearchOptionsRerankingModel string
const (
	NamespaceSearchParamsAISearchOptionsRerankingModelCfBaaiBgeRerankerBase NamespaceSearchParamsAISearchOptionsRerankingModel = "@cf/baai/bge-reranker-base"
	NamespaceSearchParamsAISearchOptionsRerankingModelEmpty                 NamespaceSearchParamsAISearchOptionsRerankingModel = ""
)

func (NamespaceSearchParamsAISearchOptionsRerankingModel) IsKnown

type NamespaceSearchParamsAISearchOptionsRetrieval

type NamespaceSearchParamsAISearchOptionsRetrieval struct {
	// 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.
	BoostBy          param.Field[[]NamespaceSearchParamsAISearchOptionsRetrievalBoostBy]    `json:"boost_by"`
	ContextExpansion param.Field[int64]                                                     `json:"context_expansion"`
	Filters          param.Field[map[string]interface{}]                                    `json:"filters"`
	FusionMethod     param.Field[NamespaceSearchParamsAISearchOptionsRetrievalFusionMethod] `json:"fusion_method"`
	// 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'.
	KeywordMatchMode param.Field[NamespaceSearchParamsAISearchOptionsRetrievalKeywordMatchMode] `json:"keyword_match_mode"`
	MatchThreshold   param.Field[float64]                                                       `json:"match_threshold"`
	MaxNumResults    param.Field[int64]                                                         `json:"max_num_results"`
	RetrievalType    param.Field[NamespaceSearchParamsAISearchOptionsRetrievalRetrievalType]    `json:"retrieval_type"`
	ReturnOnFailure  param.Field[bool]                                                          `json:"return_on_failure"`
}

func (NamespaceSearchParamsAISearchOptionsRetrieval) MarshalJSON

func (r NamespaceSearchParamsAISearchOptionsRetrieval) MarshalJSON() (data []byte, err error)

type NamespaceSearchParamsAISearchOptionsRetrievalBoostBy

type NamespaceSearchParamsAISearchOptionsRetrievalBoostBy struct {
	// 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.
	Field param.Field[string] `json:"field" api:"required"`
	// 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.
	Direction param.Field[NamespaceSearchParamsAISearchOptionsRetrievalBoostByDirection] `json:"direction"`
}

func (NamespaceSearchParamsAISearchOptionsRetrievalBoostBy) MarshalJSON

func (r NamespaceSearchParamsAISearchOptionsRetrievalBoostBy) MarshalJSON() (data []byte, err error)

type NamespaceSearchParamsAISearchOptionsRetrievalBoostByDirection

type NamespaceSearchParamsAISearchOptionsRetrievalBoostByDirection string

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.

const (
	NamespaceSearchParamsAISearchOptionsRetrievalBoostByDirectionAsc       NamespaceSearchParamsAISearchOptionsRetrievalBoostByDirection = "asc"
	NamespaceSearchParamsAISearchOptionsRetrievalBoostByDirectionDesc      NamespaceSearchParamsAISearchOptionsRetrievalBoostByDirection = "desc"
	NamespaceSearchParamsAISearchOptionsRetrievalBoostByDirectionExists    NamespaceSearchParamsAISearchOptionsRetrievalBoostByDirection = "exists"
	NamespaceSearchParamsAISearchOptionsRetrievalBoostByDirectionNotExists NamespaceSearchParamsAISearchOptionsRetrievalBoostByDirection = "not_exists"
)

func (NamespaceSearchParamsAISearchOptionsRetrievalBoostByDirection) IsKnown

type NamespaceSearchParamsAISearchOptionsRetrievalFusionMethod

type NamespaceSearchParamsAISearchOptionsRetrievalFusionMethod string
const (
	NamespaceSearchParamsAISearchOptionsRetrievalFusionMethodMax NamespaceSearchParamsAISearchOptionsRetrievalFusionMethod = "max"
	NamespaceSearchParamsAISearchOptionsRetrievalFusionMethodRrf NamespaceSearchParamsAISearchOptionsRetrievalFusionMethod = "rrf"
)

func (NamespaceSearchParamsAISearchOptionsRetrievalFusionMethod) IsKnown

type NamespaceSearchParamsAISearchOptionsRetrievalKeywordMatchMode

type NamespaceSearchParamsAISearchOptionsRetrievalKeywordMatchMode string

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'.

const (
	NamespaceSearchParamsAISearchOptionsRetrievalKeywordMatchModeAnd NamespaceSearchParamsAISearchOptionsRetrievalKeywordMatchMode = "and"
	NamespaceSearchParamsAISearchOptionsRetrievalKeywordMatchModeOr  NamespaceSearchParamsAISearchOptionsRetrievalKeywordMatchMode = "or"
)

func (NamespaceSearchParamsAISearchOptionsRetrievalKeywordMatchMode) IsKnown

type NamespaceSearchParamsAISearchOptionsRetrievalRetrievalType

type NamespaceSearchParamsAISearchOptionsRetrievalRetrievalType string
const (
	NamespaceSearchParamsAISearchOptionsRetrievalRetrievalTypeVector  NamespaceSearchParamsAISearchOptionsRetrievalRetrievalType = "vector"
	NamespaceSearchParamsAISearchOptionsRetrievalRetrievalTypeKeyword NamespaceSearchParamsAISearchOptionsRetrievalRetrievalType = "keyword"
	NamespaceSearchParamsAISearchOptionsRetrievalRetrievalTypeHybrid  NamespaceSearchParamsAISearchOptionsRetrievalRetrievalType = "hybrid"
)

func (NamespaceSearchParamsAISearchOptionsRetrievalRetrievalType) IsKnown

type NamespaceSearchParamsMessage

type NamespaceSearchParamsMessage struct {
	Content     param.Field[string]                            `json:"content" api:"required"`
	Role        param.Field[NamespaceSearchParamsMessagesRole] `json:"role" api:"required"`
	ExtraFields map[string]interface{}                         `json:"-,extras"`
}

func (NamespaceSearchParamsMessage) MarshalJSON

func (r NamespaceSearchParamsMessage) MarshalJSON() (data []byte, err error)

type NamespaceSearchParamsMessagesRole

type NamespaceSearchParamsMessagesRole string
const (
	NamespaceSearchParamsMessagesRoleSystem    NamespaceSearchParamsMessagesRole = "system"
	NamespaceSearchParamsMessagesRoleDeveloper NamespaceSearchParamsMessagesRole = "developer"
	NamespaceSearchParamsMessagesRoleUser      NamespaceSearchParamsMessagesRole = "user"
	NamespaceSearchParamsMessagesRoleAssistant NamespaceSearchParamsMessagesRole = "assistant"
	NamespaceSearchParamsMessagesRoleTool      NamespaceSearchParamsMessagesRole = "tool"
)

func (NamespaceSearchParamsMessagesRole) IsKnown

type NamespaceSearchResponse

type NamespaceSearchResponse struct {
	Chunks      []NamespaceSearchResponseChunk `json:"chunks" api:"required"`
	SearchQuery string                         `json:"search_query" api:"required"`
	Errors      []NamespaceSearchResponseError `json:"errors"`
	JSON        namespaceSearchResponseJSON    `json:"-"`
}

func (*NamespaceSearchResponse) UnmarshalJSON

func (r *NamespaceSearchResponse) UnmarshalJSON(data []byte) (err error)

type NamespaceSearchResponseChunk

type NamespaceSearchResponseChunk struct {
	ID             string                                      `json:"id" api:"required"`
	InstanceID     string                                      `json:"instance_id" api:"required"`
	Score          float64                                     `json:"score" api:"required"`
	Text           string                                      `json:"text" api:"required"`
	Type           string                                      `json:"type" api:"required"`
	Item           NamespaceSearchResponseChunksItem           `json:"item"`
	ScoringDetails NamespaceSearchResponseChunksScoringDetails `json:"scoring_details"`
	JSON           namespaceSearchResponseChunkJSON            `json:"-"`
}

func (*NamespaceSearchResponseChunk) UnmarshalJSON

func (r *NamespaceSearchResponseChunk) UnmarshalJSON(data []byte) (err error)

type NamespaceSearchResponseChunksItem

type NamespaceSearchResponseChunksItem struct {
	Key       string                                `json:"key" api:"required"`
	Metadata  map[string]interface{}                `json:"metadata"`
	Timestamp float64                               `json:"timestamp"`
	JSON      namespaceSearchResponseChunksItemJSON `json:"-"`
}

func (*NamespaceSearchResponseChunksItem) UnmarshalJSON

func (r *NamespaceSearchResponseChunksItem) UnmarshalJSON(data []byte) (err error)

type NamespaceSearchResponseChunksScoringDetails

type NamespaceSearchResponseChunksScoringDetails struct {
	FusionMethod   NamespaceSearchResponseChunksScoringDetailsFusionMethod `json:"fusion_method"`
	KeywordRank    float64                                                 `json:"keyword_rank"`
	KeywordScore   float64                                                 `json:"keyword_score"`
	RerankingScore float64                                                 `json:"reranking_score"`
	VectorRank     float64                                                 `json:"vector_rank"`
	VectorScore    float64                                                 `json:"vector_score"`
	JSON           namespaceSearchResponseChunksScoringDetailsJSON         `json:"-"`
}

func (*NamespaceSearchResponseChunksScoringDetails) UnmarshalJSON

func (r *NamespaceSearchResponseChunksScoringDetails) UnmarshalJSON(data []byte) (err error)

type NamespaceSearchResponseChunksScoringDetailsFusionMethod

type NamespaceSearchResponseChunksScoringDetailsFusionMethod string
const (
	NamespaceSearchResponseChunksScoringDetailsFusionMethodRrf NamespaceSearchResponseChunksScoringDetailsFusionMethod = "rrf"
	NamespaceSearchResponseChunksScoringDetailsFusionMethodMax NamespaceSearchResponseChunksScoringDetailsFusionMethod = "max"
)

func (NamespaceSearchResponseChunksScoringDetailsFusionMethod) IsKnown

type NamespaceSearchResponseEnvelope

type NamespaceSearchResponseEnvelope struct {
	Result  NamespaceSearchResponse             `json:"result" api:"required"`
	Success bool                                `json:"success" api:"required"`
	JSON    namespaceSearchResponseEnvelopeJSON `json:"-"`
}

func (*NamespaceSearchResponseEnvelope) UnmarshalJSON

func (r *NamespaceSearchResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NamespaceSearchResponseError

type NamespaceSearchResponseError struct {
	InstanceID string                           `json:"instance_id" api:"required"`
	Message    string                           `json:"message" api:"required"`
	JSON       namespaceSearchResponseErrorJSON `json:"-"`
}

func (*NamespaceSearchResponseError) UnmarshalJSON

func (r *NamespaceSearchResponseError) UnmarshalJSON(data []byte) (err error)

type NamespaceService

type NamespaceService struct {
	Options   []option.RequestOption
	Instances *NamespaceInstanceService
}

NamespaceService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewNamespaceService method instead.

func NewNamespaceService

func NewNamespaceService(opts ...option.RequestOption) (r *NamespaceService)

NewNamespaceService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*NamespaceService) ChatCompletions

Performs a chat completion request against multiple AI Search instances in parallel, merging retrieved content as context for generating a response.

func (*NamespaceService) Delete

Delete namespace.

func (*NamespaceService) List

List namespaces.

func (*NamespaceService) ListAutoPaging

List namespaces.

func (*NamespaceService) New

Create a new namespace.

func (*NamespaceService) Read

Read namespace.

func (*NamespaceService) Search

Multi-Instance Search

func (*NamespaceService) Update

Update namespace.

type NamespaceUpdateParams

type NamespaceUpdateParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Optional description for the namespace. Max 256 characters.
	Description param.Field[string] `json:"description"`
}

func (NamespaceUpdateParams) MarshalJSON

func (r NamespaceUpdateParams) MarshalJSON() (data []byte, err error)

type NamespaceUpdateResponse

type NamespaceUpdateResponse struct {
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	Name      string    `json:"name" api:"required"`
	// Optional description for the namespace. Max 256 characters.
	Description string                      `json:"description" api:"nullable"`
	JSON        namespaceUpdateResponseJSON `json:"-"`
}

func (*NamespaceUpdateResponse) UnmarshalJSON

func (r *NamespaceUpdateResponse) UnmarshalJSON(data []byte) (err error)

type NamespaceUpdateResponseEnvelope

type NamespaceUpdateResponseEnvelope struct {
	Result  NamespaceUpdateResponse                `json:"result" api:"required"`
	Success NamespaceUpdateResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    namespaceUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*NamespaceUpdateResponseEnvelope) UnmarshalJSON

func (r *NamespaceUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type NamespaceUpdateResponseEnvelopeSuccess

type NamespaceUpdateResponseEnvelopeSuccess bool
const (
	NamespaceUpdateResponseEnvelopeSuccessTrue NamespaceUpdateResponseEnvelopeSuccess = true
)

func (NamespaceUpdateResponseEnvelopeSuccess) IsKnown

type Permission

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type RatePlan

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanID

type RatePlanID = shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

type RatePlanParam

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type ResponseInfo

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type ResponseInfoSource

type ResponseInfoSource = shared.ResponseInfoSource

This is an alias to an internal type.

type Role

type Role = shared.Role

This is an alias to an internal type.

type RoleParam

type RoleParam = shared.RoleParam

This is an alias to an internal type.

type RolePermissions

type RolePermissions = shared.RolePermissions

This is an alias to an internal type.

type RolePermissionsParam

type RolePermissionsParam = shared.RolePermissionsParam

This is an alias to an internal type.

type SortDirection

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type Subscription

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type Token

type Token = shared.Token

This is an alias to an internal type.

type TokenCondition

type TokenCondition = shared.TokenCondition

This is an alias to an internal type.

type TokenConditionCIDRList

type TokenConditionCIDRList = shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionCIDRListParam

type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionParam

type TokenConditionParam = shared.TokenConditionParam

This is an alias to an internal type.

type TokenConditionRequestIP

type TokenConditionRequestIP = shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

type TokenConditionRequestIPParam

type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

type TokenDeleteParams

type TokenDeleteParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type TokenDeleteResponse

type TokenDeleteResponse = interface{}

type TokenDeleteResponseEnvelope

type TokenDeleteResponseEnvelope struct {
	Result  TokenDeleteResponse                `json:"result" api:"required"`
	Success TokenDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    tokenDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*TokenDeleteResponseEnvelope) UnmarshalJSON

func (r *TokenDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type TokenDeleteResponseEnvelopeSuccess

type TokenDeleteResponseEnvelopeSuccess bool
const (
	TokenDeleteResponseEnvelopeSuccessTrue TokenDeleteResponseEnvelopeSuccess = true
)

func (TokenDeleteResponseEnvelopeSuccess) IsKnown

type TokenListParams

type TokenListParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Page number (1-indexed).
	Page param.Field[int64] `query:"page"`
	// Number of results per page.
	PerPage param.Field[int64] `query:"per_page"`
	// Filter tokens whose name contains this string (case-insensitive).
	Search param.Field[string] `query:"search"`
}

func (TokenListParams) URLQuery

func (r TokenListParams) URLQuery() (v url.Values)

URLQuery serializes TokenListParams's query parameters as `url.Values`.

type TokenListResponse

type TokenListResponse struct {
	ID         string                `json:"id" api:"required" format:"uuid"`
	CfAPIID    string                `json:"cf_api_id" api:"required"`
	CreatedAt  time.Time             `json:"created_at" api:"required" format:"date-time"`
	ModifiedAt time.Time             `json:"modified_at" api:"required" format:"date-time"`
	Name       string                `json:"name" api:"required"`
	CreatedBy  string                `json:"created_by" api:"nullable"`
	Enabled    bool                  `json:"enabled"`
	Legacy     bool                  `json:"legacy"`
	ModifiedBy string                `json:"modified_by" api:"nullable"`
	JSON       tokenListResponseJSON `json:"-"`
}

func (*TokenListResponse) UnmarshalJSON

func (r *TokenListResponse) UnmarshalJSON(data []byte) (err error)

type TokenNewParams

type TokenNewParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	CfAPIID   param.Field[string] `json:"cf_api_id" api:"required"`
	CfAPIKey  param.Field[string] `json:"cf_api_key" api:"required"`
	Name      param.Field[string] `json:"name" api:"required"`
	Legacy    param.Field[bool]   `json:"legacy"`
}

func (TokenNewParams) MarshalJSON

func (r TokenNewParams) MarshalJSON() (data []byte, err error)

type TokenNewResponse

type TokenNewResponse struct {
	ID         string               `json:"id" api:"required" format:"uuid"`
	CfAPIID    string               `json:"cf_api_id" api:"required"`
	CreatedAt  time.Time            `json:"created_at" api:"required" format:"date-time"`
	ModifiedAt time.Time            `json:"modified_at" api:"required" format:"date-time"`
	Name       string               `json:"name" api:"required"`
	CreatedBy  string               `json:"created_by" api:"nullable"`
	Enabled    bool                 `json:"enabled"`
	Legacy     bool                 `json:"legacy"`
	ModifiedBy string               `json:"modified_by" api:"nullable"`
	JSON       tokenNewResponseJSON `json:"-"`
}

func (*TokenNewResponse) UnmarshalJSON

func (r *TokenNewResponse) UnmarshalJSON(data []byte) (err error)

type TokenNewResponseEnvelope

type TokenNewResponseEnvelope struct {
	Result  TokenNewResponse                `json:"result" api:"required"`
	Success TokenNewResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    tokenNewResponseEnvelopeJSON    `json:"-"`
}

func (*TokenNewResponseEnvelope) UnmarshalJSON

func (r *TokenNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type TokenNewResponseEnvelopeSuccess

type TokenNewResponseEnvelopeSuccess bool
const (
	TokenNewResponseEnvelopeSuccessTrue TokenNewResponseEnvelopeSuccess = true
)

func (TokenNewResponseEnvelopeSuccess) IsKnown

type TokenParam

type TokenParam = shared.TokenParam

This is an alias to an internal type.

type TokenPolicy

type TokenPolicy = shared.TokenPolicy

This is an alias to an internal type.

type TokenPolicyEffect

type TokenPolicyEffect = shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

type TokenPolicyParam

type TokenPolicyParam = shared.TokenPolicyParam

This is an alias to an internal type.

type TokenPolicyPermissionGroup

type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupParam

type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMeta

type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMetaParam

type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNested

type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectString

type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesUnion

type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenPolicyResourcesUnionParam

type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenReadParams

type TokenReadParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type TokenReadResponse

type TokenReadResponse struct {
	ID         string                `json:"id" api:"required" format:"uuid"`
	CfAPIID    string                `json:"cf_api_id" api:"required"`
	CreatedAt  time.Time             `json:"created_at" api:"required" format:"date-time"`
	ModifiedAt time.Time             `json:"modified_at" api:"required" format:"date-time"`
	Name       string                `json:"name" api:"required"`
	CreatedBy  string                `json:"created_by" api:"nullable"`
	Enabled    bool                  `json:"enabled"`
	Legacy     bool                  `json:"legacy"`
	ModifiedBy string                `json:"modified_by" api:"nullable"`
	JSON       tokenReadResponseJSON `json:"-"`
}

func (*TokenReadResponse) UnmarshalJSON

func (r *TokenReadResponse) UnmarshalJSON(data []byte) (err error)

type TokenReadResponseEnvelope

type TokenReadResponseEnvelope struct {
	Result  TokenReadResponse                `json:"result" api:"required"`
	Success TokenReadResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    tokenReadResponseEnvelopeJSON    `json:"-"`
}

func (*TokenReadResponseEnvelope) UnmarshalJSON

func (r *TokenReadResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type TokenReadResponseEnvelopeSuccess

type TokenReadResponseEnvelopeSuccess bool
const (
	TokenReadResponseEnvelopeSuccessTrue TokenReadResponseEnvelopeSuccess = true
)

func (TokenReadResponseEnvelopeSuccess) IsKnown

type TokenService

type TokenService struct {
	Options []option.RequestOption
}

TokenService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewTokenService method instead.

func NewTokenService

func NewTokenService(opts ...option.RequestOption) (r *TokenService)

NewTokenService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*TokenService) Delete

func (r *TokenService) Delete(ctx context.Context, id string, body TokenDeleteParams, opts ...option.RequestOption) (res *TokenDeleteResponse, err error)

Delete token.

func (*TokenService) List

List tokens.

func (*TokenService) ListAutoPaging

List tokens.

func (*TokenService) New

func (r *TokenService) New(ctx context.Context, params TokenNewParams, opts ...option.RequestOption) (res *TokenNewResponse, err error)

Create a new token.

func (*TokenService) Read

func (r *TokenService) Read(ctx context.Context, id string, query TokenReadParams, opts ...option.RequestOption) (res *TokenReadResponse, err error)

Read token.

func (*TokenService) Update

func (r *TokenService) Update(ctx context.Context, id string, params TokenUpdateParams, opts ...option.RequestOption) (res *TokenUpdateResponse, err error)

Update token.

type TokenStatus

type TokenStatus = shared.TokenStatus

Status of the token.

This is an alias to an internal type.

type TokenUpdateParams

type TokenUpdateParams struct {
	AccountID param.Field[string] `path:"account_id" api:"required"`
	CfAPIID   param.Field[string] `json:"cf_api_id" api:"required"`
	CfAPIKey  param.Field[string] `json:"cf_api_key" api:"required"`
	Name      param.Field[string] `json:"name" api:"required"`
	Legacy    param.Field[bool]   `json:"legacy"`
}

func (TokenUpdateParams) MarshalJSON

func (r TokenUpdateParams) MarshalJSON() (data []byte, err error)

type TokenUpdateResponse

type TokenUpdateResponse struct {
	ID         string                  `json:"id" api:"required" format:"uuid"`
	CfAPIID    string                  `json:"cf_api_id" api:"required"`
	CreatedAt  time.Time               `json:"created_at" api:"required" format:"date-time"`
	ModifiedAt time.Time               `json:"modified_at" api:"required" format:"date-time"`
	Name       string                  `json:"name" api:"required"`
	CreatedBy  string                  `json:"created_by" api:"nullable"`
	Enabled    bool                    `json:"enabled"`
	Legacy     bool                    `json:"legacy"`
	ModifiedBy string                  `json:"modified_by" api:"nullable"`
	JSON       tokenUpdateResponseJSON `json:"-"`
}

func (*TokenUpdateResponse) UnmarshalJSON

func (r *TokenUpdateResponse) UnmarshalJSON(data []byte) (err error)

type TokenUpdateResponseEnvelope

type TokenUpdateResponseEnvelope struct {
	Result  TokenUpdateResponse                `json:"result" api:"required"`
	Success TokenUpdateResponseEnvelopeSuccess `json:"success" api:"required"`
	JSON    tokenUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*TokenUpdateResponseEnvelope) UnmarshalJSON

func (r *TokenUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type TokenUpdateResponseEnvelopeSuccess

type TokenUpdateResponseEnvelopeSuccess bool
const (
	TokenUpdateResponseEnvelopeSuccessTrue TokenUpdateResponseEnvelopeSuccess = true
)

func (TokenUpdateResponseEnvelopeSuccess) IsKnown

type TokenValue

type TokenValue = shared.TokenValue

The token value.

This is an alias to an internal type.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL