cloudflare.AiSearchInstance

Cloudflare v6.15.0, May 2 26

Viewing docs for Cloudflare v6.15.0
published on Saturday, May 2, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-cloudflare

Viewing docs for Cloudflare v6.15.0
published on Saturday, May 2, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-cloudflare

Import

This resource does not currently support pulumi import.

Create AiSearchInstance Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new AiSearchInstance(name: string, args: AiSearchInstanceArgs, opts?: CustomResourceOptions);

@overload
def AiSearchInstance(resource_name: str,
                     args: AiSearchInstanceArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def AiSearchInstance(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     ai_search_instance_id: Optional[str] = None,
                     account_id: Optional[str] = None,
                     metadata: Optional[AiSearchInstanceMetadataArgs] = None,
                     reranking: Optional[bool] = None,
                     cache: Optional[bool] = None,
                     cache_threshold: Optional[str] = None,
                     chunk: Optional[bool] = None,
                     chunk_overlap: Optional[int] = None,
                     chunk_size: Optional[int] = None,
                     custom_metadatas: Optional[Sequence[AiSearchInstanceCustomMetadataArgs]] = None,
                     embedding_model: Optional[str] = None,
                     fusion_method: Optional[str] = None,
                     hybrid_search_enabled: Optional[bool] = None,
                     index_method: Optional[AiSearchInstanceIndexMethodArgs] = None,
                     indexing_options: Optional[AiSearchInstanceIndexingOptionsArgs] = None,
                     max_num_results: Optional[int] = None,
                     ai_gateway_id: Optional[str] = None,
                     paused: Optional[bool] = None,
                     aisearch_model: Optional[str] = None,
                     reranking_model: Optional[str] = None,
                     public_endpoint_params: Optional[AiSearchInstancePublicEndpointParamsArgs] = None,
                     retrieval_options: Optional[AiSearchInstanceRetrievalOptionsArgs] = None,
                     rewrite_model: Optional[str] = None,
                     rewrite_query: Optional[bool] = None,
                     score_threshold: Optional[float] = None,
                     source: Optional[str] = None,
                     source_params: Optional[AiSearchInstanceSourceParamsArgs] = None,
                     summarization: Optional[bool] = None,
                     summarization_model: Optional[str] = None,
                     sync_interval: Optional[float] = None,
                     system_prompt_aisearch: Optional[str] = None,
                     system_prompt_index_summarization: Optional[str] = None,
                     system_prompt_rewrite_query: Optional[str] = None,
                     token_id: Optional[str] = None,
                     type: Optional[str] = None)

func NewAiSearchInstance(ctx *Context, name string, args AiSearchInstanceArgs, opts ...ResourceOption) (*AiSearchInstance, error)

public AiSearchInstance(string name, AiSearchInstanceArgs args, CustomResourceOptions? opts = null)

public AiSearchInstance(String name, AiSearchInstanceArgs args)
public AiSearchInstance(String name, AiSearchInstanceArgs args, CustomResourceOptions options)

type: cloudflare:AiSearchInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args AiSearchInstanceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args AiSearchInstanceArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args AiSearchInstanceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AiSearchInstanceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AiSearchInstanceArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var aiSearchInstanceResource = new Cloudflare.AiSearchInstance("aiSearchInstanceResource", new()
{
    AiSearchInstanceId = "string",
    AccountId = "string",
    Metadata = new Cloudflare.Inputs.AiSearchInstanceMetadataArgs
    {
        CreatedFromAisearchWizard = false,
        SearchForAgents = new Cloudflare.Inputs.AiSearchInstanceMetadataSearchForAgentsArgs
        {
            Hostname = "string",
            ZoneId = "string",
            ZoneName = "string",
        },
        WorkerDomain = "string",
    },
    Reranking = false,
    Cache = false,
    CacheThreshold = "string",
    Chunk = false,
    ChunkOverlap = 0,
    ChunkSize = 0,
    CustomMetadatas = new[]
    {
        new Cloudflare.Inputs.AiSearchInstanceCustomMetadataArgs
        {
            DataType = "string",
            FieldName = "string",
        },
    },
    EmbeddingModel = "string",
    FusionMethod = "string",
    IndexMethod = new Cloudflare.Inputs.AiSearchInstanceIndexMethodArgs
    {
        Keyword = false,
        Vector = false,
    },
    IndexingOptions = new Cloudflare.Inputs.AiSearchInstanceIndexingOptionsArgs
    {
        KeywordTokenizer = "string",
    },
    MaxNumResults = 0,
    AiGatewayId = "string",
    Paused = false,
    AisearchModel = "string",
    RerankingModel = "string",
    PublicEndpointParams = new Cloudflare.Inputs.AiSearchInstancePublicEndpointParamsArgs
    {
        AuthorizedHosts = new[]
        {
            "string",
        },
        ChatCompletionsEndpoint = new Cloudflare.Inputs.AiSearchInstancePublicEndpointParamsChatCompletionsEndpointArgs
        {
            Disabled = false,
        },
        Enabled = false,
        Mcp = new Cloudflare.Inputs.AiSearchInstancePublicEndpointParamsMcpArgs
        {
            Description = "string",
            Disabled = false,
        },
        RateLimit = new Cloudflare.Inputs.AiSearchInstancePublicEndpointParamsRateLimitArgs
        {
            PeriodMs = 0,
            Requests = 0,
            Technique = "string",
        },
        SearchEndpoint = new Cloudflare.Inputs.AiSearchInstancePublicEndpointParamsSearchEndpointArgs
        {
            Disabled = false,
        },
    },
    RetrievalOptions = new Cloudflare.Inputs.AiSearchInstanceRetrievalOptionsArgs
    {
        BoostBies = new[]
        {
            new Cloudflare.Inputs.AiSearchInstanceRetrievalOptionsBoostByArgs
            {
                Field = "string",
                Direction = "string",
            },
        },
        KeywordMatchMode = "string",
    },
    RewriteModel = "string",
    RewriteQuery = false,
    ScoreThreshold = 0,
    Source = "string",
    SourceParams = new Cloudflare.Inputs.AiSearchInstanceSourceParamsArgs
    {
        ExcludeItems = new[]
        {
            "string",
        },
        IncludeItems = new[]
        {
            "string",
        },
        Prefix = "string",
        R2Jurisdiction = "string",
        WebCrawler = new Cloudflare.Inputs.AiSearchInstanceSourceParamsWebCrawlerArgs
        {
            CrawlOptions = new Cloudflare.Inputs.AiSearchInstanceSourceParamsWebCrawlerCrawlOptionsArgs
            {
                Depth = 0,
                IncludeExternalLinks = false,
                IncludeSubdomains = false,
                MaxAge = 0,
                Source = "string",
            },
            ParseOptions = new Cloudflare.Inputs.AiSearchInstanceSourceParamsWebCrawlerParseOptionsArgs
            {
                ContentSelectors = new[]
                {
                    new Cloudflare.Inputs.AiSearchInstanceSourceParamsWebCrawlerParseOptionsContentSelectorArgs
                    {
                        Path = "string",
                        Selector = "string",
                    },
                },
                IncludeHeaders = 
                {
                    { "string", "string" },
                },
                IncludeImages = false,
                SpecificSitemaps = new[]
                {
                    "string",
                },
                UseBrowserRendering = false,
            },
            ParseType = "string",
            StoreOptions = new Cloudflare.Inputs.AiSearchInstanceSourceParamsWebCrawlerStoreOptionsArgs
            {
                StorageId = "string",
                R2Jurisdiction = "string",
                StorageType = "string",
            },
        },
    },
    Summarization = false,
    SummarizationModel = "string",
    SyncInterval = 0,
    SystemPromptAisearch = "string",
    SystemPromptIndexSummarization = "string",
    SystemPromptRewriteQuery = "string",
    TokenId = "string",
    Type = "string",
});

example, err := cloudflare.NewAiSearchInstance(ctx, "aiSearchInstanceResource", &cloudflare.AiSearchInstanceArgs{
	AiSearchInstanceId: pulumi.String("string"),
	AccountId:          pulumi.String("string"),
	Metadata: &cloudflare.AiSearchInstanceMetadataArgs{
		CreatedFromAisearchWizard: pulumi.Bool(false),
		SearchForAgents: &cloudflare.AiSearchInstanceMetadataSearchForAgentsArgs{
			Hostname: pulumi.String("string"),
			ZoneId:   pulumi.String("string"),
			ZoneName: pulumi.String("string"),
		},
		WorkerDomain: pulumi.String("string"),
	},
	Reranking:      pulumi.Bool(false),
	Cache:          pulumi.Bool(false),
	CacheThreshold: pulumi.String("string"),
	Chunk:          pulumi.Bool(false),
	ChunkOverlap:   pulumi.Int(0),
	ChunkSize:      pulumi.Int(0),
	CustomMetadatas: cloudflare.AiSearchInstanceCustomMetadataArray{
		&cloudflare.AiSearchInstanceCustomMetadataArgs{
			DataType:  pulumi.String("string"),
			FieldName: pulumi.String("string"),
		},
	},
	EmbeddingModel: pulumi.String("string"),
	FusionMethod:   pulumi.String("string"),
	IndexMethod: &cloudflare.AiSearchInstanceIndexMethodArgs{
		Keyword: pulumi.Bool(false),
		Vector:  pulumi.Bool(false),
	},
	IndexingOptions: &cloudflare.AiSearchInstanceIndexingOptionsArgs{
		KeywordTokenizer: pulumi.String("string"),
	},
	MaxNumResults:  pulumi.Int(0),
	AiGatewayId:    pulumi.String("string"),
	Paused:         pulumi.Bool(false),
	AisearchModel:  pulumi.String("string"),
	RerankingModel: pulumi.String("string"),
	PublicEndpointParams: &cloudflare.AiSearchInstancePublicEndpointParamsArgs{
		AuthorizedHosts: pulumi.StringArray{
			pulumi.String("string"),
		},
		ChatCompletionsEndpoint: &cloudflare.AiSearchInstancePublicEndpointParamsChatCompletionsEndpointArgs{
			Disabled: pulumi.Bool(false),
		},
		Enabled: pulumi.Bool(false),
		Mcp: &cloudflare.AiSearchInstancePublicEndpointParamsMcpArgs{
			Description: pulumi.String("string"),
			Disabled:    pulumi.Bool(false),
		},
		RateLimit: &cloudflare.AiSearchInstancePublicEndpointParamsRateLimitArgs{
			PeriodMs:  pulumi.Int(0),
			Requests:  pulumi.Int(0),
			Technique: pulumi.String("string"),
		},
		SearchEndpoint: &cloudflare.AiSearchInstancePublicEndpointParamsSearchEndpointArgs{
			Disabled: pulumi.Bool(false),
		},
	},
	RetrievalOptions: &cloudflare.AiSearchInstanceRetrievalOptionsArgs{
		BoostBies: cloudflare.AiSearchInstanceRetrievalOptionsBoostByArray{
			&cloudflare.AiSearchInstanceRetrievalOptionsBoostByArgs{
				Field:     pulumi.String("string"),
				Direction: pulumi.String("string"),
			},
		},
		KeywordMatchMode: pulumi.String("string"),
	},
	RewriteModel:   pulumi.String("string"),
	RewriteQuery:   pulumi.Bool(false),
	ScoreThreshold: pulumi.Float64(0),
	Source:         pulumi.String("string"),
	SourceParams: &cloudflare.AiSearchInstanceSourceParamsArgs{
		ExcludeItems: pulumi.StringArray{
			pulumi.String("string"),
		},
		IncludeItems: pulumi.StringArray{
			pulumi.String("string"),
		},
		Prefix:         pulumi.String("string"),
		R2Jurisdiction: pulumi.String("string"),
		WebCrawler: &cloudflare.AiSearchInstanceSourceParamsWebCrawlerArgs{
			CrawlOptions: &cloudflare.AiSearchInstanceSourceParamsWebCrawlerCrawlOptionsArgs{
				Depth:                pulumi.Float64(0),
				IncludeExternalLinks: pulumi.Bool(false),
				IncludeSubdomains:    pulumi.Bool(false),
				MaxAge:               pulumi.Float64(0),
				Source:               pulumi.String("string"),
			},
			ParseOptions: &cloudflare.AiSearchInstanceSourceParamsWebCrawlerParseOptionsArgs{
				ContentSelectors: cloudflare.AiSearchInstanceSourceParamsWebCrawlerParseOptionsContentSelectorArray{
					&cloudflare.AiSearchInstanceSourceParamsWebCrawlerParseOptionsContentSelectorArgs{
						Path:     pulumi.String("string"),
						Selector: pulumi.String("string"),
					},
				},
				IncludeHeaders: pulumi.StringMap{
					"string": pulumi.String("string"),
				},
				IncludeImages: pulumi.Bool(false),
				SpecificSitemaps: pulumi.StringArray{
					pulumi.String("string"),
				},
				UseBrowserRendering: pulumi.Bool(false),
			},
			ParseType: pulumi.String("string"),
			StoreOptions: &cloudflare.AiSearchInstanceSourceParamsWebCrawlerStoreOptionsArgs{
				StorageId:      pulumi.String("string"),
				R2Jurisdiction: pulumi.String("string"),
				StorageType:    pulumi.String("string"),
			},
		},
	},
	Summarization:                  pulumi.Bool(false),
	SummarizationModel:             pulumi.String("string"),
	SyncInterval:                   pulumi.Float64(0),
	SystemPromptAisearch:           pulumi.String("string"),
	SystemPromptIndexSummarization: pulumi.String("string"),
	SystemPromptRewriteQuery:       pulumi.String("string"),
	TokenId:                        pulumi.String("string"),
	Type:                           pulumi.String("string"),
})

var aiSearchInstanceResource = new AiSearchInstance("aiSearchInstanceResource", AiSearchInstanceArgs.builder()
    .aiSearchInstanceId("string")
    .accountId("string")
    .metadata(AiSearchInstanceMetadataArgs.builder()
        .createdFromAisearchWizard(false)
        .searchForAgents(AiSearchInstanceMetadataSearchForAgentsArgs.builder()
            .hostname("string")
            .zoneId("string")
            .zoneName("string")
            .build())
        .workerDomain("string")
        .build())
    .reranking(false)
    .cache(false)
    .cacheThreshold("string")
    .chunk(false)
    .chunkOverlap(0)
    .chunkSize(0)
    .customMetadatas(AiSearchInstanceCustomMetadataArgs.builder()
        .dataType("string")
        .fieldName("string")
        .build())
    .embeddingModel("string")
    .fusionMethod("string")
    .indexMethod(AiSearchInstanceIndexMethodArgs.builder()
        .keyword(false)
        .vector(false)
        .build())
    .indexingOptions(AiSearchInstanceIndexingOptionsArgs.builder()
        .keywordTokenizer("string")
        .build())
    .maxNumResults(0)
    .aiGatewayId("string")
    .paused(false)
    .aisearchModel("string")
    .rerankingModel("string")
    .publicEndpointParams(AiSearchInstancePublicEndpointParamsArgs.builder()
        .authorizedHosts("string")
        .chatCompletionsEndpoint(AiSearchInstancePublicEndpointParamsChatCompletionsEndpointArgs.builder()
            .disabled(false)
            .build())
        .enabled(false)
        .mcp(AiSearchInstancePublicEndpointParamsMcpArgs.builder()
            .description("string")
            .disabled(false)
            .build())
        .rateLimit(AiSearchInstancePublicEndpointParamsRateLimitArgs.builder()
            .periodMs(0)
            .requests(0)
            .technique("string")
            .build())
        .searchEndpoint(AiSearchInstancePublicEndpointParamsSearchEndpointArgs.builder()
            .disabled(false)
            .build())
        .build())
    .retrievalOptions(AiSearchInstanceRetrievalOptionsArgs.builder()
        .boostBies(AiSearchInstanceRetrievalOptionsBoostByArgs.builder()
            .field("string")
            .direction("string")
            .build())
        .keywordMatchMode("string")
        .build())
    .rewriteModel("string")
    .rewriteQuery(false)
    .scoreThreshold(0.0)
    .source("string")
    .sourceParams(AiSearchInstanceSourceParamsArgs.builder()
        .excludeItems("string")
        .includeItems("string")
        .prefix("string")
        .r2Jurisdiction("string")
        .webCrawler(AiSearchInstanceSourceParamsWebCrawlerArgs.builder()
            .crawlOptions(AiSearchInstanceSourceParamsWebCrawlerCrawlOptionsArgs.builder()
                .depth(0.0)
                .includeExternalLinks(false)
                .includeSubdomains(false)
                .maxAge(0.0)
                .source("string")
                .build())
            .parseOptions(AiSearchInstanceSourceParamsWebCrawlerParseOptionsArgs.builder()
                .contentSelectors(AiSearchInstanceSourceParamsWebCrawlerParseOptionsContentSelectorArgs.builder()
                    .path("string")
                    .selector("string")
                    .build())
                .includeHeaders(Map.of("string", "string"))
                .includeImages(false)
                .specificSitemaps("string")
                .useBrowserRendering(false)
                .build())
            .parseType("string")
            .storeOptions(AiSearchInstanceSourceParamsWebCrawlerStoreOptionsArgs.builder()
                .storageId("string")
                .r2Jurisdiction("string")
                .storageType("string")
                .build())
            .build())
        .build())
    .summarization(false)
    .summarizationModel("string")
    .syncInterval(0.0)
    .systemPromptAisearch("string")
    .systemPromptIndexSummarization("string")
    .systemPromptRewriteQuery("string")
    .tokenId("string")
    .type("string")
    .build());

ai_search_instance_resource = cloudflare.AiSearchInstance("aiSearchInstanceResource",
    ai_search_instance_id="string",
    account_id="string",
    metadata={
        "created_from_aisearch_wizard": False,
        "search_for_agents": {
            "hostname": "string",
            "zone_id": "string",
            "zone_name": "string",
        },
        "worker_domain": "string",
    },
    reranking=False,
    cache=False,
    cache_threshold="string",
    chunk=False,
    chunk_overlap=0,
    chunk_size=0,
    custom_metadatas=[{
        "data_type": "string",
        "field_name": "string",
    }],
    embedding_model="string",
    fusion_method="string",
    index_method={
        "keyword": False,
        "vector": False,
    },
    indexing_options={
        "keyword_tokenizer": "string",
    },
    max_num_results=0,
    ai_gateway_id="string",
    paused=False,
    aisearch_model="string",
    reranking_model="string",
    public_endpoint_params={
        "authorized_hosts": ["string"],
        "chat_completions_endpoint": {
            "disabled": False,
        },
        "enabled": False,
        "mcp": {
            "description": "string",
            "disabled": False,
        },
        "rate_limit": {
            "period_ms": 0,
            "requests": 0,
            "technique": "string",
        },
        "search_endpoint": {
            "disabled": False,
        },
    },
    retrieval_options={
        "boost_bies": [{
            "field": "string",
            "direction": "string",
        }],
        "keyword_match_mode": "string",
    },
    rewrite_model="string",
    rewrite_query=False,
    score_threshold=float(0),
    source="string",
    source_params={
        "exclude_items": ["string"],
        "include_items": ["string"],
        "prefix": "string",
        "r2_jurisdiction": "string",
        "web_crawler": {
            "crawl_options": {
                "depth": float(0),
                "include_external_links": False,
                "include_subdomains": False,
                "max_age": float(0),
                "source": "string",
            },
            "parse_options": {
                "content_selectors": [{
                    "path": "string",
                    "selector": "string",
                }],
                "include_headers": {
                    "string": "string",
                },
                "include_images": False,
                "specific_sitemaps": ["string"],
                "use_browser_rendering": False,
            },
            "parse_type": "string",
            "store_options": {
                "storage_id": "string",
                "r2_jurisdiction": "string",
                "storage_type": "string",
            },
        },
    },
    summarization=False,
    summarization_model="string",
    sync_interval=float(0),
    system_prompt_aisearch="string",
    system_prompt_index_summarization="string",
    system_prompt_rewrite_query="string",
    token_id="string",
    type="string")

const aiSearchInstanceResource = new cloudflare.AiSearchInstance("aiSearchInstanceResource", {
    aiSearchInstanceId: "string",
    accountId: "string",
    metadata: {
        createdFromAisearchWizard: false,
        searchForAgents: {
            hostname: "string",
            zoneId: "string",
            zoneName: "string",
        },
        workerDomain: "string",
    },
    reranking: false,
    cache: false,
    cacheThreshold: "string",
    chunk: false,
    chunkOverlap: 0,
    chunkSize: 0,
    customMetadatas: [{
        dataType: "string",
        fieldName: "string",
    }],
    embeddingModel: "string",
    fusionMethod: "string",
    indexMethod: {
        keyword: false,
        vector: false,
    },
    indexingOptions: {
        keywordTokenizer: "string",
    },
    maxNumResults: 0,
    aiGatewayId: "string",
    paused: false,
    aisearchModel: "string",
    rerankingModel: "string",
    publicEndpointParams: {
        authorizedHosts: ["string"],
        chatCompletionsEndpoint: {
            disabled: false,
        },
        enabled: false,
        mcp: {
            description: "string",
            disabled: false,
        },
        rateLimit: {
            periodMs: 0,
            requests: 0,
            technique: "string",
        },
        searchEndpoint: {
            disabled: false,
        },
    },
    retrievalOptions: {
        boostBies: [{
            field: "string",
            direction: "string",
        }],
        keywordMatchMode: "string",
    },
    rewriteModel: "string",
    rewriteQuery: false,
    scoreThreshold: 0,
    source: "string",
    sourceParams: {
        excludeItems: ["string"],
        includeItems: ["string"],
        prefix: "string",
        r2Jurisdiction: "string",
        webCrawler: {
            crawlOptions: {
                depth: 0,
                includeExternalLinks: false,
                includeSubdomains: false,
                maxAge: 0,
                source: "string",
            },
            parseOptions: {
                contentSelectors: [{
                    path: "string",
                    selector: "string",
                }],
                includeHeaders: {
                    string: "string",
                },
                includeImages: false,
                specificSitemaps: ["string"],
                useBrowserRendering: false,
            },
            parseType: "string",
            storeOptions: {
                storageId: "string",
                r2Jurisdiction: "string",
                storageType: "string",
            },
        },
    },
    summarization: false,
    summarizationModel: "string",
    syncInterval: 0,
    systemPromptAisearch: "string",
    systemPromptIndexSummarization: "string",
    systemPromptRewriteQuery: "string",
    tokenId: "string",
    type: "string",
});

type: cloudflare:AiSearchInstance
properties:
    accountId: string
    aiGatewayId: string
    aiSearchInstanceId: string
    aisearchModel: string
    cache: false
    cacheThreshold: string
    chunk: false
    chunkOverlap: 0
    chunkSize: 0
    customMetadatas:
        - dataType: string
          fieldName: string
    embeddingModel: string
    fusionMethod: string
    indexMethod:
        keyword: false
        vector: false
    indexingOptions:
        keywordTokenizer: string
    maxNumResults: 0
    metadata:
        createdFromAisearchWizard: false
        searchForAgents:
            hostname: string
            zoneId: string
            zoneName: string
        workerDomain: string
    paused: false
    publicEndpointParams:
        authorizedHosts:
            - string
        chatCompletionsEndpoint:
            disabled: false
        enabled: false
        mcp:
            description: string
            disabled: false
        rateLimit:
            periodMs: 0
            requests: 0
            technique: string
        searchEndpoint:
            disabled: false
    reranking: false
    rerankingModel: string
    retrievalOptions:
        boostBies:
            - direction: string
              field: string
        keywordMatchMode: string
    rewriteModel: string
    rewriteQuery: false
    scoreThreshold: 0
    source: string
    sourceParams:
        excludeItems:
            - string
        includeItems:
            - string
        prefix: string
        r2Jurisdiction: string
        webCrawler:
            crawlOptions:
                depth: 0
                includeExternalLinks: false
                includeSubdomains: false
                maxAge: 0
                source: string
            parseOptions:
                contentSelectors:
                    - path: string
                      selector: string
                includeHeaders:
                    string: string
                includeImages: false
                specificSitemaps:
                    - string
                useBrowserRendering: false
            parseType: string
            storeOptions:
                r2Jurisdiction: string
                storageId: string
                storageType: string
    summarization: false
    summarizationModel: string
    syncInterval: 0
    systemPromptAisearch: string
    systemPromptIndexSummarization: string
    systemPromptRewriteQuery: string
    tokenId: string
    type: string

AiSearchInstance Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The AiSearchInstance resource accepts the following input properties:

AccountId string
AiSearchInstanceId string: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
AiGatewayId string
AisearchModel string: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
Cache bool
CacheThreshold string: Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
Chunk bool
ChunkOverlap int
ChunkSize int
CustomMetadatas List<AiSearchInstanceCustomMetadata>
EmbeddingModel string: Available values: "@cf/qwen/qwen3-embedding-0.6b", "@cf/baai/bge-m3", "@cf/baai/bge-large-en-v1.5", "@cf/google/embeddinggemma-300m", "google-ai-studio/gemini-embedding-001", "google-ai-studio/gemini-embedding-2-preview", "openai/text-embedding-3-small", "openai/text-embedding-3-large", "".
FusionMethod string: Available values: "max", "rrf".
HybridSearchEnabled bool: Deprecated — use indexMethod instead.
Deprecated: This attribute is deprecated.
IndexMethod AiSearchInstanceIndexMethod: Controls which storage backends are used during indexing. Defaults to vector-only.
IndexingOptions AiSearchInstanceIndexingOptions
MaxNumResults int
Metadata AiSearchInstanceMetadata
Paused bool
PublicEndpointParams AiSearchInstancePublicEndpointParams
Reranking bool
RerankingModel string: Available values: "@cf/baai/bge-reranker-base", "".
RetrievalOptions AiSearchInstanceRetrievalOptions
RewriteModel string: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
RewriteQuery bool
ScoreThreshold double
Source string
SourceParams AiSearchInstanceSourceParams
Summarization bool
SummarizationModel string: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
SyncInterval double: Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h). Available values: 900, 1800, 3600, 7200, 14400, 21600, 43200, 86400.
SystemPromptAisearch string
SystemPromptIndexSummarization string
SystemPromptRewriteQuery string
TokenId string
Type string: Available values: "r2", "web-crawler".

AccountId string
AiSearchInstanceId string: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
AiGatewayId string
AisearchModel string: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
Cache bool
CacheThreshold string: Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
Chunk bool
ChunkOverlap int
ChunkSize int
CustomMetadatas []AiSearchInstanceCustomMetadataArgs
EmbeddingModel string: Available values: "@cf/qwen/qwen3-embedding-0.6b", "@cf/baai/bge-m3", "@cf/baai/bge-large-en-v1.5", "@cf/google/embeddinggemma-300m", "google-ai-studio/gemini-embedding-001", "google-ai-studio/gemini-embedding-2-preview", "openai/text-embedding-3-small", "openai/text-embedding-3-large", "".
FusionMethod string: Available values: "max", "rrf".
HybridSearchEnabled bool: Deprecated — use indexMethod instead.
Deprecated: This attribute is deprecated.
IndexMethod AiSearchInstanceIndexMethodArgs: Controls which storage backends are used during indexing. Defaults to vector-only.
IndexingOptions AiSearchInstanceIndexingOptionsArgs
MaxNumResults int
Metadata AiSearchInstanceMetadataArgs
Paused bool
PublicEndpointParams AiSearchInstancePublicEndpointParamsArgs
Reranking bool
RerankingModel string: Available values: "@cf/baai/bge-reranker-base", "".
RetrievalOptions AiSearchInstanceRetrievalOptionsArgs
RewriteModel string: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
RewriteQuery bool
ScoreThreshold float64
Source string
SourceParams AiSearchInstanceSourceParamsArgs
Summarization bool
SummarizationModel string: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
SyncInterval 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). Available values: 900, 1800, 3600, 7200, 14400, 21600, 43200, 86400.
SystemPromptAisearch string
SystemPromptIndexSummarization string
SystemPromptRewriteQuery string
TokenId string
Type string: Available values: "r2", "web-crawler".

accountId String
aiSearchInstanceId String: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
aiGatewayId String
aisearchModel String: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
cache Boolean
cacheThreshold String: Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
chunk Boolean
chunkOverlap Integer
chunkSize Integer
customMetadatas List<AiSearchInstanceCustomMetadata>
embeddingModel String: Available values: "@cf/qwen/qwen3-embedding-0.6b", "@cf/baai/bge-m3", "@cf/baai/bge-large-en-v1.5", "@cf/google/embeddinggemma-300m", "google-ai-studio/gemini-embedding-001", "google-ai-studio/gemini-embedding-2-preview", "openai/text-embedding-3-small", "openai/text-embedding-3-large", "".
fusionMethod String: Available values: "max", "rrf".
hybridSearchEnabled Boolean: Deprecated — use indexMethod instead.
Deprecated: This attribute is deprecated.
indexMethod AiSearchInstanceIndexMethod: Controls which storage backends are used during indexing. Defaults to vector-only.
indexingOptions AiSearchInstanceIndexingOptions
maxNumResults Integer
metadata AiSearchInstanceMetadata
paused Boolean
publicEndpointParams AiSearchInstancePublicEndpointParams
reranking Boolean
rerankingModel String: Available values: "@cf/baai/bge-reranker-base", "".
retrievalOptions AiSearchInstanceRetrievalOptions
rewriteModel String: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
rewriteQuery Boolean
scoreThreshold Double
source String
sourceParams AiSearchInstanceSourceParams
summarization Boolean
summarizationModel String: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
syncInterval Double: Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h). Available values: 900, 1800, 3600, 7200, 14400, 21600, 43200, 86400.
systemPromptAisearch String
systemPromptIndexSummarization String
systemPromptRewriteQuery String
tokenId String
type String: Available values: "r2", "web-crawler".

accountId string
aiSearchInstanceId string: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
aiGatewayId string
aisearchModel string: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
cache boolean
cacheThreshold string: Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
chunk boolean
chunkOverlap number
chunkSize number
customMetadatas AiSearchInstanceCustomMetadata[]
embeddingModel string: Available values: "@cf/qwen/qwen3-embedding-0.6b", "@cf/baai/bge-m3", "@cf/baai/bge-large-en-v1.5", "@cf/google/embeddinggemma-300m", "google-ai-studio/gemini-embedding-001", "google-ai-studio/gemini-embedding-2-preview", "openai/text-embedding-3-small", "openai/text-embedding-3-large", "".
fusionMethod string: Available values: "max", "rrf".
hybridSearchEnabled boolean: Deprecated — use indexMethod instead.
Deprecated: This attribute is deprecated.
indexMethod AiSearchInstanceIndexMethod: Controls which storage backends are used during indexing. Defaults to vector-only.
indexingOptions AiSearchInstanceIndexingOptions
maxNumResults number
metadata AiSearchInstanceMetadata
paused boolean
publicEndpointParams AiSearchInstancePublicEndpointParams
reranking boolean
rerankingModel string: Available values: "@cf/baai/bge-reranker-base", "".
retrievalOptions AiSearchInstanceRetrievalOptions
rewriteModel string: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
rewriteQuery boolean
scoreThreshold number
source string
sourceParams AiSearchInstanceSourceParams
summarization boolean
summarizationModel string: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
syncInterval number: Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h). Available values: 900, 1800, 3600, 7200, 14400, 21600, 43200, 86400.
systemPromptAisearch string
systemPromptIndexSummarization string
systemPromptRewriteQuery string
tokenId string
type string: Available values: "r2", "web-crawler".

account_id str
ai_search_instance_id str: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
ai_gateway_id str
aisearch_model str: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
cache bool
cache_threshold str: Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
chunk bool
chunk_overlap int
chunk_size int
custom_metadatas Sequence[AiSearchInstanceCustomMetadataArgs]
embedding_model str: Available values: "@cf/qwen/qwen3-embedding-0.6b", "@cf/baai/bge-m3", "@cf/baai/bge-large-en-v1.5", "@cf/google/embeddinggemma-300m", "google-ai-studio/gemini-embedding-001", "google-ai-studio/gemini-embedding-2-preview", "openai/text-embedding-3-small", "openai/text-embedding-3-large", "".
fusion_method str: Available values: "max", "rrf".
hybrid_search_enabled bool: Deprecated — use indexMethod instead.
Deprecated: This attribute is deprecated.
index_method AiSearchInstanceIndexMethodArgs: Controls which storage backends are used during indexing. Defaults to vector-only.
indexing_options AiSearchInstanceIndexingOptionsArgs
max_num_results int
metadata AiSearchInstanceMetadataArgs
paused bool
public_endpoint_params AiSearchInstancePublicEndpointParamsArgs
reranking bool
reranking_model str: Available values: "@cf/baai/bge-reranker-base", "".
retrieval_options AiSearchInstanceRetrievalOptionsArgs
rewrite_model str: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
rewrite_query bool
score_threshold float
source str
source_params AiSearchInstanceSourceParamsArgs
summarization bool
summarization_model str: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
sync_interval float: Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h). Available values: 900, 1800, 3600, 7200, 14400, 21600, 43200, 86400.
system_prompt_aisearch str
system_prompt_index_summarization str
system_prompt_rewrite_query str
token_id str
type str: Available values: "r2", "web-crawler".

accountId String
aiSearchInstanceId String: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
aiGatewayId String
aisearchModel String: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
cache Boolean
cacheThreshold String: Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
chunk Boolean
chunkOverlap Number
chunkSize Number
customMetadatas List<Property Map>
embeddingModel String: Available values: "@cf/qwen/qwen3-embedding-0.6b", "@cf/baai/bge-m3", "@cf/baai/bge-large-en-v1.5", "@cf/google/embeddinggemma-300m", "google-ai-studio/gemini-embedding-001", "google-ai-studio/gemini-embedding-2-preview", "openai/text-embedding-3-small", "openai/text-embedding-3-large", "".
fusionMethod String: Available values: "max", "rrf".
hybridSearchEnabled Boolean: Deprecated — use indexMethod instead.
Deprecated: This attribute is deprecated.
indexMethod Property Map: Controls which storage backends are used during indexing. Defaults to vector-only.
indexingOptions Property Map
maxNumResults Number
metadata Property Map
paused Boolean
publicEndpointParams Property Map
reranking Boolean
rerankingModel String: Available values: "@cf/baai/bge-reranker-base", "".
retrievalOptions Property Map
rewriteModel String: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
rewriteQuery Boolean
scoreThreshold Number
source String
sourceParams Property Map
summarization Boolean
summarizationModel String: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
syncInterval Number: Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h). Available values: 900, 1800, 3600, 7200, 14400, 21600, 43200, 86400.
systemPromptAisearch String
systemPromptIndexSummarization String
systemPromptRewriteQuery String
tokenId String
type String: Available values: "r2", "web-crawler".

Outputs

All input properties are implicitly available as output properties. Additionally, the AiSearchInstance resource produces the following output properties:

CreatedAt string
CreatedBy string
Enable bool
EngineVersion double
Id string: The provider-assigned unique ID for this managed resource.
LastActivity string
ModifiedAt string
ModifiedBy string
Namespace string
PublicEndpointId string
Status string
VectorizeName string

CreatedAt string
CreatedBy string
Enable bool
EngineVersion float64
Id string: The provider-assigned unique ID for this managed resource.
LastActivity string
ModifiedAt string
ModifiedBy string
Namespace string
PublicEndpointId string
Status string
VectorizeName string

createdAt String
createdBy String
enable Boolean
engineVersion Double
id String: The provider-assigned unique ID for this managed resource.
lastActivity String
modifiedAt String
modifiedBy String
namespace String
publicEndpointId String
status String
vectorizeName String

createdAt string
createdBy string
enable boolean
engineVersion number
id string: The provider-assigned unique ID for this managed resource.
lastActivity string
modifiedAt string
modifiedBy string
namespace string
publicEndpointId string
status string
vectorizeName string

created_at str
created_by str
enable bool
engine_version float
id str: The provider-assigned unique ID for this managed resource.
last_activity str
modified_at str
modified_by str
namespace str
public_endpoint_id str
status str
vectorize_name str

createdAt String
createdBy String
enable Boolean
engineVersion Number
id String: The provider-assigned unique ID for this managed resource.
lastActivity String
modifiedAt String
modifiedBy String
namespace String
publicEndpointId String
status String
vectorizeName String

Look up Existing AiSearchInstance Resource

Get an existing AiSearchInstance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: AiSearchInstanceState, opts?: CustomResourceOptions): AiSearchInstance

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        ai_gateway_id: Optional[str] = None,
        ai_search_instance_id: Optional[str] = None,
        aisearch_model: Optional[str] = None,
        cache: Optional[bool] = None,
        cache_threshold: Optional[str] = None,
        chunk: Optional[bool] = None,
        chunk_overlap: Optional[int] = None,
        chunk_size: Optional[int] = None,
        created_at: Optional[str] = None,
        created_by: Optional[str] = None,
        custom_metadatas: Optional[Sequence[AiSearchInstanceCustomMetadataArgs]] = None,
        embedding_model: Optional[str] = None,
        enable: Optional[bool] = None,
        engine_version: Optional[float] = None,
        fusion_method: Optional[str] = None,
        hybrid_search_enabled: Optional[bool] = None,
        index_method: Optional[AiSearchInstanceIndexMethodArgs] = None,
        indexing_options: Optional[AiSearchInstanceIndexingOptionsArgs] = None,
        last_activity: Optional[str] = None,
        max_num_results: Optional[int] = None,
        metadata: Optional[AiSearchInstanceMetadataArgs] = None,
        modified_at: Optional[str] = None,
        modified_by: Optional[str] = None,
        namespace: Optional[str] = None,
        paused: Optional[bool] = None,
        public_endpoint_id: Optional[str] = None,
        public_endpoint_params: Optional[AiSearchInstancePublicEndpointParamsArgs] = None,
        reranking: Optional[bool] = None,
        reranking_model: Optional[str] = None,
        retrieval_options: Optional[AiSearchInstanceRetrievalOptionsArgs] = None,
        rewrite_model: Optional[str] = None,
        rewrite_query: Optional[bool] = None,
        score_threshold: Optional[float] = None,
        source: Optional[str] = None,
        source_params: Optional[AiSearchInstanceSourceParamsArgs] = None,
        status: Optional[str] = None,
        summarization: Optional[bool] = None,
        summarization_model: Optional[str] = None,
        sync_interval: Optional[float] = None,
        system_prompt_aisearch: Optional[str] = None,
        system_prompt_index_summarization: Optional[str] = None,
        system_prompt_rewrite_query: Optional[str] = None,
        token_id: Optional[str] = None,
        type: Optional[str] = None,
        vectorize_name: Optional[str] = None) -> AiSearchInstance

func GetAiSearchInstance(ctx *Context, name string, id IDInput, state *AiSearchInstanceState, opts ...ResourceOption) (*AiSearchInstance, error)

public static AiSearchInstance Get(string name, Input<string> id, AiSearchInstanceState? state, CustomResourceOptions? opts = null)

public static AiSearchInstance get(String name, Output<String> id, AiSearchInstanceState state, CustomResourceOptions options)

resources:  _:    type: cloudflare:AiSearchInstance    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AccountId string
AiGatewayId string
AiSearchInstanceId string: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
AisearchModel string: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
Cache bool
CacheThreshold string: Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
Chunk bool
ChunkOverlap int
ChunkSize int
CreatedAt string
CreatedBy string
CustomMetadatas List<AiSearchInstanceCustomMetadata>
EmbeddingModel string: Available values: "@cf/qwen/qwen3-embedding-0.6b", "@cf/baai/bge-m3", "@cf/baai/bge-large-en-v1.5", "@cf/google/embeddinggemma-300m", "google-ai-studio/gemini-embedding-001", "google-ai-studio/gemini-embedding-2-preview", "openai/text-embedding-3-small", "openai/text-embedding-3-large", "".
Enable bool
EngineVersion double
FusionMethod string: Available values: "max", "rrf".
HybridSearchEnabled bool: Deprecated — use indexMethod instead.
Deprecated: This attribute is deprecated.
IndexMethod AiSearchInstanceIndexMethod: Controls which storage backends are used during indexing. Defaults to vector-only.
IndexingOptions AiSearchInstanceIndexingOptions
LastActivity string
MaxNumResults int
Metadata AiSearchInstanceMetadata
ModifiedAt string
ModifiedBy string
Namespace string
Paused bool
PublicEndpointId string
PublicEndpointParams AiSearchInstancePublicEndpointParams
Reranking bool
RerankingModel string: Available values: "@cf/baai/bge-reranker-base", "".
RetrievalOptions AiSearchInstanceRetrievalOptions
RewriteModel string: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
RewriteQuery bool
ScoreThreshold double
Source string
SourceParams AiSearchInstanceSourceParams
Status string
Summarization bool
SummarizationModel string: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
SyncInterval double: Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h). Available values: 900, 1800, 3600, 7200, 14400, 21600, 43200, 86400.
SystemPromptAisearch string
SystemPromptIndexSummarization string
SystemPromptRewriteQuery string
TokenId string
Type string: Available values: "r2", "web-crawler".
VectorizeName string

AccountId string
AiGatewayId string
AiSearchInstanceId string: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
AisearchModel string: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
Cache bool
CacheThreshold string: Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
Chunk bool
ChunkOverlap int
ChunkSize int
CreatedAt string
CreatedBy string
CustomMetadatas []AiSearchInstanceCustomMetadataArgs
EmbeddingModel string: Available values: "@cf/qwen/qwen3-embedding-0.6b", "@cf/baai/bge-m3", "@cf/baai/bge-large-en-v1.5", "@cf/google/embeddinggemma-300m", "google-ai-studio/gemini-embedding-001", "google-ai-studio/gemini-embedding-2-preview", "openai/text-embedding-3-small", "openai/text-embedding-3-large", "".
Enable bool
EngineVersion float64
FusionMethod string: Available values: "max", "rrf".
HybridSearchEnabled bool: Deprecated — use indexMethod instead.
Deprecated: This attribute is deprecated.
IndexMethod AiSearchInstanceIndexMethodArgs: Controls which storage backends are used during indexing. Defaults to vector-only.
IndexingOptions AiSearchInstanceIndexingOptionsArgs
LastActivity string
MaxNumResults int
Metadata AiSearchInstanceMetadataArgs
ModifiedAt string
ModifiedBy string
Namespace string
Paused bool
PublicEndpointId string
PublicEndpointParams AiSearchInstancePublicEndpointParamsArgs
Reranking bool
RerankingModel string: Available values: "@cf/baai/bge-reranker-base", "".
RetrievalOptions AiSearchInstanceRetrievalOptionsArgs
RewriteModel string: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
RewriteQuery bool
ScoreThreshold float64
Source string
SourceParams AiSearchInstanceSourceParamsArgs
Status string
Summarization bool
SummarizationModel string: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
SyncInterval 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). Available values: 900, 1800, 3600, 7200, 14400, 21600, 43200, 86400.
SystemPromptAisearch string
SystemPromptIndexSummarization string
SystemPromptRewriteQuery string
TokenId string
Type string: Available values: "r2", "web-crawler".
VectorizeName string

accountId String
aiGatewayId String
aiSearchInstanceId String: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
aisearchModel String: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
cache Boolean
cacheThreshold String: Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
chunk Boolean
chunkOverlap Integer
chunkSize Integer
createdAt String
createdBy String
customMetadatas List<AiSearchInstanceCustomMetadata>
embeddingModel String: Available values: "@cf/qwen/qwen3-embedding-0.6b", "@cf/baai/bge-m3", "@cf/baai/bge-large-en-v1.5", "@cf/google/embeddinggemma-300m", "google-ai-studio/gemini-embedding-001", "google-ai-studio/gemini-embedding-2-preview", "openai/text-embedding-3-small", "openai/text-embedding-3-large", "".
enable Boolean
engineVersion Double
fusionMethod String: Available values: "max", "rrf".
hybridSearchEnabled Boolean: Deprecated — use indexMethod instead.
Deprecated: This attribute is deprecated.
indexMethod AiSearchInstanceIndexMethod: Controls which storage backends are used during indexing. Defaults to vector-only.
indexingOptions AiSearchInstanceIndexingOptions
lastActivity String
maxNumResults Integer
metadata AiSearchInstanceMetadata
modifiedAt String
modifiedBy String
namespace String
paused Boolean
publicEndpointId String
publicEndpointParams AiSearchInstancePublicEndpointParams
reranking Boolean
rerankingModel String: Available values: "@cf/baai/bge-reranker-base", "".
retrievalOptions AiSearchInstanceRetrievalOptions
rewriteModel String: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
rewriteQuery Boolean
scoreThreshold Double
source String
sourceParams AiSearchInstanceSourceParams
status String
summarization Boolean
summarizationModel String: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
syncInterval Double: Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h). Available values: 900, 1800, 3600, 7200, 14400, 21600, 43200, 86400.
systemPromptAisearch String
systemPromptIndexSummarization String
systemPromptRewriteQuery String
tokenId String
type String: Available values: "r2", "web-crawler".
vectorizeName String

accountId string
aiGatewayId string
aiSearchInstanceId string: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
aisearchModel string: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
cache boolean
cacheThreshold string: Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
chunk boolean
chunkOverlap number
chunkSize number
createdAt string
createdBy string
customMetadatas AiSearchInstanceCustomMetadata[]
embeddingModel string: Available values: "@cf/qwen/qwen3-embedding-0.6b", "@cf/baai/bge-m3", "@cf/baai/bge-large-en-v1.5", "@cf/google/embeddinggemma-300m", "google-ai-studio/gemini-embedding-001", "google-ai-studio/gemini-embedding-2-preview", "openai/text-embedding-3-small", "openai/text-embedding-3-large", "".
enable boolean
engineVersion number
fusionMethod string: Available values: "max", "rrf".
hybridSearchEnabled boolean: Deprecated — use indexMethod instead.
Deprecated: This attribute is deprecated.
indexMethod AiSearchInstanceIndexMethod: Controls which storage backends are used during indexing. Defaults to vector-only.
indexingOptions AiSearchInstanceIndexingOptions
lastActivity string
maxNumResults number
metadata AiSearchInstanceMetadata
modifiedAt string
modifiedBy string
namespace string
paused boolean
publicEndpointId string
publicEndpointParams AiSearchInstancePublicEndpointParams
reranking boolean
rerankingModel string: Available values: "@cf/baai/bge-reranker-base", "".
retrievalOptions AiSearchInstanceRetrievalOptions
rewriteModel string: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
rewriteQuery boolean
scoreThreshold number
source string
sourceParams AiSearchInstanceSourceParams
status string
summarization boolean
summarizationModel string: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
syncInterval number: Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h). Available values: 900, 1800, 3600, 7200, 14400, 21600, 43200, 86400.
systemPromptAisearch string
systemPromptIndexSummarization string
systemPromptRewriteQuery string
tokenId string
type string: Available values: "r2", "web-crawler".
vectorizeName string

account_id str
ai_gateway_id str
ai_search_instance_id str: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
aisearch_model str: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
cache bool
cache_threshold str: Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
chunk bool
chunk_overlap int
chunk_size int
created_at str
created_by str
custom_metadatas Sequence[AiSearchInstanceCustomMetadataArgs]
embedding_model str: Available values: "@cf/qwen/qwen3-embedding-0.6b", "@cf/baai/bge-m3", "@cf/baai/bge-large-en-v1.5", "@cf/google/embeddinggemma-300m", "google-ai-studio/gemini-embedding-001", "google-ai-studio/gemini-embedding-2-preview", "openai/text-embedding-3-small", "openai/text-embedding-3-large", "".
enable bool
engine_version float
fusion_method str: Available values: "max", "rrf".
hybrid_search_enabled bool: Deprecated — use indexMethod instead.
Deprecated: This attribute is deprecated.
index_method AiSearchInstanceIndexMethodArgs: Controls which storage backends are used during indexing. Defaults to vector-only.
indexing_options AiSearchInstanceIndexingOptionsArgs
last_activity str
max_num_results int
metadata AiSearchInstanceMetadataArgs
modified_at str
modified_by str
namespace str
paused bool
public_endpoint_id str
public_endpoint_params AiSearchInstancePublicEndpointParamsArgs
reranking bool
reranking_model str: Available values: "@cf/baai/bge-reranker-base", "".
retrieval_options AiSearchInstanceRetrievalOptionsArgs
rewrite_model str: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
rewrite_query bool
score_threshold float
source str
source_params AiSearchInstanceSourceParamsArgs
status str
summarization bool
summarization_model str: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
sync_interval float: Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h). Available values: 900, 1800, 3600, 7200, 14400, 21600, 43200, 86400.
system_prompt_aisearch str
system_prompt_index_summarization str
system_prompt_rewrite_query str
token_id str
type str: Available values: "r2", "web-crawler".
vectorize_name str

accountId String
aiGatewayId String
aiSearchInstanceId String: AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
aisearchModel String: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
cache Boolean
cacheThreshold String: Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
chunk Boolean
chunkOverlap Number
chunkSize Number
createdAt String
createdBy String
customMetadatas List<Property Map>
embeddingModel String: Available values: "@cf/qwen/qwen3-embedding-0.6b", "@cf/baai/bge-m3", "@cf/baai/bge-large-en-v1.5", "@cf/google/embeddinggemma-300m", "google-ai-studio/gemini-embedding-001", "google-ai-studio/gemini-embedding-2-preview", "openai/text-embedding-3-small", "openai/text-embedding-3-large", "".
enable Boolean
engineVersion Number
fusionMethod String: Available values: "max", "rrf".
hybridSearchEnabled Boolean: Deprecated — use indexMethod instead.
Deprecated: This attribute is deprecated.
indexMethod Property Map: Controls which storage backends are used during indexing. Defaults to vector-only.
indexingOptions Property Map
lastActivity String
maxNumResults Number
metadata Property Map
modifiedAt String
modifiedBy String
namespace String
paused Boolean
publicEndpointId String
publicEndpointParams Property Map
reranking Boolean
rerankingModel String: Available values: "@cf/baai/bge-reranker-base", "".
retrievalOptions Property Map
rewriteModel String: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
rewriteQuery Boolean
scoreThreshold Number
source String
sourceParams Property Map
status String
summarization Boolean
summarizationModel String: Available values: "@cf/meta/llama-3.3-70b-instruct-fp8-fast", "@cf/zai-org/glm-4.7-flash", "@cf/meta/llama-3.1-8b-instruct-fast", "@cf/meta/llama-3.1-8b-instruct-fp8", "@cf/meta/llama-4-scout-17b-16e-instruct", "@cf/qwen/qwen3-30b-a3b-fp8", "@cf/deepseek-ai/deepseek-r1-distill-qwen-32b", "@cf/moonshotai/kimi-k2-instruct", "@cf/google/gemma-3-12b-it", "@cf/google/gemma-4-26b-a4b-it", "@cf/moonshotai/kimi-k2.5", "anthropic/claude-3-7-sonnet", "anthropic/claude-sonnet-4", "anthropic/claude-opus-4", "anthropic/claude-3-5-haiku", "cerebras/qwen-3-235b-a22b-instruct", "cerebras/qwen-3-235b-a22b-thinking", "cerebras/llama-3.3-70b", "cerebras/llama-4-maverick-17b-128e-instruct", "cerebras/llama-4-scout-17b-16e-instruct", "cerebras/gpt-oss-120b", "google-ai-studio/gemini-2.5-flash", "google-ai-studio/gemini-2.5-pro", "grok/grok-4", "groq/llama-3.3-70b-versatile", "groq/llama-3.1-8b-instant", "openai/gpt-5", "openai/gpt-5-mini", "openai/gpt-5-nano", "".
syncInterval Number: Interval between automatic syncs, in seconds. Allowed values: 900 (15min), 1800 (30min), 3600 (1h), 7200 (2h), 14400 (4h), 21600 (6h), 43200 (12h), 86400 (24h). Available values: 900, 1800, 3600, 7200, 14400, 21600, 43200, 86400.
systemPromptAisearch String
systemPromptIndexSummarization String
systemPromptRewriteQuery String
tokenId String
type String: Available values: "r2", "web-crawler".
vectorizeName String

Supporting Types

AiSearchInstanceCustomMetadata, AiSearchInstanceCustomMetadataArgs

DataType string: Available values: "text", "number", "boolean", "datetime".
FieldName string

DataType string: Available values: "text", "number", "boolean", "datetime".
FieldName string

dataType String: Available values: "text", "number", "boolean", "datetime".
fieldName String

dataType string: Available values: "text", "number", "boolean", "datetime".
fieldName string

data_type str: Available values: "text", "number", "boolean", "datetime".
field_name str

dataType String: Available values: "text", "number", "boolean", "datetime".
fieldName String

AiSearchInstanceIndexMethod, AiSearchInstanceIndexMethodArgs

Keyword bool: Enable keyword (BM25) storage backend.
Vector bool: Enable vector (embedding) storage backend.

Keyword bool: Enable keyword (BM25) storage backend.
Vector bool: Enable vector (embedding) storage backend.

keyword Boolean: Enable keyword (BM25) storage backend.
vector Boolean: Enable vector (embedding) storage backend.

keyword boolean: Enable keyword (BM25) storage backend.
vector boolean: Enable vector (embedding) storage backend.

keyword bool: Enable keyword (BM25) storage backend.
vector bool: Enable vector (embedding) storage backend.

keyword Boolean: Enable keyword (BM25) storage backend.
vector Boolean: Enable vector (embedding) storage backend.

AiSearchInstanceIndexingOptions, AiSearchInstanceIndexingOptionsArgs

KeywordTokenizer 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. Available values: "porter", "trigram".

KeywordTokenizer 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. Available values: "porter", "trigram".

keywordTokenizer 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. Available values: "porter", "trigram".

keywordTokenizer 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. Available values: "porter", "trigram".

keyword_tokenizer str: 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. Available values: "porter", "trigram".

keywordTokenizer 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. Available values: "porter", "trigram".

AiSearchInstanceMetadata, AiSearchInstanceMetadataArgs

CreatedFromAisearchWizard bool
SearchForAgents AiSearchInstanceMetadataSearchForAgents
WorkerDomain string

CreatedFromAisearchWizard bool
SearchForAgents AiSearchInstanceMetadataSearchForAgents
WorkerDomain string

createdFromAisearchWizard Boolean
searchForAgents AiSearchInstanceMetadataSearchForAgents
workerDomain String

createdFromAisearchWizard boolean
searchForAgents AiSearchInstanceMetadataSearchForAgents
workerDomain string

created_from_aisearch_wizard bool
search_for_agents AiSearchInstanceMetadataSearchForAgents
worker_domain str

createdFromAisearchWizard Boolean
searchForAgents Property Map
workerDomain String

AiSearchInstanceMetadataSearchForAgents, AiSearchInstanceMetadataSearchForAgentsArgs

Hostname string
ZoneId string
ZoneName string

Hostname string
ZoneId string
ZoneName string

hostname String
zoneId String
zoneName String

hostname string
zoneId string
zoneName string

hostname str
zone_id str
zone_name str

hostname String
zoneId String
zoneName String

AiSearchInstancePublicEndpointParams, AiSearchInstancePublicEndpointParamsArgs

AuthorizedHosts List<string>
ChatCompletionsEndpoint AiSearchInstancePublicEndpointParamsChatCompletionsEndpoint
Enabled bool
Mcp AiSearchInstancePublicEndpointParamsMcp
RateLimit AiSearchInstancePublicEndpointParamsRateLimit
SearchEndpoint AiSearchInstancePublicEndpointParamsSearchEndpoint

AuthorizedHosts []string
ChatCompletionsEndpoint AiSearchInstancePublicEndpointParamsChatCompletionsEndpoint
Enabled bool
Mcp AiSearchInstancePublicEndpointParamsMcp
RateLimit AiSearchInstancePublicEndpointParamsRateLimit
SearchEndpoint AiSearchInstancePublicEndpointParamsSearchEndpoint

authorizedHosts List<String>
chatCompletionsEndpoint AiSearchInstancePublicEndpointParamsChatCompletionsEndpoint
enabled Boolean
mcp AiSearchInstancePublicEndpointParamsMcp
rateLimit AiSearchInstancePublicEndpointParamsRateLimit
searchEndpoint AiSearchInstancePublicEndpointParamsSearchEndpoint

authorizedHosts string[]
chatCompletionsEndpoint AiSearchInstancePublicEndpointParamsChatCompletionsEndpoint
enabled boolean
mcp AiSearchInstancePublicEndpointParamsMcp
rateLimit AiSearchInstancePublicEndpointParamsRateLimit
searchEndpoint AiSearchInstancePublicEndpointParamsSearchEndpoint

authorized_hosts Sequence[str]
chat_completions_endpoint AiSearchInstancePublicEndpointParamsChatCompletionsEndpoint
enabled bool
mcp AiSearchInstancePublicEndpointParamsMcp
rate_limit AiSearchInstancePublicEndpointParamsRateLimit
search_endpoint AiSearchInstancePublicEndpointParamsSearchEndpoint

authorizedHosts List<String>
chatCompletionsEndpoint Property Map
enabled Boolean
mcp Property Map
rateLimit Property Map
searchEndpoint Property Map

AiSearchInstancePublicEndpointParamsChatCompletionsEndpoint, AiSearchInstancePublicEndpointParamsChatCompletionsEndpointArgs

Disabled bool: Disable chat completions endpoint for this public endpoint

Disabled bool: Disable chat completions endpoint for this public endpoint

disabled Boolean: Disable chat completions endpoint for this public endpoint

disabled boolean: Disable chat completions endpoint for this public endpoint

disabled bool: Disable chat completions endpoint for this public endpoint

disabled Boolean: Disable chat completions endpoint for this public endpoint

AiSearchInstancePublicEndpointParamsMcp, AiSearchInstancePublicEndpointParamsMcpArgs

Description string
Disabled bool: Disable MCP endpoint for this public endpoint

Description string
Disabled bool: Disable MCP endpoint for this public endpoint

description String
disabled Boolean: Disable MCP endpoint for this public endpoint

description string
disabled boolean: Disable MCP endpoint for this public endpoint

description str
disabled bool: Disable MCP endpoint for this public endpoint

description String
disabled Boolean: Disable MCP endpoint for this public endpoint

AiSearchInstancePublicEndpointParamsRateLimit, AiSearchInstancePublicEndpointParamsRateLimitArgs

PeriodMs int
Requests int
Technique string: Available values: "fixed", "sliding".

PeriodMs int
Requests int
Technique string: Available values: "fixed", "sliding".

periodMs Integer
requests Integer
technique String: Available values: "fixed", "sliding".

periodMs number
requests number
technique string: Available values: "fixed", "sliding".

period_ms int
requests int
technique str: Available values: "fixed", "sliding".

periodMs Number
requests Number
technique String: Available values: "fixed", "sliding".

AiSearchInstancePublicEndpointParamsSearchEndpoint, AiSearchInstancePublicEndpointParamsSearchEndpointArgs

Disabled bool: Disable search endpoint for this public endpoint

Disabled bool: Disable search endpoint for this public endpoint

disabled Boolean: Disable search endpoint for this public endpoint

disabled boolean: Disable search endpoint for this public endpoint

disabled bool: Disable search endpoint for this public endpoint

disabled Boolean: Disable search endpoint for this public endpoint

AiSearchInstanceRetrievalOptions, AiSearchInstanceRetrievalOptionsArgs

BoostBies List<AiSearchInstanceRetrievalOptionsBoostBy>: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom*metadata field.
KeywordMatchMode 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'. Available values: "and", "or".

BoostBies []AiSearchInstanceRetrievalOptionsBoostBy: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom*metadata field.
KeywordMatchMode 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'. Available values: "and", "or".

boostBies List<AiSearchInstanceRetrievalOptionsBoostBy>: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom*metadata field.
keywordMatchMode 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'. Available values: "and", "or".

boostBies AiSearchInstanceRetrievalOptionsBoostBy[]: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom*metadata field.
keywordMatchMode 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'. Available values: "and", "or".

boost_bies Sequence[AiSearchInstanceRetrievalOptionsBoostBy]: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom*metadata field.
keyword_match_mode str: 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'. Available values: "and", "or".

boostBies List<Property Map>: Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom*metadata field.
keywordMatchMode 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'. Available values: "and", "or".

AiSearchInstanceRetrievalOptionsBoostBy, AiSearchInstanceRetrievalOptionsBoostByArgs

Field string: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custommetadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/notexists.
Direction string: Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'notexists' = boost chunks that lack the field. Optional - defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Available values: "asc", "desc", "exists", "notexists".

Field string: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custommetadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/notexists.
Direction string: Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'notexists' = boost chunks that lack the field. Optional - defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Available values: "asc", "desc", "exists", "notexists".

field String: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custommetadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/notexists.
direction String: Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'notexists' = boost chunks that lack the field. Optional - defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Available values: "asc", "desc", "exists", "notexists".

field string: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custommetadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/notexists.
direction string: Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'notexists' = boost chunks that lack the field. Optional - defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Available values: "asc", "desc", "exists", "notexists".

field str: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custommetadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/notexists.
direction str: Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'notexists' = boost chunks that lack the field. Optional - defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Available values: "asc", "desc", "exists", "notexists".

field String: Metadata field name to boost by. Use 'timestamp' for document freshness, or any custommetadata field. Numeric and datetime fields support asc/desc directions; text/boolean fields support exists/notexists.
direction String: Boost direction. 'desc' = higher values rank higher (e.g. newer timestamps). 'asc' = lower values rank higher. 'exists' = boost chunks that have the field. 'notexists' = boost chunks that lack the field. Optional - defaults to 'asc' for numeric/datetime fields, 'exists' for text/boolean fields. Available values: "asc", "desc", "exists", "notexists".

AiSearchInstanceSourceParams, AiSearchInstanceSourceParamsArgs

ExcludeItems List<string>: 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)
IncludeItems List<string>: 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)
Prefix string
R2Jurisdiction string
WebCrawler AiSearchInstanceSourceParamsWebCrawler

ExcludeItems []string: 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)
IncludeItems []string: 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)
Prefix string
R2Jurisdiction string
WebCrawler AiSearchInstanceSourceParamsWebCrawler

excludeItems List<String>: 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)
includeItems List<String>: 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)
prefix String
r2Jurisdiction String
webCrawler AiSearchInstanceSourceParamsWebCrawler

excludeItems string[]: 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)
includeItems string[]: 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)
prefix string
r2Jurisdiction string
webCrawler AiSearchInstanceSourceParamsWebCrawler

exclude_items Sequence[str]: 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)
include_items Sequence[str]: 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)
prefix str
r2_jurisdiction str
web_crawler AiSearchInstanceSourceParamsWebCrawler

excludeItems List<String>: 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)
includeItems List<String>: 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)
prefix String
r2Jurisdiction String
webCrawler Property Map

AiSearchInstanceSourceParamsWebCrawler, AiSearchInstanceSourceParamsWebCrawlerArgs

CrawlOptions AiSearchInstanceSourceParamsWebCrawlerCrawlOptions
ParseOptions AiSearchInstanceSourceParamsWebCrawlerParseOptions
ParseType string: Available values: "sitemap", "feed-rss", "crawl".
StoreOptions AiSearchInstanceSourceParamsWebCrawlerStoreOptions

CrawlOptions AiSearchInstanceSourceParamsWebCrawlerCrawlOptions
ParseOptions AiSearchInstanceSourceParamsWebCrawlerParseOptions
ParseType string: Available values: "sitemap", "feed-rss", "crawl".
StoreOptions AiSearchInstanceSourceParamsWebCrawlerStoreOptions

crawlOptions AiSearchInstanceSourceParamsWebCrawlerCrawlOptions
parseOptions AiSearchInstanceSourceParamsWebCrawlerParseOptions
parseType String: Available values: "sitemap", "feed-rss", "crawl".
storeOptions AiSearchInstanceSourceParamsWebCrawlerStoreOptions

crawlOptions AiSearchInstanceSourceParamsWebCrawlerCrawlOptions
parseOptions AiSearchInstanceSourceParamsWebCrawlerParseOptions
parseType string: Available values: "sitemap", "feed-rss", "crawl".
storeOptions AiSearchInstanceSourceParamsWebCrawlerStoreOptions

crawl_options AiSearchInstanceSourceParamsWebCrawlerCrawlOptions
parse_options AiSearchInstanceSourceParamsWebCrawlerParseOptions
parse_type str: Available values: "sitemap", "feed-rss", "crawl".
store_options AiSearchInstanceSourceParamsWebCrawlerStoreOptions

crawlOptions Property Map
parseOptions Property Map
parseType String: Available values: "sitemap", "feed-rss", "crawl".
storeOptions Property Map

AiSearchInstanceSourceParamsWebCrawlerCrawlOptions, AiSearchInstanceSourceParamsWebCrawlerCrawlOptionsArgs

Depth double
IncludeExternalLinks bool
IncludeSubdomains bool
MaxAge double
Source string: Available values: "all", "sitemaps", "links".

Depth float64
IncludeExternalLinks bool
IncludeSubdomains bool
MaxAge float64
Source string: Available values: "all", "sitemaps", "links".

depth Double
includeExternalLinks Boolean
includeSubdomains Boolean
maxAge Double
source String: Available values: "all", "sitemaps", "links".

depth number
includeExternalLinks boolean
includeSubdomains boolean
maxAge number
source string: Available values: "all", "sitemaps", "links".

depth float
include_external_links bool
include_subdomains bool
max_age float
source str: Available values: "all", "sitemaps", "links".

depth Number
includeExternalLinks Boolean
includeSubdomains Boolean
maxAge Number
source String: Available values: "all", "sitemaps", "links".

AiSearchInstanceSourceParamsWebCrawlerParseOptions, AiSearchInstanceSourceParamsWebCrawlerParseOptionsArgs

ContentSelectors List<AiSearchInstanceSourceParamsWebCrawlerParseOptionsContentSelector>: 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.
IncludeHeaders Dictionary<string, string>
IncludeImages bool
SpecificSitemaps List<string>: List of specific sitemap URLs to use for crawling. Only valid when parseType is 'sitemap'.
UseBrowserRendering bool

ContentSelectors []AiSearchInstanceSourceParamsWebCrawlerParseOptionsContentSelector: 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.
IncludeHeaders map[string]string
IncludeImages bool
SpecificSitemaps []string: List of specific sitemap URLs to use for crawling. Only valid when parseType is 'sitemap'.
UseBrowserRendering bool

contentSelectors List<AiSearchInstanceSourceParamsWebCrawlerParseOptionsContentSelector>: 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.
includeHeaders Map<String,String>
includeImages Boolean
specificSitemaps List<String>: List of specific sitemap URLs to use for crawling. Only valid when parseType is 'sitemap'.
useBrowserRendering Boolean

contentSelectors AiSearchInstanceSourceParamsWebCrawlerParseOptionsContentSelector[]: 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.
includeHeaders {[key: string]: string}
includeImages boolean
specificSitemaps string[]: List of specific sitemap URLs to use for crawling. Only valid when parseType is 'sitemap'.
useBrowserRendering boolean

content_selectors Sequence[AiSearchInstanceSourceParamsWebCrawlerParseOptionsContentSelector]: 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.
include_headers Mapping[str, str]
include_images bool
specific_sitemaps Sequence[str]: List of specific sitemap URLs to use for crawling. Only valid when parseType is 'sitemap'.
use_browser_rendering bool

contentSelectors List<Property Map>: 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.
includeHeaders Map<String>
includeImages Boolean
specificSitemaps List<String>: List of specific sitemap URLs to use for crawling. Only valid when parseType is 'sitemap'.
useBrowserRendering Boolean

AiSearchInstanceSourceParamsWebCrawlerParseOptionsContentSelector, AiSearchInstanceSourceParamsWebCrawlerParseOptionsContentSelectorArgs

Path string: Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.
Selector string: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors.

Path string: Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.
Selector string: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors.

path String: Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.
selector String: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors.

path string: Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.
selector string: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors.

path str: Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.
selector str: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors.

path String: Glob pattern to match against the page URL path. Uses standard glob syntax: * matches within a segment, ** crosses directories.
selector String: CSS selector to extract content from pages matching the path pattern. Supports standard CSS selectors including class, ID, element, and attribute selectors.

AiSearchInstanceSourceParamsWebCrawlerStoreOptions, AiSearchInstanceSourceParamsWebCrawlerStoreOptionsArgs

StorageId string
R2Jurisdiction string
StorageType string: Available values: "r2".

StorageId string
R2Jurisdiction string
StorageType string: Available values: "r2".

storageId String
r2Jurisdiction String
storageType String: Available values: "r2".

storageId string
r2Jurisdiction string
storageType string: Available values: "r2".

storage_id str
r2_jurisdiction str
storage_type str: Available values: "r2".

storageId String
r2Jurisdiction String
storageType String: Available values: "r2".

Package Details

Repository: Cloudflare pulumi/pulumi-cloudflare
License: Apache-2.0
Notes: This Pulumi package is based on the cloudflare Terraform Provider.

Viewing docs for Cloudflare v6.15.0
published on Saturday, May 2, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-cloudflare

cloudflare.AiSearchInstance

On this page

On this page

Import

Create AiSearchInstance Resource

Constructor syntax

Parameters

Constructor example

AiSearchInstance Resource Properties

Inputs

Outputs

Look up Existing AiSearchInstance Resource

Supporting Types

AiSearchInstanceCustomMetadata, AiSearchInstanceCustomMetadataArgs

AiSearchInstanceIndexMethod, AiSearchInstanceIndexMethodArgs

AiSearchInstanceIndexingOptions, AiSearchInstanceIndexingOptionsArgs

AiSearchInstanceMetadata, AiSearchInstanceMetadataArgs

AiSearchInstanceMetadataSearchForAgents, AiSearchInstanceMetadataSearchForAgentsArgs

AiSearchInstancePublicEndpointParams, AiSearchInstancePublicEndpointParamsArgs

AiSearchInstancePublicEndpointParamsChatCompletionsEndpoint, AiSearchInstancePublicEndpointParamsChatCompletionsEndpointArgs

AiSearchInstancePublicEndpointParamsMcp, AiSearchInstancePublicEndpointParamsMcpArgs

AiSearchInstancePublicEndpointParamsRateLimit, AiSearchInstancePublicEndpointParamsRateLimitArgs

AiSearchInstancePublicEndpointParamsSearchEndpoint, AiSearchInstancePublicEndpointParamsSearchEndpointArgs

AiSearchInstanceRetrievalOptions, AiSearchInstanceRetrievalOptionsArgs

AiSearchInstanceRetrievalOptionsBoostBy, AiSearchInstanceRetrievalOptionsBoostByArgs

AiSearchInstanceSourceParams, AiSearchInstanceSourceParamsArgs

AiSearchInstanceSourceParamsWebCrawler, AiSearchInstanceSourceParamsWebCrawlerArgs

AiSearchInstanceSourceParamsWebCrawlerCrawlOptions, AiSearchInstanceSourceParamsWebCrawlerCrawlOptionsArgs

AiSearchInstanceSourceParamsWebCrawlerParseOptions, AiSearchInstanceSourceParamsWebCrawlerParseOptionsArgs

AiSearchInstanceSourceParamsWebCrawlerParseOptionsContentSelector, AiSearchInstanceSourceParamsWebCrawlerParseOptionsContentSelectorArgs

AiSearchInstanceSourceParamsWebCrawlerStoreOptions, AiSearchInstanceSourceParamsWebCrawlerStoreOptionsArgs

Package Details

On this page

On this page