Orq Knowledge Base Search icon

Orq Knowledge Base Search

Search content in an Orq.ai knowledge base

Orq Knowledge Base Search

AI-generated

Overview

The Orq Knowledge Base Search node allows users to search content within an Orq.ai knowledge base. It is useful for scenarios where you need to retrieve relevant information from a knowledge base by specifying a search query and applying optional metadata filters. For example, it can be used to find documents, articles, or data entries that match certain criteria or keywords within a knowledge base.

Use Case Examples

  1. Searching a knowledge base for documents related to a specific topic using a keyword query.
  2. Filtering search results based on metadata conditions such as date ranges or categories.
  3. Using custom JSON filters to perform advanced recursive filtering on metadata fields.

Properties

Name Meaning
Knowledge Base The specific knowledge base to search in, chosen from a list or specified by ID.
Query The search query string used to find relevant content in the knowledge base.
Metadata Filter Type The type of metadata filtering to apply to the search results, such as None, AND, OR, or Custom JSON.
AND Filters A collection of conditions where all must be true for filtering results (shown if Metadata Filter Type is AND).
OR Filters A collection of conditions where any can be true for filtering results (shown if Metadata Filter Type is OR).
Custom Filter A JSON string representing a custom recursive filter structure (shown if Metadata Filter Type is Custom).
Additional Options Optional parameters such as Chunk Limit (number of results), Threshold (search threshold), and Search Type (vector, keyword, or hybrid search).

Output

JSON

  • matches - Array of matched search results from the knowledge base.
  • _note - Optional note indicating no results were found, suggesting to adjust the query or filters.

Dependencies

  • Requires an API key credential for Orq.ai API access.

Troubleshooting

  • Common issues include invalid knowledge base ID or malformed filter JSON, which may cause errors.
  • Error messages from the Orq.ai API are captured and returned with error codes, status codes, and details if available.
  • If no results are found, a note is added to the output suggesting to adjust the search query or filters.

Links

Discussion