Skip to content

AI Search: update cache, syncing, and file type docs#31661

Open
G4brym wants to merge 1 commit into
productionfrom
ai-search/cache-sync-file-crawl-docs
Open

AI Search: update cache, syncing, and file type docs#31661
G4brym wants to merge 1 commit into
productionfrom
ai-search/cache-sync-file-crawl-docs

Conversation

@G4brym

@G4brym G4brym commented Jun 24, 2026

Copy link
Copy Markdown
Member

Changes

  • Document configurable AI Search similarity cache TTLs and dashboard/API cache purge.
  • Update inactivity-paused sync behavior to describe automatic resume after search/chat activity.
  • Add .mdoc, .sql, and .log.gz to supported file types.

@cloudflare-docs-bot

cloudflare-docs-bot Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Review

⏸️ Automatic reviews for this PR are paused.

This PR has already received 2 automatic reviews. To run another review, a codeowner can comment /review or /full-review. To permanently lift the limit for this PR, a codeowner can comment /ignore-review-limit.

Tip: Keep PRs in draft mode until they are ready for review — the bot skips draft PRs automatically.


⚠️ 1 warning, 💡 2 suggestions found in commit a7b5d8a.

Code Review

This code review is in beta and may not always be helpful — use your judgment.

Warnings (1)
File Issue
ai-search/configuration/retrieval/cache.mdx line 55 Undocumented instance parameter — The change introduces cache_ttl as an instance-level create/update setting, but the canonical AI Search create-instance parameter reference (src/content/partials/ai-search/v2-create-instance-params.mdx) on this branch does not list it. Fix: Add cache_ttl to src/content/partials/ai-search/v2-create-instance-params.mdx so the create/update API reference includes the new field.

Style Guide Review

Suggestions (2)
File Issue
ai-search/configuration/retrieval/cache.mdx line 55 Active voice preferred — Sentence uses passive voice: "cached responses are retained" Fix: Rewrite as active voice: "Set cache_ttl when creating or updating an instance to control how long the instance retains cached responses."
ai-search/configuration/indexing/syncing.mdx line 47 Use refer to [link] instead of see [link] — Line adds "(see Controls)" Fix: Change to refer to [Controls](#controls)
Commands

Only codeowners can run commands. Post a comment with the command to trigger it.

Command Description
/review Runs a review now. Incremental if a prior review exists, full if not.
/full-review Re-reviews the entire PR diff from scratch, ignoring incremental history. Useful after a rebase, when you want a fresh review, or if the bot gets out of sync and reports issues that no longer exist.
/ignore-review-limit Permanently lifts the 2-review automatic limit for this PR. Future pushes will trigger reviews as normal.

@github-actions

github-actions Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/changelog/ai-search/ @cloudflare/pm-changelogs, @rita3ko, @irvinebroque, @aninibread, @mchenco, @digizeph, @cloudflare/product-owners
/src/content/docs/ai-search/ @rita3ko, @irvinebroque, @aninibread, @G4brym, @mchenco, @digizeph, @cloudflare/product-owners
* @cloudflare/product-owners

@ask-bonk ask-bonk Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One style issue to fix before merge.\n\nLOWcache.mdx lines 74-77: In API examples (curl blocks), use $VARIABLE_NAME shell variable format per the style guide instead of angle-bracket placeholders. Posted an inline suggestion.

Comment thread src/content/docs/ai-search/configuration/retrieval/cache.mdx
@ask-bonk

ask-bonk Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Posted a review on PR #31661 with one inline suggestion.

Summary of changes

  • New changelog entry for AI Search covering cache controls, crawler options, auto-resume, and file type support
  • Documents configurable cache_ttl values and the purge cache operation in cache.mdx
  • Updates sync behavior to describe automatic resume after search/chat activity in syncing.mdx
  • Adds .mdoc and .sql to supported file types in data-source/index.mdx
  • Documents website crawler option defaults in website.mdx

Issue flagged

  • LOWcache.mdx lines 74-77: The curl example uses angle-bracket placeholders (<ACCOUNT_ID>, <API_TOKEN>). The style guide requires $VARIABLE_NAME shell variable format in curl blocks. I posted an inline suggestion to change these to $ACCOUNT_ID, $INSTANCE_NAME, and $CLOUDFLARE_API_TOKEN.

Not flagged

  • The existing TypeScript example in cache.mdx uses a bare ts fence rather than the TypeScriptExample component, but this is pre-existing unchanged code so I left it per the review guidelines.

github run

@G4brym G4brym force-pushed the ai-search/cache-sync-file-crawl-docs branch from 6dfa87f to 2d36e42 Compare June 24, 2026 08:01
@G4brym G4brym changed the title AI Search: update cache, syncing, and crawler docs AI Search: update cache, syncing, and file type docs Jun 24, 2026
@G4brym G4brym force-pushed the ai-search/cache-sync-file-crawl-docs branch from 2d36e42 to a7b5d8a Compare June 24, 2026 08:02
@G4brym G4brym force-pushed the ai-search/cache-sync-file-crawl-docs branch from a7b5d8a to e662e02 Compare June 24, 2026 08:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants