Dify Webapp Plugin is a webapp plugin for Fess. This enhances the functionality of Fess by providing an API for querying documents.
You can download the plugin from the Maven Repository.
For detailed installation instructions, refer to the Plugin section of the Fess Administration Guide.
The Dify Plugin provides a retrieval API for querying documents. Below is an overview of the available endpoint.
Finds documents by search conditions using GET method.
-
Parameters:
query
(string): Search words (e.g., "Fess")top_k
(integer): Top K results to return (default: 3)operator
(string): Query operator (AND, OR)
-
Responses:
200
: Successful response with the results401
: Unauthorized request404
: Not found or validation error500
: Internal server error
- query: Search words (optional)
- top_k: Number of top results to return (optional, default: 3)
- operator: Query operator (optional, values: AND, OR)
- SuccessResponse: Contains the query results.
- UnauthorizedError: Indicates an unauthorized request.
- NotFoundError: Indicates that the requested resource was not found.
- InternalServerError: Indicates an internal server error.
- Document: Represents a document with fields such as
id
,url
, andcontent
. - HTTPValidationError: Represents a validation error.
- QueryResponse: Represents the response from a query, containing an array of documents.
- ValidationError: Represents a specific validation error.
- HTTPBearer: Uses HTTP Bearer tokens for authentication.
We welcome contributions to improve this plugin.
This project is licensed under the Apache 2.0 License. See the LICENSE file for details.