Here's the English version of the README for the Dify API Java SDK:

Dify API Java SDK

English | 简体中文) | 日本語

The Dify API Java Client is a Java client library for interacting with the Dify platform. It provides full support for Dify's application API and knowledge base API, allowing Java developers to easily integrate Dify's generative AI capabilities into their applications.

Features

The Dify API Java Client offers the following core features:

1. Support for Multiple Application Types

• Conversational Applications (Chat): Use DifyChatApi to call conversational applications, supporting session management, message feedback, and more.
• Text Generation Applications (Completion): Use DIfyCompletionApi to call text generation applications.
• Workflow Orchestrated Conversations (Chatflow): Use DifyChayflowApi to call workflow orchestrated conversational applications.
• Workflow Applications (Workflow): Use DifyWorkflowApi to call workflow applications.
• Knowledge Base Management (Datasets): Use DifyDatasetsApi to manage knowledge bases, documents, and retrieval.

2. Rich Interaction Modes

• Blocking Mode: Synchronous API calls, waiting for a complete response.
• Streaming Mode: Receive real-time generated content via callbacks, supporting typewriter effects.
• File Handling: Support for file uploads, speech-to-text, text-to-speech, and other multimedia functions.

3. Comprehensive Session Management

• Create and manage sessions.
• Retrieve historical messages.
• Rename sessions.
• Message feedback (like/dislike).
• Get suggested questions.

4. Full Knowledge Base Support

• Create and manage knowledge bases.
• Upload and manage documents.
• Document segmentation management.
• Semantic retrieval.

5. Annotation Management

• Create annotations.
• Update annotations.
• Delete annotations.
• Initial setup for annotation replies.
• Query task status for initial setup of annotation replies.

6. Flexible Configuration Options

• Custom connection timeout.
• Custom read/write timeout.
• HTTP proxy support.

Installation

System Requirements

• Java 8 or higher.
• Maven 3.x or higher.

Maven

<dependency>
    <groupId>io.github.chat-pass</groupId>
    <artifactId>dify-api-java-sdk</artifactId>
    <version>1.0.1.FINAL</version>
</dependency>

Quick Start

Basic Usage Example

// Environment configuration
Map<String,String> envs = System.getenv();
DifyChatApi difyChatApi = DifyApiFactory.newInstance(envs.get("DIFY_BASE_URL"),envs.get("DIFY_API_KEY")).newDifyChatApi();

// Send chat message
ChatMessageRequest request = new ChatMessageRequest();
request.setUser("test-user");
request.setQuery("Hello, please introduce yourself");
request.setResponseMode(ResponseMode.BLOCKING);

ChatMessageResponse response = difyChatApi.sendChatMessage(request);
System.out.println(response.getAnswer());

📚 Complete Examples Documentation

This SDK provides rich functional examples covering all major use cases:

🔗 View Complete Examples Documentation →

The examples documentation includes: - 🚀 Basic API Examples - Application info retrieval, parameter configuration - 💬 Conversational Applications - Blocking and streaming chat, message handling
- ⚡ Workflow Applications - Execution, monitoring, log management - 📊 Dataset Management - Knowledge base creation, document management, semantic retrieval - 🎵 Audio Processing - Text-to-speech, speech-to-text - 📁 File Management - File upload, processing - 🛠️ Best Practices - Error handling, performance optimization, concurrent processing

API Reference

Client Types

Response Modes

Event Types

Advanced Configuration

Custom HTTP Client

// Create custom configuration
OkHttpClient customClient = new OkHttpClient.Builder()
                .callTimeout(30, TimeUnit.SECONDS)
                .pingInterval(15, TimeUnit.SECONDS)
                .build();
DIfyApiServiceGenerator.configureHttpClient(customClient);

HTTP Proxy Settings

DIfyApiServiceGenerator.setHttpProxy("proxy.example.com", 8080, "username", "password");

Contribution

Contributions, issue reports, and suggestions for improvements are welcome. Please participate in project development through GitHub Issues or Pull Requests.

License

This project is licensed under the Apache License 2.0.

Related Links

• 📚 Complete Examples Documentation - SDK usage examples and best practices
• Dify Official Website
• Dify Documentation
• Dify GitHub