Kuantia CRM icon

Kuantia CRM

Interact with Kuantia CRM API

Actions65

Knowledge Documents → Knowledge Document Controller Query

AI-generated

Overview

This node performs a query operation on knowledge documents within the Kuantia CRM system. It allows users to search for specific information by providing a query string, filtering results by bot ID and optionally by account ID, and limiting the number of returned results. This is useful for scenarios where users need to retrieve relevant knowledge documents quickly, such as customer support automation, chatbot integrations, or knowledge base searches.

Use Case Examples

  1. A customer support agent uses the node to find documents related to payment settings by querying 'How to configure the payment settings?' and filtering by a specific bot ID.
  2. A chatbot queries the knowledge documents to provide users with answers based on the bot's knowledge base, limiting results to the top 5 matches.

Properties

Name Meaning
Query The query string to search for in the knowledge documents. This is the main search input to find relevant documents.
Bot Id The Bot ID used to filter the knowledge documents, ensuring the query is scoped to documents associated with a specific bot.
Account Id Optional Account ID to further filter the documents by account, narrowing down the search results.
Limit Maximum number of results to return from the query, controlling the size of the response.
Request Options Additional request settings such as batching, SSL certificate validation, proxy configuration, and timeout settings to control how the request is sent and handled.

Output

JSON

  • results - Array of knowledge documents matching the query criteria, containing the relevant document data.

Dependencies

  • Kuantia CRM API with an API key credential

Troubleshooting

  • Ensure the Bot ID and Account ID (if used) are correct and exist in the Kuantia CRM system to avoid empty results.
  • Check network connectivity and proxy settings if requests fail or time out.
  • If SSL certificate validation errors occur, consider enabling the 'Ignore SSL Issues' option cautiously.
  • Verify that the query string is properly formatted and not empty to get meaningful results.

Links

Discussion