Skip to main content

科大讯飞星火大模型SDK

Project description

科大讯飞星火模型 Python SDK

介绍

关于科大讯飞星火大模型,官网仅给出了Web API文档,没有提供Python版SDK,使用起来不方便,尤其是在Stream交互的场景中。本项目封装了星火大模型的Web API,提供了类似OpenAI格式的SDK。

快速体验

  1. 下载本项目代码,并安装依赖
pip install -r  requirements.txt
  1. 复制文件.env.dist 为.env,并将.env文件中的{your_app_id}, {your_api_secret}, {your_api_key}替换为自己的应用信息
cp .env.dist .env
  1. 运行demo
python demo.py

demo

备注: 使用前请确保已经在科大讯飞官网注册账号,并且已经创建了应用,获取到了app_id, api_secret, api_key

项目中使用

1.安装

pip install xunfei-spark-python==0.0.7

2.使用说明

问答接口

from xunfei.spark.client import Spark
from xunfei.spark.response import ChatResponse

if __name__ == '__main__':
    config = {
        "app_id": "{your_app_id}",
        "api_secret": "{your_api_secret}",
        "api_key": "{your_api_key}",
        "gpt_url": "wss://spark-api.xf-yun.com/v3.5/chat",
        "domain": "generalv3.5",
    }
    spark = Spark(**config)
    messages = [{"role": "user", "content": "你是谁开发的?"}]

    response: ChatResponse = spark.chat(messages=messages, temperature=0.5, max_tokens=1024)
    print('AI:', response.content)
    print('Token使用量:', response.usage)

Stream模式问答接口

from xunfei.spark.client import Spark

if __name__ == '__main__':
    config = {
        "app_id": "{your_app_id}",
        "api_secret": "{your_api_secret}",
        "api_key": "{your_api_key}",
        "gpt_url": "wss://spark-api.xf-yun.com/v3.5/chat",
        "domain": "generalv3.5",
    }
    spark = Spark(**config)
    messages = [{"role": "user", "content": "你是谁开发的?"}]

    for message in spark.chat_stream(messages=messages, temperature=0.5, max_tokens=1024):
        if message:
            if 'type' in message and message['type'] == 'chunk':
                print(f"客户端接受到的消息: {message}")
            elif 'type' in message and message['type'] == 'stop':
                print(f"结束")
                break

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xunfei-spark-python-0.0.7.tar.gz (6.0 kB view hashes)

Uploaded Source

Built Distribution

xunfei_spark_python-0.0.7-py3-none-any.whl (5.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page