> For the complete documentation index, see [llms.txt](https://docs.uptiq.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.uptiq.ai/ai-workbench-qore/ask-assistant.md).

# Ask Assistant

Ask questions about the Qore docs and get answers that link to the pages they come from.

The assistant answers your questions from the Qore and Document AI documentation on this site, and links to the pages it uses.

{% hint style="info" %}
**Beta.** The assistant is a Beta feature. AI responses may contain mistakes. If an answer is wrong or doesn't match the docs, tell us using the [feedback form](/ai-workbench-qore/feedback.md).
{% endhint %}

### Open the assistant

Select **Ask** at the top of the site, next to search. The assistant opens in a panel on the right side of the page you're reading.

<figure><img src="https://1326225582-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0qmgQjJ5aArDTj2ACFHG%2Fuploads%2Fgit-blob-9b84cdbe8eae7fa0d380438adcd4d56563231cdf%2F001_assistant_panel.png?alt=media" alt="The GitBook Assistant panel open on the right of the Accounts, Projects, Spaces page: the greeting from the Qore Knowledge Assistant, five suggested questions starting with What is Qore?, and the Ask, search, or explain… input with Based on your context and Send below it"><figcaption><p>The assistant opens beside the page you're reading.</p></figcaption></figure>

### How it can help

* **Answers questions about the docs.** Ask in your own words, in the **Ask, search, or explain…** box, then select **Send**.
* **Links to its sources.** Each answer links to the pages it used, so you can read the full page.
* **Suggests where to start.** Select one of the suggested questions below the greeting to ask it.

### How it works

The assistant uses AI and your context to generate answers. To see what context it uses, hover over **Based on your context** below the input box. It uses:

* **The page you're on now.** You can ask about the page you're reading without naming it.
* **Info about you provided by the site.**
* **Messages in your conversation.** You can ask follow-up questions that build on earlier answers.

### Report an incorrect answer

The assistant is in Beta, and your feedback helps us improve it. If it gives an answer that's incorrect, or that doesn't match what the docs say, use the [feedback form](/ai-workbench-qore/feedback.md) to tell us. Describe the question you asked and what was wrong with the answer.

***

{% columns %}
{% column width="83.33333333333334%" %}

<p align="right"><em>Maintained by</em> <mark style="color:green;">Abhishek Paul</mark><br><code>AI-assisted, human-approved</code></p>
{% endcolumn %}

{% column width="16.666666666666664%" %}

<div align="left"><img src="https://1326225582-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0qmgQjJ5aArDTj2ACFHG%2Fuploads%2Fgit-blob-d034645b4f8f8ee661985f5306b60ded3289653c%2Fmaintainer-abhishek-paul.png?alt=media" alt="" width="60"></div>
{% endcolumn %}
{% endcolumns %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.uptiq.ai/ai-workbench-qore/ask-assistant.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.