dify-plugin-knowledge-pro

KO | EN

gitlite — search

#javascript #python #llm #go #deep-learning #docker #macos #nodejs #awesome #kubernetes #pytorch #ios #openai #open-source

dify-plugin-knowledge-pro

(★ 10)

No description available.

dify-plugin-knowledge-pro Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Knowledge Pro

**Author:** [abesticode](https://github.com/abesticode)  
**Version:** 1.0.0  
**Type:** tool
**Repo:** https://github.com/abesticode/dify-plugin-knowledge-pro

## Description

Knowledge Pro is a comprehensive AI Agent tool designed for managing Dify Knowledge Bases (Datasets) via the Dify API. It provides a complete set of operations for knowledge base maintenance, document management, content chunk manipulation, and metadata filtering.

## Features

### 📁 Dataset Operations
| Tool | Description |
|------|-------------|
| **Create Dataset** | Create new empty knowledge bases |
| **List Datasets** | Browse available knowledge bases with pagination |
| **Get Dataset** | Retrieve detailed information about a specific knowledge base |
| **Update Dataset** | Modify knowledge base settings (name, description, permissions, embedding model, etc.) |
| **Delete Dataset** | Remove knowledge bases permanently |

### 📄 Document Operations
| Tool | Description |
|------|-------------|
| **Create Document by Text** | Add new documents with text content. Supports advanced options like chunk method, process rules, and metadata assignment |
| **List Documents** | Browse documents in a knowledge base |
| **Get Document** | Retrieve detailed information about a specific document |
| **Update Document by Text** | Update existing document content, process rules, and settings |
| **Update Document Status** | Enable, disable, archive, or unarchive documents in batch |
| **Delete Document** | Remove documents permanently |
| **Get Indexing Status** | Track document embedding progress |

### 🧩 Chunk/Segment Operations
| Tool | Description |
|------|-------------|
| **Add Chunks** | Add content segments to documents |
| **List Chunks** | View all segments in a document |
| **Get Chunk Details** | Get detailed information of a specific chunk |
| **Update Chunk** | Modify segment content, keywords, or status |
| **Delete Chunk** | Remove segments permanently |
| **Retrieve Chunks** | Search knowledge base with various methods (keyword, semantic, hybrid) |

### 👶 Child Chunk Operations (Hierarchical Mode)
| Tool | Description |
|------|-------------|
| **List Child Chunks** | Get child chunks from a parent segment |
| **Create Child Chunk** | Add a new child chunk under a parent segment |
| **Update Child Chunk** | Modify child chunk content |
| **Delete Child Chunk** | Remove a child chunk from parent segment |

### 🏷️ Metadata Operations
| Tool | Description |
|------|-------------|
| **Add Metadata Field** | Define custom metadata fields |
| **Update Metadata Field** | Rename metadata fields |
| **Delete Metadata Field** | Remove metadata fields |
| **List Metadata** | View all defined metadata fields and their IDs |
| **List Built-in Metadata** | View all built-in metadata fields in a knowledge base |
| **Toggle Built-in Metadata** | Enable or disable built-in metadata fields |
| **Update Document Metadata** | Assign metadata values to documents |

### 🏷️ Knowledge Tag Operations
| Tool | Description |
|------|-------------|
| **List Knowledge Tags** | View all workspace-level knowledge base tags |
| **Create Knowledge Tag** | Create a new tag for organizing knowledge bases |
| **Update Knowledge Tag** | Rename an existing knowledge base tag |
| **Delete Knowledge Tag** | Permanently delete a knowledge base tag |
| **List Dataset Tags** | View tags bound to a specific knowledge base |
| **Bind Knowledge Tags** | Attach one or more tags to a knowledge base |
| **Unbind Knowledge Tags** | Remove one or more tags from a knowledge base |

### 🤖 Model & Datasource Operations
| Tool | Description |
|------|-------------|
| **List Available Models** | Browse available embedding and reranking models |
| **List Datasource Plugins** | View available datasource plugins for knowledge bases |

### 🔄 Pipeline Operations
| Tool | Description |
|------|-------------|
| **Run Pipeline** | Execute a pipeline with specified parameters |
| **Run Datasource Node** | Run a specific datasource node within a pipeline |
| **Upload Pipeline File** | Upload a file for use in pipeline processing |

## Installation

1. Install the plugin from the Dify Marketplace or upload the `.difypkg` file
2. Navigate to your Dify workspace settings
3. Add the Knowledge Pro tool to your agent
4. Configure the required credentials:
   - **API Key**: Your Dify Knowledge Base API key
   - **Base URL**: Your Dify API endpoint (e.g., `https://api.dify.ai/v1`)

## Getting API Credentials

1. Go to your Dify Knowledge Base
2. Navigate to the **API ACCESS** page from the left navigation
3. Generate a new API key from the **API Keys** section
4. Copy the API key and base URL for configuration

---

## How to Use

### Step 1: Authorization

The `API_URL` and `API_KEY` credentials come from the Dify Knowledge Base API Access page:

![Authorization Setup](https://raw.githubusercontent.com/abesticode/dify-plugin-knowledge-pro/main/_assets/1_authorization.png)

- **API Key**: Copy from the API Keys section
- **Base URL**: Your Dify API endpoint (e.g., `https://api.dify.ai/v1`)

---

### Step 2: Get Dataset ID

The `Dataset ID` can be found in the Knowledge Base URL or settings:

![Dataset ID](https://raw.githubusercontent.com/abesticode/dify-plugin-knowledge-pro/main/_assets/2_dataset_id.png)

Copy the Dataset ID to use in the tool parameters.

---

### Step 3: Create Metadata Field

Before assigning metadata to documents, you need to create metadata fields first:

![Create Metadata](https://raw.githubusercontent.com/abesticode/dify-plugin-knowledge-pro/main/_assets/3_create_metadata.png)

Use the **Add Metadata Field** tool to define custom fields like `product_id`, `category`, etc.

---

### Step 4: Get List of Metadata IDs

To assign metadata values, you need the metadata field IDs:

![List Metadata](https://raw.githubusercontent.com/abesticode/dify-plugin-knowledge-pro/main/_assets/4_list_metadata.png)

Use the **List Metadata** tool to get the UUIDs of your metadata fields.

---

### Step 5: Configure Create/Update Document

When creating or updating documents, configure the following parameters:

**Basic Configuration:**

![Config Part 1](https://raw.githubusercontent.com/abesticode/dify-plugin-knowledge-pro/main/_assets/5_config_document_1.png)

**Chunk Method & Process Rules:**

![Config Part 2](https://raw.githubusercontent.com/abesticode/dify-plugin-knowledge-pro/main/_assets/6_config_document_2.png)

**Metadata Assignment:**

![Config Part 3](https://raw.githubusercontent.com/abesticode/dify-plugin-knowledge-pro/main/_assets/7_config_document_3.png)

---

### Step 6: Example Output

**Successful Document Creation:**

![Output Success](https://raw.githubusercontent.com/abesticode/dify-plugin-knowledge-pro/main/_assets/8_output_success.png)

**Document with Metadata:**

![Output with Metadata](https://raw.githubusercontent.com/abesticode/dify-plugin-knowledge-pro/main/_assets/9_output_metadata.png)

---

## Usage Examples

### Creating a Knowledge Base
```
Create a new knowledge base called "Product Documentation" with team access
```

### Adding Documents with Metadata
```
Add a document named "Getting Started Guide" with the following content to the Product Documentation knowledge base. 
Set the product_id metadata to "PROD-001".
```

### Searching Knowledge
```
Search for information about "installation requirements" in the Product Documentation knowledge base using semantic search
```

### Managing Metadata
```
Add a metadata field called "category" to the Product Documentation knowledge base
```

## Advanced Usage

### Process Rules

The `PROCESS_RULE` parameter controls how documents are segmented and processed. The default is `{"mode": "automatic"}`, but you can customize it based on your chunk method.

**Automatic Mode (default):**
```json
{"mode": "automatic"}
```

**Custom Mode for General or Q&A Chunk Method:**

When your `CHUNK METHOD` is `General` or `Q&A`, use this format:
```json
{
  "mode": "custom",
  "rules": {
    "pre_processing_rules": [
      {"id": "remove_extra_spaces", "enabled": true},
      {"id": "remove_urls_emails", "enabled": true}
    ],
    "segmentation": {
      "separator": "\n\n",
      "max_tokens": 1024,
      "chunk_overlap": 50
    }
  }
}
```

**Hierarchical Mode for Parent-child Chunk Method:**

When your `CHUNK METHOD` is `Parent-child`, use this format:
```json
{
  "mode": "hierarchical",
  "rules": {
    "pre_processing_rules": [
      {
        "id": "remove_extra_spaces",
        "enabled": true
      },
      {
        "id": "remove_urls_emails",
        "enabled": true
      }
    ],
    "segmentation": {
      "separator": "\n\n",
      "max_tokens": 1024,
      "chunk_overlap": 50
    },
    "parent_mode": "full-doc",
    "subchunk_segmentation": {
      "separator": "\n\n",
      "max_tokens": 1024,
      "chunk_overlap": 50
    }
  }
}
```

#### Process Rule Parameters:

| Parameter | Description |
|-----------|-------------|
| `mode` | `automatic`, `custom`, or `hierarchical` |
| `pre_processing_rules` | Rules for text cleanup before segmentation |
| `segmentation.separator` | String used to split text into chunks |
| `segmentation.max_tokens` | Maximum tokens per chunk |
| `segmentation.chunk_overlap` | Number of overlapping tokens between chunks |
| `parent_mode` | For hierarchical: `full-doc` or `paragraph` |
| `subchunk_segmentation` | Segmentation rules for child chunks (hierarchical only) |

### Metadata Assignment

To assign metadata when creating/updating documents:

1. First, use **List Metadata** to get the metadata field IDs
2. Then provide the metadata as JSON in the format:
```json
[
  {"id": "actual-field-uuid", "name": "field_name", "value": "field_value"}
]
```

## Configuration

| Parameter | Required | Description |
|-----------|----------|-------------|
| API Key | Yes | Dify Knowledge Base API key for authentication |
| Base URL | Yes | Dify API endpoint URL (e.g., `https://api.dify.ai/v1`) |

## Error Handling

The plugin provides descriptive error messages for common issues:
- Invalid API key or authentication failures
- Missing required parameters
- Resource not found errors
- API rate limiting

## Best Practices

1. **Use List Tools First**: Before updating or deleting resources, use the corresponding list tools to get the correct IDs
2. **Monitor Indexing**: After creating documents, use Get Indexing Status to track embedding progress
3. **Organize with Metadata**: Use metadata fields to categorize and filter documents effectively
4. **Choose Search Methods Wisely**: 
   - Use `semantic_search` for meaning-based queries
   - Use `keyword_search` for exact matches
   - Use `hybrid_search` for best of both

## Changelog

### v0.0.1
- Initial release
- Full CRUD operations for Datasets, Documents, and Chunks
- Metadata management support
- Multiple search methods for retrieval
- Auto create/update document feature

### v0.0.2
- Bug fixes and improvements
- Enhanced error handling

### v0.0.3
- Added animated SVG icon with floating cubes and search effect
- Updated documentation

### v0.0.4
- Added **Get Chunk Details** tool for retrieving complete chunk information
- Added **Child Chunk Operations** for hierarchical document structures:
  - List Child Chunks
  - Create Child Chunk
  - Update Child Chunk
  - Delete Child Chunk
- Updated API utility module with new endpoints
- Enhanced documentation

### v0.0.5
- Added **Keyword Search** to List Documents tool for filtering documents by name
- Improved List Documents output with document names and IDs
- Added `rag` tag to plugin manifest

### v0.0.6
- ✨ **Embedding Cost Calculation Feature:**
  - Added configurable **Embedding Model** selection in provider credentials
  - Added **Custom Cost** input for custom embedding models (cost per 1M tokens)
  - Supports preset models: OpenAI (ada-002, 3-small, 3-large), Cohere, Voyage
  - All cost calculations now use the configured model rate
- 📊 **JSON Response Enhancement:**
  - Added `cost_info` object to JSON response for easy data extraction
  - Fields include: `tokens`, `cost_usd`, `embedding_model`, `cost_per_1m_tokens_usd`
  - No more regex needed - directly select cost values from JSON!
- 🛠️ **Tools Updated with Cost Info:**
  - Create/Update Document - shows estimated tokens and cost
  - Add Chunks - shows actual/estimated tokens and cost
  - Get Indexing Status - shows actual tokens and cost after indexing
- 📁 New utility: `CostCalculator` for centralized cost calculations

### v1.0.0
🎉 **Major Release** — Comprehensive expansion of the Knowledge Pro plugin with 19 new tools and significant improvements.

#### New Dataset Operations
- **Get Dataset** — Retrieve detailed info about a specific knowledge base
- **Update Dataset** — Modify knowledge base settings (name, description, permissions, embedding model, retrieval model, etc.)

#### New Document Operations
- **Get Document** — Retrieve detailed info about a specific document including metadata
- **Update Document by Text** — Update existing document content and settings separately from create
- **Update Document Status** — Batch enable, disable, archive, or unarchive documents

#### Knowledge Tag Management (NEW category)
- **List Knowledge Tags** — View all workspace-level tags
- **Create Knowledge Tag** — Create new tags for organizing knowledge bases
- **Update Knowledge Tag** — Rename existing tags
- **Delete Knowledge Tag** — Remove tags permanently
- **List Dataset Tags** — View tags bound to a specific knowledge base
- **Bind Knowledge Tags** — Attach tags to a knowledge base
- **Unbind Knowledge Tags** — Remove tags from a knowledge base

#### Built-in Metadata Management (NEW category)
- **List Built-in Metadata** — View all built-in metadata fields
- **Toggle Built-in Metadata** — Enable or disable built-in metadata fields

#### Model & Datasource Discovery (NEW category)
- **List Available Models** — Browse available embedding and reranking models
- **List Datasource Plugins** — View available datasource plugins

#### Pipeline Operations (NEW category)
- **Run Pipeline** — Execute a pipeline with specified parameters
- **Run Datasource Node** — Run a specific datasource node within a pipeline
- **Upload Pipeline File** — Upload a file for pipeline processing

#### Improvements
- Enhanced existing tools with improved parameter handling and error messages
- Fixed `retrieve_chunks` response parsing for API compatibility
- Updated API utility module with all new endpoints
- Expanded provider configuration to register all 41 tools

## Support

For issues and feature requests, please contact [abesticode](https://github.com/abesticode/dify-plugin-knowledge-pro).

## License

This plugin is provided as-is for use with the Dify platform.

dify-plugin-knowledge-pro

dify-plugin-knowledge-pro Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

dify-plugin-knowledge-pro

dify-plugin-knowledge-pro Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README