Example app

These docs answer questions about themselves.

At build time, ask-my-site index turns the pages below into a static index. At request time, the ask endpoint searches it in memory and streams a cited answer. Press ⌘K to try it.

Running in mock mode: deterministic embeddings and a scripted, extractive model. No API key needed.

• IntroductionWhat ask-my-site is and when to use it.
• Getting startedInstall, index your content, add the endpoint and the dialog.
• Indexing contentLoaders, frontmatter, URLs, chunking and the --check mode.
• How retrieval worksBM25, cosine similarity, reciprocal rank fusion and the relevance gate.
• The index fileWhy vectors are int8, how the file stays small and diffable.
• The ask endpointcreateAskHandler options, the streaming protocol and rate limiting.
• The ask dialogAskDialog props, the useAsk hook, theming and accessibility.
• DeployingRuntimes, bundle size, cold starts and cost.
• Limits and trade-offsWhere ask-my-site stops being the right tool.