SiYuan Search Tool icon

SiYuan Search Tool

Use this tool to search and query the SiYuan knowledge base. Use "fullText" to find content by keywords, "sqlQuery" for advanced database queries, "searchByTag" to find tagged blocks, or "searchByAttribute" to find blocks by attribute values.

Actions4

Full-Text Search

AI-generated

Overview

The SiYuan Search Tool node allows users to perform a full-text search across all blocks in the SiYuan knowledge base. It is useful for quickly finding content by keywords within the knowledge base, enabling efficient retrieval of relevant information.

Use Case Examples

  1. Searching for specific keywords or phrases within the knowledge base to locate relevant blocks of information.
  2. Using the node to automate content discovery in workflows that require knowledge base querying.

Properties

Name Meaning
Search Query The text to search for across all blocks in the knowledge base.

Output

JSON

  • success - Indicates whether the search operation was successful.
  • blocks - The array of blocks matching the search query, including their content and metadata.

Dependencies

  • Requires an API key credential for SiYuan API authentication to access the knowledge base.

Troubleshooting

  • If the node returns an error, ensure the API credentials are correctly configured and have the necessary permissions.
  • Verify that the search query string is not empty and is properly formatted.
  • Network issues or incorrect API URL can cause connection failures; check network connectivity and API endpoint configuration.

Links

Discussion