From 0e85ed447d41f96380c3b4a4333cddae5862502a Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Wed, 13 Aug 2025 15:13:54 -0400 Subject: [PATCH 1/6] expand ask fern overview page --- .../getting-started/what-is-ask-fern.mdx | 47 ++++++++++++++++--- 1 file changed, 41 insertions(+), 6 deletions(-) diff --git a/fern/products/ask-fern/pages/getting-started/what-is-ask-fern.mdx b/fern/products/ask-fern/pages/getting-started/what-is-ask-fern.mdx index 48044234d..27a3717e8 100644 --- a/fern/products/ask-fern/pages/getting-started/what-is-ask-fern.mdx +++ b/fern/products/ask-fern/pages/getting-started/what-is-ask-fern.mdx @@ -3,13 +3,15 @@ title: AI Search Overview subtitle: Let your customers find answers in your documentation instantly. --- +Ask Fern is available on the [Pro plan](https://buildwithfern.com/pricing#Docs) of Fern Docs. Billing is by usage. + ## Overview Accessing AI Search -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. @@ -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. - 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. - 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. -## 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 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. \ No newline at end of file +```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 using
sentence embedding models + 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 +``` \ No newline at end of file From 246568c13810691818c1d13764e01a01f68956bc Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Wed, 13 Aug 2025 16:11:06 -0400 Subject: [PATCH 2/6] add new insights page --- fern/products/ask-fern/ask-fern.yml | 4 ++++ fern/products/ask-fern/pages/features/evals.mdx | 4 ++++ .../ask-fern/pages/features/insights.mdx | 16 ++++++++++++++++ 3 files changed, 24 insertions(+) create mode 100644 fern/products/ask-fern/pages/features/evals.mdx create mode 100644 fern/products/ask-fern/pages/features/insights.mdx diff --git a/fern/products/ask-fern/ask-fern.yml b/fern/products/ask-fern/ask-fern.yml index 12b717847..0212c1a0f 100644 --- a/fern/products/ask-fern/ask-fern.yml +++ b/fern/products/ask-fern/ask-fern.yml @@ -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 diff --git a/fern/products/ask-fern/pages/features/evals.mdx b/fern/products/ask-fern/pages/features/evals.mdx new file mode 100644 index 000000000..15743d0ff --- /dev/null +++ b/fern/products/ask-fern/pages/features/evals.mdx @@ -0,0 +1,4 @@ +--- +title: Evals +subtitle: Point users to the exact source of the answer. +--- \ No newline at end of file diff --git a/fern/products/ask-fern/pages/features/insights.mdx b/fern/products/ask-fern/pages/features/insights.mdx new file mode 100644 index 000000000..39aa8a2fd --- /dev/null +++ b/fern/products/ask-fern/pages/features/insights.mdx @@ -0,0 +1,16 @@ +--- +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 to identify documentation gaps, common themes, and areas where your docs could be enhanced. + +The Fern processes your Ask Fern usage data in three steps: + +1. Data Collection: All user queries and responses are logged as they occur +1. Analysis: Fern's insights model analyzes query-response pairs to identify patterns and themes +1. Recommendations: The system generates specific, actionable suggestions for documentation improvements + +## Availability + +Insights are currently provided as a monthly report delivered directly by the Fern team. From d16c19d54a9aaa2541db7c259fa7565ee64ee76e Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Wed, 13 Aug 2025 16:28:21 -0400 Subject: [PATCH 3/6] add evals page, made edits across pages --- fern/products/ask-fern/pages/features/evals.mdx | 12 ++++++++++-- .../ask-fern/pages/features/insights.mdx | 8 +------- .../pages/getting-started/what-is-ask-fern.mdx | 16 ++++++++-------- 3 files changed, 19 insertions(+), 17 deletions(-) diff --git a/fern/products/ask-fern/pages/features/evals.mdx b/fern/products/ask-fern/pages/features/evals.mdx index 15743d0ff..f654a3611 100644 --- a/fern/products/ask-fern/pages/features/evals.mdx +++ b/fern/products/ask-fern/pages/features/evals.mdx @@ -1,4 +1,12 @@ --- title: Evals -subtitle: Point users to the exact source of the answer. ---- \ No newline at end of file +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. \ No newline at end of file diff --git a/fern/products/ask-fern/pages/features/insights.mdx b/fern/products/ask-fern/pages/features/insights.mdx index 39aa8a2fd..cca7f4322 100644 --- a/fern/products/ask-fern/pages/features/insights.mdx +++ b/fern/products/ask-fern/pages/features/insights.mdx @@ -3,13 +3,7 @@ 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 to identify documentation gaps, common themes, and areas where your docs could be enhanced. - -The Fern processes your Ask Fern usage data in three steps: - -1. Data Collection: All user queries and responses are logged as they occur -1. Analysis: Fern's insights model analyzes query-response pairs to identify patterns and themes -1. Recommendations: The system generates specific, actionable suggestions for documentation improvements +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 diff --git a/fern/products/ask-fern/pages/getting-started/what-is-ask-fern.mdx b/fern/products/ask-fern/pages/getting-started/what-is-ask-fern.mdx index 27a3717e8..1755a82fe 100644 --- a/fern/products/ask-fern/pages/getting-started/what-is-ask-fern.mdx +++ b/fern/products/ask-fern/pages/getting-started/what-is-ask-fern.mdx @@ -1,5 +1,5 @@ --- -title: AI Search Overview +title: What is Ask Fern? subtitle: Let your customers find answers in your documentation instantly. --- @@ -13,9 +13,9 @@ subtitle: Let your customers find answers in your documentation instantly. 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. Preview of AI Search @@ -62,15 +62,15 @@ Ask Fern is Fern's AI Search feature that indexes your documentation and provide 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, +* **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 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 for the user. If the initial context isn't sufficient, it performs an additional keyword search. +* **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 From 2d02e91c8786271df5d632f22738e0a5e6d351d9 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Wed, 13 Aug 2025 16:47:10 -0400 Subject: [PATCH 4/6] nit update --- .../ask-fern/pages/getting-started/what-is-ask-fern.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/products/ask-fern/pages/getting-started/what-is-ask-fern.mdx b/fern/products/ask-fern/pages/getting-started/what-is-ask-fern.mdx index 1755a82fe..8019cd83d 100644 --- a/fern/products/ask-fern/pages/getting-started/what-is-ask-fern.mdx +++ b/fern/products/ask-fern/pages/getting-started/what-is-ask-fern.mdx @@ -85,7 +85,7 @@ sequenceDiagram participant A as Ask Fern U->>C: Submit question via Ask Fern searchbox - C->>C: Convert query to vector using
sentence embedding models + C->>C: Convert query to vector C->>V: Search for relevant chunks V->>C: Return matching documents C->>A: Send query + context From 577a1e5c5da9adf41e22953e5be7fc6af3b0eaea Mon Sep 17 00:00:00 2001 From: eden Date: Wed, 20 Aug 2025 10:56:48 -0400 Subject: [PATCH 5/6] add latest specs, add `documents` page. --- fern/apis/fai/definition/document.yml | 56 ++++++++++++++++++- fern/apis/fai/definition/guidance.yml | 13 ++--- fern/products/ask-fern/ask-fern.yml | 8 ++- .../ask-fern/pages/features/custom-faqs.mdx | 10 ---- .../ask-fern/pages/features/documents.mdx | 10 ++++ .../ask-fern/pages/features/evals.mdx | 7 ++- .../ask-fern/pages/features/guidance.mdx | 11 ++++ .../ask-fern/pages/features/insights.mdx | 2 + 8 files changed, 93 insertions(+), 24 deletions(-) delete mode 100644 fern/products/ask-fern/pages/features/custom-faqs.mdx create mode 100644 fern/products/ask-fern/pages/features/documents.mdx create mode 100644 fern/products/ask-fern/pages/features/guidance.mdx diff --git a/fern/apis/fai/definition/document.yml b/fern/apis/fai/definition/document.yml index e8e3530e8..8cfe442b3 100644 --- a/fern/apis/fai/definition/document.yml +++ b/fern/apis/fai/definition/document.yml @@ -40,7 +40,59 @@ service: authed: type: optional docs: Whether the document is authed - response: CreateDocumentResponse + response: DocumentIdResponse + errors: + - commons.BadRequestError + - commons.InternalError + + updateDocument: + docs: Update a document for a given domain + path: /{domain}/{document_id} + method: PATCH + audiences: + - customers + path-parameters: + domain: string + document_id: string + request: + name: UpdateDocumentRequest + body: + properties: + document: + type: optional + docs: The content of the document that will be returned in the tool response. + chunk: + type: optional + docs: The chunk of the document that will be indexed as a vector. + title: + type: optional + docs: The title of the document + url: + type: optional + docs: The url of the document + version: + type: optional + docs: The version of the document + keywords: + type: optional> + docs: The keywords of the document + authed: + type: optional + docs: Whether the document is authed + response: Document + errors: + - commons.BadRequestError + - commons.InternalError + + deleteDocumentById: + docs: Delete a document for a given domain + path: /{domain}/{document_id} + method: DELETE + audiences: + - customers + path-parameters: + domain: string + document_id: string errors: - commons.BadRequestError - commons.InternalError @@ -60,7 +112,7 @@ service: - commons.InternalError types: - CreateDocumentResponse: + DocumentIdResponse: properties: document_id: string diff --git a/fern/apis/fai/definition/guidance.yml b/fern/apis/fai/definition/guidance.yml index dce34fbd0..03798c69e 100644 --- a/fern/apis/fai/definition/guidance.yml +++ b/fern/apis/fai/definition/guidance.yml @@ -25,6 +25,7 @@ service: document: type: string docs: The content of the guidance document that will be returned in the tool response + response: GuidanceIdResponse errors: - commons.BadRequestError - commons.InternalError @@ -101,6 +102,10 @@ service: - commons.InternalError types: + GuidanceIdResponse: + properties: + guidance_id: string + Guidance: properties: guidance_id: string @@ -113,10 +118,4 @@ types: GuidanceList: properties: guidances: list - pagination: Pagination - - Pagination: - properties: - total: integer - page: integer - limit: integer \ No newline at end of file + pagination: commons.Pagination diff --git a/fern/products/ask-fern/ask-fern.yml b/fern/products/ask-fern/ask-fern.yml index b2327009c..e25b370eb 100644 --- a/fern/products/ask-fern/ask-fern.yml +++ b/fern/products/ask-fern/ask-fern.yml @@ -13,11 +13,13 @@ navigation: contents: - page: Citations path: ./pages/features/citations.mdx - - page: Custom FAQs - path: ./pages/features/custom-faqs.mdx + - page: Custom Guidance + path: ./pages/features/guidance.mdx + - page: Custom Documents + path: ./pages/features/documents.mdx - page: Insights path: ./pages/features/insights.mdx - - page: Evals + - page: Evaluation path: ./pages/features/evals.mdx - api: API reference api-name: fai diff --git a/fern/products/ask-fern/pages/features/custom-faqs.mdx b/fern/products/ask-fern/pages/features/custom-faqs.mdx deleted file mode 100644 index 6a2fd1208..000000000 --- a/fern/products/ask-fern/pages/features/custom-faqs.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Custom FAQs -subtitle: Fine-tune your AI search responses. ---- - - - -You can add custom FAQs to your documentation to "override" Ask Fern's responses to specific user queries. This is useful for content that you may not wish to display publically, such as billing information, legal terms, and other sensitive content. - -Fern offers an internal CMS (content management system) that allows you to add and edit FAQ documents as needed. \ No newline at end of file diff --git a/fern/products/ask-fern/pages/features/documents.mdx b/fern/products/ask-fern/pages/features/documents.mdx new file mode 100644 index 000000000..21a413551 --- /dev/null +++ b/fern/products/ask-fern/pages/features/documents.mdx @@ -0,0 +1,10 @@ +--- +title: Documents +subtitle: Add arbitrary documents to Ask Fern. +--- + +You can add arbitrary documents to Ask Fern. This is useful for adding additional content that may improve Ask Fern's accuracy +(such as help desk tickets, internal company FAQs, etc.). + +Fern offers an internal CMS (content management system) via the `documents` API that allows you to add, update, +and delete documents as needed. diff --git a/fern/products/ask-fern/pages/features/evals.mdx b/fern/products/ask-fern/pages/features/evals.mdx index f654a3611..da241cc34 100644 --- a/fern/products/ask-fern/pages/features/evals.mdx +++ b/fern/products/ask-fern/pages/features/evals.mdx @@ -1,11 +1,14 @@ --- title: Evals -description: Benchmark Ask Fern's performance against competitors and track improvements. +description: Benchmark Ask Fern's accuracy against your documentation. --- + + 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. +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 diff --git a/fern/products/ask-fern/pages/features/guidance.mdx b/fern/products/ask-fern/pages/features/guidance.mdx new file mode 100644 index 000000000..adba04374 --- /dev/null +++ b/fern/products/ask-fern/pages/features/guidance.mdx @@ -0,0 +1,11 @@ +--- +title: Custom Guidance +subtitle: Fine-tune your AI search responses. +--- + +You can add custom guidance (FAQs) to "override" Ask Fern's responses to specific user queries. +This is useful for content that you may not wish to display publically, such as billing information, +legal terms, and other sensitive content. + +Fern offers an internal CMS (content management system) via the `guidance` API that allows you to add, +update, and delete FAQs as needed. \ No newline at end of file diff --git a/fern/products/ask-fern/pages/features/insights.mdx b/fern/products/ask-fern/pages/features/insights.mdx index cca7f4322..a1c0049bc 100644 --- a/fern/products/ask-fern/pages/features/insights.mdx +++ b/fern/products/ask-fern/pages/features/insights.mdx @@ -3,6 +3,8 @@ 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 From 55ad33bd69c3c1d177c05b35131853b37e9149ca Mon Sep 17 00:00:00 2001 From: eden Date: Wed, 20 Aug 2025 11:07:18 -0400 Subject: [PATCH 6/6] fix error --- fern/apis/fai/definition/commons.yml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/fern/apis/fai/definition/commons.yml b/fern/apis/fai/definition/commons.yml index 62d895dc2..a5a9fac8f 100644 --- a/fern/apis/fai/definition/commons.yml +++ b/fern/apis/fai/definition/commons.yml @@ -7,3 +7,10 @@ errors: InternalError: status-code: 401 type: string + +types: + Pagination: + properties: + total: integer + page: integer + limit: integer \ No newline at end of file