对接指南

知识库支持通过 API 接口进行操作，在使用 API 接口之前，需要先完成以下操作。

已通过 注册账号及开通服务 页面操作完成注册账号及开通服务。

在调用知识库的各个能力之前，确保您已生成访问密钥 Access Key。Access Key 包括 Access Key ID（简称为 AK） 和 Access Key Secret（简称为 SK），其中，Access Key ID 用于标识用户，Access Key Secret 用于验证用户的密钥，请您妥善保管。
AK/SK 密钥获取方式如下，更多详情请参考 Access Key（密钥）管理。

1. 单击右上角账号名下拉框中的【密钥管理】进入对应页面。
2. 单击【新建密钥】按钮，可获取 AK/SK，可以此为凭证调用上述已接入应用的接口。

获取到 AK/SK 后，生成签名。签名过程说明详情请参考 签名过程Demo，通过源码生成签名详情请参考 签名源码示例，通过 SDK 生成签名详情请参考 SDK概览。

Python 语言 SDK 生成签名

1. 安装火山引擎程序包。

   pip install volcengine

2. 生成签名。

   import json
   import sys
   import requests
   
   from volcengine.auth.SignerV4 import SignerV4
   from volcengine.base.Request import Request
   from volcengine.Credentials import Credentials
   
   def prepare_request(method, path, ak, sk, params=None, data=None, doseq=0):
       if params:
           for key in params:
               if (
                   type(params[key]) == int
                   or type(params[key]) == float
                   or type(params[key]) == bool
               ):
                   params[key] = str(params[key])
               elif sys.version_info[0] != 3:
                   if type(params[key]) == unicode:
                       params[key] = params[key].encode("utf-8")
               elif type(params[key]) == list:
                   if not doseq:
                       params[key] = ",".join(params[key])
       r = Request()
       r.set_shema("http")
       r.set_method(method)
       r.set_connection_timeout(10)
       r.set_socket_timeout(10)
       mheaders = {
           "Accept": "application/json",
           "Content-Type": "application/json",
           "Host": "api-knowledgebase.ml_platform.cn-beijing.volces.com",
       }
       r.set_headers(mheaders)
       if params:
           r.set_query(params)
       r.set_host("api-knowledgebase.ml_platform.cn-beijing.volces.com")
       r.set_path(path)
       if data is not None:
           r.set_body(json.dumps(data))
       # 生成签名
       credentials = Credentials(ak, sk, "air", "cn-north-1")
       SignerV4.sign(r, credentials)
       return r
   
   if __name__ == "__main__":
       # user your ak,sk,collection_name and query
       ak = 'your_ak'
       sk = 'your_sk'
       request_params = {
           "name" : "your_collection_name",
           "query": "your query",
       }
   
       method = 'POST'
       DOMAIN = "api-knowledgebase.ml_platform.cn-beijing.volces.com"
       path = '/api/knowledge/collection/search'
   
       info_req = prepare_request(method = method, path = path, ak = ak, sk = sk, data = request_params)
   
       res = requests.request(method=info_req.method,
                       url = "http://{}{}".format(DOMAIN, info_req.path),
                       headers = info_req.headers,
                       data = info_req.body)
       print(res.text)
   

GO 语言 SDK 生成签名

1. 安装火山引擎程序包。

   go get -u github.com/volcengine/volc-sdk-golang

2. 生成签名。

   package main
   
   import (
           "bytes"
           "fmt"
           "net/http"
           "net/url"
           "strings"
           "io/ioutil"
           "github.com/volcengine/volc-sdk-golang/base"
   )
   
   const (
           testAk = "***"
           testSk = "***"
   )
   
   func PrepareRequest(method string, path string, ak string, sk string, query url.Values, body []byte) *http.Request {
           u := url.URL{
                   Scheme:   "http",
                   Host:     "api-knowledgebase.ml_platform.cn-beijing.volces.com",
                   Path:     "/api/knowledge/collection/search",
           }
           if query != nil {
                   u.RawQuery = query.Encode()
           }
           req, _ := http.NewRequest(strings.ToUpper(method), u.String(), bytes.NewReader(body))
           req.Header.Add("Accept", "application/json")
           req.Header.Add("Content-Type", "application/json")
           req.Header.Add("Host", "api-knowledgebase.ml_platform.cn-beijing.volces.com")
           credential := base.Credentials{
                   AccessKeyID:     ak,
                   SecretAccessKey: sk,
                   Service:         "air",
                   Region:          "cn-north-1",
           }
           req = credential.Sign(req)
           return req
   }
   
   func main() {
           body := []byte(`{"name":"test_collection", "query":"introduce a new document level structure"}`)
           req := PrepareRequest("POST", "/api/knowledge/collection/search", testAk, testSk, nil, body)
           fmt.Printf("%+v\n", req)
           // 发送请求
           client := &http.Client{}
           resp, err := client.Do(req)
           if err != nil {
                   fmt.Println("Error sending request:", err)
                   return
           }
           defer resp.Body.Close()
   
           rb, _ := ioutil.ReadAll(resp.Body)
           fmt.Println(string(rb))
   }
   

Java语言 SDK 生成签名

1. 安装火山引擎程序包。

   <dependency>
       <groupId>com.volcengine</groupId>
       <artifactId>volc-sdk-java</artifactId>
       <version>最新版本</version>
   </dependency> 
   

2. 生成签名

   package javaTest;
   
   import java.util.List;
   
   import org.apache.http.HttpResponse;
   import org.apache.http.NameValuePair;
   import org.apache.http.client.HttpClient;
   import org.apache.http.client.config.RequestConfig;
   import org.apache.http.client.utils.URIBuilder;
   import org.apache.http.entity.StringEntity;
   import org.apache.http.impl.client.HttpClients;
   import org.apache.http.util.EntityUtils;
   
   import com.volcengine.auth.ISignerV4;
   import com.volcengine.auth.impl.SignerV4Impl;
   import com.volcengine.model.Credentials;
   import com.volcengine.service.SignableRequest;
   
   public class sign {
     public static SignableRequest prepareRequest(String host, String path, String method, List<NameValuePair> params, String body, String ak, String sk) throws Exception {
       SignableRequest request = new SignableRequest();
       request.setMethod(method);
       request.setHeader("Accept", "application/json");
       request.setHeader("Content-Type", "application/json");
       request.setHeader("Host", "api-knowledgebase.ml_platform.cn-beijing.volces.com");
       request.setEntity(new StringEntity(body, "utf-8"));
   
       URIBuilder builder = request.getUriBuilder();
       builder.setScheme("http");
       builder.setHost(host);
       builder.setPath(path);
       if (params != null) {
         builder.setParameters(params);
       }
   
       RequestConfig requestConfig = RequestConfig.custom().setSocketTimeout(5000).setConnectTimeout(2000).build();
       request.setConfig(requestConfig);
   
       Credentials credentials = new Credentials("cn-north-1", "air");
       credentials.setAccessKeyID(ak);
       credentials.setSecretAccessKey(sk);
   
       // 签名
       ISignerV4 ISigner = new SignerV4Impl();
       ISigner.sign(request, credentials);
   
       return request;
     }
   
     public static void main(String[] args) throws Exception {
       String host = "api-knowledgebase.ml_platform.cn-beijing.volces.com";
       String path = "/api/knowledge/collection/search";
       String method = "POST";
       String body = "{\"name\":\"test_name\",\"query\":\"introduce a new document level structure\"}";
       String ak = "your_ak_on_volcengine";
       String sk = "your_sk_on_volcengine";
       SignableRequest request = prepareRequest(host, path, method, null, body, ak, sk);
       System.out.println(request.getURI());
   
       HttpClient client = HttpClients.createDefault();
       HttpResponse response = client.execute(request);
   
       int statusCode = response.getStatusLine().getStatusCode();
       String content = EntityUtils.toString(response.getEntity());
   
       System.out.println(statusCode);
       System.out.println(content);
     }
   }