Skip to content

Commit 577a1e5

Browse files
committed
add latest specs, add documents page.
1 parent bdafa29 commit 577a1e5

File tree

8 files changed

+93
-24
lines changed

8 files changed

+93
-24
lines changed

fern/apis/fai/definition/document.yml

Lines changed: 54 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,59 @@ service:
4040
authed:
4141
type: optional<boolean>
4242
docs: Whether the document is authed
43-
response: CreateDocumentResponse
43+
response: DocumentIdResponse
44+
errors:
45+
- commons.BadRequestError
46+
- commons.InternalError
47+
48+
updateDocument:
49+
docs: Update a document for a given domain
50+
path: /{domain}/{document_id}
51+
method: PATCH
52+
audiences:
53+
- customers
54+
path-parameters:
55+
domain: string
56+
document_id: string
57+
request:
58+
name: UpdateDocumentRequest
59+
body:
60+
properties:
61+
document:
62+
type: optional<string>
63+
docs: The content of the document that will be returned in the tool response.
64+
chunk:
65+
type: optional<string>
66+
docs: The chunk of the document that will be indexed as a vector.
67+
title:
68+
type: optional<string>
69+
docs: The title of the document
70+
url:
71+
type: optional<string>
72+
docs: The url of the document
73+
version:
74+
type: optional<string>
75+
docs: The version of the document
76+
keywords:
77+
type: optional<list<string>>
78+
docs: The keywords of the document
79+
authed:
80+
type: optional<boolean>
81+
docs: Whether the document is authed
82+
response: Document
83+
errors:
84+
- commons.BadRequestError
85+
- commons.InternalError
86+
87+
deleteDocumentById:
88+
docs: Delete a document for a given domain
89+
path: /{domain}/{document_id}
90+
method: DELETE
91+
audiences:
92+
- customers
93+
path-parameters:
94+
domain: string
95+
document_id: string
4496
errors:
4597
- commons.BadRequestError
4698
- commons.InternalError
@@ -60,7 +112,7 @@ service:
60112
- commons.InternalError
61113

62114
types:
63-
CreateDocumentResponse:
115+
DocumentIdResponse:
64116
properties:
65117
document_id: string
66118

fern/apis/fai/definition/guidance.yml

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ service:
2525
document:
2626
type: string
2727
docs: The content of the guidance document that will be returned in the tool response
28+
response: GuidanceIdResponse
2829
errors:
2930
- commons.BadRequestError
3031
- commons.InternalError
@@ -101,6 +102,10 @@ service:
101102
- commons.InternalError
102103

103104
types:
105+
GuidanceIdResponse:
106+
properties:
107+
guidance_id: string
108+
104109
Guidance:
105110
properties:
106111
guidance_id: string
@@ -113,10 +118,4 @@ types:
113118
GuidanceList:
114119
properties:
115120
guidances: list<Guidance>
116-
pagination: Pagination
117-
118-
Pagination:
119-
properties:
120-
total: integer
121-
page: integer
122-
limit: integer
121+
pagination: commons.Pagination

fern/products/ask-fern/ask-fern.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,13 @@ navigation:
1313
contents:
1414
- page: Citations
1515
path: ./pages/features/citations.mdx
16-
- page: Custom FAQs
17-
path: ./pages/features/custom-faqs.mdx
16+
- page: Custom Guidance
17+
path: ./pages/features/guidance.mdx
18+
- page: Custom Documents
19+
path: ./pages/features/documents.mdx
1820
- page: Insights
1921
path: ./pages/features/insights.mdx
20-
- page: Evals
22+
- page: Evaluation
2123
path: ./pages/features/evals.mdx
2224
- api: API reference
2325
api-name: fai

fern/products/ask-fern/pages/features/custom-faqs.mdx

Lines changed: 0 additions & 10 deletions
This file was deleted.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: Documents
3+
subtitle: Add arbitrary documents to Ask Fern.
4+
---
5+
6+
You can add arbitrary documents to Ask Fern. This is useful for adding additional content that may improve Ask Fern's accuracy
7+
(such as help desk tickets, internal company FAQs, etc.).
8+
9+
Fern offers an internal CMS (content management system) via the `documents` API that allows you to add, update,
10+
and delete documents as needed.

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
---
22
title: Evals
3-
description: Benchmark Ask Fern's performance against competitors and track improvements.
3+
description: Benchmark Ask Fern's accuracy against your documentation.
44
---
55

6+
<Markdown src="/snippets/wip-callout.mdx" />
7+
68
Fern evaluates how accurately Ask Fern answers questions on your documentation site compared to competitor AI search solutions.
79

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.
10+
Fern first generates evaluation questions from your documentation files, then runs those questions through both Ask Fern and competitor systems.
11+
Finally, Fern evaluates each answer against the original documentation for accuracy. You receive detailed performance metrics and comparative analysis.
912

1013
## Availability
1114

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Custom Guidance
3+
subtitle: Fine-tune your AI search responses.
4+
---
5+
6+
You can add custom guidance (FAQs) to "override" Ask Fern's responses to specific user queries.
7+
This is useful for content that you may not wish to display publically, such as billing information,
8+
legal terms, and other sensitive content.
9+
10+
Fern offers an internal CMS (content management system) via the `guidance` API that allows you to add,
11+
update, and delete FAQs as needed.

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Insights
33
description: Fern identifies documentation gaps and improvement opportunities from your user queries.
44
---
55

6+
<Markdown src="/snippets/wip-callout.mdx" />
7+
68
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.
79

810
## Availability

0 commit comments

Comments
 (0)