Skip to content

Commit 0e85ed4

Browse files
committed
expand ask fern overview page
1 parent 6400fb2 commit 0e85ed4

File tree

1 file changed

+41
-6
lines changed

1 file changed

+41
-6
lines changed

fern/products/ask-fern/pages/getting-started/what-is-ask-fern.mdx

Lines changed: 41 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,15 @@ title: AI Search Overview
33
subtitle: Let your customers find answers in your documentation instantly.
44
---
55

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

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

12-
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:
14+
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
1315

1416
- **Decrease the time to find needed information** - Help users quickly locate crucial documentation without navigating through a maze of tabs and endpoints.
1517
- **Integrate your product faster** - Accelerate implementation with ready-to-use code samples that demonstrate practical applications.
@@ -27,7 +29,7 @@ Fern AI Search indexes your documentation and provides an interface for your use
2729
icon="regular book-open"
2830
href="/learn/ai-search/custom-prompting"
2931
>
30-
Tailor AI Search results to your users' needs.
32+
Tailor Ask Fern results to your users' needs.
3133
</Card>
3234

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

4951
<Card
5052
title="All-in-one platform"
5153
icon="regular fa-layer-group"
5254
href="/learn/docs/getting-started/overview"
5355
>
54-
Create seamless UX by offering a 'one-stop-shop' for all docs questions.
56+
Create seamless UX by offering a one-stop-shop for all docs questions.
5557
</Card>
5658

5759
</CardGroup>
5860

59-
## Pricing
61+
## How it works
62+
63+
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:
64+
65+
* **Content Indexing**: Fern automatically processes your documentation pages,
66+
breaking them into semantic chunks and converting each chunk into a vector
67+
using sentence embedding models. They're stored in a database that serves as
68+
Ask Fern's search index.
69+
* **Query Processing**: When users ask questions, Ask Fern vectorizes their
70+
query and searches the database to find the most relevant documentation
71+
chunks.
72+
* **Response Generation**: Ask Fern uses the retrieved chunks as context to
73+
generate accurate answers with citations for the user. If the initial context isn't sufficient, it performs an additional keyword search.
74+
75+
### Life of a query
76+
77+
Each Ask Fern user query follows these steps:
6078

61-
Ask Fern is available on the [Pro plan](https://buildwithfern.com/pricing#Docs) of Fern Docs. Billing is by usage.
79+
```mermaid
80+
sequenceDiagram
81+
autonumber
82+
participant U as User
83+
participant C as /chat Endpoint
84+
participant V as Documentation Database
85+
participant A as Ask Fern
86+
87+
U->>C: Submit question via Ask Fern searchbox
88+
C->>C: Convert query to vector using<br/>sentence embedding models
89+
C->>V: Search for relevant chunks
90+
V->>C: Return matching documents
91+
C->>A: Send query + context
92+
A->>V: Perform additional keyword search if needed
93+
V->>A: Return additional chunks
94+
A->>A: Generate response
95+
A->>U: Return answer with citations
96+
```

0 commit comments

Comments
 (0)