Retrieval Testing on Knowledge Base — API

Path parameters

KB_IdPathintegerrequired
knowledgebase_id

Query parameters

project_idQueryintegerrequired
Project ID
active_iamQueryintegeroptional
Active IAM ID (To access contact person account) Find your Active IAM ID here

Request body

application/json

object

pageintegerrequired

example1

sizeintegerrequired

example10

questionstringrequired

exampleitem

similarity_thresholdnumber·floatrequired

example0.2

vector_similarity_weightnumber·floatrequired

example0.21

top_kintegerrequired

example1024

rerank_idintegerrequired

example5

doc_idsarrayrequired

Responses

200Success

object

codeinteger

example200

dataobject

errorsobject

messagestring

exampleSuccess

Request

curl -X POST 'https://api.e2enetworks.com/myaccount/api/v1/gpu/rag/knowledgebase/{KB_Id}/retrieval/?project_id=%3Cproject_id%3E&active_iam=%3Cactive_iam%3E&apikey=%3Capikey%3E' \
  -H 'Authorization: Bearer <JWT>' \
  -H 'Content-Type: application/json' \
  -d '{
  "page": 1,
  "size": 10,
  "question": "item",
  "similarity_threshold": 0.2,
  "vector_similarity_weight": 0.21,
  "top_k": 1024,
  "rerank_id": 5,
  "doc_ids": []
}'

Response · 200

{
  "code": 200,
  "data": {
    "chunks": [
      {
        "chunk_id": "1510993c99b187dd071ac655b7f7e838",
        "content_ltks": "e-enetworks.t 0.00 f) inco from previ mployer pay item am total linc th><th></th></tr>\n<tr><th  >(i) Iing</th></tr>\n<tr><th  >Sub Total</th><th></th></tr>\n</table>",
        "doc_id": "f337f46eb88111efafd816fd5bc7de9f",
        "docnm_kwd": "Aashish (4).pdf",
        "img_id": "ragf-4624e122b78911ef943362d4577b3e2b-1510993c99b187dd071ac655b7f7e838",
        "important_kwd": [],
        "kb_id": "ragf-4624e122b78911ef943362d4577b3e2b",
        "positions": [
          [
            1,
            28,
            298,
            316,
            829
          ]
        ],
        "similarity": 0.21638480767672919,
        "term_similarity": 0.6761202015558534,
        "vector_similarity": 0.094176665
      }
    ],
    "doc_aggs": [
      {
        "count": 1,
        "doc_id": "f337f46eb88111efafd816fd5bc7de9f",
        "doc_name": "Aashish (4).pdf"
      }
    ],
    "total": 3
  },
  "errors": {},
  "message": "Success"
}