.query() method empowers developers to ask questions and receive relevant answers through a user-friendly query API. Function signature is given below:
Parameters
The purpose is to test the prompt structure without actually running LLM inference. Defaults to
FalseReturns
If
If
citations=False, return a stringified answer to the question asked. If
citations=True, returns a tuple with answer and citations respectively.Usage
With citations
If you want to get the answer to question and return both answer and citations, use the following code snippet:With Citations
When
citations=True, note that the returned sources are a list of tuples where each tuple has two elements (in the following order):- source chunk
- dictionary with metadata about the source chunk
url: url of the sourcedoc_id: document id (used for book keeping purposes)score: score of the source chunk with respect to the question- other metadata you might have added at the time of adding the source
Without citations
If you just want to return answers and don’t want to return citations, you can use the following example:Without Citations