CRBNai API

Chat with a Knowledge Bot

Testing

POST

/api/knowledge-bots/{id}/summarize

kbchat

Interact with your knowledge bot by asking questions or even a more complex chat history.

Soon to be replaced with the normal chat API design with persistent chats.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

string

required

Body Params application/json

query

string

required

The question you want to ask your Knowledge Bot.

history

array [object {2}]

required

role

string

required

"user" or "assistant"

content

string

required

The content of the previous queries and answers.

Example

{
  "query": "string",
  "history": [
    {
      "role": "string",
      "content": "string"
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://app.crbnai.com/api/knowledge-bots//summarize' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200OK

text/plain

Body

object {0}

Example

{"id":"c688c936-cf4d-4b64-b8be-8ea9cbf2a56e","content":"Quote 1 within the provided documents","similarity":0.87255812550904,"document_name":"source-document-1.pdf","page_number":2,"type":"section"}
{"id":"923edb1b-f731-4560-bb23-7a509aef4e79","content":"Quote n within the provided documents","similarity":0.87255812550904,"document_name":"source-document-n.pdf","page_number":17,"type":"section"}
{"delta":"One or multiple deltas containing the generated response including references to the documents from above. [c688c936-cf4d-4b64-b8be-8ea9cbf2a56e]","type":"delta"}

Modified at 2023-12-12 06:38:20

Create Knowledge Bot chat

Create Knowledge Bot