Retrieve knowledge context

Searches indexed chunks by semantic similarity. Requires L0 authorization.

POST /api/v1/knowledge/retrieve

Retrieve knowledge context

cURL

curl --request POST \
  --url http://127.0.0.1:4000/api/v1/knowledge/retrieve \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "topK": 25,
  "minScore": 0,
  "projectId": "<string>",
  "documentId": "<string>"
}
'

import requests

url = "http://127.0.0.1:4000/api/v1/knowledge/retrieve"

payload = {
    "query": "<string>",
    "topK": 25,
    "minScore": 0,
    "projectId": "<string>",
    "documentId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    query: '<string>',
    topK: 25,
    minScore: 0,
    projectId: '<string>',
    documentId: '<string>'
  })
};

fetch('http://127.0.0.1:4000/api/v1/knowledge/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 => "4000",
  CURLOPT_URL => "http://127.0.0.1:4000/api/v1/knowledge/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>',
    'topK' => 25,
    'minScore' => 0,
    'projectId' => '<string>',
    'documentId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://127.0.0.1:4000/api/v1/knowledge/retrieve"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"topK\": 25,\n  \"minScore\": 0,\n  \"projectId\": \"<string>\",\n  \"documentId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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://127.0.0.1:4000/api/v1/knowledge/retrieve")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\",\n  \"topK\": 25,\n  \"minScore\": 0,\n  \"projectId\": \"<string>\",\n  \"documentId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://127.0.0.1:4000/api/v1/knowledge/retrieve")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"<string>\",\n  \"topK\": 25,\n  \"minScore\": 0,\n  \"projectId\": \"<string>\",\n  \"documentId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "query": "<string>",
  "topK": 123,
  "items": [
    {
      "id": "<string>",
      "score": 123,
      "model": "<string>",
      "documentId": "<string>",
      "documentName": "<string>",
      "projectId": "<string>",
      "source": "<string>",
      "chunkIndex": 123,
      "sectionPath": "<string>",
      "page": 123,
      "content": "<string>",
      "metadata": {}
    }
  ]
}

{
  "statusCode": 123,
  "code": "<string>",
  "message": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

query · string · required

Minimum string length: 1

topK · integer

Required range: 1 <= x <= 50

minScore · number

Required range: -1 <= x <= 1

projectId · string

Minimum string length: 1

documentId · string

Minimum string length: 1

Response

200

application/json

Retrieval result

query · string · required

topK · integer · required

items · object[] · required

Show child attributes