Skip to content

Expand Ask Fern documentation #444

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions fern/products/ask-fern/ask-fern.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ navigation:
path: ./pages/features/citations.mdx
- page: Custom FAQs
path: ./pages/features/custom-faqs.mdx
- page: Insights
path: ./pages/features/insights.mdx
- page: Evals
path: ./pages/features/evals.mdx
- api: API Reference
api-name: fai
icon: fa-regular fa-pro
Expand Down
12 changes: 12 additions & 0 deletions fern/products/ask-fern/pages/features/evals.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Evals
description: Benchmark Ask Fern's performance against competitors and track improvements.
---

Fern evaluates how accurately Ask Fern answers questions on your documentation site compared to competitor AI search solutions.

Fern first generates evaluation questions from your documentation files, then runs those questions through both Ask Fern and competitor systems. Finally, Fern evaluates each answer against the original documentation for accuracy. You receive detailed performance metrics and comparative analysis.

## Availability

Evals are currently provided as custom analysis delivered directly by the Fern team.
10 changes: 10 additions & 0 deletions fern/products/ask-fern/pages/features/insights.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Insights
description: Fern identifies documentation gaps and improvement opportunities from your user queries.
---

Fern analyzes Ask Fern query patterns to surface actionable recommendations for improving your documentation. After collecting sufficient query data over a month, Fern processes this through specialized models that analyze query-response pairs to identify documentation gaps, extract common themes, and generate specific suggestions for enhancing your docs.

## Availability

Insights are currently provided as a monthly report delivered directly by the Fern team.
55 changes: 45 additions & 10 deletions fern/products/ask-fern/pages/getting-started/what-is-ask-fern.mdx
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
---
title: AI Search Overview
title: What is Ask Fern?
subtitle: Let your customers find answers in your documentation instantly.
---

<Note>Ask Fern is available on the [Pro plan](https://buildwithfern.com/pricing#Docs) of Fern Docs. Billing is by usage.</Note>

## Overview

<Frame caption="AI Search is accessed via the search bar, alongside keyword search.">
<img src="../assets/search-modal.png" alt="Accessing AI Search" />
</Frame>

Fern AI Search indexes your documentation and provides an interface for your users to ask questions and get answers. We've found that it helps our customers:
Ask Fern is Fern's AI Search feature that indexes your documentation and provides an interface for your users to ask questions and get answers. It helps our customers

- **Decrease the time to find needed information** - Help users quickly locate crucial documentation without navigating through a maze of tabs and endpoints.
- **Integrate your product faster** - Accelerate implementation with ready-to-use code samples that demonstrate practical applications.
- **Surface where your docs have gaps** - Identify documentation weaknesses through user feedback and search patterns.
- **Decrease the time to find needed information** Help users quickly locate crucial documentation without navigating through a maze of tabs and endpoints.
- **Integrate your product faster** Accelerate implementation with ready-to-use code samples that demonstrate practical applications.
- **Surface where your docs have gaps** Identify documentation weaknesses through user feedback and search patterns.

<Frame caption="Users can ask questions and get support in an intuitive chat interface.">
<img src="../assets/ask-ai-modal.png" alt="Preview of AI Search" />
Expand All @@ -27,7 +29,7 @@ Fern AI Search indexes your documentation and provides an interface for your use
icon="regular book-open"
href="/learn/ai-search/custom-prompting"
>
Tailor AI Search results to your users' needs.
Tailor Ask Fern results to your users' needs.
</Card>

<Card
Expand All @@ -43,19 +45,52 @@ Fern AI Search indexes your documentation and provides an interface for your use
icon="regular plug"
href="/learn/docs/building-and-customizing-your-docs/search"
>
Offer flexibility to have users 'Ask AI' or search your docs directly with Algolia.
Offer flexibility to have users "Ask AI" or search your docs directly with Algolia.
</Card>

<Card
title="All-in-one platform"
icon="regular fa-layer-group"
href="/learn/docs/getting-started/overview"
>
Create seamless UX by offering a 'one-stop-shop' for all docs questions.
Create seamless UX by offering a one-stop-shop for all docs questions.
</Card>

</CardGroup>

## Pricing
## How it works

Ask Fern is a **Retrieval Augmented Generation (RAG)** system built on top of your documentation site that transforms your documentation into an intelligent, searchable knowledge base. The main parts of the Ask Fern system are:

* **Content indexing** – Fern automatically processes your documentation pages,
breaking them into semantic chunks and converting each chunk into a vector
using sentence embedding models. They're stored in a database that serves as
Ask Fern's search index.
* **Query processing** – When users ask questions, Ask Fern vectorizes their
query and searches the database to find the most relevant documentation
chunks.
* **Response generation** – Ask Fern uses the retrieved chunks as context to
generate accurate answers with [citations](/ask-fern/features/citations) for the user. If the initial context isn't sufficient, it performs an additional keyword search.

### Life of a query

Each Ask Fern user query follows these steps:

Ask Fern is available on the [Pro plan](https://buildwithfern.com/pricing#Docs) of Fern Docs. Billing is by usage.
```mermaid
sequenceDiagram
autonumber
participant U as User
participant C as /chat Endpoint
participant V as Documentation Database
participant A as Ask Fern

U->>C: Submit question via Ask Fern searchbox
C->>C: Convert query to vector
C->>V: Search for relevant chunks
V->>C: Return matching documents
C->>A: Send query + context
A->>V: Perform additional keyword search if needed
V->>A: Return additional chunks
A->>A: Generate response
A->>U: Return answer with citations
```