Skip to main content
PATCH
/
v2
/
knowledge
/
{knowledge_id}
/
datasources
/
{datasource_id}
/
chunks
/
{chunk_id}
Update a chunk
curl --request PATCH \
  --url https://api.orq.ai/v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks/{chunk_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "<string>",
  "embedding": [
    123
  ],
  "metadata": {}
}
'
{
  "_id": "<string>",
  "text": "<string>",
  "enabled": true,
  "status": "pending",
  "created": "<string>",
  "updated": "<string>",
  "metadata": {},
  "created_by_id": "<string>",
  "update_by_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
chunk_id
string
required

The unique identifier of the chunk

​
datasource_id
string
required

The unique identifier of the data source

​
knowledge_id
string
required

The unique identifier of the knowledge base

Body

application/json
​
text
string

The text content of the chunk

​
embedding
number[]

The embedding vector of the chunk. If not provided the chunk will be embedded with the knowledge base embeddings model.

​
metadata
object

Metadata of the chunk

Response

200 - application/json

Chunk successfully updated

​
_id
string
required

The unique identifier of the chunk

​
text
string
required

The text content of the chunk

​
enabled
boolean
required

Whether the chunk is enabled

​
status
enum<string>
required

The status of the chunk

Available options:
pending,
processing,
completed,
failed,
queued
​
created
string
required

The date and time the chunk was created

​
updated
string
required

The date and time the chunk was updated

​
metadata
object

Metadata of the chunk. Can include page_number or any other key-value pairs

​
created_by_id
string | null

The unique identifier of the user who created the chunk

​
update_by_id
string | null

The unique identifier of the user who updated the chunk