Documents

Overview

You can extend Ask Fern’s knowledge beyond your core documentation by indexing additional custom content. Adding materials such as internal FAQs, help desk tickets, knowledge base articles, marketing sites, research papers, and other resources helps Ask Fern provide more complete answers to developers.

The Documents API lets you upload, update, and delete custom documents that Ask Fern can reference when responding to user questions.

Usage

To get started, upload a document, title, and URL via the Documents API. Here’s an example:

1
{
2
    "document": "Ferns are plants native to the tropical and subtropical regions of the world. They are characterized by their fronds, which are large, leaf-like structures that are often found in the understory of forests.",
3
    "title": "What are ferns?",
4
    "url": "https://en.wikipedia.org/wiki/Fern"
5
}

This document will be indexed and made available to Ask Fern as context when users ask questions about ferns. If Ask Fern references this content in a response, it will include the URL as a citation.