Skip to content

Commit 418c453

Browse files
committed
progress
1 parent 6cdcd57 commit 418c453

File tree

13 files changed

+392
-122
lines changed

13 files changed

+392
-122
lines changed

src/content/docs/autorag/concepts/how-autorag-works.mdx

Lines changed: 0 additions & 8 deletions
This file was deleted.

src/content/docs/autorag/configuration/index.mdx

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,7 @@
22
pcx_content_type: navigation
33
title: Configuration
44
sidebar:
5-
order: 4
6-
group:
7-
hideIndex: true
5+
order: 5
86
---
97

10-
import { DirectoryListing } from "~/components";
11-
12-
<DirectoryListing />
8+
something about all the configurations
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
pcx_content_type: concept
3+
title: Indexing
4+
sidebar:
5+
order: 4
6+
---
7+
8+
import {
9+
Badge,
10+
Description,
11+
Render,
12+
TabItem,
13+
Tabs,
14+
WranglerConfig,
15+
MetaInfo,
16+
Type,
17+
} from "~/components";
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
pcx_content_type: concept
3+
title: System prompt
4+
sidebar:
5+
order: 4
6+
---
7+
8+
import {
9+
Badge,
10+
Description,
11+
Render,
12+
TabItem,
13+
Tabs,
14+
WranglerConfig,
15+
MetaInfo,
16+
Type,
17+
} from "~/components";

src/content/docs/autorag/configuration/workers-binding.mdx

Lines changed: 0 additions & 87 deletions
This file was deleted.

src/content/docs/autorag/get-started.mdx

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ head:
1111

1212
AutoRAG allows developers to create fully managed retrieval-augmented generation (RAG) pipelines to power AI applications with accurate and up-to-date information without needing to manage infrastructure.
1313

14-
## 1. Upload data, or use existing data in R2
14+
## 1. Upload data or use existing data in R2
1515

16-
AutoRAG integrates with R2 for data import. Create an R2 bucket if you don’t have one and upload your data.
16+
AutoRAG integrates with R2 for data import. Create an R2 bucket if you don’t have one and upload your data.
1717

1818
:::note
1919
Before you create your first bucket, you must purchase R2 from the Cloudflare dashboard.
@@ -29,24 +29,18 @@ To create and upload objects to your bucket from the Cloudflare Dashboard:
2929

3030
To create a new AutoRAG:
3131

32-
1. Log in to the [Cloudflare Dashboard](https://dash.cloudflare.com) and select **AI** then **AutoRAG**.
33-
2. Select **Create AutoRAG** and complete the setup process:
34-
- Select a **R2 bucket**.
35-
- Select an **embedding model**.
36-
- Select a **LLM model**.
37-
- Select or create an **AI Gateway**.
38-
- Enter a **name** for the AutoRAG.
39-
- Create a new **API token** or reuse an existing API token.
40-
3. Select **Create**
32+
1. Log in to the [Cloudflare Dashboard](https://dash.cloudflare.com) and select **AI** > **AutoRAG**.
33+
2. Select **Create AutoRAG**, configure the AutoRAG, and complete the setup process.
34+
3. Select **Create**.
4135

42-
## 3. Monitor indexing
36+
## 3. Monitor indexing
4337

44-
Once created, AutoRAG will create a Vectorize database in your account and begin indexing the data.
38+
Once created, AutoRAG will create a Vectorize index in your account and begin indexing the data.
4539

4640
To monitor the indexing progress:
4741

4842
1. From the **AutoRAG** page in the dashboard, locate and select your AutoRAG.
49-
2. Navigate to the **Overview** page to view the current indexing progress.
43+
2. Navigate to the **Overview** page to view the current indexing status.
5044

5145
## 4. Try it out
5246

@@ -57,10 +51,9 @@ Once indexing is complete, you can run your first query:
5751
3. Select **Search with AI** or **Search**.
5852
4. Enter a **query** to test out its response.
5953

60-
6154
## Use AutoRAG options
6255

6356
Cloudflare provides multiple ways for developers to use AutoRAG in their applications:
6457

65-
- REST API
66-
- Workers Binding
58+
- [Workers Binding](/autorag/use-autorag/workers-binding/)
59+
- [REST API](/autorag/use-autorag/rest-api/)
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
pcx_content_type: concept
3+
title: How AutoRAG works
4+
sidebar:
5+
order: 3
6+
---
7+
8+
AutoRAG simplifies the process of building and managing a Retrieval-Augmented Generation (RAG) pipeline using Cloudflare's serverless platform. Instead of manually stitching together components like Workers AI, Vectorize, and writing custom logic for indexing, retireval, and generation, AutoRAG handles it all for you. It also continuously indexes your data to ensure responses stay accurate and up-to-date.
9+
10+
AutoRAG consists of two core processes:
11+
12+
- **Indexing:** An asynchronous background process that monitors your data source for changes and transforms your data into vector representation for search.
13+
- **Querying:** A synchronous process triggered by user queries. It retrieves the most relevant content and generates context-aware responses using a large language model (LLM).
14+
15+
## Indexing
16+
17+
Indexing begins automatically when you create an AutoRAG instance and connect a data source. It runs asynchronously in the background and checks for updates periodically, so new or updated data are automatically indexed in the vector index.
18+
19+
Here is what happens during indexing:
20+
21+
1. **Data ingestion:** AutoRAG reads from your connected data source. Files that are unsupported or exceed size limits are flagged and reported as indexing errors.
22+
2. **Markdown conversion:** AutoRAG uses a Worker powered by [Workers AI’s Markdown Conversion](/workers-ai/markdown-conversion/) to convert all data into structured Markdown. This ensures consistency across diverse file types. For images, Workers AI is used to perform object detection followed by vision-to-language transformation to convert images into Markdown text.
23+
3. **Chunking:** The extracted text is chunked to improve retrieval granularity.
24+
4. **Embedding:** Each chunk is embedded using Workers AI’s embedding model to transform the content into vectors.
25+
5. **Vector storage:** The resulting vectors, along with metadata like source location and file name, are stored in a Vectorize index created on your account.
26+
27+
[INSERT IMAGE]
28+
29+
## Querying
30+
31+
Once indexing is complete, AutoRAG is ready to respond to end-user queries in real time.
32+
33+
Here’s how the querying pipeline works:
34+
35+
1. **Receive query from AutoRAG API:** The query workflow begins when you send a request to the AutoRAG API.
36+
2. **Query rewriting (optional):** The input query can be rewritten by one of Workers AI’s LLMs to improve semantic retrieval, if enabled.
37+
3. **Embedding the query:** The rewritten (or original) query is turned into a vector via the same embedding model in Workers AI.
38+
4. **Querying Vectorize index:** The query vector is [searched](/vectorize/best-practices/query-vectors/) against the Vectorize index associated with your AutoRAG instance.
39+
5. **Content retrieval:** Vectorize returns the most relevant chunks and their metadata. And the original content is retrieved from the R2 bucket. These are passed to a text-generation model.
40+
6. **Response generation:** A text-generation model from Workers AI is used to a response using the retrieved content and the original user’s query using the generation model you select.
41+
42+
[INSERT IMAGE]
43+
44+
## Get Started
45+
46+
Learn how to [get started](/autorag/get-started/) with AutoRAG.

src/content/docs/autorag/index.mdx

Lines changed: 75 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,88 @@ import {
1515
LinkTitleCard,
1616
Plan,
1717
RelatedProduct,
18+
LinkButton,
1819
} from "~/components";
1920

2021
<Plan type="all" />
22+
23+
AutoRAG allows developers to create fully-managed retrieval-augmented generation (RAG) pipelines powered by Cloudflare allowing developers to integrate context-aware AI into their applications without managing infrastructure.
24+
25+
<div>
26+
<LinkButton href="/autorag/get-started">Get started</LinkButton>
27+
<LinkButton target="_blank" variant="secondary" icon="external" href="">
28+
Watch an AutoRAG demo
29+
</LinkButton>
30+
</div>
31+
2132
---
2233

2334
## Features
35+
2436
---
2537

2638
## Related products
39+
40+
<RelatedProduct header="Workers AI" href="/workers-ai/" product="workers-ai">
41+
42+
Run machine learning models, powered by serverless GPUs, on Cloudflare’s global network.
43+
44+
</RelatedProduct>
45+
46+
<RelatedProduct header="AI Gateway" href="/ai-gateway/" product="ai-gateway">
47+
48+
Observe and control your AI applications with caching, rate limiting, request retries, model fallback, and more.
49+
50+
</RelatedProduct>
51+
52+
<RelatedProduct header="Vectorize" href="/vectorize/" product="vectorize">
53+
54+
Build full-stack AI applications with Vectorize, Cloudflare’s vector database.
55+
56+
</RelatedProduct>
57+
58+
<RelatedProduct header="Workers" href="/workers/" product="workers">
59+
60+
Build serverless applications and deploy instantly across the globe for exceptional performance, reliability, and scale.
61+
62+
</RelatedProduct>
63+
64+
<RelatedProduct header="R2" href="/r2/" product="r2">
65+
66+
Store large amounts of unstructured data without the costly egress bandwidth fees associated with typical cloud storage services.
67+
68+
</RelatedProduct>
69+
2770
---
28-
## More resources
71+
72+
## More resources
73+
74+
<CardGrid>
75+
76+
<LinkTitleCard
77+
title="Get started"
78+
href="/workers-ai/get-started/workers-wrangler/"
79+
icon="open-book"
80+
>
81+
Build and deploy your first Workers AI application.
82+
</LinkTitleCard>
83+
84+
<LinkTitleCard
85+
title="Developer Discord"
86+
href="https://discord.cloudflare.com"
87+
icon="discord"
88+
>
89+
Connect with the Workers community on Discord to ask questions, share what you
90+
are building, and discuss the platform with other developers.
91+
</LinkTitleCard>
92+
93+
<LinkTitleCard
94+
title="@CloudflareDev"
95+
href="https://x.com/cloudflaredev"
96+
icon="x.com"
97+
>
98+
Follow @CloudflareDev on Twitter to learn about product announcements, and
99+
what is new in Cloudflare Workers.
100+
</LinkTitleCard>
101+
102+
</CardGrid>
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
pcx_content_type: navigation
3-
title: Key concepts
3+
title: Use AutoRAG
44
sidebar:
5-
order: 2
5+
order: 4
66
group:
77
hideIndex: true
88
---
99

1010
import { DirectoryListing } from "~/components";
1111

12-
<DirectoryListing />
12+
<DirectoryListing />

0 commit comments

Comments
 (0)