docs(cookbook): revamp semantic-caching against playbook#663
Open
SuhaniNagpal7 wants to merge 1 commit into
Open
docs(cookbook): revamp semantic-caching against playbook#663SuhaniNagpal7 wants to merge 1 commit into
SuhaniNagpal7 wants to merge 1 commit into
Conversation
What changed - Frontmatter: full kebab-case schema (slug, author, products, frameworks, difficulty, tags, og-image, canonical, last-tested-date, structured last-tested-with, code-repo-url, page-type). - Added "What you'll build" section with 5 concrete artifact bullets so the reader sees the deliverables before they invest 10 minutes. - Rewrote "Why this matters" as a reader-facing diagnosis: "your support bot's bill grows with rephrasings, not new questions," with a "pull a day of your own request logs" prompt that lets the reader confirm the symptom in their own setup. Covers the four playbook elements (incident, why standard caches miss, FAGI fix, proof metric on the x-agentcc-cache header). - Removed the unused `pip install agentcc` (was never imported). - Strip em dashes (12 occurrences) per docs style. - Troubleshooting table gained the "Verify" column. - Replaced "Explore further" reference cards with a 4-item technical next-steps ladder (force-refresh in CI, namespaces, threshold tuning, routing policy) plus one reference link. - Step 4 closes with a real screenshot of the Gateway -> Providers -> Cache panel showing 80% hit rate, 30 requests, 24 hits, $0.0089 saved. Real product UI with mock numbers matching the cookbook's example math (6 unique x 5 = 30; 6 misses + 24 hits = 80%). Out of scope - No notebook changes in this PR. cookbooks/command-center/ semantic-caching.ipynb has equivalent revamp ready but lives in a different repo; will follow up there.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
title+descriptiononlyslug,date,author,products,frameworks,difficulty,time-to-complete,tags,og-image,canonical,last-tested-date, structuredlast-tested-with,code-repo-url,page-typex-agentcc-cacheheader values)pip install openai agentcc(unused)pip install openaionlyVerifyWhy this is shaped the way it is
localhost:8000dashboard layout), not a from-scratch mockup. Numbers are overlaid so they match the cookbook's worked example (6 unique * 5 = 30 calls; 6 misses + 24 hits = 80% hit rate; $0.0111 baseline - $0.00222 actual = ~$0.0089 saved).Depends on
<Mermaid>component is not required here. This cookbook has no<Mermaid>usage. Can merge independently.Test plan
pnpm devand visit/docs/cookbook/command-center/semantic-caching-- confirm the new Step 4 screenshot loads from S3 and all 5 step blocks render.grep -nE "(-|-)" src/pages/docs/cookbook/command-center/semantic-caching.mdxreturns no hits.pnpm astro buildpasses.Out of scope
cookbooks/command-center/semantic-caching.ipynb) has an equivalent revamp pending in thefuture-agi/cookbooksrepo. Tracked separately; not part of this PR.