Creates a new KnowledgeChunk - Cognigy Documentation

POST

v2.0

knowledgestores

{knowledgeStoreId}

sources

{sourceId}

chunks

Creates a new KnowledgeChunk

curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/knowledgestores/{knowledgeStoreId}/sources/{sourceId}/chunks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "order": 1,
  "text": "This is a paragraph from an article",
  "data": {}
}'

{
  "order": 1,
  "text": "This is a paragraph from an article",
  "data": {},
  "disabled": true,
  "referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}

Authorizations

X-API-Key

string

header

required

Supply the API Key in the HTTP-Header

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

api_key

string

query

required

Supply the API Key in the Url-Query

Headers

enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:

application/json,

application/hal+json,

application/xml,

text/xml,

text/csv

Path Parameters

knowledgeStoreId

string

required

The Id of the KnowledgeStore

Required string length: 24

sourceId

string

required

The Id of the KnowledgeSource

Required string length: 24

Body

application/json

order

number

The name of the KnowledgeChunk

Example:

1

text

string

The text that is the actual content of the chunk

Example:

"This is a paragraph from an article"

data

object

The extended data of KnowledgeChunk

Response

Returns KnowledgeChunk metadata object.

The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.

order

number

The name of the KnowledgeChunk

Example:

1

text

string

The text that is the actual content of the chunk

Example:

"This is a paragraph from an article"

data

object

The extended data of KnowledgeChunk

disabled

boolean

The status to check if knowledge chunk is disabled

referenceId

string<uuid>

_id

string

Required string length: 24

createdAt

integer

Unix-timestamp

Required range: 0 <= x <= 2147483647

Example:

1694518620

lastChanged

integer

Unix-timestamp

Required range: 0 <= x <= 2147483647

Example:

1694518620

createdBy

string

Required string length: 24

lastChangedBy

string

Required string length: 24

Get a KnowledgeChunkGet a single [KnowledgeChunk](doc:KnowledgeChunk) resource in a project.

Creates a new KnowledgeChunk

curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/knowledgestores/{knowledgeStoreId}/sources/{sourceId}/chunks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "order": 1,
  "text": "This is a paragraph from an article",
  "data": {}
}'

{
  "order": 1,
  "text": "This is a paragraph from an article",
  "data": {},
  "disabled": true,
  "referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}