Cloudflare/ai Search
@swamp/cloudflare/ai-searchv2026.06.24.1
01README
Cloudflare ai-search infrastructure models
02Release Notes
- Updated: instances
03Models
instances.tsv2026.06.24.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| ai_gateway_id? | string | |
| ai_search_model? | enum | |
| cache? | boolean | |
| cache_threshold? | enum | |
| cache_ttl? | union | |
| chunk? | boolean | |
| chunk_overlap? | number | |
| chunk_size? | number | |
| custom_metadata? | array | |
| embedding_model? | enum | |
| fusion_method? | enum | |
| index_method? | object | Controls which storage backends are used during indexing. Defaults to vector-only. |
| indexing_options? | object | |
| max_num_results? | number | |
| metadata? | object | |
| paused? | boolean | |
| public_endpoint_params? | object | |
| reranking? | boolean | |
| reranking_model? | enum | |
| retrieval_options? | object | |
| rewrite_model? | enum | |
| rewrite_query? | boolean | |
| score_threshold? | number | |
| source? | string | |
| source_params? | object | |
| summarization? | boolean | |
| summarization_model? | enum | |
| sync_interval? | union | |
| system_prompt_ai_search? | string | |
| system_prompt_index_summarization? | string | |
| system_prompt_rewrite_query? | string | |
| token_id? | string | |
| hybrid_search_enabled? | boolean | Deprecated — use index_method instead. |
| id | string | AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores. |
| type? | enum | |
| apiToken? | string | Cloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| apiKey? | string | Cloudflare API key for the legacy key+email auth path; overrides the CLOUDFLARE_API_KEY environment variable. Wire with a vault.get(...) expression. Requires email. |
| email? | string | Cloudflare account email for the legacy key+email auth path; overrides the CLOUDFLARE_EMAIL environment variable. Requires apiKey. |
fn create()
Create a Instances
fn get(id: string)
Get a Instances
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Instances |
fn update()
Update Instances attributes
fn delete(id: string)
Delete the Instances
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Instances |
fn sync()
Sync Instances state from Cloudflare
namespaces.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| description? | string | Optional description for the namespace. Max 256 characters. |
| name | string | |
| apiToken? | string | Cloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| apiKey? | string | Cloudflare API key for the legacy key+email auth path; overrides the CLOUDFLARE_API_KEY environment variable. Wire with a vault.get(...) expression. Requires email. |
| email? | string | Cloudflare account email for the legacy key+email auth path; overrides the CLOUDFLARE_EMAIL environment variable. Requires apiKey. |
fn create()
Create a Namespaces
fn get(id: string)
Get a Namespaces
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Namespaces |
fn update()
Update Namespaces attributes
fn delete(id: string)
Delete the Namespaces
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Namespaces |
fn sync()
Sync Namespaces state from Cloudflare
tokens.tsv2026.06.08.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| cf_api_id | string | |
| cf_api_key | string | |
| legacy? | boolean | |
| name | string | |
| apiToken? | string | Cloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| apiKey? | string | Cloudflare API key for the legacy key+email auth path; overrides the CLOUDFLARE_API_KEY environment variable. Wire with a vault.get(...) expression. Requires email. |
| email? | string | Cloudflare account email for the legacy key+email auth path; overrides the CLOUDFLARE_EMAIL environment variable. Requires apiKey. |
fn create()
Create a Tokens
fn get(id: string)
Get a Tokens
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Tokens |
fn update()
Update Tokens attributes
fn delete(id: string)
Delete the Tokens
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Tokens |
fn sync()
Sync Tokens state from Cloudflare
04Previous Versions
2026.06.08.2Jun 8, 2026
- Updated: instances
- Updated: namespaces
- Updated: tokens
2026.05.29.1May 29, 2026
- Updated: instances
- Updated: namespaces
- Updated: tokens
2026.05.22.1May 22, 2026
- Added: instances
- Added: namespaces
- Added: tokens
05Stats
A
100 / 100
Downloads
0
Archive size
21.4 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels