Skip to content

Commit d16c19d

Browse files
committed
add evals page, made edits across pages
1 parent 246568c commit d16c19d

File tree

3 files changed

+19
-17
lines changed

3 files changed

+19
-17
lines changed
Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
11
---
22
title: Evals
3-
subtitle: Point users to the exact source of the answer.
4-
---
3+
description: Benchmark Ask Fern's performance against competitors and track improvements.
4+
---
5+
6+
Fern evaluates how accurately Ask Fern answers questions on your documentation site compared to competitor AI search solutions.
7+
8+
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.
9+
10+
## Availability
11+
12+
Evals are currently provided as custom analysis delivered directly by the Fern team.

fern/products/ask-fern/pages/features/insights.mdx

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,7 @@ title: Insights
33
description: Fern identifies documentation gaps and improvement opportunities from your user queries.
44
---
55

6-
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 to identify documentation gaps, common themes, and areas where your docs could be enhanced.
7-
8-
The Fern processes your Ask Fern usage data in three steps:
9-
10-
1. Data Collection: All user queries and responses are logged as they occur
11-
1. Analysis: Fern's insights model analyzes query-response pairs to identify patterns and themes
12-
1. Recommendations: The system generates specific, actionable suggestions for documentation improvements
6+
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.
137

148
## Availability
159

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: AI Search Overview
2+
title: What is Ask Fern?
33
subtitle: Let your customers find answers in your documentation instantly.
44
---
55

@@ -13,9 +13,9 @@ subtitle: Let your customers find answers in your documentation instantly.
1313

1414
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
1515

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

2020
<Frame caption="Users can ask questions and get support in an intuitive chat interface.">
2121
<img src="../assets/ask-ai-modal.png" alt="Preview of AI Search" />
@@ -62,15 +62,15 @@ Ask Fern is Fern's AI Search feature that indexes your documentation and provide
6262

6363
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:
6464

65-
* **Content Indexing**: Fern automatically processes your documentation pages,
65+
* **Content indexing** Fern automatically processes your documentation pages,
6666
breaking them into semantic chunks and converting each chunk into a vector
6767
using sentence embedding models. They're stored in a database that serves as
6868
Ask Fern's search index.
69-
* **Query Processing**: When users ask questions, Ask Fern vectorizes their
69+
* **Query processing** When users ask questions, Ask Fern vectorizes their
7070
query and searches the database to find the most relevant documentation
7171
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.
72+
* **Response generation** Ask Fern uses the retrieved chunks as context to
73+
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.
7474

7575
### Life of a query
7676

0 commit comments

Comments
 (0)