检索知识库
curl --request POST \
--url http://localhost:5300/api/v1/knowledge/bases/{kb_uuid}/retrieve \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"query": "<string>",
"retrieval_settings": {
"top_k": 123
}
}
'import requests
url = "http://localhost:5300/api/v1/knowledge/bases/{kb_uuid}/retrieve"
payload = {
"query": "<string>",
"retrieval_settings": { "top_k": 123 }
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({query: '<string>', retrieval_settings: {top_k: 123}})
};
fetch('http://localhost:5300/api/v1/knowledge/bases/{kb_uuid}/retrieve', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "5300",
CURLOPT_URL => "http://localhost:5300/api/v1/knowledge/bases/{kb_uuid}/retrieve",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => '<string>',
'retrieval_settings' => [
'top_k' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:5300/api/v1/knowledge/bases/{kb_uuid}/retrieve"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"retrieval_settings\": {\n \"top_k\": 123\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:5300/api/v1/knowledge/bases/{kb_uuid}/retrieve")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"retrieval_settings\": {\n \"top_k\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:5300/api/v1/knowledge/bases/{kb_uuid}/retrieve")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"retrieval_settings\": {\n \"top_k\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"code": 0,
"data": {
"results": [
{}
]
}
}知识库
检索知识库
对知识库进行语义检索,返回相关文档片段。
POST
/
api
/
v1
/
knowledge
/
bases
/
{kb_uuid}
/
retrieve
检索知识库
curl --request POST \
--url http://localhost:5300/api/v1/knowledge/bases/{kb_uuid}/retrieve \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"query": "<string>",
"retrieval_settings": {
"top_k": 123
}
}
'import requests
url = "http://localhost:5300/api/v1/knowledge/bases/{kb_uuid}/retrieve"
payload = {
"query": "<string>",
"retrieval_settings": { "top_k": 123 }
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({query: '<string>', retrieval_settings: {top_k: 123}})
};
fetch('http://localhost:5300/api/v1/knowledge/bases/{kb_uuid}/retrieve', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "5300",
CURLOPT_URL => "http://localhost:5300/api/v1/knowledge/bases/{kb_uuid}/retrieve",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'query' => '<string>',
'retrieval_settings' => [
'top_k' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:5300/api/v1/knowledge/bases/{kb_uuid}/retrieve"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"retrieval_settings\": {\n \"top_k\": 123\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:5300/api/v1/knowledge/bases/{kb_uuid}/retrieve")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"retrieval_settings\": {\n \"top_k\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:5300/api/v1/knowledge/bases/{kb_uuid}/retrieve")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"query\": \"<string>\",\n \"retrieval_settings\": {\n \"top_k\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"code": 0,
"data": {
"results": [
{}
]
}
}⌘I
