初始化实例

获得 API 密匙

请登录Doc2X 开放平台获取 API 密匙。

相关信息

如您想要完全自己掌控处理PDF文件的过程(例如集成在您的GUI软件中)，您可以参见异步实现

描述

Doc2X 类的初始化方法用于创建一个 Doc2X 客户端实例。该实例用于处理 PDF 文件的转换操作。

参数

参数名	类型	默认值	描述
apikey	str	None	Doc2X 的 API 密钥。如果未提供，将尝试从环境变量 DOC2X_APIKEY 中获取。
thread	int	5	最大并发线程数。除非您确信您需要修改，请使用默认值。
max_pages	int	1000	处理的最大页数。除非您确信您需要修改，请使用默认值。
retry_time	int	5	最高重试次数。除非您确信您需要修改，请使用默认值。
max_time	int	90	等待响应的最大时间（以秒为单位）。如您网速过慢可适当调高此值。
debug	bool	False	是否启用调试日志记录。
full_speed	bool	False	beta功能，其会自动嗅探并发上限，试探当前可用的最高并发上限，由于该功能可能会导致频繁触发访问上限导致请求停滞缓慢, 请谨慎使用。

Beta功能说明

full_speed：当设置为True时，该功能会自动检测并维持在当前可用的最高并发上限。它会根据服务器的响应动态调整并发数量，但不会低于thread参数指定的值。启用full_speed后，由于其通过触发服务器速率限制警告来进行嗅探，因此会忽略retry_time和max_time的设置，强制将其分别设为10和180。

异常

异常类型	描述
ValueError	如果未找到 API 密钥，将引发此异常。

使用环境变量导入密匙(推荐)

运行以下代码以导入您的 API 密匙，此时程序将会从环境变量中寻找DOC2X_APIKEY：

from pdfdeal import Doc2X
client = Doc2X()

MacOS/Linux

请使用以下命令为当前终端设置环境变量：

export DOC2X_APIKEY = "Your API Key"

您也可以将以上命令添加到~/.zshrc或~/.bashrc以持久化环境变量。

Windows

请使用以下命令为当前终端设置环境变量：

set "DOC2X_APIKEY" "Your API Key"

您可以使用命令setx "DOC2X_APIKEY" "Your API Key"中以持久化保存变量(而不是当前终端会话)。

为项目单独设置 API 密匙

若您希望 API 密钥仅对单个项目可见，可创建一个包含您的 API 密钥的本地.env文件。以下是一个.env文件的示范：

DOC2X_APIKEY = "Your API Key"

导入的代码与使用环境变量的方法相同。

注意：这可能需要您使用集成开发环境，例如 VSCode

指定 API 密匙(不推荐)

如果您想指定您的 API 密匙，您可以通过以下代码导入：

from pdfdeal import Doc2X

client = Doc2X(apikey="Your API key")

代码示范

修改同时请求限制

警告

除非您确信您需要修改请求频率，请不要修改同时请求限制，请使用默认的设置。

from pdfdeal import Doc2X

client = Doc2X(max_pages=100, thread=2)

修改日志显示等级

默认情况下，程序将仅会显示出错信息，中间过程(例如处理进度)等信息将仅会以logging.INFO等级输出。您可以在初始化时传入参数debug=true以显示所有日志。

from pdfdeal import Doc2X

client = Doc2X(debug=True)

启用full_speed模式

注意

此功能仍处于beta状态，请谨慎使用。

from pdfdeal import Doc2X

client = Doc2X(debug=True, thread=5, full_speed=True)