Python调用讯飞星火大模型v3.x api接口使用教程

1、获取api接口的ID和key

        这里我们可以获取星火免费赠送的200万个token使用和测试，获取方法如下:

        打卡网站讯飞星火认知大模型-AI大语言模型-星火大模型-科大讯飞 ，登录用户点击免费使用

        

 1.1 创建应用

       点击购买首次应该会让创建一个应用， 如下图，按要求内容随意填写，然后提交

1.2  购买token

        创建完成应用，回去购买，我这里选择个人的(这些都是在完成认证及设置了支付密码的基础)

1.3 获取 ID和key

        在工单中心这个大模型3.0,页面就是，appid这三个我们会用到

2、 Python调用api

        我的Python版本是在3.8左右的

        创建一个名为SparkApi.py的Python文件，将下面代码粘进去

        下面官方的代码有个坑，就是answer = ""是个全局变量，这个会将所有的提问拼接在一起，不过这个影响不大，就是打印answer的结果不好看，只要我们输入时text列表清除历史输入，token还是不带历史

1. import _thread as thread
2. import base64
3. import datetime
4. import hashlib
5. import hmac
6. import json
7. from urllib.parse import urlparse
8. import ssl
9. from datetime import datetime
10. from time import mktime
11. from urllib.parse import urlencode
12. from wsgiref.handlers import format_date_time
14. import websocket # 使用websocket_client
15. answer = ""
17. class Ws_Param(object):
18. # 初始化
19. def __init__(self, APPID, APIKey, APISecret, Spark_url):
20. self.APPID = APPID
21. self.APIKey = APIKey
22. self.APISecret = APISecret
23. self.host = urlparse(Spark_url).netloc
24. self.path = urlparse(Spark_url).path
25. self.Spark_url = Spark_url
27. # 生成url
28. def create_url(self):
29. # 生成RFC1123格式的时间戳
30. now = datetime.now()
31. date = format_date_time(mktime(now.timetuple()))
33. # 拼接字符串
34. signature_origin = "host: " + self.host + "\n"
35. signature_origin += "date: " + date + "\n"
36. signature_origin += "GET " + self.path + " HTTP/1.1"
38. # 进行hmac-sha256进行加密
39. signature_sha = hmac.new(self.APISecret.encode('utf-8'), signature_origin.encode('utf-8'),
40. digestmod=hashlib.sha256).digest()
42. signature_sha_base64 = base64.b64encode(signature_sha).decode(encoding='utf-8')
44. authorization_origin = f'api_key="{self.APIKey}", algorithm="hmac-sha256", headers="host date request-line", signature="{signature_sha_base64}"'
46. authorization = base64.b64encode(authorization_origin.encode('utf-8')).decode(encoding='utf-8')
48. # 将请求的鉴权参数组合为字典
49. v = {
50. "authorization": authorization,
51. "date": date,
52. "host": self.host
53. }
54. # 拼接鉴权参数，生成url
55. url = self.Spark_url + '?' + urlencode(v)
56. # 此处打印出建立连接时候的url,参考本demo的时候可取消上方打印的注释，比对相同参数时生成的url与自己代码生成的url是否一致
57. return url
60. # 收到websocket错误的处理
61. def on_error(ws, error):
62. print("### error:", error)
65. # 收到websocket关闭的处理
66. def on_close(ws,one,two):
67. print(" ")
70. # 收到websocket连接建立的处理
71. def on_open(ws):
72. thread.start_new_thread(run, (ws,))
75. def run(ws, *args):
76. data = json.dumps(gen_params(appid=ws.appid, domain= ws.domain,question=ws.question))
77. ws.send(data)
80. # 收到websocket消息的处理
81. def on_message(ws, message):
82. # print(message)
83. data = json.loads(message)
84. code = data['header']['code']
85. if code != 0:
86. print(f'请求错误: {code}, {data}')
87. ws.close()
88. else:
89. choices = data["payload"]["choices"]
90. status = choices["status"]
91. content = choices["text"][0]["content"]
92. print(content,end ="")
93. global answer
94. answer += content
95. # print(1)
96. if status == 2:
97. ws.close()
100. def gen_params(appid, domain,question):
101. """
102. 通过appid和用户的提问来生成请参数
103. """
104. data = {
105. "header": {
106. "app_id": appid,
107. "uid": "1234"
108. },
109. "parameter": {
110. "chat": {
111. "domain": domain,
112. "temperature": 0.5,
113. "max_tokens": 2048
114. }
115. },
116. "payload": {
117. "message": {
118. "text": question
119. }
120. }
121. }
122. return data
125. def main(appid, api_key, api_secret, Spark_url,domain, question):
126. wsParam = Ws_Param(appid, api_key, api_secret, Spark_url)
127. websocket.enableTrace(False)
128. wsUrl = wsParam.create_url()
129. ws = websocket.WebSocketApp(wsUrl, on_message=on_message, on_error=on_error, on_close=on_close, on_open=on_open)
130. ws.appid = appid
131. ws.question = question
132. ws.domain = domain
133. ws.run_forever(sslopt={"cert_reqs": ssl.CERT_NONE})

 在随便建一个py文件，将下面代码粘进去，这个是调用客户端，上面文件是服务端

1. import SparkApi
2. #以下密钥信息从控制台获取
3. appid = "XXXXXXXX" #填写控制台中获取的 APPID 信息
4. api_secret = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" #填写控制台中获取的 APISecret 信息
5. api_key ="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" #填写控制台中获取的 APIKey 信息
7. domain = "generalv3" # v3版本
8. #云端环境的服务地址
9. Spark_url = "ws://spark-api.xf-yun.com/v3.1/chat" # v3环境的地址（"wss://spark-api.xf-yun.com/v3.1/chat）
12. text =[]
14. # length = 0
16. def getText(role,content):
17. jsoncon = {}
18. jsoncon["role"] = role
19. jsoncon["content"] = content
20. text.append(jsoncon)
21. return text
23. def getlength(text):
24. length = 0
25. for content in text:
26. temp = content["content"]
27. leng = len(temp)
28. length += leng
29. return length
31. def checklen(text):
32. while (getlength(text) > 8000):
33. del text[0]
34. return text
38. if __name__ == '__main__':
39. text.clear
40. while(1):
41. Input = input("\n" +"我:")
42. question = checklen(getText("user",Input))
43. SparkApi.answer =""
44. print("星火:",end = "")
45. SparkApi.main(appid,api_key,api_secret,Spark_url,domain,question)
46. getText("assistant",SparkApi.answer)
47. # print(str(text))

        这里就需要把刚才控制台的信息替换掉那些xxxx

        ps：这里就是一个python的简易问答，如果想掉用接口，在这个调用文件里加一个调用函数

1. def spark_api(question):
2. """
3. :param question:
4. :return:
5. """
7. question = checklen(getText("user",question))
8. SparkApi.answer =""
9. SparkApi.main(appid,api_key,api_secret,Spark_url,domain,question)
10. text.clear()
11. return SparkApi.answer

        建议在使用接口函数调用是加上text.clear(),清除历史对话，否则在一个长的连接调用时历史的token会加越来越长，十分消耗token，不需要历史的建议clear

3 、应用分享

        最近作者在做项目是使用到了api辅助数据处理，其中发现在在提示词中加入一个历史对话可能会让结果更标准。下面是测试样例：

        

1. def getText(role,content):
3. jsoncon = {}
4. history_put = """['工程','货物',]\n请从上面选项中选择一个属于下面文本的分类\n左侧边坡宣传标语
5. ,结果只输出1,2 ,如果都不属于输出0
6. """
7. text.append({'role':'user','content':history_put })
8. text.append({'role': 'assistant', 'content': '0'})
9. jsoncon["role"] = role
10. jsoncon["content"] = content
11. text.append(jsoncon)
12. return text

         上面代码是作者在函数中加入一串历史对话，这种思路就是每次调用都是一次历史和本次调用，这样在输出的结果上大部分都是一致的。在我测试7000条数据中仅有10条是有解释性话术。

4、bug问题

bug：如下图：

这个是缺少包安装这个即可：websocket-client==1.4.2

如下图：

这个我认为是spark_url="ws(s)://spark-api.xf-yun.com/v3.1/chat"  # 错误案例

正确的spark_url="wss://spark-api.xf-yun.com/v3.1/chat" 或者ws://spark-api.xf-yun.com/v3.1/chat

5、v3.5最新版接口新增功能补充

（1） 接口参数：对应的domain参数为generalv3.5  ，ws地址3.1改成3.5

（2）system：设置对话背景或者模型角色

        如果想获取结合上下文的回答，需要开发者每次将历史问答信息一起传给服务端，如下示例
        注意：text里面的所有content内容加一起的tokens需要控制在8192以内，开发者如有较长对话需求，需要适当裁剪历史信息。

使用方法--> 旧版本传入请求数据时列表中只有usr和assistant这两个字典数据，现在要是使用system，只需要在usr前加入提示语字典如下图。

        也就是在上文应用分享中 getText函数，text.append(                   {"role":"system","content":"你现在扮演李白，你豪情万丈，狂放不羁；接下来请用李白的口吻和用户对话。"} )后面每次调用接口都是自带system

1. # 参数构造示例如下
2. {
3. "header": {
4. "app_id": "12345",
5. "uid": "12345"
6. },
7. "parameter": {
8. "chat": {
9. "domain": "generalv3.5",
10. "temperature": 0.5,
11. "max_tokens": 1024,
12. }
13. },
14. "payload": {
15. "message": {
16. # 如果想获取结合上下文的回答，需要开发者每次将历史问答信息一起传给服务端，如下示例
17. # 注意：text里面的所有content内容加一起的tokens需要控制在8192以内，开发者如有较长对话需求，需要适当裁剪历史信息
18. "text": [
19. {"role":"system","content":"你现在扮演李白，你豪情万丈，狂放不羁；接下来请用李白的口吻和用户对话。"} #设置对话背景或者模型角色
20. {"role": "user", "content": "你是谁"} # 用户的历史问题
21. {"role": "assistant", "content": "....."} # AI的历史回答结果
22. # ....... 省略的历史对话
23. {"role": "user", "content": "你会做什么"} # 最新的一条问题，如无需上下文，可只传最新一条问题
24. ]
25. }
26. }
27. }

（3）了functions.text字段：用于方法的注册

1. # 参数构造示例如下,仅在原本生成的基础上，增加了functions.text字段，用于方法的注册
2. {
3. "header": {
4. "app_id": appid,
5. "uid": "1234"
6. },
7. "parameter": {
9. "chat": {
10. "domain": domain,
11. "random_threshold": 0.5,
12. "max_tokens": 2048,
13. "auditing": "default"
14. }
15. },
16. "payload": {
17. "message": {
18. "text": [
19. {"role": "user", "content": ""} # 用户的提问
20. ]
21. },
22. "functions": {
23. "text": [
24. {
25. "name": "天气查询",
26. "description": "天气插件可以提供天气相关信息。你可以提供指定的地点信息、指定的时间点或者时间段信息，来检索诗词库，精准检索到天气信息。",
27. "parameters": {
28. "type": "object",
29. "properties": {
30. "location": {
31. "type": "string",
32. "description": "地点，比如北京。"
33. },
34. "date": {
35. "type": "string",
36. "description": "日期。"
37. }
38. },
39. "required": [
40. "location"
41. ]
42. }
43. },
44. {
45. "name": "税率查询",
46. "description": "税率查询可以查询某个地方的个人所得税率情况。你可以提供指定的地点信息、指定的时间点，精准检索到所得税率。",
47. "parameters": {
48. "type": "object",
49. "properties": {
50. "location": {
51. "type": "string",
52. "description": "地点，比如北京。"
53. },
54. "date": {
55. "type": "string",
56. "description": "日期。"
57. }
58. },
59. "required": [
60. "location"
61. ]
62. }
63. }
64. ]
65. }
66. }
67. }

     6、参数说明

项目地址：

https://github.com/liukangjia666/spark_demo

小彩蛋：关注wx公众号-->  AI疯人院 

                ps：我把讯飞3.5封装到了公众号聊天中,欢迎测试