本文档描述 Assistants API中与 Message 相关的接口。

首先需要安装AppBuilder-SDK代码库，若已在开发环境安装，则可跳过此步。

注意：: appbuilder-sdk 的python版本要求 3.9+，安装的SDK version >= 0.7.0

  
  
  
  
  
  

   
   
   
   
   
   

    !python3 -m pip install appbuilder-sdk
   
   
   
   
   
   
  
  
  
  
  
  

  
  
  
  
  
  

   
   
   
   
   
   

    import os
   
   
   
   
   
   
   
   
   
   
   
   

    import appbuilder
   
   
   
   
   
   
   
   
   
   
   
   

    
   
   
   
   
   
   
   
   
   
   
   
   

    # 配置你的密钥，主要在这之前需要首先申请Assistant API的内测资格
   
   
   
   
   
   
   
   
   
   
   
   

    os.environ["APPBUILDER_TOKEN"] = "your_appbuilder_token"
   
   
   
   
   
   
  
  
  
  
  
  

创建Message附加到指定Thread末尾

  
  
  
  
  
  

   
   
   
   
   
   

    # 首先创建一个对话thread
   
   
   
   
   
   
   
   
   
   
   
   

    thread = appbuilder.assistant.threads.create()
   
   
   
   
   
   
   
   
   
   
   
   

    
   
   
   
   
   
   
   
   
   
   
   
   

    # 创建Message附加到指定Thread末尾i
   
   
   
   
   
   
   
   
   
   
   
   

    msg = appbuilder.assistant.threads.messages.create(
   
   
   
   
   
   
   
   
   
   
   
   

        thread_id=thread.id,
   
   
   
   
   
   
   
   
   
   
   
   

        content="hello world?"
   
   
   
   
   
   
   
   
   
   
   
   

    )
   
   
   
   
   
   
  
  
  
  
  
  

查询指定Thread下的Message列表

  
  
  
  
  
  

   
   
   
   
   
   

    # 查询相应thread下的message列表，你可以指定limit来控制返回的message数量，默认值为20
   
   
   
   
   
   
   
   
   
   
   
   

    msg_list = appbuilder.assistant.threads.messages.list(
   
   
   
   
   
   
   
   
   
   
   
   

        thread_id=msg.thread_id,
   
   
   
   
   
   
   
   
   
   
   
   

        limit=10
   
   
   
   
   
   
   
   
   
   
   
   

    ) 
   
   
   
   
   
   
   
   
   
   
   
   

    
   
   
   
   
   
   
   
   
   
   
   
   

    # 打印查询到的message信息
   
   
   
   
   
   
   
   
   
   
   
   

    for msg_data in msg_list.data:
   
   
   
   
   
   
   
   
   
   
   
   

        print(msg_data)
   
   
   
   
   
   
  
  
  
  
  
  

id='msg_d563991f8383424aa9334a24fb06b713' object='thread.message' role=<AssistantMessageRole.USER: 'user'> content=[AssistantContent(type='text', text=AssistantText(value='hello world?', annotations=[]))] created_at=1717645387637 thread_id='thread_a361a66e3cb94928b3b6050789d55dae' assistant_id='' run_id='' file_ids=[]

根据message_id查询指定Message的信息

  
  
  
  
  
  

   
   
   
   
   
   

    # 提供thread_id与message_id查询message的信息
   
   
   
   
   
   
   
   
   
   
   
   

    msg_query = appbuilder.assistant.threads.messages.query(
   
   
   
   
   
   
   
   
   
   
   
   

        thread_id=msg.thread_id,
   
   
   
   
   
   
   
   
   
   
   
   

        message_id=msg.id
   
   
   
   
   
   
   
   
   
   
   
   

    )
   
   
   
   
   
   
   
   
   
   
   
   

    
   
   
   
   
   
   
   
   
   
   
   
   

    # 打印查询到的message信息
   
   
   
   
   
   
   
   
   
   
   
   

    print(msg_query)
   
   
   
   
   
   
  
  
  
  
  
  

id='msg_d563991f8383424aa9334a24fb06b713' object='thread.message' role=<AssistantMessageRole.USER: 'user'> content=[AssistantContent(type='text', text=AssistantText(value='hello world?', annotations=[]))] created_at=1717645387637 thread_id='thread_a361a66e3cb94928b3b6050789d55dae' assistant_id='' run_id='' file_ids=[]

修改Message对象，允许content和file_ids字段

  
  
  
  
  
  

   
   
   
   
   
   

    # 将content更新为'你好'
   
   
   
   
   
   
   
   
   
   
   
   

    msg_update= appbuilder.assistant.threads.messages.update(
   
   
   
   
   
   
   
   
   
   
   
   

        thread_id=msg.thread_id,
   
   
   
   
   
   
   
   
   
   
   
   

        message_id=msg.id,
   
   
   
   
   
   
   
   
   
   
   
   

        content='你好'
   
   
   
   
   
   
   
   
   
   
   
   

    )
   
   
   
   
   
   
  
  
  
  
  
  

查询一个Message对象下挂载的的File文件列表

  
  
  
  
  
  

   
   
   
   
   
   

    # 查询一个Message对象下挂载的的File文件列表，可以通过设置līmit参数来控制返回File的数量，默认返回20个File对象
   
   
   
   
   
   
   
   
   
   
   
   

    msg_files = appbuilder.assistant.threads.messages.files(
   
   
   
   
   
   
   
   
   
   
   
   

        thread_id=msg_update.thread_id,
   
   
   
   
   
   
   
   
   
   
   
   

        message_id=msg_update.id,
   
   
   
   
   
   
   
   
   
   
   
   

        limit=10
   
   
   
   
   
   
   
   
   
   
   
   

    )
   
   
   
   
   
   
   
   
   
   
   
   

    
   
   
   
   
   
   
   
   
   
   
   
   

    # 打印查询到的File文件信息
   
   
   
   
   
   
   
   
   
   
   
   

    for file_data in msg_files.data:
   
   
   
   
   
   
   
   
   
   
   
   

        print(file_data)