Skip to content
Merged
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
19 changes: 18 additions & 1 deletion fern/products/ask-fern/ask-fern.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,22 @@ navigation:
contents:
- page: Custom prompting
path: ./pages/configuration/custom-prompting.mdx
- section: Features
contents:
- page: Citations
path: ./pages/configuration/citations.mdx
path: ./pages/features/citations.mdx
- page: Custom FAQs
path: ./pages/features/custom-faqs.mdx
- api: API Reference
api-name: fai
icon: fa-regular fa-pro
paginated: true
layout:
- page: Overview
path: ./pages/getting-started/api-get-started.mdx
- chat:
- endpoint: chat.chatCompletion
- index:
- endpoint: index.indexDocument
- endpoint: index.getDocument
- endpoint: index.updateDocument
Binary file modified fern/products/ask-fern/pages/assets/ask-ai-modal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified fern/products/ask-fern/pages/assets/search-modal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions fern/products/ask-fern/pages/features/custom-faqs.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Custom FAQs
subtitle: Fine-tune your AI search responses.
---

<Markdown src="/snippets/wip-callout.mdx" />

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.
16 changes: 16 additions & 0 deletions fern/products/ask-fern/pages/getting-started/api-get-started.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: 'Introduction'
subtitle: 'Welcome to the Fern API reference.'
---

<Markdown src="/snippets/pro-callout.mdx" />

The Fern AI API allows you to manage your Ask Fern configuration using Fern's public RESTful API. You can use the API to:

- Build your own support integrations that leverage Ask Fern's AI-powered search
- Add custom context and FAQs to your documentation
- Source usage and analytics data from your Ask Fern instances

## Authentication

Fern API requests require a bearer token for authentication. Use the CLI command [`fern token`](/learn/cli-api/cli-reference/commands#fern-token) to generate a bearer token. Tokens do not expire.
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Fern AI Search indexes your documentation and provides an interface for your use
- **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>
<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" />
</Frame>

Expand Down
3 changes: 3 additions & 0 deletions fern/snippets/wip-callout.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<Warning title='Work in Progress'>
This feature is currently not yet generally available. Please [email us](mailto:support@buildwithfern.com) to get started.
</Warning>