Knowledge Base object
Field | Type | Required | Description | Example |
---|---|---|---|---|
id |
str | ✔️ | The unique identifier of the knowledge base. | |
created |
str | ✔️ | The creation date of the knowledge base. | |
description |
Optional[str] | ➖ | The description of the knowledge base. | |
key |
str | ✔️ | The unique key of the knowledge base. | |
model |
str | ✔️ | The embeddings model used for the knowledge base. | |
path |
Optional[str] | ➖ | The path where the entity is stored in the project structure. The first element of the path always represents the project name. Any subsequent path element after the project will be created as a folder in the project if it does not exists. | Customer Service/Billing/Refund |
retrieval_settings |
Optional[models.UpdateKnowledgeKnowledgeRetrievalSettings] | ➖ | The retrieval settings for the knowledge base. If not provider, Hybrid Search will be used as a default query strategy. | |
created_by_id |
OptionalNullable[str] | ➖ | N/A | |
updated_by_id |
OptionalNullable[str] | ➖ | N/A | |
updated |
str | ✔️ | The last update date of the knowledge base. |