knowledge-base

Update a knowledge base

put/v1/knowledge-base/knowledge-bases/{kb_id}

Path parameters

kb_idstring uuid required

Request body

namestring nullable
descriptionstring nullable
metadataobject nullable
is_activeboolean nullable
chunk_sizeinteger nullable
chunk_overlapinteger nullable
retrieval_top_kinteger nullable
pdf_extraction_effort'low' nullable
default_sensitivity_levelinteger nullable

Response

Successful Response

idstring uuid required
organization_idstring uuid required
namestring required
descriptionstring nullable required
is_activeboolean required
metadataobject
document_countinteger required
embedding_modelstring required
embedding_dimensionsinteger required
chunk_sizeinteger required
chunk_overlapinteger required
retrieval_top_kinteger required
default_sensitivity_levelinteger
processing_configobject
pdf_extraction_effortstring
created_atstring date-time required
updated_atstring date-time required

Changes

Changed in 1 of the 3 revisions of this API.6

    • added the optional property retry_after to the response with the 400 status

      response-optional-property-added

    • added the optional property retry_after to the response with the 401 status

      response-optional-property-added

    • added the optional property retry_after to the response with the 404 status

      response-optional-property-added

    • added the optional property retryable to the response with the 400 status

      response-optional-property-added

    • added the optional property retryable to the response with the 401 status

      response-optional-property-added

    • added the optional property retryable to the response with the 404 status

      response-optional-property-added

    This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog