Index knowledge document

Runs converter, chunking, and embeddings for a document. Requires L0 authorization.

POST /api/v1/knowledge/documents/{id}/index

Index knowledge document

cURL

curl --request POST \
  --url http://127.0.0.1:4000/api/v1/knowledge/documents/{id}/index \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "commandId": "<string>",
  "maxChars": 2200,
  "overlapChars": 800
}
'

import requests

url = "http://127.0.0.1:4000/api/v1/knowledge/documents/{id}/index"

payload = {
    "commandId": "<string>",
    "maxChars": 2200,
    "overlapChars": 800
}
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({commandId: '<string>', maxChars: 2200, overlapChars: 800})
};

fetch('http://127.0.0.1:4000/api/v1/knowledge/documents/{id}/index', 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/documents/{id}/index",
  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([
    'commandId' => '<string>',
    'maxChars' => 2200,
    'overlapChars' => 800
  ]),
  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/documents/{id}/index"

	payload := strings.NewReader("{\n  \"commandId\": \"<string>\",\n  \"maxChars\": 2200,\n  \"overlapChars\": 800\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/documents/{id}/index")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"commandId\": \"<string>\",\n  \"maxChars\": 2200,\n  \"overlapChars\": 800\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://127.0.0.1:4000/api/v1/knowledge/documents/{id}/index")

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  \"commandId\": \"<string>\",\n  \"maxChars\": 2200,\n  \"overlapChars\": 800\n}"

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

201

{
  "document": {
    "id": "<string>",
    "name": "<string>",
    "fileType": "<string>",
    "source": "<string>",
    "projectId": "<string>",
    "version": 123,
    "checksum": "<string>",
    "filePath": "<string>",
    "markdownPath": "<string>",
    "converterCommand": "<string>",
    "converterMeta": {},
    "errorMessage": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "chunkCount": 123,
  "embeddingModel": "<string>"
}

{
  "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.

Path Parameters

id · string · required

Minimum string length: 1

Body

application/json

commandId · string

Minimum string length: 1

maxChars · integer

Required range: 400 <= x <= 4000

overlapChars · integer

Required range: 0 <= x <= 1600

Response

201

application/json

Indexing completed

document · object · required

Show child attributes

chunkCount · integer · required

embeddingModel · string · required