-
Notifications
You must be signed in to change notification settings - Fork 10k
[AI Audit] Initialising AI Audit docs #22950
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
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
bc249b4
Initialising AI Audit docs
Oxyjun bf572b5
Fixing product yaml file.
Oxyjun 95d5ae8
Setting up more pages for AI Audit docs
Oxyjun cacb286
Documenting AI Audit metrics
Oxyjun 543f9c3
Iterating over feedback part 1
Oxyjun 054fa20
changelog update
kodster28 e952c41
proxy clarification
kodster28 968ff6c
Adding more content, matching text to current UI.
Oxyjun ec02bcb
Adding docs on Violations only toggle.
Oxyjun ebf9e01
Removing inaccuracy.
Oxyjun 5b165ca
Wording clarification.
Oxyjun ce8b300
Fixing incorrect sentence
Oxyjun 2baeb44
minor tweaks
kodster28 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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 17 additions & 0 deletions
17
src/content/changelog/ai-audit/2024-09-23-ai-audit-launch.mdx
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,17 @@ | ||
| --- | ||
| title: AI Audit | ||
| description: AI Audit is available to all customers | ||
| date: 2024-09-23T11:00:00Z | ||
| --- | ||
|
|
||
| Every site on Cloudflare now has access to [**AI Audit**](/ai-audit/), which summarizes the crawling behavior of popular and known AI services. | ||
|
|
||
| You can use this data to: | ||
|
|
||
| - Understand how and how often crawlers access your site (and which content is the most popular). | ||
| - Block some or all of the AI bots accessing your site. | ||
| - Use Cloudflare to enforce your `robots.txt` policy via an automatic WAF rule. | ||
|
|
||
|  | ||
|
|
||
| To get started, explore [AI audit](/ai-audit/). |
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,12 @@ | ||
| --- | ||
| pcx_content_type: changelog | ||
| title: Changelog | ||
| sidebar: | ||
| order: 100 | ||
| --- | ||
|
|
||
| import { ProductChangelog } from "~/components"; | ||
|
|
||
| {/* <!-- Actual content lives in /src/content/changelog/ai-audit/. Update the file there for new entries to appear here. For more details, refer to https://developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/changelog/#yaml-file --> */} | ||
|
|
||
| <ProductChangelog product="ai-audit" /> |
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,46 @@ | ||
| --- | ||
| title: Detect AI crawlers | ||
| pcx_content_type: concept | ||
| sidebar: | ||
| order: 2 | ||
| --- | ||
|
|
||
| AI Audit metrics provides you with insight on how AI crawlers are interacting with your website. | ||
|
|
||
| ## View AI Audit metrics | ||
|
|
||
| AI Audit provides you with the following metrics to help you understand how AI crawlers are interacting with your website. | ||
|
|
||
| | Metric | Description | | ||
| | --------------------------------- | ------------------------------------------------------------------------ | | ||
| | Request by AI crawlers | A graph which displays the number of crawl requests from each AI crawler | | ||
| | Summary | A list of AI crawlers with the most number of crawl requests | | ||
| | Most popular paths by AI crawlers | The most popular pages crawled by AI crawlers, for each AI crawler | | ||
|
|
||
| The **Summary** table also enables you to [Enforce your robots.txt](/ai-audit/features/enforce-robots-txt/). | ||
|
|
||
| ## Filter AI crawler data | ||
|
|
||
| You can use filters to narrow the scope of your result. | ||
|
|
||
| - **Provider:** Filter by the AI crawler owners. | ||
| - **Bot type:** Filter by the type of the AI bot (for example, AI crawler, AI assistant, or archiver). | ||
| - **Date range:** Filter the date range of your results. You can choose from three predetermined date ranges: | ||
| - Past 7 days | ||
| - Past 14 days | ||
| - Past month | ||
|
|
||
| The values of the AI Audit metrics will update according to your filter. | ||
|
|
||
| ## Filter subdomains | ||
|
|
||
| You can use the subdomain filter to narrow the scope of your result. | ||
|
|
||
| From the dropdown, select either **All subdomains**, or the specific subdomain you wish to view. | ||
|
|
||
| Selecting a specific subdomain allows you to access: | ||
|
|
||
| - **Violations only** toggle: Toggles the AI Audit page to only display bots which are violating your configured rules. | ||
| - [**Enforce robots.txt policy**](/ai-audit/features/enforce-robots-txt/): Ensure bots cannot access webpages which are off-limits, as specified in your `robots.txt` file. | ||
|
|
||
| The values of the AI Audit metrics will update according to your filter. |
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,37 @@ | ||
| --- | ||
| title: Enforce robots.txt | ||
| pcx_content_type: concept | ||
| sidebar: | ||
| order: 5 | ||
| --- | ||
|
|
||
| import { Steps } from "~/components"; | ||
|
|
||
| AI Audit allows you to enforce [`robots.txt`](/radar/glossary/#robotstxt) which instructs bots which webpages they can and cannot access. | ||
|
|
||
| To enforce `robots.txt`: | ||
|
|
||
| <Steps> | ||
| 1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain. | ||
| 2. Go to **AI Audit**. | ||
| 3. From the dropdown at the top of the page, select a specific subdomain where you wish you enforce `robots.txt`. | ||
| 4. From **Summary**, select **Enforce robots.txt policy**. | ||
| 5. From the **Enforce your robots.txt policy** page, select **Go to WAF custom rules**. | ||
| 6. From the **New custom rule** page, name your custom rule. | ||
| - The page will automatically populate the values for the custom rule. | ||
| 7. From **Then take action...**: | ||
| - For **Choose action**, select **Block**. | ||
| - For **With response type**, select **Default Cloudflare WAF block page**. | ||
| 8. From **Place at**: | ||
| - For **Select order**, select **Last**. | ||
| 9. Select **Deploy**. | ||
| </Steps> | ||
|
|
||
| This custom rule ensures that bots cannot access the pages specified in your `robots.txt` file. | ||
|
|
||
| ## Related resources | ||
|
|
||
| For more information, refer to the following resources. | ||
|
|
||
| - [What is robots.txt? | How a robots.txt file works](https://www.cloudflare.com/en-gb/learning/bots/what-is-robots-txt/) | ||
| - [Direct AI crawlers with managed robots.txt](/bots/additional-configurations/managed-robots-txt/) |
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,12 @@ | ||
| --- | ||
| title: Features | ||
| pcx_content_type: navigation | ||
| sidebar: | ||
| group: | ||
| hideIndex: true | ||
| order: 5 | ||
| --- | ||
|
|
||
| import { DirectoryListing } from "~/components"; | ||
|
|
||
| <DirectoryListing /> |
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,76 @@ | ||
| --- | ||
| title: Get started | ||
| pcx_content_type: get-started | ||
| sidebar: | ||
| order: 2 | ||
| group: | ||
| badge: beta | ||
| head: | ||
| - tag: title | ||
| content: Get started with Cloudflare AI Audit | ||
| description: Learn how to set up AI Audit. | ||
| --- | ||
|
|
||
| import { Render, Steps } from "~/components"; | ||
|
|
||
| This guide instructs you through | ||
|
|
||
| - Viewing AI crawlers that are interacting with your domain. | ||
| - Creating a rule to block AI crawlers on your website. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| 1. Sign up for a [Cloudflare account](https://dash.cloudflare.com/sign-up/). | ||
| 2. [Connect your domain to Cloudflare](/fundamentals/manage-domains/add-site/). | ||
Oxyjun marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 3. Make sure your domain is [proxying traffic through Cloudflare](/fundamentals/concepts/how-cloudflare-works/#cloudflare-as-a-reverse-proxy). | ||
|
|
||
| ## 1. Block all AI crawlers | ||
|
|
||
| To use AI Audit: | ||
|
|
||
| {/* prettier-ignore */} | ||
| <Steps> | ||
| 1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain. | ||
| 2. Go to **AI Audit**. | ||
| 3. From **Most Popular Paths**, select **Block All**. | ||
| 4. From the **Bot traffic** page, under **Block AI Bots**, select **Enable**. | ||
| </Steps> | ||
|
|
||
| ## 2. Block specific bot categories (Enterprise plan only) | ||
|
|
||
| Customers on the Enterprise plan -- and with a [Bot Management subscription](/bots/plans/bm-subscription/) -- can choose to only block specific AI crawlers, while allowing others. | ||
|
|
||
| {/* prettier-ignore */} | ||
| <Steps> | ||
| 1. Go to the **AI Audit**. | ||
| 2. From **Most Popular Paths**, select **Block Some**. | ||
| 3. From the **Security rules** page, select **Create rule** > **Custom rules**. | ||
| 4. Provide a name for the custom rule. For example, "Block unwanted AI crawlers". | ||
| 5. From the **Field** dropdown, select **Verified Bot Category**. | ||
| 6. From the **Value** dropdown, select the specific bot category you wish to block. | ||
| - You can use **And** / **Or** buttons to add additional conditions. For example, you can use multiple **Or** options to include multiple bot categories in the same rule. | ||
| 7. From the **Then take action...** section: | ||
| - For **Choose action**, select **Block**. | ||
| - For **With response type**, select **Default Cloudflare WAF block page**. | ||
| 8. From the **Place at** section: | ||
| - For **Select order**, select **First**. | ||
| 9. Select **Save**. | ||
| </Steps> | ||
|
|
||
| This custom rule will only block the AI bots which belong to the [verified bot categories](/bots/concepts/bot/verified-bots/categories/) you have included in your rule (in step 6). | ||
|
|
||
| For more information on creating a custom WAF rule, refer to [Create a custom rule in the dashboard](/waf/custom-rules/create-dashboard/). | ||
|
|
||
| ## 3. Review detected AI crawlers | ||
|
|
||
| Review the AI crawlers detected on your site in the **Metrics** tab of the Cloudflare dashboard for key metrics. | ||
|
|
||
| Refer to [Detect AI crawlers](/ai-audit/features/detect-ai-crawlers/) for more information. | ||
|
|
||
| ## Related resources | ||
|
|
||
| Refer to the following related resources: | ||
|
|
||
| - Cloudflare blog: [Start auditing and controlling the AI models accessing your content](https://blog.cloudflare.com/nl-nl/cloudflare-ai-audit-control-ai-content-crawlers/) | ||
| - Block AI crawlers that do not adhere to recommended guidelines using [Cloudflare AI Labyrinth](/bots/additional-configurations/ai-labyrinth/). | ||
| - [Direct AI crawlers with managed robots.txt](/bots/additional-configurations/managed-robots-txt/). | ||
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,69 @@ | ||
| --- | ||
| title: AI Audit | ||
| pcx_content_type: overview | ||
| sidebar: | ||
| order: 1 | ||
| badge: Beta | ||
| head: | ||
| - tag: title | ||
| content: Overview | ||
| description: AI Audit is a tool which allows you to analyze and control how third-party AI crawlers interact with your website. | ||
| --- | ||
|
|
||
| import { Description, Feature, FeatureTable, Plan, LinkButton, RelatedProduct } from "~/components"; | ||
|
|
||
| <Description> | ||
|
|
||
| Analyze and control third-party AI crawlers in your website. | ||
|
|
||
| </Description> | ||
|
|
||
| <Plan type="all" /> | ||
|
|
||
| AI Audit helps manage AI crawlers on your website by providing visibility on which crawlers are accessing your webpage, and allowing you to block unwanted crawlers. | ||
Oxyjun marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| <LinkButton href="/ai-audit/get-started/">Get started </LinkButton> | ||
|
|
||
| :::note[Beta phase] | ||
| AI Audit is currently only available as a beta product. | ||
| ::: | ||
|
|
||
| --- | ||
|
|
||
| ## Features | ||
|
|
||
| <Feature | ||
| header="AI crawler detection" | ||
| href="/ai-audit/features/ai-crawler-detection/" | ||
| cta="View AI crawlers" | ||
| > | ||
| Displays information about AI crawlers in your domains' pages. | ||
| </Feature> | ||
|
|
||
Oxyjun marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| <Feature | ||
| header="Enforce robots.txt" | ||
| href="/ai-audit/features/enforce-robots-txt/" | ||
| cta="Enforce your robots.txt" | ||
| > | ||
| Enforce your `robots.txt` with a Cloudflare WAF rule. | ||
| </Feature> | ||
|
|
||
| --- | ||
|
|
||
| ## Related Products | ||
|
|
||
| <RelatedProduct | ||
| header="Bots" | ||
| href="/bots/" | ||
| product="bots" | ||
| > | ||
| Identify and mitigate automated traffic to protect your domain from bad bots. | ||
| </RelatedProduct> | ||
|
|
||
| <RelatedProduct | ||
| header="Web Application Firewall" | ||
| href="/waf/" | ||
| product="waf" | ||
| > | ||
| Get automatic protection from vulnerabilities and the flexibility to create custom rules. | ||
| </RelatedProduct> | ||
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,10 @@ | ||
| name: AI Audit | ||
| product: | ||
| title: AI Audit | ||
| url: /ai-audit/ | ||
| group: Core platform | ||
| additional_groups: [AI] | ||
| meta: | ||
| title: AI Audit | ||
| description: Analyze and control third-party AI crawlers in your website | ||
| author: "@cloudflare" |
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,11 @@ | ||
| --- | ||
| link: "/ai-audit/changelog/" | ||
| productName: AI Audit | ||
| productLink: "/ai-audit/" | ||
| productArea: Core platform | ||
| productAreaLink: /fundamentals/reference/changelog/platform/ | ||
| entries: | ||
| - publish_date: "2025-06-09" | ||
| title: Documentation for AI Audit | ||
| description: There is now documentation for AI Audit | ||
|
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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.