Sypht Python Client 开源项目常见问题解决方案

Sypht Python Client 开源项目常见问题解决方案

sypht-python-client A python client for the Sypht API 项目地址: https://gitcode.com/gh_mirrors/sy/sypht-python-client

1. 项目基础介绍与主要编程语言

Sypht Python Client 是一个开源项目，旨在提供一个 Python 客户端实现，用于与 Sypht API 进行交互。Sypht API 是一种 SaaS 服务，可以从文档和图像中提取关键字段。例如，你可以上传账单或发票的图片或 PDF 文件，并提取应付款项、到期日期、发票号码和账单信息等。该项目使用的主要编程语言是 Python。

2. 新手使用项目时需注意的三个问题及解决步骤

问题一：如何安装 Sypht Python Client？

问题描述： 新手在使用该项目时，可能不知道如何正确安装 Sypht Python Client。

解决步骤：

1. 确保已安装 Python 环境。
2. 打开终端或命令行窗口。
3. 输入以下命令安装最新版本的 Sypht Python Client：

   pip install sypht
   

问题二：如何使用 Sypht Python Client 上传文档并提取信息？

问题描述： 初学者可能不清楚如何使用 Sypht Python Client 上传文档和提取信息。

解决步骤：

1. 首先需要从 Sypht 获取 API 凭据，即 client_id 和 client_secret。
2. 使用以下代码创建 SyphtClient 实例：

   from sypht.client import SyphtClient
   
   sc = SyphtClient('<client_id>', '<client_secret>')
   

3. 使用以下代码上传文档并提取信息：

   with open('invoice.png', 'rb') as f:
       fid = sc.upload(f, products=["forms-&-reports"])
   print(sc.fetch_results(fid))
   

问题三：如何通过命令行使用 Sypht Python Client？

问题描述： 用户可能不知道如何通过命令行使用 Sypht Python Client。

解决步骤：

1. 设置环境变量 SYPHT_API_KEY，值为 <client_id>:<client_secret>。
2. 在终端或命令行窗口中，使用以下命令进行提取：

   sypht extract --product invoices path/to/your/document.pdf
   

通过以上步骤，新手用户可以更好地开始使用 Sypht Python Client 项目，并解决常见的问题。

sypht-python-client A python client for the Sypht API 项目地址: https://gitcode.com/gh_mirrors/sy/sypht-python-client