smartsearch

Basic Information

• Author: cloudswayai
• Version: 0.1.0
• Type: tool (Dify plugin)

Description

is an intelligent search tool for the Dify ecosystem, integrating the Cloudsway Search API to provide efficient and controllable web full-text search capabilities for large model applications. It supports multi-language filtering, content safety level adjustment, freshness and site filtering, and structured result output — suitable for deep content analysis, fact-checking, and multi-source information aggregation scenarios.

Key Features

• Precise Web Search: Supports keyword search, configurable result count, pagination offset, language filtering, freshness filtering, site restriction, and safety level.
• Full-Text Content Extraction: Returns complete page content (supports HTML/MARKDOWN format) to meet deep analysis needs.
• Structured Output: Results are returned in JSON format, including title, URL, publication date, summary, and full content for easy parsing and downstream processing.
• Seamless Dify Integration: Complies with Dify plugin specifications and can be called directly in Dify applications and workflows.

Usage Guide

1. Prerequisites

• Obtain a Cloudsway Search API key () in the format .
• How to get it: Log in to the Cloudsway Console or contact to apply.

2. Configuration Steps

After installing the plugin in Dify, configure the environment variable in "Plugin Settings":

3. Tool Parameters

Parameter	Type	Required	Default	Description
	string	Yes	-	Search keyword or question (e.g., "Latest advances in machine learning 2024").
	number	No	10	Number of results to return. Accepted values: 10, 20, 30, 40, 50. Max: 50. Recommended: 3-10 for concise outputs.
	number	No	0	Zero-based pagination offset (e.g., offset=10 starts from result #11).
	string	No	"en"	Language filter. Recommended format: language-region (e.g., , ). Default: .
	string	No	(no default)	Content safety level: , , .
	string	No	(no default)	Time filter for results: , , , or a date range (e.g., ).
	string	No	(no default)	Restrict results to a host or domain (e.g., ).

Notes:

• is required and cannot be empty.
• If is omitted, the plugin returns 10 results by default.

4. Example Parameters (Dify UI)

• Query string:
• Result count:
• Language:
• Freshness:
• Sites:

Sample Output (simplified):

Response Structure

Successful response (JSON) includes these key fields:

• : the submitted query.
• : list of result items. Each item may include:
  • : Page title.
  • : Full page URL.
  • : Display-friendly URL.
  • : Short description or excerpt.
  • : Publication date if available.
  • : Last crawl timestamp.
  • : Source site name.
  • : Optional thumbnail image URL.
  • : Relevance score (0.0 - 1.0).

Error Handling

Common HTTP status codes returned by the Cloudsway API:

• 200 — success
• 429 — rate limit exceeded (QPS limit reached). If you need higher QPS or have account issues, contact Cloudsway support.
• 4xx / 5xx — other client/server errors. Check request parameters and your .

Privacy Policy

• Data Collected: This plugin only collects the search keyword () entered by the user for real-time calls to the Cloudsway Search API. The plugin does not collect any personally identifiable information such as name, email, or device information.
• Data Usage: All input is used solely for instant search requests and is not stored, analyzed, or used for any other purpose.
• Third-Party Processing: Search requests are processed in real-time by the Cloudsway API. Data is only transmitted to Cloudsway during the request and is not shared with other third parties.
• Security Measures: The API key is used only for authentication and is not stored or leaked by the plugin. All data transmission is encrypted via HTTPS.
• User Rights: Users can delete or replace their API key at any time. The plugin does not save any historical data.
• Support & Feedback: For privacy-related questions, please contact us at [email protected].

License

This project is open-sourced under the MIT License. See LICENSE for details.

FAQ

Q: Call failed?
A: Check the format (it must include both endpoint and accesskey), verify the key is valid in the Cloudsway Console, and ensure required parameters (like ) are provided.

Q: Empty results?
A: Try adjusting , using a broader or removing filtering, or optimize your keywords.

Q: What languages are supported?
A: It covers 20+ languages including (Chinese), (English), (Japanese), (Korean), (French), etc. Use for language filtering.

For more support, you can submit an Issue to the GitHub repository or contact [email protected].