一分钟学会文心一言API如何接入,文心一言API接入教程

1,882次阅读
没有评论

1第一步:注册百度智能云账号

要使用百度智能云提供的服务和产品,您首先需要注册一个百度智能云账号。您可以通过以下方式进行注册:

  • 访问百度智能云官网(cloud.baidu.com/),点击右上角“免费注…
  • 输入您的手机号码,并获取验证码。
  • 设置您的登录密码,并同意服务协议。
  • 完成实名认证,并选择账号类型(个人或企业)。
  • 完成以上步骤后,您就成功注册了一个百度智能云账号。

2第二步:申请文心一言API调用权限

要使用文心一言API调用接口,您需要申请相应的权限。您可以通过以下方式进行申请:

  • 登录百度智能云控制台(console.bce.baidu.com/),点击左侧导航栏“人…
  • 在自然语言处理页面中,找到“文心一言”产品,并点击“立即使用”按钮。
  • 在弹出窗口中填写相关信息,并提交申请。
  • 等待审核结果。审核通过后,您就可以在控制台中查看并管理您的文心一言API调用权限。

3第三步:配置并测试文心一言API调用接口

要使用文心一言API调用接口,您需要配置相关参数,并进行测试。您可以通过以下方式进行配置和测试:

  • 在控制台中进入“自然语言处理”页面,并点击“文心一言”产品下方的“管理”按钮,进入文心一言API调用接口的配置页面。
  • 在配置页面中,您可以查看并修改您的文心一言API调用接口的基本信息,如应用名称、应用描述、应用类型等。
  • 您还可以在配置页面中设置您的文心一言API调用接口的安全认证方式,如Access Key ID和Secret Access Key。这些是您调用文心一言API时需要提供的身份凭证,建议您妥善保管,并定期更换。
  • 您还可以在配置页面中设置您的文心一言API调用接口的配额和限流策略,如每日请求次数、每秒请求次数等。这些是为了保障您和其他用户的服务质量和安全性,建议您根据自己的业务需求合理分配,并避免超出限制。
  • 在完成以上配置后,您就可以在配置页面中点击“在线测试”按钮,进行文心一言API调用接口的测试。测试时,您需要输入一个对话语句,并选择一个对话领域和场景。然后点击“发送”按钮,即可查看文心一言API返回的对话回复。

04第四步:集成并使用文心一言API调用接口

要集成并使用文心一言API调用接口,您需要根据自己的开发环境和语言选择合适的SDK或工具,并编写相应的代码。百度智能云提供了多种语言和平台支持的SDK或工具,如JavaPythonPHP、Node.js、Android、iOS等。您可以通过以下方式进行集成和使用:

  • 在控制台中进入“自然语言处理”页面,并点击“文心一言”产品下方的“文档”按钮,进入文心一言API调用接口的文档页面。
  • 在文档页面中,您可以查看并下载您所需要的SDK或工具,并参考相关的示例代码和说明进行集成和使用。
  • 在完成集成和使用后,您就可以在您的应用中调用文心一言API,实现与用户的智能对话功能 4第四步. 注意事项

在对接API时,需要注意以下事项:

  • 确保自己的API服务代码安全可靠,能够应对各种情况。
  • 在设置API密钥时,要妥善保管,避免泄露或丢失。
  • 及时更新API服务代码和参数设置,以适应文心千帆平台的变化和需求的变化。

01接下来我们直接开始

  • 1. 获取 Access_token

百度AI开放平台使用OAuth2.0授权调用开放API,调用API时必须在URL中带上Access_token参数,获取Access_token的流程如下:

请求URL数据格式

向授权服务地址https://aip.baidubce.com/oauth/2.0/token发送请求(推荐使用POST),并在URL中带上以下参数:

  • grant_type:  必须参数,固定为client_credentials
  • client_id:  必须参数,应用的API Key
  • client_secret:  必须参数,应用的Secret Key

例如:

bash

复制代码https://aip.baidubce.com/oauth/2.0/token?grant_type=client_credentials&client_id=Va5yQRHlA4Fq5eR3LT0vuXV4&client_secret=0rDSjzQ20XUj5itV6WRtznPQSzr5pVw2&

  • 2. 创建chat

他这里有很多模型大家可以自己去看文档

image.png 官方文档:cloud.baidu.com/doc/WENXINW…

请求说明

基本信息

请求地址: aip.baidubce.com/rpc/2.0/ai_…

请求方式: POST

Header参数

名称
Content-Type application/json

Query参数

名称 类型 必填 描述
access_token string 通过API Key和Secret Key获取的access_token,参考Access Token获取

Body参数

名称 类型 必填 描述
messages List(message) 聊天上下文信息。说明: (1)messages成员不能为空,1个成员表示单轮对话,多个成员表示多轮对话 (2)最后一个message为当前请求的信息,前面的message为历史对话信息 (3)必须为奇数个成员,成员中message的role必须依次为user、assistant (4)最后一个message的content长度(即此轮对话的问题)不能超过2000个字符;如果messages中content总长度大于2000字符,系统会依次遗忘最早的历史会话,直到content的总长度不超过2000个字符
stream bool 是否以流式接口的形式返回数据,默认false
user_id string 表示最终用户的唯一标识符,可以监视和检测滥用行为,防止接口恶意调用

message说明

名称 类型 描述
role string 当前支持以下: user: 表示用户 assistant: 表示对话助手
content string 对话内容,不能为空

响应说明

名称 类型 描述
id string 本轮对话的id
object string 回包类型 chat.completion:多轮对话返回
created int 时间戳
sentence_id int 表示当前子句的序号。只有在流式接口模式下会返回该字段
is_end bool 表示当前子句是否是最后一句。只有在流式接口模式下会返回该字段
is_truncated bool 当前生成的结果是否被截断
result string 对话返回结果
need_clear_history bool 表示用户输入是否存在安全,是否关闭当前会话,清理历史回话信息。 true:是,表示用户输入存在安全风险,建议关闭当前会话,清理历史会话信息。 false:否,表示用户输入无安全风险
usage usage token统计信息,token数 = 汉字数+单词数*1.3 (仅为估算逻辑)

usage说明

名称 类型 描述
prompt_tokens int 问题tokens数
completion_tokens int 回答tokens数
total_tokens int tokens总数

注意 :同步模式和流式模式,响应参数返回不同,详细内容参考示例描述。

  • 同步模式下,响应参数为以上字段的完整json包。
  • 流式模式下,各字段的响应参数为 data: {响应参数}。

示例

请求示例(单轮)

vbnet

复制代码curl -XPOST https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/chat/eb-instant?access_token={access_token} -d '{ "messages": [ {"role":"user","content":"介绍一下你自己"} ] }' | iconv -f utf-8 -t utf-8

响应示例(单轮)

vbnet

复制代码HTTP/1.1 200 OK Date: Thu, 23 Mar 2023 03:12:03 GMT Content-Type: application/json;charset=utf-8 Statement: AI-generated { "id": "as-bcmt5ct4iy", "object": "chat.completion", "created": 1680167072, "result": "您好,我是百度研发的知识增强大语言模型,中文名是文心一言,英文名是ERNIE Bot。我能够与人对话互动,回答问题,协助创作,高效便捷地帮助人们获取信息、知识和灵感。", "is_truncated":false, "need_clear_history": false, "usage": { "prompt_tokens": 7, "completion_tokens": 67, "total_tokens": 74 } }

接口请求示例

image.png 这里需要注意一下

image.png 传值传body里面

  • 3. 总结

本教程介绍了如何对接文心千帆平台的API服务,包括准备工作、对接步骤和注意事项。通过本教程的学习,可以掌握如何将自己的API服务与文心千帆平台进行对接,实现更加便捷、高效的服务。 剩下的大家去试试吧。

正文完
可以使用微信扫码关注公众号(ID:xzluomor)
post-qrcode
 
评论(没有评论)