https://chatdoc.xfyun.cn/new-chat

不用copy文字了

星火知识库 API 文档

#一、服务介绍

#开通授权

#产品体验

#接口 Demo

示例 Demo请点击 调用示例 下载。

#接口要求

#二、鉴权认证

#鉴权方法

#1、设置签名

• 文档上传接口：在 Http Request Header 中配置以下参数

String appId = "应用ID"；
String secret = "应用的秘钥"
Long timestamp = System.currentTimeMillis()/1000;
String signature = ApiAuthAlgorithm.getSignature(appId, secret, timestamp);
request.setHeader("appId",appId);
request.setHeader("timestamp",timestamp);
request.setHeader("signature",signature);

• 文档问答接口：通过在请求地址后面加上鉴权相关参数的方式

wss://chatdoc.xfyun.cn/openapi/chat?appId=xxx&timestamp=xxx&signature=xxxxxx

#2、签名（signature）生成规则

• 首先，用应用 ID（appId）和时间戳（timestamp）通过 MD5 算法生成随机授权参数 auth
• 再使用授权参数 auth 和接口密钥（secret）基于 HmacSHA1 生产签名 signature

public class ApiAuthAlgorithm {
  private static final char[] MD5_TABLE = {
    '0',
    '1',
    '2',
    '3',
    '4',
    '5',
    '6',
    '7',
    '8',
    '9',
    'a',
    'b',
    'c',
    'd',
    'e',
    'f'
  };
  /**
   * 获取签名
   *
   * @param appId    签名的key
   * @param secret 签名秘钥
   * @return 返回签名
   */
  public String getSignature(String appId, String secret, long ts) {
    try {
      String auth = md5(appId + ts);
      return hmacSHA1Encrypt(auth, secret);
    } catch (SignatureException e) {
      return null;
    }
  }
  /**
   * sha1加密
   *
   * @param encryptText 加密文本
   * @param encryptKey  加密键
   * @return 加密
   */
  private String hmacSHA1Encrypt(String encryptText, String encryptKey)
    throws SignatureException {
    byte[] rawHmac;
    try {
      byte[] data = encryptKey.getBytes(StandardCharsets.UTF_8);
      SecretKeySpec secretKey = new SecretKeySpec(data, "HmacSHA1");
      Mac mac = Mac.getInstance("HmacSHA1");
      mac.init(secretKey);
      byte[] text = encryptText.getBytes(StandardCharsets.UTF_8);
      rawHmac = mac.doFinal(text);
    } catch (InvalidKeyException e) {
      throw new SignatureException("InvalidKeyException:" + e.getMessage());
    } catch (NoSuchAlgorithmException e) {
      throw new SignatureException(
        "NoSuchAlgorithmException:" + e.getMessage()
      );
    }
    return new String(Base64.encodeBase64(rawHmac));
  }
  private String md5(String cipherText) {
    try {
      byte[] data = cipherText.getBytes();
      // 信息摘要是安全的单向哈希函数，它接收任意大小的数据，并输出固定长度的哈希值。
      MessageDigest mdInst = MessageDigest.getInstance("MD5");
      // MessageDigest对象通过使用 update方法处理数据， 使用指定的byte数组更新摘要
      mdInst.update(data);
      // 摘要更新之后，通过调用digest（）执行哈希计算，获得密文
      byte[] md = mdInst.digest();
      // 把密文转换成十六进制的字符串形式
      int j = md.length;
      char[] str = new char[j * 2];
      int k = 0;
      for (byte byte0 : md) { // i = 0
        str[k++] = MD5_TABLE[byte0 >>> 4 & 0xf]; // 5
        str[k++] = MD5_TABLE[byte0 & 0xf]; // F
      }
      // 返回经过加密后的字符串
      return new String(str);
    } catch (Exception e) {
      return null;
    }
  }
}

#鉴权结果

#三、接口列表

#1、文档上传

#接口描述

#接口地址

https://chatdoc.xfyun.cn/openapi/fileUpload

#请求参数说明

POST，multipart/form-data

#返回参数示例

{
  "flag": true,
  "sid": "9746244f046340e2869630e5f6fe8daa",
  "code": 0,
  "desc": null,
  "data": {
    "fileId": "24c4109a57944997bc6b82661243ef67"
  }
}

#返回参数说明

#2、文档问答

#接口描述

#接口地址

wss://chatdoc.xfyun.cn/openapi/chat?appId=xxxx&timestamp=xxxxxxxx&signature=xxxxxx

#请求参数说明

#发送消息格式

• WebSocket 建立成功后，即可发送问答消息，消息格式如下：

{
  "chatExtends": {
    "wikiPromptTpl": "请将以下内容作为已知信息：\n<wikicontent>\n请根据以上内容回答用户的问题。\n问题:<wikiquestion>\n回答:",
    "wikiFilterScore": 65,
    "temperature": 0.5
  },
  "fileIds": ["8b1b17171212121212114fd0806"],
  "messages": [
    {
      "role": "user",
      "content": "如何理赔"
    },
    {
      "role": "assistant",
      "content": "您好，根据您提供的信息，理赔操作指引如下：\n\n1. 登录小程序，点击“理赔申请”。\n2. 选择对应保单。\n3. 上传理赔相关资料。\n4. 填写发票总金额。\n5. 填写银行账户，需精确到支行。\n6. 点击“提交”成功后，返回“理赔服务”界面，点选“理赔查询”，查看理赔进度和申请记录。\n7. 如有需要，点击“查看详情”，查看理赔详情和金额。\n\n请注意，如有严重既往症员工还请和HR部门及时报备沟通，如未及时报备，保险公司不承担相关责任。同时，索赔资料不齐全导致延迟赔付等问题也需要注意。"
    },
    {
      "role": "user",
      "content": "家属有什么福利"
    }
  ]
}

• 参数说明：

#返回消息格式

• 客户端发送消息后，服务端处理后会返回消息，格式如下

{
  "code": 0,
  "content": "和指南。在此之前，我可以为您",
  "fileRefer": "{\"b2de1116b590911111119d0f3dbfc8\":[3,7,8]}",
  "sid": "870b299a48ba46b6b5e4dfbd99fe4497",
  "status": 1
}

#返回参数说明

#3、文档总结

#接口描述

#接口地址

https://chatdoc.xfyun.cn/openapi/startSummary

#请求参数说明

POST，multipart/form-data

#返回参数示例

{
  "flag": true,
  "sid": "9746244f046340e2869630e5f6fe8daa",
  "code": 0,
  "desc": null,
  "data": null
}

#返回参数说明

#4、获取文档总结/概要信息

#接口描述

#接口地址

https://chatdoc.xfyun.cn/openapi/fileSummary

#请求参数说明

POST，multipart/form-data

#返回参数示例

{
  "flag": true,
  "sid": "9746244f046340e2869630e5f6fe8daa",
  "code": 0,
  "desc": null,
  "data": null
}

#返回参数说明

#5、高级功能

#四、错误码

#五、调用示例

文档知识库 demo java 语言

文档知识库 demo python 语言

文档知识库 demo go 语言

注： 也欢迎热心的开发者到 讯飞开放平台社区 分享你们的 demo。

#六、常见问题

#文档知识库的主要功能是什么？

#文档知识库现在支持哪些格式的文档？

#文档知识库支持什么应用平台？