diff --git a/fern/products/ask-fern/ask-fern.yml b/fern/products/ask-fern/ask-fern.yml index a23b7ff10..61bf0f592 100644 --- a/fern/products/ask-fern/ask-fern.yml +++ b/fern/products/ask-fern/ask-fern.yml @@ -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 \ No newline at end of file diff --git a/fern/products/ask-fern/pages/assets/ask-ai-modal.png b/fern/products/ask-fern/pages/assets/ask-ai-modal.png index 7d8973ec1..7b7bc7367 100644 Binary files a/fern/products/ask-fern/pages/assets/ask-ai-modal.png and b/fern/products/ask-fern/pages/assets/ask-ai-modal.png differ diff --git a/fern/products/ask-fern/pages/assets/search-modal.png b/fern/products/ask-fern/pages/assets/search-modal.png index db19654d2..1c5c2a58b 100644 Binary files a/fern/products/ask-fern/pages/assets/search-modal.png and b/fern/products/ask-fern/pages/assets/search-modal.png differ diff --git a/fern/products/ask-fern/pages/configuration/citations.mdx b/fern/products/ask-fern/pages/features/citations.mdx similarity index 100% rename from fern/products/ask-fern/pages/configuration/citations.mdx rename to fern/products/ask-fern/pages/features/citations.mdx diff --git a/fern/products/ask-fern/pages/features/custom-faqs.mdx b/fern/products/ask-fern/pages/features/custom-faqs.mdx new file mode 100644 index 000000000..6a2fd1208 --- /dev/null +++ b/fern/products/ask-fern/pages/features/custom-faqs.mdx @@ -0,0 +1,10 @@ +--- +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/getting-started/api-get-started.mdx b/fern/products/ask-fern/pages/getting-started/api-get-started.mdx new file mode 100644 index 000000000..ed17e1f59 --- /dev/null +++ b/fern/products/ask-fern/pages/getting-started/api-get-started.mdx @@ -0,0 +1,16 @@ +--- +title: 'Introduction' +subtitle: 'Welcome to the Fern API reference.' +--- + + + +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. 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 69e62275f..48044234d 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 @@ -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. - + Preview of AI Search diff --git a/fern/snippets/wip-callout.mdx b/fern/snippets/wip-callout.mdx new file mode 100644 index 000000000..fba8119fd --- /dev/null +++ b/fern/snippets/wip-callout.mdx @@ -0,0 +1,3 @@ + + This feature is currently not yet generally available. Please [email us](mailto:support@buildwithfern.com) to get started. + \ No newline at end of file