SERVICEME RAG Plugin for Dify

SERVICEME is an enterprise-grade, unified AI middle platform built to accelerate digital transformation with advanced knowledge management and Retrieval-Augmented Generation (RAG) capabilities. This plugin lets you access SERVICEME knowledge and actions inside Dify so your assistants can search trusted enterprise content and trigger SERVICEME-driven automation in a single workflow.

Key Capabilities

• Invoke SERVICEME knowledge bases with hybrid, embedding, or keyword search modes.
• Retrieve structured answers, metadata, and workspace context for downstream steps.
• Apply workspace scoping, relevance thresholds, hybrid weights, and reranking options that match enterprise governance policies.
• Automatically manage SERVICEME authentication so Dify tools stay authorized as tokens expire.

Prerequisites

• An active SERVICEME environment with API access.
• OAuth credentials (client ID, client secret, and user account) created according to the SERVICEME OpenAPI guide: https://docs.serviceme.com/en/docs/technical-guide/open-api/#client-and-user-account-authentication.
• A Dify workspace with permission to import and configure custom tools.

OAuth Configuration in Dify

1. Import the SERVICEME RAG plugin into your Dify workspace.
2. Open Vendor Configuration for the plugin and provide:
   • Base URL – Your SERVICEME domain, including protocol (for example, https://example.serviceme.com).
   • Client Id / Client Secret – Credentials issued from the SERVICEME administrator console.
   • Account – The SERVICEME user account (UserName) used for OpenAPI calls.
3. Save the configuration. The plugin requests an access token through /openapi/auth/client_with_account and refreshes it automatically whenever the token expires.

Using the Tool in Dify

When you add the serviceme-rag tool to an agent or workflow step, you can fine-tune the retrieval behavior with these inputs:

Input	Description
query	Optional natural-language prompt; provide this or keywords.
keywords	Optional keyword list separated by |.
workspaces	Optional array of SERVICEME workspace IDs to limit search scope.
top_k	Required number of results to return.
rag_object	Required search target (both, qna, or doc).
rag_mode	Required retrieval mode (hybrid, embedding, or fulltext).
min_similarity	Optional similarity threshold between 0 and 1 (default 0.8).
metadata_filter	Optional metadata filter list (currently supports default).
weights	Optional JSON object defining RRF weights for hybrid retrieval.
reranker	Optional reranker model name; leave blank to disable reranking.

After execution, the tool returns:

• A text preview with the top three matches.
• A JSON payload containing results, searchId, available_workspaces, and related metadata.
• Workflow variables results (JSON string) and search_id for chaining into subsequent Dify steps.

Localization

End-user guides in other languages are available under readme/:

• readme/README_zh_Hans.md – Simplified Chinese
• readme/README_ja_JP.md – Japanese

Support

If you need assistance setting up OAuth credentials or tailoring the plugin for your organization, contact your SERVICEME or Medalsoft representative and reference the SERVICEME OpenAPI documentation above.