Server API

List<AppsResponseVO> apps(String mode, String name);

@Resource
private DifyServer difyServer;

@Test
public void testGetApps() {
    // 获取所有应用
    List<AppsResponseVO> apps = difyServer.apps("");

    // 获取带名称过滤的应用
    List<AppsResponseVO> filteredApps = difyServer.apps("myApp");
}

AppsResponseResult apps(AppsRequest appsRequest);

@Resource
private DifyServer difyServer;

@Test
public void testGetAppsPaginated() {
    // 创建分页请求
    AppsRequest request = new AppsRequest();
    request.setPage(1);
    request.setLimit(10);
    request.setMode("chat");
    request.setName("myApp");
    request.setIsCreatedByMe(true);

    // 获取分页应用列表
    AppsResponseResult result = difyServer.apps(request);

    System.out.println("当前页: " + result.getPage());
    System.out.println("每页数量: " + result.getLimit());
    System.out.println("总数: " + result.getTotal());
    System.out.println("是否有更多: " + result.getHasMore());
    System.out.println("数据大小: " + result.getData().size());
}

AppsResponseVO app(String appId);

@Resource
private DifyServer difyServer;

@Test
public void testGetApp() {
    AppsResponseVO app = difyServer.app("app-123456789");
}

AppsResponse createApp(AppCreateRequest request);

@Resource
private DifyServer difyServer;

@Test
public void testCreateApp() {
    AppCreateRequest request = new AppCreateRequest();
    request.setName("My Agent");
    request.setMode("agent-chat");
    request.setDescription("智能体应用示例");

    AppsResponse app = difyServer.createApp(request);
}

AppsResponse updateApp(String appId, AppUpdateRequest request);

@Resource
private DifyServer difyServer;

@Test
public void testUpdateApp() {
    AppUpdateRequest request = new AppUpdateRequest();
    request.setName("Renamed App");
    request.setDescription("更新后的描述");

    AppsResponse app = difyServer.updateApp("app-123456789", request);
}

void deleteApp(String appId);

@Resource
private DifyServer difyServer;

@Test
public void testDeleteApp() {
    difyServer.deleteApp("app-123456789");
}

List<ApiKeyResponseVO> getAppApiKey(String id);

@Resource
private DifyServer difyServer;

@Test
public void testGetAppApiKeys() {
    List<ApiKeyResponseVO> apiKeys = difyServer.getAppApiKey("app-123456789");
}

List<ApiKeyResponseVO> initAppApiKey(String id);

@Resource
private DifyServer difyServer;

@Test
public void testInitAppApiKey() {
    List<ApiKeyResponseVO> apiKeys = difyServer.initAppApiKey("app-123456789");
}

void deleteAppApiKey(String appId, String apiKeyId);

@Resource
private DifyServer difyServer;

@Test
public void testDeleteAppApiKey() {
    // 删除指定应用的API密钥
    difyServer.deleteAppApiKey("app-123456789", "key-789012345");
}

void workflowsPublish(String appId);

@Resource
private DifyServer difyServer;

@Test
public void testWorkflowsPublish() {
    // 发布指定工作流应用
    difyServer.workflowsPublish("app-123456789");
}

void updateAppModelConfig(String appId, AppModelConfigRequest request);

@Resource
private DifyServer difyServer;

@Test
public void testUpdateAppModelConfig() {
    AppModelConfigRequest request = new AppModelConfigRequest();
    request.setPrePrompt("hi2");
    request.setPromptType("simple");
    request.setOpeningStatement("你好！有什么问题我可以帮助你解答吗？");
    request.setSuggestedQuestions(List.of("hi", "hello"));

    AppModelConfigRequest.Model model = new AppModelConfigRequest.Model();
    model.setProvider("langgenius/ollama/ollama");
    model.setName("qwen2.5:latest");
    model.setMode("chat");
    model.setCompletionParams(Map.of("stop", List.of()));
    request.setModel(model);

    AppModelConfigRequest.AgentMode agentMode = new AppModelConfigRequest.AgentMode();
    agentMode.setEnabled(true);
    agentMode.setMaxIteration(5);
    agentMode.setStrategy("function_call");
    request.setAgentMode(agentMode);

    difyServer.updateAppModelConfig("app-123456789", request);
}

List<DatasetApiKeyResponseVO> getDatasetApiKey();

@Resource
private DifyServer difyServer;

@Test
public void testGetDatasetApiKeys() {
    List<DatasetApiKeyResponseVO> datasetApiKeys = difyServer.getDatasetApiKey();
}

List<DatasetApiKeyResponseVO> initDatasetApiKey();

@Resource
private DifyServer difyServer;

@Test
public void testInitDatasetApiKey() {
    List<DatasetApiKeyResponseVO> datasetApiKeys = difyServer.initDatasetApiKey();
}

void deleteDatasetApiKey(String apiKeyId);

@Resource
private DifyServer difyServer;

@Test
public void testDeleteDatasetApiKey() {
    // 删除指定的知识库API密钥
    difyServer.deleteDatasetApiKey("89f04b59-6906-4d32-a630-d2911d3b5fd8");
}

DocumentIndexingStatusResponse getDatasetIndexingStatus(String datasetId);

@Resource
private DifyServer difyServer;

@Test
public void testGetDatasetIndexingStatus() {
    String datasetId = "dataset-123456789";

    // 获取知识库索引状态
    DocumentIndexingStatusResponse indexingStatus = difyServer.getDatasetIndexingStatus(datasetId);

    if (indexingStatus.getData() != null && !indexingStatus.getData().isEmpty()) {
        for (DocumentIndexingStatusResponse.ProcessingStatus doc : indexingStatus.getData()) {
            System.out.println("文档ID: " + doc.getId());
            System.out.println("索引状态: " + doc.getIndexingStatus());
            System.out.println("已完成分段: " + doc.getCompletedSegments() + "/" + doc.getTotalSegments());
        }
    }
}

DocumentIndexingStatusResponse.ProcessingStatus getDocumentIndexingStatus(String datasetId, String documentId);

@Resource
private DifyServer difyServer;

@Test
public void testGetDocumentIndexingStatus() {
    String datasetId = "dataset-123456789";
    String documentId = "doc-987654321";

    // 获取文档索引状态
    DocumentIndexingStatusResponse.ProcessingStatus documentStatus =
        difyServer.getDocumentIndexingStatus(datasetId, documentId);

    System.out.println("文档ID: " + documentStatus.getId());
    System.out.println("索引状态: " + documentStatus.getIndexingStatus());
    System.out.println("已完成分段: " + documentStatus.getCompletedSegments() + "/" + documentStatus.getTotalSegments());

    if (documentStatus.getError() != null) {
        System.out.println("错误信息: " + documentStatus.getError());
    }
}

DatasetErrorDocumentsResponse getDatasetErrorDocuments(String datasetId);

@Resource
private DifyServer difyServer;

@Test
public void testGetDatasetErrorDocuments() {
    String datasetId = "dataset-123456789";

    // 获取知识库错误文档
    DatasetErrorDocumentsResponse errorDocuments = difyServer.getDatasetErrorDocuments(datasetId);

    System.out.println("错误文档总数: " + errorDocuments.getTotal());

    if (errorDocuments.getData() != null && !errorDocuments.getData().isEmpty()) {
        for (DatasetErrorDocumentsResponse.ErrorDocument doc : errorDocuments.getData()) {
            System.out.println("文档ID: " + doc.getId());
            System.out.println("文档名称: " + doc.getName());
            System.out.println("错误信息: " + doc.getError());
        }
    } else {
        System.out.println("没有错误文档");
    }
}

void retryDocumentIndexing(DocumentRetryRequest request);

@Resource
private DifyServer difyServer;

@Test
public void testRetryDocumentIndexing() {
    String datasetId = "dataset-123456789";

    // 先获取错误文档
    DatasetErrorDocumentsResponse errorDocuments = difyServer.getDatasetErrorDocuments(datasetId);

    if (errorDocuments.getData() != null && !errorDocuments.getData().isEmpty()) {
        // 提取错误文档ID
        List<String> errorDocIds = errorDocuments.getData().stream()
            .map(DatasetErrorDocumentsResponse.ErrorDocument::getId)
            .collect(Collectors.toList());

        // 创建重试请求
        DocumentRetryRequest request = new DocumentRetryRequest();
        request.setDatasetId(datasetId);
        request.setDocumentIds(errorDocIds);

        // 重试文档索引
        difyServer.retryDocumentIndexing(request);
        System.out.println("已触发 " + errorDocIds.size() + " 个文档的索引重试");
    } else {
        System.out.println("没有需要重试的错误文档");
    }
}

DifyPageResult<ChatConversationResponse> chatConversations(ChatConversationsRequest request);

@Resource
private DifyServer difyServer;

@Test
public void testGetChatConversations() {
    // 创建请求对象
    ChatConversationsRequest request = new ChatConversationsRequest();
    request.setAppId("app-123456789");
    request.setPage(1);
    request.setLimit(10);
    request.setStart("2025-10-23 00:00");
    request.setEnd("2025-10-30 23:59");
    request.setAnnotationStatus("all");
    request.setSortBy("-created_at");

    // 获取聊天会话列表
    DifyPageResult<ChatConversationResponse> result = difyServer.chatConversations(request);

    System.out.println("当前页: " + result.getPage());
    System.out.println("每页数量: " + result.getLimit());
    System.out.println("总数: " + result.getTotal());
    System.out.println("是否有更多: " + result.getHasMore());
    System.out.println("数据大小: " + result.getData().size());

    for (ChatConversationResponse conversation : result.getData()) {
        System.out.println("会话ID: " + conversation.getId());
        System.out.println("会话名称: " + conversation.getName());
        System.out.println("是否标注: " + conversation.isAnnotated());
    }
}

List<DailyConversationsResponse> dailyConversations(String appId, LocalDateTime start, LocalDateTime end);

@Resource
private DifyServer difyServer;

@Test
public void testGetDailyConversations() {
    String appId = "08534c1a-4316-4cd3-806d-bbbca03f58aa";
    LocalDateTime start = LocalDateTime.of(2025, 10, 23, 0, 0);
    LocalDateTime end = LocalDateTime.of(2025, 10, 30, 23, 59);

    // 获取每日对话统计
    List<DailyConversationsResponse> dailyStats = difyServer.dailyConversations(appId, start, end);

    if (dailyStats != null) {
        for (DailyConversationsResponse dailyStat : dailyStats) {
            System.out.println("日期: " + dailyStat.getDate());
            System.out.println("对话数量: " + dailyStat.getConversationCount());
        }
    }
}

List<DailyWorkflowConversationsResponse> dailyWorkflowConversations(String appId, LocalDateTime start, LocalDateTime end);

@Resource
private DifyServer difyServer;

@Test
public void testGetDailyWorkflowConversations() {
    String appId = "08534c1a-4316-4cd3-806d-bbbca03f58aa";
    LocalDateTime start = LocalDateTime.of(2025, 10, 23, 0, 0);
    LocalDateTime end = LocalDateTime.of(2025, 10, 30, 23, 59);

    // 获取每日工作流对话统计
    List<DailyWorkflowConversationsResponse> dailyWorkflowStats = difyServer.dailyWorkflowConversations(appId, start, end);

    if (dailyWorkflowStats != null) {
        for (DailyWorkflowConversationsResponse dailyStat : dailyWorkflowStats) {
            System.out.println("日期: " + dailyStat.getDate());
            System.out.println("工作流运行次数: " + dailyStat.getRuns());
        }
    }
}

List<DailyEndUsersResponse> dailyEndUsers(String appId, LocalDateTime start, LocalDateTime end);

@Resource
private DifyServer difyServer;

@Test
public void testGetDailyEndUsers() {
    String appId = "08534c1a-4316-4cd3-806d-bbbca03f58aa";
    LocalDateTime start = LocalDateTime.of(2025, 10, 23, 0, 0);
    LocalDateTime end = LocalDateTime.of(2025, 10, 30, 23, 59);

    // 获取每日终端用户统计
    List<DailyEndUsersResponse> dailyEndUsersStats = difyServer.dailyEndUsers(appId, start, end);

    if (dailyEndUsersStats != null) {
        for (DailyEndUsersResponse dailyStat : dailyEndUsersStats) {
            System.out.println("日期: " + dailyStat.getDate());
            System.out.println("终端用户数量: " + dailyStat.getTerminalCount());
        }
    }
}

List<AverageSessionInteractionsResponse> averageSessionInteractions(String appId, LocalDateTime start, LocalDateTime end);

@Resource
private DifyServer difyServer;

@Test
public void testGetAverageSessionInteractions() {
    String appId = "08534c1a-4316-4cd3-806d-bbbca03f58aa";
    LocalDateTime start = LocalDateTime.of(2025, 10, 23, 0, 0);
    LocalDateTime end = LocalDateTime.of(2025, 10, 30, 23, 59);

    // 获取平均会话交互统计
    List<AverageSessionInteractionsResponse> averageSessionInteractionsStats = difyServer.averageSessionInteractions(appId, start, end);

    if (averageSessionInteractionsStats != null) {
        for (AverageSessionInteractionsResponse dailyStat : averageSessionInteractionsStats) {
            System.out.println("日期: " + dailyStat.getDate());
            System.out.println("平均会话交互数: " + dailyStat.getInteractions());
        }
    }
}

List<TokensPerSecondResponse> tokensPerSecond(String appId, LocalDateTime start, LocalDateTime end);

@Resource
private DifyServer difyServer;

@Test
public void testGetTokensPerSecond() {
    String appId = "08534c1a-4316-4cd3-806d-bbbca03f58aa";
    LocalDateTime start = LocalDateTime.of(2025, 10, 23, 0, 0);
    LocalDateTime end = LocalDateTime.of(2025, 10, 30, 23, 59);

    // 获取每秒令牌统计
    List<TokensPerSecondResponse> tokensPerSecondStats = difyServer.tokensPerSecond(appId, start, end);

    if (tokensPerSecondStats != null) {
        for (TokensPerSecondResponse dailyStat : tokensPerSecondStats) {
            System.out.println("日期: " + dailyStat.getDate());
            System.out.println("每秒令牌数: " + dailyStat.getTps());
        }
    }
}

List<UserSatisfactionRateResponse> userSatisfactionRate(String appId, LocalDateTime start, LocalDateTime end);

@Resource
private DifyServer difyServer;

@Test
public void testGetUserSatisfactionRate() {
    String appId = "08534c1a-4316-4cd3-806d-bbbca03f58aa";
    LocalDateTime start = LocalDateTime.of(2025, 10, 23, 0, 0);
    LocalDateTime end = LocalDateTime.of(2025, 10, 30, 23, 59);

    // 获取用户满意度率统计
    List<UserSatisfactionRateResponse> userSatisfactionRateStats = difyServer.userSatisfactionRate(appId, start, end);

    if (userSatisfactionRateStats != null) {
        for (UserSatisfactionRateResponse dailyStat : userSatisfactionRateStats) {
            System.out.println("日期: " + dailyStat.getDate());
            System.out.println("用户满意度率: " + dailyStat.getRate());
        }
    }
}

List<TokenCostsResponse> tokenCosts(String appId, LocalDateTime start, LocalDateTime end);

@Resource
private DifyServer difyServer;

@Test
public void testGetTokenCosts() {
    String appId = "08534c1a-4316-4cd3-806d-bbbca03f58aa";
    LocalDateTime start = LocalDateTime.of(2025, 10, 23, 0, 0);
    LocalDateTime end = LocalDateTime.of(2025, 10, 30, 23, 59);

    // 获取令牌费用统计
    List<TokenCostsResponse> tokenCostsStats = difyServer.tokenCosts(appId, start, end);

    if (tokenCostsStats != null) {
        for (TokenCostsResponse dailyStat : tokenCostsStats) {
            System.out.println("日期: " + dailyStat.getDate());
            System.out.println("令牌数量: " + dailyStat.getTokenCount());
            System.out.println("总费用: " + dailyStat.getTotalPrice());
            System.out.println("货币类型: " + dailyStat.getCurrency());
        }
    }
}

List<DailyMessagesResponse> dailyMessages(String appId, LocalDateTime start, LocalDateTime end);

@Resource
private DifyServer difyServer;

@Test
public void testGetDailyMessages() {
    String appId = "08534c1a-4316-4cd3-806d-bbbca03f58aa";
    LocalDateTime start = LocalDateTime.of(2025, 10, 23, 0, 0);
    LocalDateTime end = LocalDateTime.of(2025, 10, 30, 23, 59);

    // 获取每日消息统计
    List<DailyMessagesResponse> dailyMessagesStats = difyServer.dailyMessages(appId, start, end);

    if (dailyMessagesStats != null) {
        for (DailyMessagesResponse dailyStat : dailyMessagesStats) {
            System.out.println("日期: " + dailyStat.getDate());
            System.out.println("消息数量: " + dailyStat.getMessageCount());
        }
    }
}

MemberInviteResponse inviteMembers(MemberInviteRequest request);

@Resource
private DifyServer difyServer;

@Test
public void testInviteMembers() {
    MemberInviteRequest request = new MemberInviteRequest();
    request.setEmails(List.of("alice@example.com", "bob@example.com"));
    request.setRole("normal");
    request.setLanguage("zh-Hans");

    MemberInviteResponse response = difyServer.inviteMembers(request);

    for (MemberInviteResponse.InvitationResult item : response.getInvitationResults()) {
        System.out.println(item.getEmail() + " -> " + item.getStatus());
        if ("success".equals(item.getStatus())) {
            System.out.println("激活链接：" + item.getUrl());
        }
    }
}