Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Cloudflare Provider
  4. API Docs
  5. AiSearchInstance
Viewing docs for Cloudflare v6.23.1
published on Wednesday, Oct 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-cloudflare

cloudflare.AiSearchInstance

cloudflare logo cloudflare logo
Viewing docs for Cloudflare v6.23.1
published on Wednesday, Oct 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-cloudflare

    Import

    $ pulumi import cloudflare:index/aiSearchInstance:AiSearchInstance example '<account_id>/<id>'

    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,
                     paused: Optional[bool] = None,
                     public_endpoint_params: Optional[AiSearchInstancePublicEndpointParamsArgs] = None,
                     cache: Optional[bool] = None,
                     cache_threshold: Optional[str] = None,
                     cache_ttl: Optional[float] = 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,
                     reranking: Optional[bool] = None,
                     hybrid_search_enabled: Optional[bool] = None,
                     index_method: Optional[AiSearchInstanceIndexMethodArgs] = None,
                     indexing_options: Optional[AiSearchInstanceIndexingOptionsArgs] = None,
                     max_num_results: Optional[int] = None,
                     metadata: Optional[AiSearchInstanceMetadataArgs] = None,
                     aisearch_model: Optional[str] = None,
                     ai_gateway_id: Optional[str] = None,
                     fusion_method: Optional[str] = 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,
                     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.


    resource "cloudflare_ai_search_instance" "name" {
    # resource properties
}

    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",
    Paused = false,
    PublicEndpointParams = new Cloudflare.Inputs.AiSearchInstancePublicEndpointParamsArgs
    {
        AuthorizedHosts = new[]
        {
            "string",
        },
        ChatCompletionsEndpoint = new Cloudflare.Inputs.AiSearchInstancePublicEndpointParamsChatCompletionsEndpointArgs
        {
            Disabled = false,
        },
        CustomDomains = new[]
        {
            "string",
        },
        DefaultDomainEnabled = 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,
        },
    },
    Cache = false,
    CacheThreshold = "string",
    CacheTtl = 0.0,
    Chunk = false,
    ChunkOverlap = 0,
    ChunkSize = 0,
    CustomMetadatas = new[]
    {
        new Cloudflare.Inputs.AiSearchInstanceCustomMetadataArgs
        {
            DataType = "string",
            FieldName = "string",
        },
    },
    EmbeddingModel = "string",
    Reranking = false,
    IndexMethod = new Cloudflare.Inputs.AiSearchInstanceIndexMethodArgs
    {
        Keyword = false,
        Vector = false,
    },
    IndexingOptions = new Cloudflare.Inputs.AiSearchInstanceIndexingOptionsArgs
    {
        KeywordTokenizer = "string",
        UseOcr = false,
    },
    MaxNumResults = 0,
    Metadata = new Cloudflare.Inputs.AiSearchInstanceMetadataArgs
    {
        CreatedFromAisearchWizard = false,
        CreatedFromEmdashPlugin = new Cloudflare.Inputs.AiSearchInstanceMetadataCreatedFromEmdashPluginArgs
        {
            Type = "string",
            Version = "string",
        },
        WorkerDomain = "string",
    },
    AisearchModel = "string",
    AiGatewayId = "string",
    FusionMethod = "string",
    RerankingModel = "string",
    RetrievalOptions = new Cloudflare.Inputs.AiSearchInstanceRetrievalOptionsArgs
    {
        BoostBies = new[]
        {
            new Cloudflare.Inputs.AiSearchInstanceRetrievalOptionsBoostByArgs
            {
                Field = "string",
                Direction = "string",
            },
        },
        KeywordMatchMode = "string",
    },
    RewriteModel = "string",
    RewriteQuery = false,
    ScoreThreshold = 0.0,
    Source = "string",
    SourceParams = new Cloudflare.Inputs.AiSearchInstanceSourceParamsArgs
    {
        ExcludeItems = new[]
        {
            "string",
        },
        IncludeItems = new[]
        {
            "string",
        },
        Prefix = "string",
        R2Jurisdiction = "string",
        WebCrawler = new Cloudflare.Inputs.AiSearchInstanceSourceParamsWebCrawlerArgs
        {
            StoreOptions = new Cloudflare.Inputs.AiSearchInstanceSourceParamsWebCrawlerStoreOptionsArgs
            {
                R2Jurisdiction = "string",
                StorageId = "string",
                StorageType = "string",
            },
            DiscoverOptions = new Cloudflare.Inputs.AiSearchInstanceSourceParamsWebCrawlerDiscoverOptionsArgs
            {
                Depth = 0.0,
                IncludeExternalLinks = false,
                IncludeSubdomains = false,
                Limit = 0.0,
                MaxAge = 0.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",
        },
    },
    Summarization = false,
    SummarizationModel = "string",
    SyncInterval = 0.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"),
	Paused:             pulumi.Bool(false),
	PublicEndpointParams: &cloudflare.AiSearchInstancePublicEndpointParamsArgs{
		AuthorizedHosts: pulumi.StringArray{
			pulumi.String("string"),
		},
		ChatCompletionsEndpoint: &cloudflare.AiSearchInstancePublicEndpointParamsChatCompletionsEndpointArgs{
			Disabled: pulumi.Bool(false),
		},
		CustomDomains: pulumi.StringArray{
			pulumi.String("string"),
		},
		DefaultDomainEnabled: 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),
		},
	},
	Cache:          pulumi.Bool(false),
	CacheThreshold: pulumi.String("string"),
	CacheTtl:       pulumi.Float64(0),
	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"),
	Reranking:      pulumi.Bool(false),
	IndexMethod: &cloudflare.AiSearchInstanceIndexMethodArgs{
		Keyword: pulumi.Bool(false),
		Vector:  pulumi.Bool(false),
	},
	IndexingOptions: &cloudflare.AiSearchInstanceIndexingOptionsArgs{
		KeywordTokenizer: pulumi.String("string"),
		UseOcr:           pulumi.Bool(false),
	},
	MaxNumResults: pulumi.Int(0),
	Metadata: &cloudflare.AiSearchInstanceMetadataArgs{
		CreatedFromAisearchWizard: pulumi.Bool(false),
		CreatedFromEmdashPlugin: &cloudflare.AiSearchInstanceMetadataCreatedFromEmdashPluginArgs{
			Type:    pulumi.String("string"),
			Version: pulumi.String("string"),
		},
		WorkerDomain: pulumi.String("string"),
	},
	AisearchModel:  pulumi.String("string"),
	AiGatewayId:    pulumi.String("string"),
	FusionMethod:   pulumi.String("string"),
	RerankingModel: pulumi.String("string"),
	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{
			StoreOptions: &cloudflare.AiSearchInstanceSourceParamsWebCrawlerStoreOptionsArgs{
				R2Jurisdiction: pulumi.String("string"),
				StorageId:      pulumi.String("string"),
				StorageType:    pulumi.String("string"),
			},
			DiscoverOptions: &cloudflare.AiSearchInstanceSourceParamsWebCrawlerDiscoverOptionsArgs{
				Depth:                pulumi.Float64(0),
				IncludeExternalLinks: pulumi.Bool(false),
				IncludeSubdomains:    pulumi.Bool(false),
				Limit:                pulumi.Float64(0),
				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"),
		},
	},
	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"),
})

    resource "cloudflare_ai_search_instance" "aiSearchInstanceResource" {
  lifecycle {
    create_before_destroy = true
  }
  ai_search_instance_id = "string"
  account_id            = "string"
  paused                = false
  public_endpoint_params = {
    authorized_hosts = ["string"]
    chat_completions_endpoint = {
      disabled = false
    }
    custom_domains         = ["string"]
    default_domain_enabled = false
    enabled                = false
    mcp = {
      description = "string"
      disabled    = false
    }
    rate_limit = {
      period_ms = 0
      requests  = 0
      technique = "string"
    }
    search_endpoint = {
      disabled = false
    }
  }
  cache           = false
  cache_threshold = "string"
  cache_ttl       = 0
  chunk           = false
  chunk_overlap   = 0
  chunk_size      = 0
  custom_metadatas {
    data_type  = "string"
    field_name = "string"
  }
  embedding_model = "string"
  reranking       = false
  index_method = {
    keyword = false
    vector  = false
  }
  indexing_options = {
    keyword_tokenizer = "string"
    use_ocr           = false
  }
  max_num_results = 0
  metadata = {
    created_from_aisearch_wizard = false
    created_from_emdash_plugin = {
      type    = "string"
      version = "string"
    }
    worker_domain = "string"
  }
  aisearch_model  = "string"
  ai_gateway_id   = "string"
  fusion_method   = "string"
  reranking_model = "string"
  retrieval_options = {
    boost_bies = [{
      field     = "string"
      direction = "string"
    }]
    keyword_match_mode = "string"
  }
  rewrite_model   = "string"
  rewrite_query   = false
  score_threshold = 0
  source          = "string"
  source_params = {
    exclude_items   = ["string"]
    include_items   = ["string"]
    prefix          = "string"
    r2_jurisdiction = "string"
    web_crawler = {
      store_options = {
        r2_jurisdiction = "string"
        storage_id      = "string"
        storage_type    = "string"
      }
      discover_options = {
        depth                  = 0
        include_external_links = false
        include_subdomains     = false
        limit                  = 0
        max_age                = 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"
    }
  }
  summarization                     = false
  summarization_model               = "string"
  sync_interval                     = 0
  system_prompt_aisearch            = "string"
  system_prompt_index_summarization = "string"
  system_prompt_rewrite_query       = "string"
  token_id                          = "string"
  type                              = "string"
}

    var aiSearchInstanceResource = new AiSearchInstance("aiSearchInstanceResource", AiSearchInstanceArgs.builder()
    .aiSearchInstanceId("string")
    .accountId("string")
    .paused(false)
    .publicEndpointParams(AiSearchInstancePublicEndpointParamsArgs.builder()
        .authorizedHosts("string")
        .chatCompletionsEndpoint(AiSearchInstancePublicEndpointParamsChatCompletionsEndpointArgs.builder()
            .disabled(false)
            .build())
        .customDomains("string")
        .defaultDomainEnabled(false)
        .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())
    .cache(false)
    .cacheThreshold("string")
    .cacheTtl(0.0)
    .chunk(false)
    .chunkOverlap(0)
    .chunkSize(0)
    .customMetadatas(AiSearchInstanceCustomMetadataArgs.builder()
        .dataType("string")
        .fieldName("string")
        .build())
    .embeddingModel("string")
    .reranking(false)
    .indexMethod(AiSearchInstanceIndexMethodArgs.builder()
        .keyword(false)
        .vector(false)
        .build())
    .indexingOptions(AiSearchInstanceIndexingOptionsArgs.builder()
        .keywordTokenizer("string")
        .useOcr(false)
        .build())
    .maxNumResults(0)
    .metadata(AiSearchInstanceMetadataArgs.builder()
        .createdFromAisearchWizard(false)
        .createdFromEmdashPlugin(AiSearchInstanceMetadataCreatedFromEmdashPluginArgs.builder()
            .type("string")
            .version("string")
            .build())
        .workerDomain("string")
        .build())
    .aisearchModel("string")
    .aiGatewayId("string")
    .fusionMethod("string")
    .rerankingModel("string")
    .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()
            .storeOptions(AiSearchInstanceSourceParamsWebCrawlerStoreOptionsArgs.builder()
                .r2Jurisdiction("string")
                .storageId("string")
                .storageType("string")
                .build())
            .discoverOptions(AiSearchInstanceSourceParamsWebCrawlerDiscoverOptionsArgs.builder()
                .depth(0.0)
                .includeExternalLinks(false)
                .includeSubdomains(false)
                .limit(0.0)
                .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")
            .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",
    paused=False,
    public_endpoint_params={
        "authorized_hosts": ["string"],
        "chat_completions_endpoint": {
            "disabled": False,
        },
        "custom_domains": ["string"],
        "default_domain_enabled": False,
        "enabled": False,
        "mcp": {
            "description": "string",
            "disabled": False,
        },
        "rate_limit": {
            "period_ms": 0,
            "requests": 0,
            "technique": "string",
        },
        "search_endpoint": {
            "disabled": False,
        },
    },
    cache=False,
    cache_threshold="string",
    cache_ttl=float(0),
    chunk=False,
    chunk_overlap=0,
    chunk_size=0,
    custom_metadatas=[{
        "data_type": "string",
        "field_name": "string",
    }],
    embedding_model="string",
    reranking=False,
    index_method={
        "keyword": False,
        "vector": False,
    },
    indexing_options={
        "keyword_tokenizer": "string",
        "use_ocr": False,
    },
    max_num_results=0,
    metadata={
        "created_from_aisearch_wizard": False,
        "created_from_emdash_plugin": {
            "type": "string",
            "version": "string",
        },
        "worker_domain": "string",
    },
    aisearch_model="string",
    ai_gateway_id="string",
    fusion_method="string",
    reranking_model="string",
    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": {
            "store_options": {
                "r2_jurisdiction": "string",
                "storage_id": "string",
                "storage_type": "string",
            },
            "discover_options": {
                "depth": float(0),
                "include_external_links": False,
                "include_subdomains": False,
                "limit": float(0),
                "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",
        },
    },
    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",
    paused: false,
    publicEndpointParams: {
        authorizedHosts: ["string"],
        chatCompletionsEndpoint: {
            disabled: false,
        },
        customDomains: ["string"],
        defaultDomainEnabled: false,
        enabled: false,
        mcp: {
            description: "string",
            disabled: false,
        },
        rateLimit: {
            periodMs: 0,
            requests: 0,
            technique: "string",
        },
        searchEndpoint: {
            disabled: false,
        },
    },
    cache: false,
    cacheThreshold: "string",
    cacheTtl: 0,
    chunk: false,
    chunkOverlap: 0,
    chunkSize: 0,
    customMetadatas: [{
        dataType: "string",
        fieldName: "string",
    }],
    embeddingModel: "string",
    reranking: false,
    indexMethod: {
        keyword: false,
        vector: false,
    },
    indexingOptions: {
        keywordTokenizer: "string",
        useOcr: false,
    },
    maxNumResults: 0,
    metadata: {
        createdFromAisearchWizard: false,
        createdFromEmdashPlugin: {
            type: "string",
            version: "string",
        },
        workerDomain: "string",
    },
    aisearchModel: "string",
    aiGatewayId: "string",
    fusionMethod: "string",
    rerankingModel: "string",
    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: {
            storeOptions: {
                r2Jurisdiction: "string",
                storageId: "string",
                storageType: "string",
            },
            discoverOptions: {
                depth: 0,
                includeExternalLinks: false,
                includeSubdomains: false,
                limit: 0,
                maxAge: 0,
                source: "string",
            },
            parseOptions: {
                contentSelectors: [{
                    path: "string",
                    selector: "string",
                }],
                includeHeaders: {
                    string: "string",
                },
                includeImages: false,
                specificSitemaps: ["string"],
                useBrowserRendering: false,
            },
            parseType: "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
    cacheTtl: 0
    chunk: false
    chunkOverlap: 0
    chunkSize: 0
    customMetadatas:
        - dataType: string
          fieldName: string
    embeddingModel: string
    fusionMethod: string
    indexMethod:
        keyword: false
        vector: false
    indexingOptions:
        keywordTokenizer: string
        useOcr: false
    maxNumResults: 0
    metadata:
        createdFromAisearchWizard: false
        createdFromEmdashPlugin:
            type: string
            version: string
        workerDomain: string
    paused: false
    publicEndpointParams:
        authorizedHosts:
            - string
        chatCompletionsEndpoint:
            disabled: false
        customDomains:
            - string
        defaultDomainEnabled: 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:
            discoverOptions:
                depth: 0
                includeExternalLinks: false
                includeSubdomains: false
                limit: 0
                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
    A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
    Cache bool
    CacheThreshold string
    Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
    CacheTtl double
    Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d). Available values: 600, 1800, 3600, 7200, 21600, 43200, 86400, 172800, 259200, 518400.
    Chunk bool
    ChunkOverlap int
    ChunkSize int
    CustomMetadatas List<AiSearchInstanceCustomMetadata>
    EmbeddingModel string
    FusionMethod string
    Available values: "max", "rrf".
    HybridSearchEnabled bool
    Deprecated — use indexMethod instead. Defaults to true for new instances; set false to create a vector-only instance.

    Deprecated: This attribute is deprecated.

    IndexMethod AiSearchInstanceIndexMethod
    Controls which storage backends are used during indexing. Defaults to vector and keyword indexing for new instances.
    IndexingOptions AiSearchInstanceIndexingOptions
    MaxNumResults int
    Metadata AiSearchInstanceMetadata
    Paused bool
    PublicEndpointParams AiSearchInstancePublicEndpointParams
    Reranking bool
    RerankingModel string
    RetrievalOptions AiSearchInstanceRetrievalOptions
    RewriteModel string
    A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
    RewriteQuery bool
    ScoreThreshold double
    Source string
    SourceParams AiSearchInstanceSourceParams
    Summarization bool
    SummarizationModel string
    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
    Source type. When omitted or null with a non-blank source, HTTP(S) URLs infer web-crawler and existing R2 bucket names infer r2. A missing or blank source without a type uses managed upload-only storage. Available values: "r2", "web-crawler".
    AccountId string
    AiSearchInstanceId string
    AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
    AiGatewayId string
    AisearchModel string
    A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
    Cache bool
    CacheThreshold string
    Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
    CacheTtl float64
    Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d). Available values: 600, 1800, 3600, 7200, 21600, 43200, 86400, 172800, 259200, 518400.
    Chunk bool
    ChunkOverlap int
    ChunkSize int
    CustomMetadatas []AiSearchInstanceCustomMetadataArgs
    EmbeddingModel string
    FusionMethod string
    Available values: "max", "rrf".
    HybridSearchEnabled bool
    Deprecated — use indexMethod instead. Defaults to true for new instances; set false to create a vector-only instance.

    Deprecated: This attribute is deprecated.

    IndexMethod AiSearchInstanceIndexMethodArgs
    Controls which storage backends are used during indexing. Defaults to vector and keyword indexing for new instances.
    IndexingOptions AiSearchInstanceIndexingOptionsArgs
    MaxNumResults int
    Metadata AiSearchInstanceMetadataArgs
    Paused bool
    PublicEndpointParams AiSearchInstancePublicEndpointParamsArgs
    Reranking bool
    RerankingModel string
    RetrievalOptions AiSearchInstanceRetrievalOptionsArgs
    RewriteModel string
    A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
    RewriteQuery bool
    ScoreThreshold float64
    Source string
    SourceParams AiSearchInstanceSourceParamsArgs
    Summarization bool
    SummarizationModel string
    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
    Source type. When omitted or null with a non-blank source, HTTP(S) URLs infer web-crawler and existing R2 bucket names infer r2. A missing or blank source without a type uses managed upload-only storage. Available values: "r2", "web-crawler".
    account_id string
    ai_search_instance_id string
    AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
    ai_gateway_id string
    aisearch_model string
    A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
    cache bool
    cache_threshold string
    Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
    cache_ttl number
    Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d). Available values: 600, 1800, 3600, 7200, 21600, 43200, 86400, 172800, 259200, 518400.
    chunk bool
    chunk_overlap number
    chunk_size number
    custom_metadatas list(object)
    embedding_model string
    fusion_method string
    Available values: "max", "rrf".
    hybrid_search_enabled bool
    Deprecated — use indexMethod instead. Defaults to true for new instances; set false to create a vector-only instance.

    Deprecated: This attribute is deprecated.

    index_method object
    Controls which storage backends are used during indexing. Defaults to vector and keyword indexing for new instances.
    indexing_options object
    max_num_results number
    metadata object
    paused bool
    public_endpoint_params object
    reranking bool
    reranking_model string
    retrieval_options object
    rewrite_model string
    A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
    rewrite_query bool
    score_threshold number
    source string
    source_params object
    summarization bool
    summarization_model string
    sync_interval 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.
    system_prompt_aisearch string
    system_prompt_index_summarization string
    system_prompt_rewrite_query string
    token_id string
    type string
    Source type. When omitted or null with a non-blank source, HTTP(S) URLs infer web-crawler and existing R2 bucket names infer r2. A missing or blank source without a type uses managed upload-only storage. Available values: "r2", "web-crawler".
    accountId String
    aiSearchInstanceId String
    AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
    aiGatewayId String
    aisearchModel String
    A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
    cache Boolean
    cacheThreshold String
    Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
    cacheTtl Double
    Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d). Available values: 600, 1800, 3600, 7200, 21600, 43200, 86400, 172800, 259200, 518400.
    chunk Boolean
    chunkOverlap Integer
    chunkSize Integer
    customMetadatas List<AiSearchInstanceCustomMetadata>
    embeddingModel String
    fusionMethod String
    Available values: "max", "rrf".
    hybridSearchEnabled Boolean
    Deprecated — use indexMethod instead. Defaults to true for new instances; set false to create a vector-only instance.

    Deprecated: This attribute is deprecated.

    indexMethod AiSearchInstanceIndexMethod
    Controls which storage backends are used during indexing. Defaults to vector and keyword indexing for new instances.
    indexingOptions AiSearchInstanceIndexingOptions
    maxNumResults Integer
    metadata AiSearchInstanceMetadata
    paused Boolean
    publicEndpointParams AiSearchInstancePublicEndpointParams
    reranking Boolean
    rerankingModel String
    retrievalOptions AiSearchInstanceRetrievalOptions
    rewriteModel String
    A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
    rewriteQuery Boolean
    scoreThreshold Double
    source String
    sourceParams AiSearchInstanceSourceParams
    summarization Boolean
    summarizationModel String
    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
    Source type. When omitted or null with a non-blank source, HTTP(S) URLs infer web-crawler and existing R2 bucket names infer r2. A missing or blank source without a type uses managed upload-only storage. Available values: "r2", "web-crawler".
    accountId string
    aiSearchInstanceId string
    AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
    aiGatewayId string
    aisearchModel string
    A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
    cache boolean
    cacheThreshold string
    Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
    cacheTtl number
    Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d). Available values: 600, 1800, 3600, 7200, 21600, 43200, 86400, 172800, 259200, 518400.
    chunk boolean
    chunkOverlap number
    chunkSize number
    customMetadatas AiSearchInstanceCustomMetadata[]
    embeddingModel string
    fusionMethod string
    Available values: "max", "rrf".
    hybridSearchEnabled boolean
    Deprecated — use indexMethod instead. Defaults to true for new instances; set false to create a vector-only instance.

    Deprecated: This attribute is deprecated.

    indexMethod AiSearchInstanceIndexMethod
    Controls which storage backends are used during indexing. Defaults to vector and keyword indexing for new instances.
    indexingOptions AiSearchInstanceIndexingOptions
    maxNumResults number
    metadata AiSearchInstanceMetadata
    paused boolean
    publicEndpointParams AiSearchInstancePublicEndpointParams
    reranking boolean
    rerankingModel string
    retrievalOptions AiSearchInstanceRetrievalOptions
    rewriteModel string
    A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
    rewriteQuery boolean
    scoreThreshold number
    source string
    sourceParams AiSearchInstanceSourceParams
    summarization boolean
    summarizationModel string
    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
    Source type. When omitted or null with a non-blank source, HTTP(S) URLs infer web-crawler and existing R2 bucket names infer r2. A missing or blank source without a type uses managed upload-only storage. 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
    A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
    cache bool
    cache_threshold str
    Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
    cache_ttl float
    Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d). Available values: 600, 1800, 3600, 7200, 21600, 43200, 86400, 172800, 259200, 518400.
    chunk bool
    chunk_overlap int
    chunk_size int
    custom_metadatas Sequence[AiSearchInstanceCustomMetadataArgs]
    embedding_model str
    fusion_method str
    Available values: "max", "rrf".
    hybrid_search_enabled bool
    Deprecated — use indexMethod instead. Defaults to true for new instances; set false to create a vector-only instance.

    Deprecated: This attribute is deprecated.

    index_method AiSearchInstanceIndexMethodArgs
    Controls which storage backends are used during indexing. Defaults to vector and keyword indexing for new instances.
    indexing_options AiSearchInstanceIndexingOptionsArgs
    max_num_results int
    metadata AiSearchInstanceMetadataArgs
    paused bool
    public_endpoint_params AiSearchInstancePublicEndpointParamsArgs
    reranking bool
    reranking_model str
    retrieval_options AiSearchInstanceRetrievalOptionsArgs
    rewrite_model str
    A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
    rewrite_query bool
    score_threshold float
    source str
    source_params AiSearchInstanceSourceParamsArgs
    summarization bool
    summarization_model str
    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
    Source type. When omitted or null with a non-blank source, HTTP(S) URLs infer web-crawler and existing R2 bucket names infer r2. A missing or blank source without a type uses managed upload-only storage. Available values: "r2", "web-crawler".
    accountId String
    aiSearchInstanceId String
    AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
    aiGatewayId String
    aisearchModel String
    A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
    cache Boolean
    cacheThreshold String
    Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
    cacheTtl Number
    Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d). Available values: 600, 1800, 3600, 7200, 21600, 43200, 86400, 172800, 259200, 518400.
    chunk Boolean
    chunkOverlap Number
    chunkSize Number
    customMetadatas List<Property Map>
    embeddingModel String
    fusionMethod String
    Available values: "max", "rrf".
    hybridSearchEnabled Boolean
    Deprecated — use indexMethod instead. Defaults to true for new instances; set false to create a vector-only instance.

    Deprecated: This attribute is deprecated.

    indexMethod Property Map
    Controls which storage backends are used during indexing. Defaults to vector and keyword indexing for new instances.
    indexingOptions Property Map
    maxNumResults Number
    metadata Property Map
    paused Boolean
    publicEndpointParams Property Map
    reranking Boolean
    rerankingModel String
    retrievalOptions Property Map
    rewriteModel String
    A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
    rewriteQuery Boolean
    scoreThreshold Number
    source String
    sourceParams Property Map
    summarization Boolean
    summarizationModel String
    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
    Source type. When omitted or null with a non-blank source, HTTP(S) URLs infer web-crawler and existing R2 bucket names infer r2. A missing or blank source without a type uses managed upload-only storage. 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
    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
    created_at string
    created_by string
    enable bool
    engine_version number
    id string
    The provider-assigned unique ID for this managed resource.
    last_activity string
    modified_at string
    modified_by string
    namespace string
    public_endpoint_id string
    status 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
    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
    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
    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

    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,
        cache_ttl: Optional[float] = 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) -> 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}
    import {
  to = cloudflare_ai_search_instance.example
  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
    A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
    Cache bool
    CacheThreshold string
    Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
    CacheTtl double
    Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d). Available values: 600, 1800, 3600, 7200, 21600, 43200, 86400, 172800, 259200, 518400.
    Chunk bool
    ChunkOverlap int
    ChunkSize int
    CreatedAt string
    CreatedBy string
    CustomMetadatas List<AiSearchInstanceCustomMetadata>
    EmbeddingModel string
    Enable bool
    EngineVersion double
    FusionMethod string
    Available values: "max", "rrf".
    HybridSearchEnabled bool
    Deprecated — use indexMethod instead. Defaults to true for new instances; set false to create a vector-only instance.

    Deprecated: This attribute is deprecated.

    IndexMethod AiSearchInstanceIndexMethod
    Controls which storage backends are used during indexing. Defaults to vector and keyword indexing for new instances.
    IndexingOptions AiSearchInstanceIndexingOptions
    LastActivity string
    MaxNumResults int
    Metadata AiSearchInstanceMetadata
    ModifiedAt string
    ModifiedBy string
    Namespace string
    Paused bool
    PublicEndpointId string
    PublicEndpointParams AiSearchInstancePublicEndpointParams
    Reranking bool
    RerankingModel string
    RetrievalOptions AiSearchInstanceRetrievalOptions
    RewriteModel string
    A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
    RewriteQuery bool
    ScoreThreshold double
    Source string
    SourceParams AiSearchInstanceSourceParams
    Status string
    Summarization bool
    SummarizationModel string
    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
    Source type. When omitted or null with a non-blank source, HTTP(S) URLs infer web-crawler and existing R2 bucket names infer r2. A missing or blank source without a type uses managed upload-only storage. Available values: "r2", "web-crawler".
    AccountId string
    AiGatewayId string
    AiSearchInstanceId string
    AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
    AisearchModel string
    A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
    Cache bool
    CacheThreshold string
    Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
    CacheTtl float64
    Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d). Available values: 600, 1800, 3600, 7200, 21600, 43200, 86400, 172800, 259200, 518400.
    Chunk bool
    ChunkOverlap int
    ChunkSize int
    CreatedAt string
    CreatedBy string
    CustomMetadatas []AiSearchInstanceCustomMetadataArgs
    EmbeddingModel string
    Enable bool
    EngineVersion float64
    FusionMethod string
    Available values: "max", "rrf".
    HybridSearchEnabled bool
    Deprecated — use indexMethod instead. Defaults to true for new instances; set false to create a vector-only instance.

    Deprecated: This attribute is deprecated.

    IndexMethod AiSearchInstanceIndexMethodArgs
    Controls which storage backends are used during indexing. Defaults to vector and keyword indexing for new instances.
    IndexingOptions AiSearchInstanceIndexingOptionsArgs
    LastActivity string
    MaxNumResults int
    Metadata AiSearchInstanceMetadataArgs
    ModifiedAt string
    ModifiedBy string
    Namespace string
    Paused bool
    PublicEndpointId string
    PublicEndpointParams AiSearchInstancePublicEndpointParamsArgs
    Reranking bool
    RerankingModel string
    RetrievalOptions AiSearchInstanceRetrievalOptionsArgs
    RewriteModel string
    A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
    RewriteQuery bool
    ScoreThreshold float64
    Source string
    SourceParams AiSearchInstanceSourceParamsArgs
    Status string
    Summarization bool
    SummarizationModel string
    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
    Source type. When omitted or null with a non-blank source, HTTP(S) URLs infer web-crawler and existing R2 bucket names infer r2. A missing or blank source without a type uses managed upload-only storage. Available values: "r2", "web-crawler".
    account_id string
    ai_gateway_id string
    ai_search_instance_id string
    AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
    aisearch_model string
    A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
    cache bool
    cache_threshold string
    Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
    cache_ttl number
    Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d). Available values: 600, 1800, 3600, 7200, 21600, 43200, 86400, 172800, 259200, 518400.
    chunk bool
    chunk_overlap number
    chunk_size number
    created_at string
    created_by string
    custom_metadatas list(object)
    embedding_model string
    enable bool
    engine_version number
    fusion_method string
    Available values: "max", "rrf".
    hybrid_search_enabled bool
    Deprecated — use indexMethod instead. Defaults to true for new instances; set false to create a vector-only instance.

    Deprecated: This attribute is deprecated.

    index_method object
    Controls which storage backends are used during indexing. Defaults to vector and keyword indexing for new instances.
    indexing_options object
    last_activity string
    max_num_results number
    metadata object
    modified_at string
    modified_by string
    namespace string
    paused bool
    public_endpoint_id string
    public_endpoint_params object
    reranking bool
    reranking_model string
    retrieval_options object
    rewrite_model string
    A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
    rewrite_query bool
    score_threshold number
    source string
    source_params object
    status string
    summarization bool
    summarization_model string
    sync_interval 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.
    system_prompt_aisearch string
    system_prompt_index_summarization string
    system_prompt_rewrite_query string
    token_id string
    type string
    Source type. When omitted or null with a non-blank source, HTTP(S) URLs infer web-crawler and existing R2 bucket names infer r2. A missing or blank source without a type uses managed upload-only storage. Available values: "r2", "web-crawler".
    accountId String
    aiGatewayId String
    aiSearchInstanceId String
    AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
    aisearchModel String
    A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
    cache Boolean
    cacheThreshold String
    Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
    cacheTtl Double
    Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d). Available values: 600, 1800, 3600, 7200, 21600, 43200, 86400, 172800, 259200, 518400.
    chunk Boolean
    chunkOverlap Integer
    chunkSize Integer
    createdAt String
    createdBy String
    customMetadatas List<AiSearchInstanceCustomMetadata>
    embeddingModel String
    enable Boolean
    engineVersion Double
    fusionMethod String
    Available values: "max", "rrf".
    hybridSearchEnabled Boolean
    Deprecated — use indexMethod instead. Defaults to true for new instances; set false to create a vector-only instance.

    Deprecated: This attribute is deprecated.

    indexMethod AiSearchInstanceIndexMethod
    Controls which storage backends are used during indexing. Defaults to vector and keyword indexing for new instances.
    indexingOptions AiSearchInstanceIndexingOptions
    lastActivity String
    maxNumResults Integer
    metadata AiSearchInstanceMetadata
    modifiedAt String
    modifiedBy String
    namespace String
    paused Boolean
    publicEndpointId String
    publicEndpointParams AiSearchInstancePublicEndpointParams
    reranking Boolean
    rerankingModel String
    retrievalOptions AiSearchInstanceRetrievalOptions
    rewriteModel String
    A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
    rewriteQuery Boolean
    scoreThreshold Double
    source String
    sourceParams AiSearchInstanceSourceParams
    status String
    summarization Boolean
    summarizationModel String
    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
    Source type. When omitted or null with a non-blank source, HTTP(S) URLs infer web-crawler and existing R2 bucket names infer r2. A missing or blank source without a type uses managed upload-only storage. Available values: "r2", "web-crawler".
    accountId string
    aiGatewayId string
    aiSearchInstanceId string
    AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
    aisearchModel string
    A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
    cache boolean
    cacheThreshold string
    Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
    cacheTtl number
    Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d). Available values: 600, 1800, 3600, 7200, 21600, 43200, 86400, 172800, 259200, 518400.
    chunk boolean
    chunkOverlap number
    chunkSize number
    createdAt string
    createdBy string
    customMetadatas AiSearchInstanceCustomMetadata[]
    embeddingModel string
    enable boolean
    engineVersion number
    fusionMethod string
    Available values: "max", "rrf".
    hybridSearchEnabled boolean
    Deprecated — use indexMethod instead. Defaults to true for new instances; set false to create a vector-only instance.

    Deprecated: This attribute is deprecated.

    indexMethod AiSearchInstanceIndexMethod
    Controls which storage backends are used during indexing. Defaults to vector and keyword indexing for new instances.
    indexingOptions AiSearchInstanceIndexingOptions
    lastActivity string
    maxNumResults number
    metadata AiSearchInstanceMetadata
    modifiedAt string
    modifiedBy string
    namespace string
    paused boolean
    publicEndpointId string
    publicEndpointParams AiSearchInstancePublicEndpointParams
    reranking boolean
    rerankingModel string
    retrievalOptions AiSearchInstanceRetrievalOptions
    rewriteModel string
    A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
    rewriteQuery boolean
    scoreThreshold number
    source string
    sourceParams AiSearchInstanceSourceParams
    status string
    summarization boolean
    summarizationModel string
    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
    Source type. When omitted or null with a non-blank source, HTTP(S) URLs infer web-crawler and existing R2 bucket names infer r2. A missing or blank source without a type uses managed upload-only storage. Available values: "r2", "web-crawler".
    account_id str
    ai_gateway_id str
    ai_search_instance_id str
    AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
    aisearch_model str
    A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
    cache bool
    cache_threshold str
    Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
    cache_ttl float
    Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d). Available values: 600, 1800, 3600, 7200, 21600, 43200, 86400, 172800, 259200, 518400.
    chunk bool
    chunk_overlap int
    chunk_size int
    created_at str
    created_by str
    custom_metadatas Sequence[AiSearchInstanceCustomMetadataArgs]
    embedding_model str
    enable bool
    engine_version float
    fusion_method str
    Available values: "max", "rrf".
    hybrid_search_enabled bool
    Deprecated — use indexMethod instead. Defaults to true for new instances; set false to create a vector-only instance.

    Deprecated: This attribute is deprecated.

    index_method AiSearchInstanceIndexMethodArgs
    Controls which storage backends are used during indexing. Defaults to vector and keyword indexing for new instances.
    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
    retrieval_options AiSearchInstanceRetrievalOptionsArgs
    rewrite_model str
    A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
    rewrite_query bool
    score_threshold float
    source str
    source_params AiSearchInstanceSourceParamsArgs
    status str
    summarization bool
    summarization_model str
    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
    Source type. When omitted or null with a non-blank source, HTTP(S) URLs infer web-crawler and existing R2 bucket names infer r2. A missing or blank source without a type uses managed upload-only storage. Available values: "r2", "web-crawler".
    accountId String
    aiGatewayId String
    aiSearchInstanceId String
    AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.
    aisearchModel String
    A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
    cache Boolean
    cacheThreshold String
    Available values: "superstrictmatch", "closeenough", "flexiblefriend", "anythingGoes".
    cacheTtl Number
    Cache entry TTL in seconds. Allowed values: 600 (10min), 1800 (30min), 3600 (1h), 7200 (2h), 21600 (6h), 43200 (12h), 86400 (24h), 172800 (48h), 259200 (72h), 518400 (6d). Available values: 600, 1800, 3600, 7200, 21600, 43200, 86400, 172800, 259200, 518400.
    chunk Boolean
    chunkOverlap Number
    chunkSize Number
    createdAt String
    createdBy String
    customMetadatas List<Property Map>
    embeddingModel String
    enable Boolean
    engineVersion Number
    fusionMethod String
    Available values: "max", "rrf".
    hybridSearchEnabled Boolean
    Deprecated — use indexMethod instead. Defaults to true for new instances; set false to create a vector-only instance.

    Deprecated: This attribute is deprecated.

    indexMethod Property Map
    Controls which storage backends are used during indexing. Defaults to vector and keyword indexing for new instances.
    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
    retrievalOptions Property Map
    rewriteModel String
    A Workers AI model ID or an AI Gateway model ID compatible with the OpenAI Chat Completions API. An empty string uses the configured or default model.
    rewriteQuery Boolean
    scoreThreshold Number
    source String
    sourceParams Property Map
    status String
    summarization Boolean
    summarizationModel String
    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
    Source type. When omitted or null with a non-blank source, HTTP(S) URLs infer web-crawler and existing R2 bucket names infer r2. A missing or blank source without a type uses managed upload-only storage. Available values: "r2", "web-crawler".

    Supporting Types

    AiSearchInstanceCustomMetadata, AiSearchInstanceCustomMetadataArgs

    DataType string
    Available values: "text", "number", "boolean", "datetime".
    FieldName string
    DataType string
    Available values: "text", "number", "boolean", "datetime".
    FieldName string
    data_type string
    Available values: "text", "number", "boolean", "datetime".
    field_name 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 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".
    UseOcr bool
    Enables OCR ingestion for PDFs and images. Changing this triggers a full re-index. Defaults to false.
    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".
    UseOcr bool
    Enables OCR ingestion for PDFs and images. Changing this triggers a full re-index. Defaults to false.
    keyword_tokenizer 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".
    use_ocr bool
    Enables OCR ingestion for PDFs and images. Changing this triggers a full re-index. Defaults to false.
    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".
    useOcr Boolean
    Enables OCR ingestion for PDFs and images. Changing this triggers a full re-index. Defaults to false.
    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".
    useOcr boolean
    Enables OCR ingestion for PDFs and images. Changing this triggers a full re-index. Defaults to false.
    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".
    use_ocr bool
    Enables OCR ingestion for PDFs and images. Changing this triggers a full re-index. Defaults to false.
    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".
    useOcr Boolean
    Enables OCR ingestion for PDFs and images. Changing this triggers a full re-index. Defaults to false.

    AiSearchInstanceMetadata, AiSearchInstanceMetadataArgs

    AiSearchInstanceMetadataCreatedFromEmdashPlugin, AiSearchInstanceMetadataCreatedFromEmdashPluginArgs

    Type string
    Available values: "native", "rest".
    Version string
    Type string
    Available values: "native", "rest".
    Version string
    type string
    Available values: "native", "rest".
    version string
    type String
    Available values: "native", "rest".
    version String
    type string
    Available values: "native", "rest".
    version string
    type str
    Available values: "native", "rest".
    version str
    type String
    Available values: "native", "rest".
    version String

    AiSearchInstancePublicEndpointParams, AiSearchInstancePublicEndpointParamsArgs

    AuthorizedHosts List<string>
    ChatCompletionsEndpoint AiSearchInstancePublicEndpointParamsChatCompletionsEndpoint
    CustomDomains List<string>
    Custom domain hostnames that alias this public endpoint. GET and create responses return the current set; on update (PUT) this field is only echoed back when supplied in the request body, otherwise it is null (omit it to leave domains unchanged).
    DefaultDomainEnabled bool
    When false, the instance is reachable only via a registered custom domain and the default \n\n.search.ai.cloudflare.com host returns 404. Requires at least one custom domain. Defaults to true. publicendpointparams is replaced wholesale on update, so resend defaultdomainenabled on every update to keep the default host off — omitting it resets to true.
    Enabled bool
    Mcp AiSearchInstancePublicEndpointParamsMcp
    RateLimit AiSearchInstancePublicEndpointParamsRateLimit
    SearchEndpoint AiSearchInstancePublicEndpointParamsSearchEndpoint
    AuthorizedHosts []string
    ChatCompletionsEndpoint AiSearchInstancePublicEndpointParamsChatCompletionsEndpoint
    CustomDomains []string
    Custom domain hostnames that alias this public endpoint. GET and create responses return the current set; on update (PUT) this field is only echoed back when supplied in the request body, otherwise it is null (omit it to leave domains unchanged).
    DefaultDomainEnabled bool
    When false, the instance is reachable only via a registered custom domain and the default \n\n.search.ai.cloudflare.com host returns 404. Requires at least one custom domain. Defaults to true. publicendpointparams is replaced wholesale on update, so resend defaultdomainenabled on every update to keep the default host off — omitting it resets to true.
    Enabled bool
    Mcp AiSearchInstancePublicEndpointParamsMcp
    RateLimit AiSearchInstancePublicEndpointParamsRateLimit
    SearchEndpoint AiSearchInstancePublicEndpointParamsSearchEndpoint
    authorized_hosts list(string)
    chat_completions_endpoint object
    custom_domains list(string)
    Custom domain hostnames that alias this public endpoint. GET and create responses return the current set; on update (PUT) this field is only echoed back when supplied in the request body, otherwise it is null (omit it to leave domains unchanged).
    default_domain_enabled bool
    When false, the instance is reachable only via a registered custom domain and the default \n\n.search.ai.cloudflare.com host returns 404. Requires at least one custom domain. Defaults to true. publicendpointparams is replaced wholesale on update, so resend defaultdomainenabled on every update to keep the default host off — omitting it resets to true.
    enabled bool
    mcp object
    rate_limit object
    search_endpoint object
    authorizedHosts List<String>
    chatCompletionsEndpoint AiSearchInstancePublicEndpointParamsChatCompletionsEndpoint
    customDomains List<String>
    Custom domain hostnames that alias this public endpoint. GET and create responses return the current set; on update (PUT) this field is only echoed back when supplied in the request body, otherwise it is null (omit it to leave domains unchanged).
    defaultDomainEnabled Boolean
    When false, the instance is reachable only via a registered custom domain and the default \n\n.search.ai.cloudflare.com host returns 404. Requires at least one custom domain. Defaults to true. publicendpointparams is replaced wholesale on update, so resend defaultdomainenabled on every update to keep the default host off — omitting it resets to true.
    enabled Boolean
    mcp AiSearchInstancePublicEndpointParamsMcp
    rateLimit AiSearchInstancePublicEndpointParamsRateLimit
    searchEndpoint AiSearchInstancePublicEndpointParamsSearchEndpoint
    authorizedHosts string[]
    chatCompletionsEndpoint AiSearchInstancePublicEndpointParamsChatCompletionsEndpoint
    customDomains string[]
    Custom domain hostnames that alias this public endpoint. GET and create responses return the current set; on update (PUT) this field is only echoed back when supplied in the request body, otherwise it is null (omit it to leave domains unchanged).
    defaultDomainEnabled boolean
    When false, the instance is reachable only via a registered custom domain and the default \n\n.search.ai.cloudflare.com host returns 404. Requires at least one custom domain. Defaults to true. publicendpointparams is replaced wholesale on update, so resend defaultdomainenabled on every update to keep the default host off — omitting it resets to true.
    enabled boolean
    mcp AiSearchInstancePublicEndpointParamsMcp
    rateLimit AiSearchInstancePublicEndpointParamsRateLimit
    searchEndpoint AiSearchInstancePublicEndpointParamsSearchEndpoint
    authorized_hosts Sequence[str]
    chat_completions_endpoint AiSearchInstancePublicEndpointParamsChatCompletionsEndpoint
    custom_domains Sequence[str]
    Custom domain hostnames that alias this public endpoint. GET and create responses return the current set; on update (PUT) this field is only echoed back when supplied in the request body, otherwise it is null (omit it to leave domains unchanged).
    default_domain_enabled bool
    When false, the instance is reachable only via a registered custom domain and the default \n\n.search.ai.cloudflare.com host returns 404. Requires at least one custom domain. Defaults to true. publicendpointparams is replaced wholesale on update, so resend defaultdomainenabled on every update to keep the default host off — omitting it resets to true.
    enabled bool
    mcp AiSearchInstancePublicEndpointParamsMcp
    rate_limit AiSearchInstancePublicEndpointParamsRateLimit
    search_endpoint AiSearchInstancePublicEndpointParamsSearchEndpoint
    authorizedHosts List<String>
    chatCompletionsEndpoint Property Map
    customDomains List<String>
    Custom domain hostnames that alias this public endpoint. GET and create responses return the current set; on update (PUT) this field is only echoed back when supplied in the request body, otherwise it is null (omit it to leave domains unchanged).
    defaultDomainEnabled Boolean
    When false, the instance is reachable only via a registered custom domain and the default \n\n.search.ai.cloudflare.com host returns 404. Requires at least one custom domain. Defaults to true. publicendpointparams is replaced wholesale on update, so resend defaultdomainenabled on every update to keep the default host off — omitting it resets to true.
    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 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 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".
    period_ms number
    requests number
    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 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/datetime 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. When omitted on an update, the existing stored value is preserved; when never set, search falls back 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/datetime 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. When omitted on an update, the existing stored value is preserved; when never set, search falls back to 'and'. Available values: "and", "or".
    boost_bies list(object)
    Metadata fields to boost search results by. Each entry specifies a metadata field and an optional direction. Direction defaults to 'asc' for numeric/datetime fields and 'exists' for text/boolean fields. Fields must match 'timestamp' or a defined custom*metadata field.
    keyword_match_mode 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. When omitted on an update, the existing stored value is preserved; when never set, search falls back 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/datetime 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. When omitted on an update, the existing stored value is preserved; when never set, search falls back 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/datetime 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. When omitted on an update, the existing stored value is preserved; when never set, search falls back 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/datetime 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. When omitted on an update, the existing stored value is preserved; when never set, search falls back 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/datetime 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. When omitted on an update, the existing stored value is preserved; when never set, search falls back 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 all four directions (asc, desc, exists, notexists); text/boolean fields only support exists/not_exists.
    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 all four directions (asc, desc, exists, notexists); text/boolean fields only support exists/not_exists.
    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 all four directions (asc, desc, exists, notexists); text/boolean fields only support exists/not_exists.
    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 all four directions (asc, desc, exists, notexists); text/boolean fields only support exists/not_exists.
    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 all four directions (asc, desc, exists, notexists); text/boolean fields only support exists/not_exists.
    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 all four directions (asc, desc, exists, notexists); text/boolean fields only support exists/not_exists.
    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 all four directions (asc, desc, exists, notexists); text/boolean fields only support exists/not_exists.
    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). Most accounts are limited to 10 rules; contact support to raise it.
    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). Most accounts are limited to 10 rules; contact support to raise it.
    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). Most accounts are limited to 10 rules; contact support to raise it.
    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). Most accounts are limited to 10 rules; contact support to raise it.
    Prefix string
    R2Jurisdiction string
    WebCrawler AiSearchInstanceSourceParamsWebCrawler
    exclude_items 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). Most accounts are limited to 10 rules; contact support to raise it.
    include_items 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). Most accounts are limited to 10 rules; contact support to raise it.
    prefix string
    r2_jurisdiction string
    web_crawler object
    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). Most accounts are limited to 10 rules; contact support to raise it.
    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). Most accounts are limited to 10 rules; contact support to raise it.
    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). Most accounts are limited to 10 rules; contact support to raise it.
    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). Most accounts are limited to 10 rules; contact support to raise it.
    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). Most accounts are limited to 10 rules; contact support to raise it.
    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). Most accounts are limited to 10 rules; contact support to raise it.
    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). Most accounts are limited to 10 rules; contact support to raise it.
    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). Most accounts are limited to 10 rules; contact support to raise it.
    prefix String
    r2Jurisdiction String
    webCrawler Property Map

    AiSearchInstanceSourceParamsWebCrawler, AiSearchInstanceSourceParamsWebCrawlerArgs

    StoreOptions AiSearchInstanceSourceParamsWebCrawlerStoreOptions
    DiscoverOptions AiSearchInstanceSourceParamsWebCrawlerDiscoverOptions
    Options for parse*type 'discover', where Browser Run discovers URLs by link following and sitemaps. Ignored for 'sitemap'.
    ParseOptions AiSearchInstanceSourceParamsWebCrawlerParseOptions
    ParseType string
    How URLs are discovered. 'sitemap' reads XML sitemaps; 'discover' follows links recursively and requires the source to be a Verified zone on this account. Available values: "sitemap", "discover".
    StoreOptions AiSearchInstanceSourceParamsWebCrawlerStoreOptions
    DiscoverOptions AiSearchInstanceSourceParamsWebCrawlerDiscoverOptions
    Options for parse*type 'discover', where Browser Run discovers URLs by link following and sitemaps. Ignored for 'sitemap'.
    ParseOptions AiSearchInstanceSourceParamsWebCrawlerParseOptions
    ParseType string
    How URLs are discovered. 'sitemap' reads XML sitemaps; 'discover' follows links recursively and requires the source to be a Verified zone on this account. Available values: "sitemap", "discover".
    store_options object
    discover_options object
    Options for parse*type 'discover', where Browser Run discovers URLs by link following and sitemaps. Ignored for 'sitemap'.
    parse_options object
    parse_type string
    How URLs are discovered. 'sitemap' reads XML sitemaps; 'discover' follows links recursively and requires the source to be a Verified zone on this account. Available values: "sitemap", "discover".
    storeOptions AiSearchInstanceSourceParamsWebCrawlerStoreOptions
    discoverOptions AiSearchInstanceSourceParamsWebCrawlerDiscoverOptions
    Options for parse*type 'discover', where Browser Run discovers URLs by link following and sitemaps. Ignored for 'sitemap'.
    parseOptions AiSearchInstanceSourceParamsWebCrawlerParseOptions
    parseType String
    How URLs are discovered. 'sitemap' reads XML sitemaps; 'discover' follows links recursively and requires the source to be a Verified zone on this account. Available values: "sitemap", "discover".
    storeOptions AiSearchInstanceSourceParamsWebCrawlerStoreOptions
    discoverOptions AiSearchInstanceSourceParamsWebCrawlerDiscoverOptions
    Options for parse*type 'discover', where Browser Run discovers URLs by link following and sitemaps. Ignored for 'sitemap'.
    parseOptions AiSearchInstanceSourceParamsWebCrawlerParseOptions
    parseType string
    How URLs are discovered. 'sitemap' reads XML sitemaps; 'discover' follows links recursively and requires the source to be a Verified zone on this account. Available values: "sitemap", "discover".
    store_options AiSearchInstanceSourceParamsWebCrawlerStoreOptions
    discover_options AiSearchInstanceSourceParamsWebCrawlerDiscoverOptions
    Options for parse*type 'discover', where Browser Run discovers URLs by link following and sitemaps. Ignored for 'sitemap'.
    parse_options AiSearchInstanceSourceParamsWebCrawlerParseOptions
    parse_type str
    How URLs are discovered. 'sitemap' reads XML sitemaps; 'discover' follows links recursively and requires the source to be a Verified zone on this account. Available values: "sitemap", "discover".
    storeOptions Property Map
    discoverOptions Property Map
    Options for parse*type 'discover', where Browser Run discovers URLs by link following and sitemaps. Ignored for 'sitemap'.
    parseOptions Property Map
    parseType String
    How URLs are discovered. 'sitemap' reads XML sitemaps; 'discover' follows links recursively and requires the source to be a Verified zone on this account. Available values: "sitemap", "discover".

    AiSearchInstanceSourceParamsWebCrawlerDiscoverOptions, AiSearchInstanceSourceParamsWebCrawlerDiscoverOptionsArgs

    Depth double
    Maximum link-follow depth from the seed URL.
    IncludeExternalLinks bool
    Follow links that point outside the source domain. Must stay false — discover crawls are restricted to the zone you own.
    IncludeSubdomains bool
    Follow links to subdomains of the source host.
    Limit double
    Maximum number of pages to crawl (1-100000).
    MaxAge double
    Maximum content age in seconds to accept (0–604800).
    Source string
    Where the crawler looks for URLs: 'sitemaps' reads sitemap XML only, 'links' follows page links only, 'all' does both. Available values: "all", "sitemaps", "links".
    Depth float64
    Maximum link-follow depth from the seed URL.
    IncludeExternalLinks bool
    Follow links that point outside the source domain. Must stay false — discover crawls are restricted to the zone you own.
    IncludeSubdomains bool
    Follow links to subdomains of the source host.
    Limit float64
    Maximum number of pages to crawl (1-100000).
    MaxAge float64
    Maximum content age in seconds to accept (0–604800).
    Source string
    Where the crawler looks for URLs: 'sitemaps' reads sitemap XML only, 'links' follows page links only, 'all' does both. Available values: "all", "sitemaps", "links".
    depth number
    Maximum link-follow depth from the seed URL.
    include_external_links bool
    Follow links that point outside the source domain. Must stay false — discover crawls are restricted to the zone you own.
    include_subdomains bool
    Follow links to subdomains of the source host.
    limit number
    Maximum number of pages to crawl (1-100000).
    max_age number
    Maximum content age in seconds to accept (0–604800).
    source string
    Where the crawler looks for URLs: 'sitemaps' reads sitemap XML only, 'links' follows page links only, 'all' does both. Available values: "all", "sitemaps", "links".
    depth Double
    Maximum link-follow depth from the seed URL.
    includeExternalLinks Boolean
    Follow links that point outside the source domain. Must stay false — discover crawls are restricted to the zone you own.
    includeSubdomains Boolean
    Follow links to subdomains of the source host.
    limit Double
    Maximum number of pages to crawl (1-100000).
    maxAge Double
    Maximum content age in seconds to accept (0–604800).
    source String
    Where the crawler looks for URLs: 'sitemaps' reads sitemap XML only, 'links' follows page links only, 'all' does both. Available values: "all", "sitemaps", "links".
    depth number
    Maximum link-follow depth from the seed URL.
    includeExternalLinks boolean
    Follow links that point outside the source domain. Must stay false — discover crawls are restricted to the zone you own.
    includeSubdomains boolean
    Follow links to subdomains of the source host.
    limit number
    Maximum number of pages to crawl (1-100000).
    maxAge number
    Maximum content age in seconds to accept (0–604800).
    source string
    Where the crawler looks for URLs: 'sitemaps' reads sitemap XML only, 'links' follows page links only, 'all' does both. Available values: "all", "sitemaps", "links".
    depth float
    Maximum link-follow depth from the seed URL.
    include_external_links bool
    Follow links that point outside the source domain. Must stay false — discover crawls are restricted to the zone you own.
    include_subdomains bool
    Follow links to subdomains of the source host.
    limit float
    Maximum number of pages to crawl (1-100000).
    max_age float
    Maximum content age in seconds to accept (0–604800).
    source str
    Where the crawler looks for URLs: 'sitemaps' reads sitemap XML only, 'links' follows page links only, 'all' does both. Available values: "all", "sitemaps", "links".
    depth Number
    Maximum link-follow depth from the seed URL.
    includeExternalLinks Boolean
    Follow links that point outside the source domain. Must stay false — discover crawls are restricted to the zone you own.
    includeSubdomains Boolean
    Follow links to subdomains of the source host.
    limit Number
    Maximum number of pages to crawl (1-100000).
    maxAge Number
    Maximum content age in seconds to accept (0–604800).
    source String
    Where the crawler looks for URLs: 'sitemaps' reads sitemap XML only, 'links' follows page links only, 'all' does both. 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. Omit the field to disable content selection — empty arrays are rejected.
    IncludeHeaders Dictionary<string, string>
    Up to 5 custom HTTP headers sent with each crawl request. Names must be RFC-7230 token characters (no spaces, colons, or control characters); values must be HTAB + printable ASCII (no CR/LF).
    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. Omit the field to disable content selection — empty arrays are rejected.
    IncludeHeaders map[string]string
    Up to 5 custom HTTP headers sent with each crawl request. Names must be RFC-7230 token characters (no spaces, colons, or control characters); values must be HTAB + printable ASCII (no CR/LF).
    IncludeImages bool
    SpecificSitemaps []string
    List of specific sitemap URLs to use for crawling. Only valid when parseType is 'sitemap'.
    UseBrowserRendering bool
    content_selectors list(object)
    List of path-to-selector mappings for extracting specific content from crawled pages. Each entry pairs a URL glob pattern with a CSS selector. The first matching path wins. Only the matched HTML fragment is stored and indexed. Omit the field to disable content selection — empty arrays are rejected.
    include_headers map(string)
    Up to 5 custom HTTP headers sent with each crawl request. Names must be RFC-7230 token characters (no spaces, colons, or control characters); values must be HTAB + printable ASCII (no CR/LF).
    include_images bool
    specific_sitemaps list(string)
    List of specific sitemap URLs to use for crawling. Only valid when parseType is 'sitemap'.
    use_browser_rendering 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. Omit the field to disable content selection — empty arrays are rejected.
    includeHeaders Map<String,String>
    Up to 5 custom HTTP headers sent with each crawl request. Names must be RFC-7230 token characters (no spaces, colons, or control characters); values must be HTAB + printable ASCII (no CR/LF).
    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. Omit the field to disable content selection — empty arrays are rejected.
    includeHeaders {[key: string]: string}
    Up to 5 custom HTTP headers sent with each crawl request. Names must be RFC-7230 token characters (no spaces, colons, or control characters); values must be HTAB + printable ASCII (no CR/LF).
    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. Omit the field to disable content selection — empty arrays are rejected.
    include_headers Mapping[str, str]
    Up to 5 custom HTTP headers sent with each crawl request. Names must be RFC-7230 token characters (no spaces, colons, or control characters); values must be HTAB + printable ASCII (no CR/LF).
    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. Omit the field to disable content selection — empty arrays are rejected.
    includeHeaders Map<String>
    Up to 5 custom HTTP headers sent with each crawl request. Names must be RFC-7230 token characters (no spaces, colons, or control characters); values must be HTAB + printable ASCII (no CR/LF).
    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. Must not contain disallowed characters (;, `, $, {, }, ). Must target a single element; if multiple elements match, the selector is ignored and the full page is used.
    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. Must not contain disallowed characters (;, `, $, {, }, ). Must target a single element; if multiple elements match, the selector is ignored and the full page is used.
    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. Must not contain disallowed characters (;, `, $, {, }, ). Must target a single element; if multiple elements match, the selector is ignored and the full page is used.
    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. Must not contain disallowed characters (;, `, $, {, }, ). Must target a single element; if multiple elements match, the selector is ignored and the full page is used.
    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. Must not contain disallowed characters (;, `, $, {, }, ). Must target a single element; if multiple elements match, the selector is ignored and the full page is used.
    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. Must not contain disallowed characters (;, `, $, {, }, ). Must target a single element; if multiple elements match, the selector is ignored and the full page is used.
    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. Must not contain disallowed characters (;, `, $, {, }, ). Must target a single element; if multiple elements match, the selector is ignored and the full page is used.

    AiSearchInstanceSourceParamsWebCrawlerStoreOptions, AiSearchInstanceSourceParamsWebCrawlerStoreOptionsArgs

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo cloudflare logo
    Viewing docs for Cloudflare v6.23.1
    published on Wednesday, Oct 21, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-cloudflare

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial