相关推荐
百度智能云千帆AppBuilder-应用API调用说明
2024-11-10 22:51

百度智能云千帆AppBuilder

本文介绍了百度智能云千帆AI原生应用工作台提供的API调用应用能力以及如何调用API的流程等。

百度智能云千帆AppBuilder-应用API调用说明

首先请登录工作台,创建个人应用并完成配置,其次点击发布应用并新增该应用API Key(密钥,然后即可参考下文应用调用接口说明,进行个人应用的API调用。

鉴权的主要目的是通过API Key(密钥,校验调用者的身份信息。在调用百度智能云千帆AI原生应用工作台提供的API前,必须先获取API Key(密钥)。

如何获取 API Key(密钥

在完成应用配置和效果调试后,可点击【发布】按钮完成应用发布。成功发布将获得体验分享链接并支持创建API调用密钥,你可通过分享该链接给朋友或其他开发者,使他们能够在web体验页立即体验你的AI原生应用demo;同时你也可以通过应用API调用接口,以API形式进行调用。

  • 体验demo或API调用,都将消耗开发者的调用额度。
  • API Key(密钥)为该应用的重要凭证,您最多可创建10个,且因密钥长期有效,请勿放在浏览器或外部客户端代码中;如意外泄露,删除密钥即可关闭对应访问入口。
  • 重新生成体验地址或删除API Key(密钥)后,旧地址和已删除密钥将无法继续请求服务,并无法恢复,请谨慎操作。

web体验页应用demo示意

您可通过API Key(密钥),和下文的应用调用接口进行个人应用的API调用。出于安全考虑,目前该接口不支持跨域请求。

请求说明

基本信息

请求地址: 请求方式

Header参数
参数值说明Content-Typeapplication/json-X-Appbuilder-AuthorizationBearer {API Key}鉴权字段,请将“ {API Key}”(含大括号)替换为应用API Key(密钥
Body参数

注意:要求使用 JSON 格式的结构体来描述一个请求的具体内容。

参数是否必选类型可选值范围描述query是string-用户的请求queryresponse_mode是stringstreaming/blocking响应模式,支持以下两种: 1. streaming:流式响应,使用SSE协议 2. blocking:阻塞响应conversation_id否uuid-对话ID,仅对话型应用生效。在对话型应用中: 1. 空:表示表新建会话 2. 非空:表示在对应的会话中继续进行对话,服务内部维护对话历史
响应说明
参数是否必选类型描述code是int错误码。非0为错误,请参考错误码说明message是string报错信息result否object返回结果+ answer是string应用响应结果+ conversation_id否uuid对话ID,仅对话式应用生效。如果是对话请求中没有conversation_id,则会自动生成一个

错误码

错误码错误信息描述400InvalidRequestArgumentError请求参数错误401PermissionDeniedError权限错误404NotFoundResource账户、应用、模型、模版等无法找到500InternalServerError服务器内部错误1001QuotaLimitExceeded调用超限,免费额度不足1004LLMStreamingResponseError模型服务报错1005TemplatevaluesError模版参数校验错误1006QuotaLimitExpired免费额度已过期1007QianfanServiceError千帆服务无法访问1008QianfanPermissionDeniedError千帆服务访问失败,一般是权限错误

示例代码

基础生成应用与对话式类似,但不需要传conversation_id参数。请求示例:以RAG问答应用对话为例,因为是首次对话,未传conversation_id参数。注意:示例代码中Bearer {API Key}的大括号为占位符,实际使用时请删除大括号并替换应用API Key。

 

返回示例:对应的返回示例如下,后端生成了一个conversation_id,后续继续对话需要在请求时带上该conversation_id参数。

    以上就是本篇文章【百度智能云千帆AppBuilder-应用API调用说明】的全部内容了,欢迎阅览 ! 文章地址:http://ktsh.xhstdz.com/quote/70290.html 
     栏目首页      相关文章      动态      同类文章      热门文章      网站地图      返回首页 物流园资讯移动站 http://ktsh.xhstdz.com/mobile/ , 查看更多   
发表评论
0评