Skip to main content
PUT
Update Knowledge Document Metadata

Authorizations

Authorization
string
header
required

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

Path Parameters

knowledge_id
string
required

Knowledge base ID

document_id
string
required

Document to update

Body

application/json
title
string | null

Document title. Passing it also renames the document

entity_names
string[] | null

Tags. Values written as "key:value" drive metadata pre-filtering at retrieval time

published_at
integer | null
content_at
integer | null
time_periods
string[] | null
summary
string | null
external_user
string | null
document_scope
integer | null

Visibility scope of the document

language
string | null
custom_data
Custom Data · object | null

Free-form key-values. Stored, indexed and returned, but never used for filtering. Replaced as a whole, not deep merged

pdf_parsing_mode
enum<integer> | null

Changing it re-triggers parsing. 1: page, 2: section (recommended), 3: section v2

Available options:
1,
2,
3
audio_parsing_mode
enum<integer> | null

Changing it re-triggers parsing. 1: transcript, 2: speaker diarization

Available options:
1,
2

Response

Successful Response

org_id
string
required
Maximum string length: 20
user_id
string
required
Maximum string length: 20
dataset_id
string
required
file_id
string
required
document_id
string
required
created_at
integer
updated_at
integer
overall_summarize_enabled
boolean | null
default:true

Generate an overall summary. Boolean

smart_indexing_mode
integer | null
default:0

Smart indexing mode. 0: disabled (recommended), 1: standard, 2: advanced

smart_indexing_enabled
boolean | null
default:true

Enable smart indexing. Boolean. Takes effect only together with smart_indexing_mode 2 (advanced); leaving it false is recommended unless the corpus needs it, as it adds noticeable processing time and token cost

split_media_enabled
boolean | null
default:true

Generate media segments. Boolean

pdf_parsing_mode
integer | null
default:2

PDF parsing mode. 1: page, 2: section (recommended), 3: section v2

pdf_parsing_element_types
integer[] | null

pdf parsing element list, eg: [1, 2]. 1: table, 2: image, 3: formula

read_pdf_pages
string | null

read pdf pages, Example: '1,3,4' or '1,4-end' or 'all'

audio_parsing_mode
integer | null

audio parsing mode, 1: transcript, 2: speaker diarization

audio_chunk_mode
integer | null
default:1
name
string | null
Maximum string length: 256
document_type
integer | null
default:1
next_step
boolean | null
default:true

next step

llm
Llm · object | null
metadata_info
Metadata Info · object
task_priority
integer | null

task priority

description
string | null
default:""
Maximum string length: 512
summary
string | null
default:""
step_status
integer | null
default:100
status
integer | null
default:1
process_status
integer | null
default:100
version
integer | null
default:2
splitter_type
integer | null
default:1
splitter
Splitter · object
sections
Sections · object[]
content_text
string | null
trim_text
boolean | null
default:true