metaso_sdk ¶
metaso-sdk package.
The official Python SDK for https://metaso.cn
Modules:
-
bookshelf
– -
cli
–Module that contains the command line application.
-
debug
–Debugging utilities.
-
search
– -
subject
–
Functions:
-
create_topic
–创建一个新专题。
-
delete_file
–删除文件。
-
delete_topic
–删除指定的专题。
-
update_progress
–更新处理进度。
-
upload_book
–上传文件或 URL 到书架。
-
upload_directory
–递归上传指定目录下的文件到指定专题。
-
upload_file
–上传文件到指定专题。
create_topic ¶
create_topic(topic: Topic) -> Optional[Topic]
创建一个新专题。
:param topic (Topic): 要创建的专题对象。 :return: 专题对象。
Source code in src/metaso_sdk/subject.py
10 11 12 13 14 15 16 17 18 19 20 21 22 |
|
delete_file ¶
删除文件。
:param file_or_book: 待删除的 File 或者 Book 对象。 :return: 如果删除成功,返回True。否则返回False。
Source code in src/metaso_sdk/subject.py
69 70 71 72 73 74 75 76 77 78 79 |
|
delete_topic ¶
delete_topic(topic: Topic) -> bool
删除指定的专题。
:param topic (Topic): 要删除的Topic对象。 :return: 如果成功删除Topic返回True,否则返回False。
Source code in src/metaso_sdk/subject.py
25 26 27 28 29 30 31 32 33 34 |
|
update_progress ¶
更新处理进度。
:param file_or_book: 待更新进度的 File 或者 Book 对象。 :return: 更新 progress 后的对象。
Source code in src/metaso_sdk/subject.py
53 54 55 56 57 58 59 60 61 62 63 64 65 66 |
|
upload_book ¶
upload_book(fileobj_or_url) -> Optional[Book]
上传文件或 URL 到书架。
:param fileobj_or_url: 待上传的文件对象或则 URL。 :return: 如果文件上传成功,返回 Book 对象;否则返回 None。
Source code in src/metaso_sdk/bookshelf.py
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
|
upload_directory ¶
递归上传指定目录下的文件到指定专题。
参数: - topic: 目标专题。 - path: 需要上传的本地目录路径。 - pattern: 文件匹配模式,默认为"*/",表示匹配所有文件。 - concurrency: 并发上传的数量,默认为10。
返回: - List[File]: 成功上传的文件列表。
Source code in src/metaso_sdk/subject.py
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 |
|
upload_file ¶
upload_file(topic: Topic, file) -> Optional[File]
上传文件到指定专题。
:param topic (Topic): 文件所属的专题。 :param file: 待上传的文件对象。 :return: 如果文件上传成功,返回文件对象;否则返回None。
Source code in src/metaso_sdk/subject.py
37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
|