Package io.github.guoshiqiufeng.dify.server

Interface DifyServer

All Known Implementing Classes:
DifyServerClientImpl
public interface DifyServer
Dify服务接口，提供与Dify平台交互的方法
Since:
2025/3/4 15:05
Version:
1.0
Author:
yanghq

  • Method Details

    • apps

      List<AppsResponse> apps(String mode, String name)
      获取所有应用列表
      Parameters:
      mode - 模式 chat\agent-chat\completion\advanced-chat\workflow
      name - 应用名称，用于过滤应用列表（可选，传入空字符串时表示不过滤）
      Returns:
      返回符合条件的应用列表，每个应用封装为 AppsResponse 对象
      Throws:
      IllegalArgumentException - 如果传入的参数不符合预期格式或范围

    • app

      AppsResponse app(String appId)
      根据应用ID获取单个应用的详细信息
      Parameters:
      appId - 应用的唯一标识符，不能为空
      Returns:
      返回封装了应用详细信息的 AppsResponse 对象，如果未找到应用则返回null
      Throws:
      NullPointerException - 如果 appId 为 null

    • getAppApiKey

      List<ApiKeyResponse> getAppApiKey(String appId)
      根据应用ID获取该应用的所有API Key列表
      Parameters:
      appId - 应用的唯一标识符，不能为空
      Returns:
      返回封装了API Key信息的列表，每个API Key封装为 ApiKeyResponse 对象
      Throws:
      NullPointerException - 如果 id 为 null

    • initAppApiKey

      List<ApiKeyResponse> initAppApiKey(String appId)
      初始化应用的API Key 如果应用尚未创建API Key，此方法将创建并返回新的API Key
      Parameters:
      appId - 应用的唯一标识符，不能为空
      Returns:
      返回初始化后的API Key列表，每个API Key封装为 ApiKeyResponse 对象
      Throws:
      NullPointerException - 如果 id 为 null

    • getDatasetApiKey

      List<DatasetApiKeyResponse> getDatasetApiKey()
      获取知识库的API Key列表 用于访问Dify平台上的知识库资源
      Returns:
      返回知识库API Key列表，每个API Key封装为 DatasetApiKeyResponse 对象， 如果未找到则返回null

    • initDatasetApiKey

      List<DatasetApiKeyResponse> initDatasetApiKey()
      初始化知识库的API Key 如果知识库尚未创建API Key，此方法将创建并返回新的API Key
      Returns:
      返回初始化后的知识库API Key列表，每个API Key封装为 DatasetApiKeyResponse 对象， 如果初始化失败则返回空列表