Design an AI coding assistant
How an editor assistant suggests code in under a second: gathering context, retrieval, the model, streaming and keeping private code safe.
On the roadmap:Software Architect · step 5: Learn from the giants
Lesson 18 of 18 · 11 min read · quiz · exercise
The problem
An assistant inside the editor that completes code as you type, answers questions in a chat panel, and can edit files. The hard constraints:
- Latency: inline suggestions must appear in roughly a few hundred milliseconds, or the user has already moved on.
- Relevance: good suggestions need the right context from a large codebase, not just the current line.
- Cost: language-model inference is expensive per request, and typing generates a request storm.
- Privacy and security: customer source code and secrets are sensitive.
- Quality: wrong or insecure suggestions must be limited and measurable.
Architecture
Figure SDA-RWS-18-1 · AI coding assistant architecture · © forcsguy.com
1. The editor extension
Runs in the user's editor. It watches typing, debounces requests (waits a few tens of milliseconds), cancels outdated requests when the user continues typing, and streams the suggestion into the editor as ghost text. It also handles accept, reject and partial accept, and enforces local privacy rules (excluded files, secret detection).
2. Building context
Prompt = instructions + context + the code around the cursor. Context comes from:
- The current file: the code before the cursor (prefix) and after it (suffix, for fill-in-the-middle).
- Open tabs and recently edited files.
- Imports and related files: definitions of functions and types being used.
- Retrieved snippets from the wider project.
All of it must fit the model's context window and a token budget, so the builder ranks pieces by relevance and trims.
3. Retrieval over a codebase
A repository is too big to include whole, so it is indexed:
- Split files into chunks (functions, classes, blocks).
- Compute embeddings (vectors capturing meaning) and store them in a vector index, together with a symbol and dependency graph (what calls what).
- At request time, search with the current code as the query and combine semantic results with structural ones (definitions, callers, tests).
- Update the index incrementally as files change, and keep per-user and per-organisation isolation.
4. Model serving
- A language model generates tokens. Serving systems batch many requests together, reuse a KV cache of already-processed prompt tokens, and stream output so the first words show immediately.
- Use smaller, faster models for inline completion and larger ones for chat and complex edits.
- Cache repeated prompts and completions where context is identical, and prefix-cache shared prompt parts.
- Autoscale GPU capacity, and route by region for latency.
5. Post-processing and safety
- Trim the output to a sensible stopping point (end of block or line).
- Filter secrets, personal data and known insecure patterns; optionally check for verbatim public code matches and licence concerns.
- Reject low-confidence suggestions instead of showing noise.
- For agents that edit files or run commands, require explicit user approval and run actions in a sandbox.
Figure SDA-RWS-18-2 · How a code model is trained and judged · © forcsguy.com
Latency budget
For inline suggestions, a budget like this keeps the experience smooth:
| Step | Target |
|---|---|
| Debounce and local context | about 30 ms |
| Network to the service | about 30 ms |
| Retrieval and prompt building | about 30 ms |
| Model: time to first token | about 150 ms |
| Streaming and display | continuous |
Everything else (retrieval, indexing, safety checks) must fit inside it or run asynchronously ahead of time.
Privacy, security and trust
- Send only what is needed, respect ignore files, and redact secrets.
- Provide enterprise controls: private deployment or isolated tenancy, no training on customer code, short retention, audit logs.
- Encrypt in transit and at rest; strong authentication and per-user quotas.
- Defend against prompt injection (malicious text in files or web pages trying to instruct the model): treat retrieved content as data, limit tool permissions, require confirmation for risky actions.
Measuring quality
- Offline evaluation: run the model on held-out code and tests, measure pass rates and exact-match similarity.
- Online metrics: acceptance rate of suggestions, characters kept after acceptance, latency percentiles, and errors.
- A/B test changes to prompts, models and retrieval, and watch for regressions in security and licence filters.
- Collect feedback signals (thumbs up or down) while respecting privacy.
What this design reuses
Debouncing and cancellation, caching, rate limiting and quotas, queues and batching, vector search, streaming responses and careful privacy controls: the same building blocks from the rest of this course, applied to a latency-sensitive AI workload.
Real-world reading
Related reading
- Secret Detector: Preventing Secrets in Source Code at YelpYelp engineers · YelpCase Studies
- Samza: Stream Processing System for Latency Insighs at LinkedInLinkedIn engineers · LinkedInCase Studies
- Use The Index, LukeMarkus Winand · use-the-index-luke.comCourses
- Backend Developer Roadmaproadmap.sh community · roadmap.shCourses
Show 6 moreShow fewer
- Natural Language Processing and Content Analysis (2 parts) at Condé NastCondé Nast engineers · Condé NastCase Studies
- Machine Learning for Indexing Text from Billions of Images at DropboxDropbox engineers · DropboxCase Studies
- Optimizing Web Servers for High Throughput and Low Latency at DropboxDropbox engineers · DropboxCase Studies
- Scalable User Privacy at SpotifySpotify engineers · SpotifyCase Studies
- Privacy-Preserving Analytics and Reporting at LinkedInLinkedIn engineers · LinkedInCase Studies
- Learning with Privacy at Scale at AppleScale at Apple engineers · Scale at AppleCase Studies
Check your understanding
Question 1 of 3
0 correct so far
Why must an inline code-completion request be cancelled when the user keeps typing?
Go deeper
- Retrieval-augmented generation and LLM serving (vLLM, PagedAttention) by Lewis et al.; Kwon et al.: search for the papers and documentation; background for the retrieval and serving parts
Practise it: Model calls are the bottleneck
Everything below is already set up for this lesson: change the design, run the traffic, and see whether you meet the goal.
- 1The task
- 2Build and test
40% of 350 requests per second need an AI model. One inference instance handles about 40 requests a second, and each costs a lot.
Goal: Under 1% errors, slowest 5% under 3,000 ms, within $7,500 a month.
Look at the AI inference part's instances. More capacity costs real money, so watch the monthly figure.
Try it yourself
The assistant works well in small files but gives poor suggestions in a 2 million line repository. Explain why and how you would improve it.
Click what a strong design here would need:
More in Real systems
© 2026 forcsguy.com. Original lesson text and diagrams. Books and sites linked above belong to their authors.