Package io.github.guoshiqiufeng.dify.chat

Interface DifyChat

All Known Implementing Classes:
DifyChatClientImpl
public interface DifyChat
聊天相关接口定义
Since:
2025/3/4 14:24
Version:
1.0
Author:
yanghq

  • Method Details

    • send

      ChatMessageSendResponse send(ChatMessageSendRequest sendRequest)
      发送消息
      Parameters:
      sendRequest - 消息发送请求对象，包含消息内容等信息
      Returns:
      ChatMessageSendResponse 消息发送响应对象，包含发送结果等信息

    • sendChatMessageStream

      reactor.core.publisher.Flux<ChatMessageSendCompletionResponse> sendChatMessageStream(ChatMessageSendRequest sendRequest)
      发送消息并获取消息流
      Parameters:
      sendRequest - 消息发送请求对象，包含消息内容等信息
      Returns:
      Flux 消息流，实时返回消息发送的结果

    • stopMessagesStream

      void stopMessagesStream(String apiKey, String taskId, String userId)
      停止消息流
      Parameters:
      apiKey - API密钥，用于身份验证
      taskId - 任务ID，标识需要停止的消息流任务
      userId - 用户ID，标识操作者

    • messageFeedback

      MessageFeedbackResponse messageFeedback(MessageFeedbackRequest messageFeedbackRequest)
      消息反馈
      Parameters:
      messageFeedbackRequest - 消息反馈请求对象，包含消息ID、反馈内容等信息
      Returns:
      MessageFeedbackResponse 消息反馈响应

    • conversations

      io.github.guoshiqiufeng.dify.core.pojo.DifyPageResult<MessageConversationsResponse> conversations(MessageConversationsRequest request)
      获取会话列表
      Parameters:
      request - 会话查询请求对象，包含分页、过滤条件等信息
      Returns:
      DifyPageResult 分页结果，包含会话列表信息

    • messages

      io.github.guoshiqiufeng.dify.core.pojo.DifyPageResult<io.github.guoshiqiufeng.dify.core.pojo.response.MessagesResponseVO> messages(MessagesRequest request)
      获取消息列表
      Parameters:
      request - 消息查询请求对象，包含分页、过滤条件等信息
      Returns:
      DifyPageResult 分页结果，包含消息列表信息

    • messagesSuggested

      List<String> messagesSuggested(String messageId, String apiKey, String userId)
      获取建议消息列表
      Parameters:
      messageId - 消息ID，标识需要获取建议消息的目标消息
      apiKey - API密钥，用于身份验证
      userId - 用户ID，标识查询者
      Returns:
      List 建议消息列表，包含建议的消息内容

    • deleteConversation

      void deleteConversation(String conversationId, String apiKey, String userId)
      删除会话
      Parameters:
      conversationId - 会话ID，标识需要删除的会话
      apiKey - API密钥，用于身份验证
      userId - 用户ID，标识操作者

    • renameConversation

      MessageConversationsResponse renameConversation(RenameConversationRequest renameConversationRequest)
      会话重命名
      Parameters:
      renameConversationRequest - 会话重命名请求对象，包含会话ID、新名称等信息
      Returns:
      MessageConversationsResponse 重命名后的会话信息

    • parameters

      AppParametersResponseVO parameters(String apiKey)
      获取应用参数
      Parameters:
      apiKey - API密钥，用于身份验证
      Returns:
      DifyAppParametersResponseVO 应用参数响应对象，包含应用配置信息

    • textToAudio

      org.springframework.http.ResponseEntity<byte[]> textToAudio(TextToAudioRequest request)
      文本转语音
      Parameters:
      request - 文本转语音请求对象，包含文本内容等信息
      Returns:
      语音文件流

    • audioToText

      DifyTextVO audioToText(AudioToTextRequest request)
      语音转文本
      Parameters:
      request - 语音转文本请求对象，包含语音文件等信息
      Returns:
      DifyTextVO 文本响应对象，包含转换后的文本内容

    • fileUpload

      FileUploadResponse fileUpload(FileUploadRequest request)
      上传文件
      Parameters:
      request - 上传文件请求对象
      Returns:
      上传文件结果
      Since:
      0.10.0

    • info

      AppInfoResponse info(String apiKey)
      app info
      Parameters:
      apiKey - The API key for authentication and retrieving app parameters
      Returns:
      Application info
      Since:
      0.10.0

    • meta

      AppMetaResponse meta(String apiKey)
      app meta
      Parameters:
      apiKey - The API key for authentication and retrieving app parameters
      Returns:
      Application meta
      Since:
      0.10.0

    • site

      AppSiteResponse site(String apikey)
      app site
      Parameters:
      apikey - The API key for authentication and retrieving app parameters
      Returns:
      Application site
      Since:
      1.1.0, Dify version 1.4.0 or higher

    • pageAppAnnotation

      io.github.guoshiqiufeng.dify.core.pojo.DifyPageResult<AppAnnotationResponse> pageAppAnnotation(AppAnnotationPageRequest request)
      Paginate application annotations
      Parameters:
      request - Annotation pagination request containing page parameters and filters
      Returns:
      DifyPageResult Paginated result with annotation list
      Since:
      0.10.0, Dify version 1.2.0 or higher

    • createAppAnnotation

      AppAnnotationResponse createAppAnnotation(AppAnnotationCreateRequest request)
      Create application annotation
      Parameters:
      request - Annotation creation request containing annotation content and metadata
      Returns:
      AppAnnotationResponse The created annotation information
      Since:
      0.10.0, Dify version 1.2.0 or higher

    • updateAppAnnotation

      AppAnnotationResponse updateAppAnnotation(AppAnnotationUpdateRequest request)
      Update application annotation
      Parameters:
      request - Annotation update request containing modified annotation content and metadata
      Returns:
      AppAnnotationResponse The updated annotation information
      Since:
      0.10.0, Dify version 1.3.1 or higher

    • deleteAppAnnotation

      void deleteAppAnnotation(String annotationId, String apiKey)
      Delete application annotation
      Parameters:
      annotationId - Annotation ID to identify the annotation to delete
      apiKey - API key for authentication
      Since:
      0.10.0, Dify version 1.2.0 or higher

    • annotationReply

      AppAnnotationReplyResponse annotationReply(AppAnnotationReplyRequest request)
      Reply to an annotation
      Parameters:
      request - Annotation reply request containing the reply content and metadata
      Returns:
      AppAnnotationReplyResponse Response containing the created reply information
      Since:
      0.10.0, Dify version 1.2.0 or higher

    • queryAnnotationReply

      AppAnnotationReplyResponse queryAnnotationReply(AppAnnotationReplyQueryRequest request)
      Query annotation reply information
      Parameters:
      request - Query parameters for retrieving annotation reply data
      Returns:
      AppAnnotationReplyResponse Response containing the requested reply information
      Since:
      0.10.0, Dify version 1.2.0 or higher