-
Notifications
You must be signed in to change notification settings - Fork 10k
nlweb docs #24614
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
nlweb docs #24614
Changes from 4 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
c61cc5c
nlweb docs
aninibread d9cfebe
add link
aninibread dac2d0f
fix link
aninibread abf5e2f
fix
aninibread 6494066
Update src/content/docs/autorag/how-to/nlweb.mdx
aninibread 8c4f254
Update src/content/docs/autorag/how-to/nlweb.mdx
aninibread 9d92dbb
Update src/content/docs/autorag/how-to/nlweb.mdx
aninibread 7cc8dc0
Apply suggestions from code review
aninibread 59dd4cd
future change flow
aninibread 3aeb0af
update
aninibread fe962ee
embeddable snippet
aninibread File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| --- | ||
| pcx_content_type: concept | ||
| title: NLWeb | ||
| sidebar: | ||
| order: 1 | ||
| --- | ||
|
|
||
| Enable conversational search on your website with NLWeb and Cloudflare AutoRAG. This template crawls your site, indexes the content, and deploys NLWeb-standard endpoints to serve both people and AI agents. | ||
|
|
||
| :::note | ||
| This is a public preview ideal for experimentation. If you're interested in running this in production workflows please contact us at [email protected] | ||
| ::: | ||
|
|
||
| ## What is NLWeb | ||
|
|
||
| [NLWeb](https://github.com/nlweb-ai/NLWeb) is an open project developed by Microsoft that defines a standard protocol for natural language queries on websites. Its goal is to make every website as accessible and interactive as a conversational AI app, so both people and AI agents can reliably query site content. It does this by exposing two key endpoints: | ||
|
|
||
| - `/ask`: Conversational endpoint for user queries | ||
| - `/mcp`: Structured Model Context Protocol (MCP) endpoint for AI agents | ||
|
|
||
| ## How to Use It | ||
aninibread marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| You can deploy NLWeb on your website directly through the AutoRAG dashboard: | ||
|
|
||
| 1. Navigate to Compute & AI > AutoRAG in the Cloudflare Dashboard | ||
| 2. Select Create, then choose the NLWeb Website option | ||
| 3. Select your domain from your Cloudflare account | ||
| 4. Click Deploy | ||
aninibread marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Once complete, AutoRAG will crawl and index your site, then deploy an NLWeb Worker for you. | ||
|
|
||
| ## What This Template Includes | ||
aninibread marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Choosing the NLWeb Website option extends a normal AutoRAG by tailoring it for content‑heavy websites and giving you everything needed to adopt NLWeb as the standard for conversational search on your site. Specifically, the template provides: | ||
aninibread marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| - **Website as a data source:** Uses [Website](/autorag/configuration/data-source/website/) as data source option to crawl and ingest pages with the Rendered Sites option. | ||
| - **Defaults for content-heavy websites:** Applies tuned embedding and retrieval configurations ideal for publishing and content‑rich websites. | ||
| - **NLWeb Worker deployment:** Automatically spins up a Cloudflare Worker from the [NLWeb Worker template](https://github.com/cloudflare/templates). | ||
|
|
||
| ## What the Worker Includes | ||
aninibread marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Your deployed Worker provides two endpoints: | ||
|
|
||
| - `/ask` — NLWeb’s standard conversational endpoint | ||
| - Powers the conversational UI at the root (`/`) | ||
| - Powers the embeddable preview widget (`/snippet.html`) | ||
| - `/mcp` — NLWeb’s MCP server endpoint for trusted AI agents | ||
|
|
||
| These endpoints give both people and agents structured access to your content. | ||
|
|
||
| ## Using It on Your Website | ||
|
|
||
| To integrate NLWeb search directly into your site: | ||
|
|
||
| 1. Find your deployed Worker in the Cloudflare Dashboard. You can do so by going to your AutoRAG, selecting Connect, then the NLWeb tab, and clicking Go to Worker | ||
aninibread marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 2. Add a [custom domain](/workers/configuration/routing/custom-domains/) to your Worker (for example, ask.example.com) | ||
| 3. Use the /ask endpoint on your custom domain to power the search (for example, ask.example.com/ask) | ||
aninibread marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| This lets you serve conversational AI search directly from your own domain, with control over how people and agents access your content. | ||
aninibread marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
|
|
||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.