Server与Client之间的通信说明

数据结构：

Client上传的数据：

User log up, log in:

细节参见源码 labridge/interface/http_server

ClientLogInUpReq:

• user_id: 用户名
• password: 用户密码

Sign in:

• Post URL: /accounts/log-up
• Return: 若成功返回user_id，失败返回None

Log up:

• Post URL: /accounts/log-up
• Return: 若成功返回user_id，失败返回None

Shared paper notes:

Get notes:

• doi (str): 之前服务器返回的该文献的DOI字符串

返回数据结构

• chunk_contents (Optional[Dict[str, str]]): 若没有任何笔记，为 None; 若存在笔记，这是一个字典，key为每个位置的文献文本的哈希值，value为文献文本内容。

• user_notes (Optional[List[Dict[str, Any]]]): 若没有任何笔记，为 None; 若存在笔记，这是一个列表，列表中每个元素为一条笔记，是一个字典，该字典包含如下key:

  • doi: 文献DOI；类型：str
  • page_label: 该笔记所在的页数（从1开始）；类型：int
  • chunk_hash: 该笔记所对应文献文本的哈希值；类型：str
  • user_id: 记下该条笔记的用户ID；类型：str
  • note: 笔记文本；类型：str
  • timestamp: 笔记记录时间；类型：str

Get URL: /users/{user_id}/paper_notes/get_note

Add note:

• user_id (str): 记录该文献笔记的用户名
• doi (str): 该文献的DOI字符串
• page_label (int): 该笔记记录位置的文献页码（从1开始）
• chunk_info (str): 该笔记对应的文中文本（如用户划的文本）
• note (str): 笔记文本

Chat with text:

细节参见源码 labridge/interface/http_server

ClientTextReq:

• text (str): 用户的消息字符串
• reply_in_speech (bool): 用户希望得到语音回复还是文本回复。
• enable_instruct (bool): 当前轮次QA, 用户是否介入Agent的Reasoning
• enable_comment (bool): 当前轮次QA, 用户是否介入Agent的Acting

Post URL: /users/{user_id}/chat_text

Download File:

细节参见源码 labridge/interface/http_server

ClientDownloadReq:

• filepath (str): 申请下载的文件路径

Post URL: /users/{user_id}/files/bytes

Chat with file:

• file (bytes): 上传文件的二进制数据
• file_name (str): 上传文件的文件名（包含后缀）
• text (str): 用户与该文件相关的消息
• reply_in_speech (bool): 用户希望得到语音回复还是文本回复。
• enable_instruct (bool): 当前轮次QA, 用户是否介入Agent的Reasoning
• enable_comment (bool): 当前轮次QA, 用户是否介入Agent的Acting

Post URL: /users/{user_id}/chat_with_file

Chat with speech:

• file (bytes): 语音文件的二进制数据
• file_suffix (str): 语音文件的后缀。支持： .wav
• reply_in_speech (bool): 用户希望得到语音回复还是文本回复。
• enable_instruct (bool): 当前轮次QA, 用户是否介入Agent的Reasoning
• enable_comment (bool): 当前轮次QA, 用户是否介入Agent的Acting

Post URL: /users/{user_id}/chat_speech

从Server获取回复:

Get URL: /users/{user_id}/response

返回的数据结构

细节参见源码 labridge/agent/chat_msg/msg_types.py

ServerReply:

• reply_text (str): Agent的回复字符串
• valid (bool): 本回复是否是有效回复，若没有得到有效回复，客户端应轮询直至获得有效回复

• references (Optional[List[dict]]): 参考文件信息，若没有参考文件，为None；若有，是一个列表。列表中每个元素是一个字典；该字典中有如下key具有有效信息：

  • ref_file_path: 文件存储路径；value类型为：str
  • ref_file_size: 文件大小；value类型为：str
  • doi: 仅当该文件为共享文献时，value为有效字符串，否则为None；value类型为：Optional[str]
  • error (str): 错误信息，如果没有错误，则为None.
  • inner_chat (bool): 本回复是否是一个Chat调用内部的回复。如果为True, 客户端应该把用户接下来的回复发送到相应的 Inner URL.

ServerSpeechReply:

• reply_speech (Dict[str, int]): Key: Agent回复的语音文件在Server的存储路径, Value: 语音文件字节数。
• valid (bool): 本回复是否是有效回复，若没有得到有效回复，客户端应轮询直至获得有效回复

• references (Optional[List[dict]]): 参考文件信息，若没有参考文件，为None；若有，是一个列表。列表中每个元素是一个字典；该字典中有如下key具有有效信息：

  • ref_file_path: 文件存储路径；value类型为：str
  • ref_file_size: 文件大小；value类型为：str
  • doi: 仅当该文件为共享文献时，value为有效字符串，否则为None；value类型为：Optional[str]
  • inner_chat: Optional[bool] = False
  • error (str): 错误信息，如果没有错误，则为None.

相应的 Inner URL:

Chat with text:

Inner URL: /users/{user_id}/inner_chat_text

Chat with speech:

Inner URL: /users/{user_id}/inner_chat_speech

Chat with file:

Inner URL: /users/{user_id}/inner_chat_with_file