Overview of how the query engine generates plans and runs them
Deep Analytics
and RAG
. Deep Analytics
mode will generate a query plan for your query, which you can then run or edit before executing — this is ideal for complex queries that require multiple steps and operations on the data. RAG
mode will retrieve relevant documents and generate a natural language response based on those documents — this is ideal for simpler queries that do not require complex query plans and this could also be useful for querying a small set of documents. In the Workspaces UI, you can toggle between these two modes using the Deep Analytics
toggle in the query box. In the Aryn SDK, you can specify the mode using the rag_mode
parameter in the query
method of the Client
class.
If you want to just get started querying your data, you don’t need to know all of these specifics - just use the Workspaces UI.
Operator | Description |
---|---|
Filter | Filters records based on a range or match filter. Can be combined with the Query Database operator. |
Count | Returns a count of the number of records provided in the input. It can optionally count the distinct records. |
Limit | Limits the number of records returned. |
Math | Performs arithmetic operation on two input numbers. Returns a number. |
Query Database | Retrieves data from Aryn’s keyword index using a full-text, term-level, and other query types. Uses OpenSearch Query DSL. |
Query Vector Database | Retrieves data from Aryn’s vector index using vector search, and returns the top k records. Uses OpenSearch Query DSL. |
Sort | Sorts the records based on the value of a Property. |
Group By | Returns the count of unique values for a given unique Property key |
Operator | Description |
---|---|
LLM Extract Entity | Adds a new Property by extracting information from an existing text-representation or Property. |
LLM Filter | Filters records based on the value of a field. Used when the semantic understanding of a field is needed. |
Summarize Data | This operation generates an English response to a request based on the input data provided. |