文档

消息关联文件

更新时间:
一键部署

检索消息的关联文件

from dashscope.threads.messages.files import Files as MessageFiles


message_file = MessageFiles.retrieve('file_id',
                                     thread_id='thread_id',
                                     message_id='message_id')
import com.alibaba.dashscope.exception.ApiException;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.InvalidateParameter;
import com.alibaba.dashscope.exception.NoApiKeyException;
import com.alibaba.dashscope.threads.messages.MessageFile;
import com.alibaba.dashscope.threads.messages.Messages;

public class Main {
    public static void main(String[] args) throws ApiException, NoApiKeyException, InputRequiredException, InvalidateParameter, InterruptedException {
        // create a message to thread
        Messages messages = new Messages();
        MessageFile messageFile = messages.retrieveFile("threadId", "messageId", "fileId");
    }
}

输入参数

参数

类型

默认值

说明

file_id

str

-

指定要查询的file id

message_id

str

-

指定要查询的file关联的thread id

thread_id

str

-

指定要查询的File所属Thread id

workspace

str

None

DashScope workspace id

api_key

str

None

DashScope api key,可以通过环境变量等方法设置。

输出参数

参数

类型

默认值

说明

id

str

-

file id

message_id

str

-

指定要查询的file关联的thread id

created_at

timestamp

assistant创建时间

gmt_created

datatime

2024-03-22 17:12:31

gmt_modified

datatime

2024-03-22 17:12:31

code

str

表示请求失败,表示错误码,成功忽略。

python only

message

str

失败,表示失败详细信息,成功忽略。

python only

列出消息的关联文件

from dashscope.threads.messages.files import Files as MessageFiles
MessageFiles.list('message_id',
                  thread_id='thread_id',
                  limit=1,
                  order='desc',
                  after='',
                  before='')
import com.alibaba.dashscope.common.GeneralListParam;
import com.alibaba.dashscope.common.ListResult;
import com.alibaba.dashscope.exception.ApiException;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.InvalidateParameter;
import com.alibaba.dashscope.exception.NoApiKeyException;
import com.alibaba.dashscope.threads.messages.MessageFile;
import com.alibaba.dashscope.threads.messages.Messages;

public class Main {
    public static void main(String[] args) throws ApiException, NoApiKeyException, InputRequiredException, InvalidateParameter, InterruptedException {
        // create a message to thread
        Messages messages = new Messages();
        GeneralListParam listMessageFile = GeneralListParam.builder().build();
        ListResult<MessageFile> message = messages.listFiles("threadId", "messageId", listMessageFile);
    }
}

请求参数

参数

类型

默认值

说明

message_id

str

-

MessageFile所属Message id

thread_id

str

-

MessageFile 所属Thread id.

limit

str

指定要查询的assistant id

order

after

before

workspace

str

None

DashScope workspace id

api_key

str

None

DashScope api key,可以通过环境变量等方法设置。

返回参数

输出MessageFileList对象字段说明

字段名

字段类型

字段描述

his_more

bool

last_id

str

first_id

str

data

list[MessageFile]

MessageFile对象列表