如何获取讯飞星火 API Key 密钥(分步指南)

如何获取讯飞星火 API Key 密钥(分步指南)

现如今已经是人工智能时代,人工智能技术正以前所未有的速度发展,其中语音识别和处理技术尤为突出。科大讯飞作为全球领先的智能语音和人工智能企业,其旗下的讯飞星火API为开发者提供了强大的语音识别、语音合成、自然语言处理等能力。撰写本篇文章是希望能够帮助那些想要利用讯飞星火API开发智能应用的开发者提供一个详细的入门教程。我们将一步步指导您如何获取API密钥,并进行可用性测试以及常见问题解答。

获取讯飞星火API步骤如下:

1.访问 https://xinghuo.xfyun.cn/sparkapi 官网

2.成为开发者,点击页面右上角“注册/登录”按钮,注册并完善信息,即可成为开发者。

如何获取讯飞星火 API Key 密钥(分步指南) 3.访问控制台,登录后点在线调试进入控制台。

如何获取讯飞星火 API Key 密钥(分步指南) 4.点击创建新应用创建应用。

科大讯飞 星火 教程如何获取讯飞星火 API Key 密钥(分步指南) 5.进入服务详情页

可以访问接口文档,对应用进行自定义设置。

如何获取讯飞星火 API Key 密钥(分步指南) 如何获取讯飞星火 API Key 密钥(分步指南)

在获取API密钥后,进行可用性测试是确保其正常工作的重要步骤。

快速调用集成星火认知大模型(Python示例)

注:项目仅支持 Python3.8+
步骤一:安装PyPI上的包,在python环境中执行命令


步骤二:python代码示例执行


在使用讯飞星火API搭建应用时,除了获取和测试API密钥外,还需考虑以下因素:

注意: 该接口可以正式使用。如您需要申请使用,请点击前往产品页面。

Tips:

1 计费包含接口的输入和输出内容 2 1 token约等于1.5个中文汉字 或者 0.8个英文单词 3 Spark Lite支持[搜索]内置插件;Spark Pro, Spark Max和Spark 4.0Ultra支持[搜索]、[天气]、[日期]、[诗词]、[字词]、[股票]六个内置插件 4 Spark 4.0Ultra/Max现已支持system、Function Call功能 5 Spark 4.0Ultra版本现已支持返回联网检索的信源标题及地址

Tips: 星火大模型API当前有Lite、Pro、Pro-128K、Max、Max-32K和4.0 Ultra六个版本,各版本独立计量tokens。

传输协议 :ws(s),为提高安全性,强烈推荐wss

请求版本 请求地址 Spark4.0 Ultra wss://spark-api.xf-yun.com/v4.0/chat Spark Max-32K wss://spark-api.xf-yun.com/chat/max-32k Spark Max wss://spark-api.xf-yun.com/v3.5/chat Spark Pro-128K wss://spark-api.xf-yun.com/chat/pro-128k Spark Pro wss://spark-api.xf-yun.com/v3.1/chat Spark Lite wss://spark-api.xf-yun.com/v1.1/chat

URL鉴权是保护Web应用中敏感资源的重要安全措施,它通过在URL中嵌入特定参数来控制对资源的访问权限。这些参数通常包括时间戳、随机数、用户ID等,并结合密钥使用哈希算法生成签名,以验证请求的合法性。

讯飞星火URL鉴权参考 通用URL鉴权文档

1.3.1 请求参数


接口请求字段由三个部分组成:header,parameter, payload。 字段解释如下

header部分

参数名称 类型 必传 参数要求 app_id string 是 应用appid,从开放平台控制台创建的应用中获取 uid string 否 每个用户的id,非必传字段,用于后续扩展 ,”maxLength”:32

parameter.chat部分

参数名称 类型 必传 参数要求 参数说明 domain string 是 取值为[lite,generalv3,pro-128k,generalv3.5,max-32k,4.0Ultra] 指定访问的模型版本:

lite指向Lite版本;
generalv3指向Pro版本;
pro-128k指向Pro-128K版本;
generalv3.5指向Max版本;
max-32k指向Max-32K版本;
4.0Ultra指向4.0 Ultra版本;
注意:不同的取值对应的url也不一样! |

| temperature | float | 否 | 取值范围 (0,1] ,默认值0.5 | 核采样阈值。用于决定结果随机性,取值越高随机性越强即相同的问题得到的不同答案的可能性越高 |
| max_tokens | int | 否 | Pro、Max、Max-32K、4.0 Ultra 取值为[1,8192],默认为4096;
Lite、Pro-128K 取值为[1,4096],默认为4096。 | 模型回答的tokens的最大长度 |
| top_k | int | 否 | 取值为[1,6],默认为4 | 从k个候选中随机选择⼀个(⾮等概率) |
| show_ref_label | boolean | 否 | 取值范围[true,false] ,默认 false | 该参数仅4.0 Ultra版本支持,当设置为true时,如果输入内容触发联网检索插件,会先返回检索信源列表,然后再返回星火回复结果,否则仅返回星火回复结果 |

payload.message.text部分
注意:1、请确保text下所有content内容累计的tokens数量在模型上下文长度的限制之内。具体可参考下文中content字段的参数要求
2、如果传入system参数,需要保证第一条是system;多轮交互需要将之前的交互历史按照system-user-assistant-user-assistant进行拼接

参数名称 类型 必传 参数要求 参数说明 role string 是 取值为[system,user,assistant] system用于设置对话背景(仅Max、Ultra版本支持)

| content | string | 是 | 所有content的累计tokens长度,不同版本限制不同:

Pro-128K版本:不超过 128*1024; | 用户和AI的对话内容 |

在不返回检索信源的情况下,大模型流式返回结构如下:


在不返回检索信源的情况下,接口返回字段分为两个部分,header,payload。字段解释如下

header部分

字段名 类型 字段说明 code int 错误码,0表示正常,非0表示出错;详细释义可在接口说明文档最后的错误码说明了解 message string 会话是否成功的描述信息 sid string 会话的唯一id,用于讯飞技术人员查询服务端会话日志使用,出现调用错误时建议留存该字段 status int 会话状态,取值为[0,1,2];0代表首次结果;1代表中间结果;2代表最后一个结果

payload.choices部分

字段名 类型 字段说明 status int 文本响应状态,取值为[0,1,2]; 0代表首个文本结果;1代表中间文本结果;2代表最后一个文本结果 seq int 返回的数据序号,取值为[0,] content string AI的回答内容 role string 角色标识,固定为assistant,标识角色为AI index int 结果序号,取值为[0,10]; 当前为保留字段,开发者可忽略

payload.usage部分(在最后一次结果返回)

字段名 类型 字段说明 question_tokens int 保留字段,可忽略 prompt_tokens int 包含历史问题的总tokens大小 completion_tokens int 回答的tokens大小 total_tokens int prompt_tokens和completion_tokens的和,也是本次交互计费的tokens大小

在返回检索信源的情况下,在大模型返回结果之前会先返回检索信源,结构如下:


解析检索信源Python示例:


Function call 作为大模型能力扩展的核心,支持大模型在交互过程中识别出需要调度的外部接口:
注:当前仅Spark Max/4.0 Ultra 支持了该功能;需要请求参数payload.functions中申明大模型需要辨别的外部接口,申明方式见下方请求示例

1.1.1 请求示例



版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请联系我们举报,一经查实,本站将立刻删除。

发布者:Ai探索者,转载请注明出处:https://javaforall.net/281649.html原文链接:https://javaforall.net

(0)
上一篇 2026年3月14日 下午7:15
下一篇 2026年3月14日 下午7:15


相关推荐

关注全栈程序员社区公众号