Skip to content
Open
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
82 changes: 82 additions & 0 deletions fern/apis/fai/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -6638,6 +6638,60 @@
"title": "Rewrite Query",
"description": "Whether to rewrite the query using query decomposition",
"default": false
},
"user_is_authed": {
"type": "boolean",
"title": "User Is Authed",
"description": "Whether the requesting user is authenticated. When true, authed chunks are included in results.",
"default": false
},
"allowed_roles": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Allowed Roles",
"description": "Roles the authenticated user has. Used to filter chunks by role-based access control."
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Source",
"description": "The origin of the request (e.g. 'web', 'slack', 'api')."
},
"basepaths": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Basepaths",
"description": "Restrict retrieval to pages under these URL path prefixes (e.g. ['/my-product']). Matches the scoping the Ask AI widget applies when embedded under a product path. Omit to search the whole site."
},
"skip_save_query": {
"type": "boolean",
"title": "Skip Save Query",
"description": "Set to true for test or eval traffic. The request is answered (and billed) normally but is excluded from usage analytics.",
"default": false
}
},
"type": "object",
Expand All @@ -6663,6 +6717,14 @@
"type": "array",
"title": "Citations",
"description": "List of citation strings"
},
"sources": {
"items": {
"$ref": "#/components/schemas/ChatSource"
},
"type": "array",
"title": "Sources",
"description": "Pages the answer was grounded in, one entry per cited page"
}
},
"type": "object",
Expand Down Expand Up @@ -7595,6 +7657,26 @@
"updated_at"
],
"title": "Website"
},
"ChatSource": {
"properties": {
"url": {
"type": "string",
"title": "Url",
"description": "URL of the cited documentation page"
},
"title": {
"type": "string",
"title": "Title",
"description": "Title of the cited documentation page"
}
},
"type": "object",
"required": [
"url",
"title"
],
"title": "ChatSource"
}
},
"securitySchemes": {
Expand Down
Loading