SDK 文档结构升级，优化自动生成文档脚本 (baidubce#593)

* SDK文档结构调整以及链接地址更换

* 测试mkdocs文档是否运行正常

* 更改.gitignore文件

* 回滚更改.gitignore文件

* 更改mkdocs.yml文件配置

* 更改mkdocs文件配置

* 完成SDK代码库脚本及文档更新

* 更行Python-API文档相对路径

* 添加API文档目录

* 更改API目录文档

* 完成组件文档迁移功能,并完善整个文档

* 更新脚本注释

---------

Co-authored-by: yinjiaqi <[email protected]>

.gitignore

@@ -154,3 +154,4 @@ go/coverage_diff.html
 .gitignore
 go/appbuilder/coverage_full.html
 go/appbuilder/coverage_diff.html
+

docs/API-Reference/Python/PythonAPI.md

@@ -0,0 +1,7 @@
+# Python API Reference
+
+
+- [基础 API](appbuilder.md)
+    - [Assistant API](appbuilder.core.assistant.md)
+    - [Components API](appbuilder.core.components.md)
+    - [Console API](appbuilder.core.console.md)

docs/sphinx_md/appbuilder.core.assistant.assistants.md → docs/API-Reference/Python/appbuilder.core.assistant.assistants.md

@@ -8,21 +8,21 @@
 
 基类：`object`
 
-#### create(name: str, description: str, model: str | None = 'ERNIE-4.0-8K', response_format: str | None = 'text', instructions: str | None = '你是百度制作的AI助手', thought_instructions: str | None = '', chat_instructions: str | None = '', tools: list[AssistantTool] | None = [], file_ids: list[str] | None = [], metadata: dict | None = {}) → AssistantCreateResponse
+#### create(name: str, description: str, model: str | None = 'ERNIE-4.0T-8K', response_format: str | None = 'text', instructions: str | None = '你是百度制作的AI助手', thought_instructions: str | None = '', chat_instructions: str | None = '', tools: list[AssistantTool] | None = [], file_ids: list[str] | None = [], metadata: dict | None = {}) → AssistantCreateResponse
 
 创建助手实例
 
 * **参数:**
-  * **name** (*str*) – 助手名称
-  * **description** (*str*) – 助手描述
-  * **model** (*Optional* *[**str* *]* *,* *optional*) – 模型名称. Defaults to “ERNIE-4.0-8K”.
-  * **response_format** (*Optional* *[**str* *]* *,* *optional*) – 响应格式. Defaults to ‘text’.
-  * **instructions** (*Optional* *[**str* *]* *,* *optional*) – 指令. Defaults to “”.
-  * **thought_instructions** (*Optional* *[**str* *]* *,* *optional*) – 思考指令. Defaults to “”.
-  * **chat_instructions** (*Optional* *[**str* *]* *,* *optional*) – 聊天指令. Defaults to “”.
-  * **tools** (*Optional* *[**list* *[**assistant_type.AssistantTool* *]* *]* *,* *optional*) – 工具列表. Defaults to [].
-  * **file_ids** (*Optional* *[**list* *[**str* *]* *]* *,* *optional*) – 文件ID列表. Defaults to [].
-  * **metadata** (*Optional* *[**dict* *]* *,* *optional*) – 元数据. Defaults to {}.
+  * **name** (*str*) -- 助手名称
+  * **description** (*str*) -- 助手描述
+  * **model** (*Optional* *[**str* *]* *,* *optional*) -- 模型名称. Defaults to "ERNIE-4.0T-8K".
+  * **response_format** (*Optional* *[**str* *]* *,* *optional*) -- 响应格式. Defaults to 'text'.
+  * **instructions** (*Optional* *[**str* *]* *,* *optional*) -- 指令. Defaults to "".
+  * **thought_instructions** (*Optional* *[**str* *]* *,* *optional*) -- 思考指令. Defaults to "".
+  * **chat_instructions** (*Optional* *[**str* *]* *,* *optional*) -- 聊天指令. Defaults to "".
+  * **tools** (*Optional* *[**list* *[**assistant_type.AssistantTool* *]* *]* *,* *optional*) -- 工具列表. Defaults to [].
+  * **file_ids** (*Optional* *[**list* *[**str* *]* *]* *,* *optional*) -- 文件ID列表. Defaults to [].
+  * **metadata** (*Optional* *[**dict* *]* *,* *optional*) -- 元数据. Defaults to {}.
 * **返回:**
   助手创建响应
 * **返回类型:**
@@ -33,13 +33,13 @@
 根据assistant_id删除指定Assitant
 
 * **参数:**
-  **assistant_id** (*Optional* *[**str* *]*) – 待删除的助手实例ID。
+  **assistant_id** (*Optional* *[**str* *]*) -- 待删除的助手实例ID。
 * **返回:**
   删除助手实例后的响应结果。
 * **返回类型:**
   assistant_type.AssistantDeleteResponse
 * **抛出:**
-  **HttpRequestError** – 发送HTTP请求时发生错误。
+  **HttpRequestError** -- 发送HTTP请求时发生错误。
 
 #### *property* files
 
@@ -57,10 +57,10 @@
 查询当前用户已创建的assistant列表
 
 * **参数:**
-  * **limit** (*Optional* *[**int* *]* *,* *optional*) – 返回助手列表的最大数量，默认为20。
-  * **order** (*Optional* *[**str* *]* *,* *optional*) – 返回助手列表的排序方式，可选值为”asc”或”desc”，默认为”desc”。
-  * **after** (*Optional* *[**str* *]* *,* *optional*) – 返回助手列表中id在指定id之后的助手，默认为空字符串。
-  * **before** (*Optional* *[**str* *]* *,* *optional*) – 返回助手列表中id在指定id之前的助手，默认为空字符串。
+  * **limit** (*Optional* *[**int* *]* *,* *optional*) -- 返回助手列表的最大数量，默认为20。
+  * **order** (*Optional* *[**str* *]* *,* *optional*) -- 返回助手列表的排序方式，可选值为"asc"或"desc"，默认为"desc"。
+  * **after** (*Optional* *[**str* *]* *,* *optional*) -- 返回助手列表中id在指定id之后的助手，默认为空字符串。
+  * **before** (*Optional* *[**str* *]* *,* *optional*) -- 返回助手列表中id在指定id之前的助手，默认为空字符串。
 * **返回:**
   助手列表响应体。
 * **返回类型:**
@@ -71,8 +71,8 @@
 指定file_id和assistant_id，挂载File到对应的Assistant
 
 * **参数:**
-  * **assistant_id** (*Optional* *[**str* *]*) – 助理ID。
-  * **file_id** (*Optional* *[**str* *]*) – 文件ID。
+  * **assistant_id** (*Optional* *[**str* *]*) -- 助理ID。
+  * **file_id** (*Optional* *[**str* *]*) -- 文件ID。
 * **返回:**
   助理文件列表响应对象。
 * **返回类型:**
@@ -83,11 +83,11 @@
 查询Assistant挂载的File列表
 
 * **参数:**
-  * **assistant_id** (*Optional* *[**str* *]*) – 助手ID，为空时获取当前登录用户的助手文件列表。
-  * **limit** (*Optional* *[**int* *]* *,* *optional*) – 每页最多显示多少个文件。默认为20。
-  * **order** (*Optional* *[**AssistantListRole* *]* *,* *optional*) – 文件列表排序方式。可选值为 ‘asc’ 或 ‘desc’。默认为 ‘desc’。
-  * **after** (*Optional* *[**str* *]* *,* *optional*) – 返回文件ID大于该值的文件列表。默认为空字符串。
-  * **before** (*Optional* *[**str* *]* *,* *optional*) – 返回文件ID小于该值的文件列表。默认为空字符串。
+  * **assistant_id** (*Optional* *[**str* *]*) -- 助手ID，为空时获取当前登录用户的助手文件列表。
+  * **limit** (*Optional* *[**int* *]* *,* *optional*) -- 每页最多显示多少个文件。默认为20。
+  * **order** (*Optional* *[**AssistantListRole* *]* *,* *optional*) -- 文件列表排序方式。可选值为 'asc' 或 'desc'。默认为 'desc'。
+  * **after** (*Optional* *[**str* *]* *,* *optional*) -- 返回文件ID大于该值的文件列表。默认为空字符串。
+  * **before** (*Optional* *[**str* *]* *,* *optional*) -- 返回文件ID小于该值的文件列表。默认为空字符串。
 * **返回:**
   包含文件列表信息的响应对象。
 * **返回类型:**
@@ -98,21 +98,21 @@
 根据assistant_id查询Assistant信息
 
 * **参数:**
-  **assistant_id** (*Optional* *[**str* *]*) – 助手ID
+  **assistant_id** (*Optional* *[**str* *]*) -- 助手ID
 * **返回:**
   助手查询响应结果
 * **返回类型:**
   assistant_type.AssistantQueryResponse
 * **抛出:**
-  **HTTPError** – 请求失败，抛出HTTPError异常
+  **HTTPError** -- 请求失败，抛出HTTPError异常
 
 #### unmount_files(assistant_id: str | None, file_id: str | None) → AssistantFilesDeleteResponse
 
 指定assistant_id和file_id，解绑Assistant中对应File的关联
 
 * **参数:**
-  * **assistant_id** (*Optional* *[**str* *]*) – 助理ID。
-  * **file_id** (*Optional* *[**str* *]*) – 文件ID。
+  * **assistant_id** (*Optional* *[**str* *]*) -- 助理ID。
+  * **file_id** (*Optional* *[**str* *]*) -- 文件ID。
 * **返回:**
   响应对象。
 * **返回类型:**
@@ -123,17 +123,17 @@
 根据assistant_id修改一个已创建的Assistant
 
 * **参数:**
-  * **assistant_id** (*str*) – 助手ID。
-  * **model** (*Optional* *[**str* *]*) – 助手模型。
-  * **name** (*Optional* *[**str* *]*) – 助手名称。
-  * **description** (*Optional* *[**str* *]*) – 助手描述。
-  * **response_format** (*Optional* *[**str* *]* *,* *optional*) – 响应格式。默认为None。
-  * **instructions** (*Optional* *[**str* *]* *,* *optional*) – 助手指令。默认为None。
-  * **thought_instructions** (*Optional* *[**str* *]* *,* *optional*) – 思考指令。默认为None。
-  * **chat_instructions** (*Optional* *[**str* *]* *,* *optional*) – 聊天指令。默认为None。
-  * **tools** (*Optional* *[**list* *[**assistant_type.AssistantTool* *]* *]* *,* *optional*) – 助手工具列表。默认为空列表。
-  * **file_ids** (*Optional* *[**list* *[**str* *]* *]* *,* *optional*) – 文件ID列表。默认为空列表。
-  * **metadata** (*Optional* *[**dict* *]* *,* *optional*) – 助手元数据。默认为空字典。
+  * **assistant_id** (*str*) -- 助手ID。
+  * **model** (*Optional* *[**str* *]*) -- 助手模型。
+  * **name** (*Optional* *[**str* *]*) -- 助手名称。
+  * **description** (*Optional* *[**str* *]*) -- 助手描述。
+  * **response_format** (*Optional* *[**str* *]* *,* *optional*) -- 响应格式。默认为None。
+  * **instructions** (*Optional* *[**str* *]* *,* *optional*) -- 助手指令。默认为None。
+  * **thought_instructions** (*Optional* *[**str* *]* *,* *optional*) -- 思考指令。默认为None。
+  * **chat_instructions** (*Optional* *[**str* *]* *,* *optional*) -- 聊天指令。默认为None。
+  * **tools** (*Optional* *[**list* *[**assistant_type.AssistantTool* *]* *]* *,* *optional*) -- 助手工具列表。默认为空列表。
+  * **file_ids** (*Optional* *[**list* *[**str* *]* *]* *,* *optional*) -- 文件ID列表。默认为空列表。
+  * **metadata** (*Optional* *[**dict* *]* *,* *optional*) -- 助手元数据。默认为空字典。
 * **返回:**
   助手更新响应。
 * **返回类型:**
@@ -150,61 +150,61 @@
 获取指定文件的内容
 
 * **参数:**
-  * **file_id** (*str*) – 文件ID
-  * **timeout** (*Optional* *[**int* *]* *,* *optional*) – 请求超时时间，单位秒. Defaults to None.
+  * **file_id** (*str*) -- 文件ID
+  * **timeout** (*Optional* *[**int* *]* *,* *optional*) -- 请求超时时间，单位秒. Defaults to None.
 * **返回:**
   包含文件内容的响应对象
 * **返回类型:**
   assistant_type.AssistantFilesContentResponse
 * **抛出:**
-  * **TypeError** – 当file_id不是字符串类型时引发此异常
-  * **FileNotFoundError** – 当指定的文件路径不存在时引发此异常
-  * **HTTPConnectionException** – 当请求失败时引发此异常
+  * **TypeError** -- 当file_id不是字符串类型时引发此异常
+  * **FileNotFoundError** -- 当指定的文件路径不存在时引发此异常
+  * **HTTPConnectionException** -- 当请求失败时引发此异常
 
 #### create(file_path: str, purpose: str = 'assistant') → AssistantFilesCreateResponse
 
 上传文件到助理存储中。
 
 * **参数:**
-  * **file_path** (*str*) – 要上传的文件路径。
-  * **purpose** (*str* *,* *optional*) – 上传文件的用途。默认为 “assistant”。
+  * **file_path** (*str*) -- 要上传的文件路径。
+  * **purpose** (*str* *,* *optional*) -- 上传文件的用途。默认为 "assistant"。
 * **返回:**
   上传文件后返回的响应对象。
 * **返回类型:**
   assistant_type.AssistantFilesCreateResponse
 * **抛出:**
-  **ValueError** – 如果指定的文件路径不存在，则会引发此异常。
+  **ValueError** -- 如果指定的文件路径不存在，则会引发此异常。
 
 #### delete(file_id: str) → AssistantFilesDeleteResponse
 
 删除文件
 
 * **参数:**
-  **file_id** (*str*) – 文件ID
+  **file_id** (*str*) -- 文件ID
 * **返回:**
   删除文件后的响应对象。
 * **返回类型:**
   assistant_type.AssistantFilesDeleteResponse
 * **抛出:**
-  **无** – 
+  **无** -- 
 
 #### download(file_id: str, file_path: str = '', timeout: int | None = None)
 
 下载文件
 
 * **参数:**
-  * **file_id** (*str*) – 文件ID
-  * **file_path** (*str* *,* *optional*) – 文件保存路径，默认为空字符串。如果未指定，则使用文件名的默认值。要求若文件路径不为空，需要以/结尾。
-  * **timeout** (*Optional* *[**int* *]* *,* *optional*) – 请求超时时间，单位秒。如果未指定，则使用默认超时时间。
+  * **file_id** (*str*) -- 文件ID
+  * **file_path** (*str* *,* *optional*) -- 文件保存路径，默认为空字符串。如果未指定，则使用文件名的默认值。要求若文件路径不为空，需要以/结尾。
+  * **timeout** (*Optional* *[**int* *]* *,* *optional*) -- 请求超时时间，单位秒。如果未指定，则使用默认超时时间。
 * **返回:**
   None
 * **抛出:**
-  * **TypeError** – 当file_path或file_id类型不为str时引发此异常。
-  * **ValueError** – 当file_id为空或None时，或file_path不是文件目录时引发此异常。
-  * **FileNotFoundError** – 当指定的文件路径或文件不存在时引发此异常。
-  * **OSError** – 当磁盘空间不足时引发此异常。
-  * **HTTPConnectionException** – 当请求失败时引发此异常。
-  * **Exception** – 当发生其他异常时引发此异常。
+  * **TypeError** -- 当file_path或file_id类型不为str时引发此异常。
+  * **ValueError** -- 当file_id为空或None时，或file_path不是文件目录时引发此异常。
+  * **FileNotFoundError** -- 当指定的文件路径或文件不存在时引发此异常。
+  * **OSError** -- 当磁盘空间不足时引发此异常。
+  * **HTTPConnectionException** -- 当请求失败时引发此异常。
+  * **Exception** -- 当发生其他异常时引发此异常。
 
 #### list() → AssistantFilesListResponse
 
@@ -217,7 +217,7 @@
   **无**
 * **返回:**
   文件列表的响应对象，包含以下属性：
-  - object (str): 表示对象类型，默认值为 “list”
+  - object (str): 表示对象类型，默认值为 "list"
   - data (list[AssistantFilesListData]): 包含文件信息的列表，列表中的每个元素为 AssistantFilesListData 对象。该对象包含以下属性：
     > - id (str): 文件ID
     > - bytes (int): 文件大小（字节）
@@ -231,18 +231,18 @@
 * **返回类型:**
   assistant_type.AssistantFilesListResponse
 * **抛出:**
-  **assistant_type.AssistantError** – 请求发生错误时抛出，具体错误信息可通过 error_msg 属性获取。
+  **assistant_type.AssistantError** -- 请求发生错误时抛出，具体错误信息可通过 error_msg 属性获取。
 
 #### query(file_id: str) → AssistantFilesQueryResponse
 
 根据文件ID查询文件信息
 
 * **参数:**
-  **file_id** (*str*) – 文件ID
+  **file_id** (*str*) -- 文件ID
 * **返回:**
   文件查询响应对象
 * **返回类型:**
   assistant_type.AssistantFilesQueryResponse
 * **抛出:**
-  * **TypeError** – 如果file_id不是str类型
-  * **ValueError** – 如果file_id不存在
+  * **TypeError** -- 如果file_id不是str类型
+  * **ValueError** -- 如果file_id不存在

docs/sphinx_md/appbuilder.core.assistant.threads.md → docs/API-Reference/Python/appbuilder.core.assistant.threads.md

@@ -74,11 +74,11 @@
 创建一个新的对话线程。
 
 * **参数:**
-  **messages** – 要发送给助手的消息列表。如果不传入此参数，则会创建一个空对话线程。
+  **messages** -- 要发送给助手的消息列表。如果不传入此参数，则会创建一个空对话线程。
 * **返回:**
   一个ThreadCreateResponse对象，包含新创建的线程的相关信息。
 * **抛出:**
-  **ValueError** – 如果传入的messages参数不是列表类型。
+  **ValueError** -- 如果传入的messages参数不是列表类型。
 
 #### delete(thread_id: str) → ThreadDeleteResponse
 
@@ -88,7 +88,7 @@
 * **返回:**
   一个ThreadDeleteResponse对象，包含对话线程的相关信息。
 * **抛出:**
-  **ValueError** – 如果传入的thread_id参数不是字符串类型。
+  **ValueError** -- 如果传入的thread_id参数不是字符串类型。
 
 #### *property* messages *: [Messages](appbuilder.core.assistant.threads.messages.md#appbuilder.core.assistant.threads.messages.messages.Messages)*
 
@@ -106,11 +106,11 @@
 查询对话线程信息。
 
 * **参数:**
-  **thread_id** – 要查询的对话线程ID。
+  **thread_id** -- 要查询的对话线程ID。
 * **返回:**
   一个ThreadQueryResponse对象，包含对话线程的相关信息。
 * **抛出:**
-  **ValueError** – 如果传入的thread_id参数不是字符串类型。
+  **ValueError** -- 如果传入的thread_id参数不是字符串类型。
 
 #### *property* runs *: [Runs](appbuilder.core.assistant.threads.runs.md#appbuilder.core.assistant.threads.runs.runs.Runs)*
 
@@ -128,12 +128,12 @@
 更新线程信息
 
 * **参数:**
-  * **thread_id** (*str*) – 线程ID
-  * **metadata** (*Optional* *[**dict* *]* *,* *optional*) – 线程元数据. 默认为空字典.
+  * **thread_id** (*str*) -- 线程ID
+  * **metadata** (*Optional* *[**dict* *]* *,* *optional*) -- 线程元数据. 默认为空字典.
 * **返回:**
   线程更新响应
 * **返回类型:**
   thread_type.ThreadUpdateResponse
 * **抛出:**
-  * **TypeError** – 如果metadata不是字典类型
-  * **ValueError** – 如果metadata的键超过64个字符或值超过512个字符
+  * **TypeError** -- 如果metadata不是字典类型
+  * **ValueError** -- 如果metadata的键超过64个字符或值超过512个字符