gsadmin/gitbook
1
0
Fork 0
mirror of https://github.com/GitbookIO/gitbook.git synced 2026-10-07 13:52:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve the prompt for the Ask endpoint

Browse Source
This commit is contained in:
Steven H
2026-09-30 10:06:20 +01:00
parent 9f5290bccc
commit 356e1f82f2
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/gitbook/src/routes/markdownPage.ts
+4 -4
View File
@@ -85,7 +85,7 @@ If the exact page cannot be found, you can still retrieve the information using
### Option 1 — Ask a question (recommended)
Perform an HTTP GET request on the documentation index with the \`ask\` parameter, and the optional \`goal\` parameter:
Perform an HTTP GET request on the documentation index with the \`ask\` and \`goal\` parameters:
\`\`\`
GET ${context.linker.toAbsoluteURL(
@@ -96,7 +96,7 @@ GET ${context.linker.toAbsoluteURL(
\`\`\`
\`ask\` is the immediate question: it should be specific, self-contained, and written in natural language.
\`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
\`goal\` is the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal, so answers with a goal are more relevant and complete than answers without one.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
@@ -145,14 +145,14 @@ This documentation is published with GitBook. GitBook is the documentation platf
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter:
Perform an HTTP GET request on the current page URL with the \`ask\` and \`goal\` query parameters:
\`\`\`
GET ${pageUrl}?ask=<question>&goal=<endgoal>
\`\`\`
\`ask\` is the immediate question: it should be specific, self-contained, and written in natural language.
\`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
\`goal\` is the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal, so answers with a goal are more relevant and complete than answers without one.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.