Metadata-Version: 2.1
Name: sparkdesk
Version: 0.1.4
Summary: 
Author: vicalloy
Author-email: zbirder@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Provides-Extra: cli
Requires-Dist: click (>=8.1.7,<9.0.0) ; extra == "cli"
Requires-Dist: websockets (>=11.0.3,<12.0.0)
Description-Content-Type: text/markdown

# sparkdesk 讯飞星火大模型API

讯飞星火大模型API。支持 `sync` 和 `async` 。

## 安装

```shell
pip install 'sparkdesk[cli]'
```

## 讯飞星火 API 申请

讯飞星火的API需要前往官网进行[申请](https://xinghuo.xfyun.cn/sparkapi?scr=price)。
新用户可获取一定量都免费额度。

## CLI 使用方法

```shell
> python -m sparkdesk.cli --help
Usage: python -m sparkdesk.cli [OPTIONS]

Options:
  --app-id TEXT      [required]
  --api-secret TEXT  [required]
  --api-key TEXT     [required]
  --api-version TEXT
  --help             Show this message and exit.
```

## API使用方法

参考： `sparkdesk/cli.py` 和 `sparkdesk/async/cli.py`
接口返回数据结构参考官方文档 https://www.xfyun.cn/doc/spark/Web.html

## TODO

1. 添加返回JSON数据对应的 dataclass

