APapinizer
KnowledgeBase

Add a knowledge base to specified project

Changed on

Adds a knowledge base to specified project. If a knowledge base with the same name exists, it is updated (upsert). The VectorDB and embedding provider connections are named by vectorDbName and embeddingProviderName (own project, then admin project); a sent name sets vectorDbRef / embeddingProviderRef.

post/apiops/projects/{projectName}/knowledge-bases/{name}/

Request

Path parameters

projectNamestring required

Project name

namestring required

Knowledge base name

Request body

idstring
projectIdstring required
namestring required
descriptionstring
vectorDbRefstring
embeddingProviderRefstring
vectorDbNamestring
embeddingProviderNamestring
collectionNamestring
chunkSizeinteger
chunkOverlapinteger
embeddingModelIdstring
statusstring
docCountinteger
chunkCountinteger
createdAtstring date-time
updatedAtstring date-time

Response

successful operation!

status'SUCCESS' | 'FAILURE'
resultMessagestring
resultListstring[]
resultCountinteger
unresolvedReferencesstring[]

Changes

  • d1a546deccf0Revision changes
    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property's minLength was increased from 0 to 1

    • breaking

      the request property's minLength was increased from 0 to 1

    • breaking

      the request property format changed from no format to int32

    • breaking

      the request property format changed from no format to int32

    • breaking

      the request property format changed from no format to int32

    • breaking

      the request property format changed from no format to int32

    This list may be incomplete.

  • 9ae232e55479Revision changes
    • info

      endpoint added