sparkdesk-api - 讯飞星火大模型API的安装与使用说明

项目介绍：sparkdesk-api

sparkdesk-api 是一个支持讯飞星火大模型的 API 项目，该项目能够让用户通过不同的模式调用讯飞星火的服务，便于进行语言处理与对话交互。本文将为大家详细介绍如何使用 sparkdesk-api 项目。

安装指南

用户可以通过 pip 命令安装 sparkdesk-api。支持两种安装方式：

pip install sparkdesk-api==1.5.0

或者

pip install sparkdesk-api==1.5.0 -i https://pypi.org/simple

使用模式

sparkdesk-api 提供两种主要使用模式：Web模式和API模式。

1. Web模式

Web模式下，用户需要首先获取3个参数：cookie、fd 和 GtToken。这些参数可以通过访问讯飞星火大模型的 Web 端并使用浏览器开发者工具（F12）进行抓取。

命令行操作

要在 Web模式下以命令行形式操作，可以使用以下命令：

python sparkdesk_web_cli.py

API调用

用户可以调用以下函数来启动聊天：

chat(): 进行单次询问。
chat_stream(): 进行连续询问，类似于命令行模式的效果。

以下是示例代码：

from sparkdesk_web.core import SparkWeb

sparkWeb = SparkWeb(
     cookie=cookie,
     fd=fd,
     GtToken=GtToken
 )

 # 单次聊天
 print(sparkWeb.chat("repeat: hello world"))
 # 连续聊天
 sparkWeb.chat_stream()

2. API模式

API模式支持多个版本，包括 v3.5、v3.0、v2.0 和 v1.0，默认使用的接口版本是 v3.5。用户如需使用其他版本，需要指定 Version 参数。

要使用 API模式，用户需要先申请 3 个关键信息：app_id、api_key 和 api_secret。具体申请步骤是访问讯飞星火官方网站，进入“星火认知大模型”栏目中进行相关申请流程，建议使用公司邮箱以提高申请速度。

以下为 API模式的调用示例：

from sparkdesk_api.core import SparkAPI

# 创建 SparkAPI 实例，默认接口版本为3.5
sparkAPI = SparkAPI(
    app_id=app_id,
    api_secret=api_secret,
    api_key=api_key,
    # 如果需要其他版本，可指定 version 参数
    # version=2.1,
    # assistant_id="xyzspsb4i5s7_v1"
)
sparkAPI.chat_stream()

API调用的具体方法与 Web模式类似，只需在相应的实例下调用相应方法即可。

赞助项目

如果您觉得该项目对您的工作或学习有帮助，可以通过赞助的方式支持作者。作者提供了一种轻松方式，欢迎扫二维码购买一杯蜜雪冰城来表示对项目的支持。

贡献者鸣谢

sparkdesk-api 项目的开发感谢所有贡献者的支持与努力。参与人员的详细信息可以在项目的贡献者页面查看。您的每一个贡献都使项目更加完善与强大。

通过对项目的详细介绍，希望您能更好地理解和使用 sparkdesk-api。在实际应用中探索更多可能性，享受更便捷的技术体验！