KnowledgeApi API

The knowledgeApi module of the @codebolt/plugin-sdk.

import plugin from '@codebolt/plugin-sdk';

Quick Reference

Method	Description
addDocumentFromUrl
addDocuments
createCollection
deleteCollection
deleteDocument
getCollection
getDocument
getSettings
getStrategies
getStrategyOptions
listCollections
listDocuments
rechunkDocument
updateChunk
updateCollection
updateSettings

Methods

---

addDocumentFromUrl

plugin.knowledgeApi.addDocumentFromUrl(id: string, data: AddKnowledgeDocumentFromUrlRequest): Promise<unknown>

Parameter	Type	Required	Description
id	string	Yes
data	AddKnowledgeDocumentFromUrlRequest	Yes

Returns: Promise<unknown>

Full reference →

---

addDocuments

plugin.knowledgeApi.addDocuments(id: string, data: AddKnowledgeDocumentsRequest): Promise<unknown>

Parameter	Type	Required	Description
id	string	Yes
data	AddKnowledgeDocumentsRequest	Yes

Returns: Promise<unknown>

Full reference →

---

createCollection

plugin.knowledgeApi.createCollection(data: CreateKnowledgeCollectionRequest): Promise<KnowledgeCollection>

Parameter	Type	Required	Description
data	CreateKnowledgeCollectionRequest	Yes

Returns: Promise<KnowledgeCollection>

Full reference →

---

deleteCollection

plugin.knowledgeApi.deleteCollection(id: string): Promise<unknown>

Parameter	Type	Required	Description
id	string	Yes

Returns: Promise<unknown>

Full reference →

---

deleteDocument

plugin.knowledgeApi.deleteDocument(documentId: string): Promise<unknown>

Parameter	Type	Required	Description
documentId	string	Yes

Returns: Promise<unknown>

Full reference →

---

getCollection

plugin.knowledgeApi.getCollection(id: string): Promise<KnowledgeCollection>

Parameter	Type	Required	Description
id	string	Yes

Returns: Promise<KnowledgeCollection>

Full reference →

---

getDocument

plugin.knowledgeApi.getDocument(documentId: string): Promise<KnowledgeDocument>

Parameter	Type	Required	Description
documentId	string	Yes

Returns: Promise<KnowledgeDocument>

Full reference →

---

getSettings

plugin.knowledgeApi.getSettings(id: string): Promise<KnowledgeCollectionSettings>

Parameter	Type	Required	Description
id	string	Yes

Returns: Promise<KnowledgeCollectionSettings>

Full reference →

---

getStrategies

plugin.knowledgeApi.getStrategies(): Promise<KnowledgeStrategy[]>

No parameters.

Returns: Promise<KnowledgeStrategy[]>

Full reference →

---

getStrategyOptions

plugin.knowledgeApi.getStrategyOptions(strategy: string): Promise<KnowledgeStrategyOptions>

Parameter	Type	Required	Description
strategy	string	Yes

Returns: Promise<KnowledgeStrategyOptions>

Full reference →

---

listCollections

plugin.knowledgeApi.listCollections(params?: Record<string, unknown>): Promise<KnowledgeCollection[]>

Parameter	Type	Required	Description
params	Record<string, unknown>	No

Returns: Promise<KnowledgeCollection[]>

Full reference →

---

listDocuments

plugin.knowledgeApi.listDocuments(id: string, params?: Record<string, unknown>): Promise<KnowledgeDocument[]>

Parameter	Type	Required	Description
id	string	Yes
params	Record<string, unknown>	No

Returns: Promise<KnowledgeDocument[]>

Full reference →

---

rechunkDocument

plugin.knowledgeApi.rechunkDocument(documentId: string, data?: RechunkDocumentRequest): Promise<unknown>

Parameter	Type	Required	Description
documentId	string	Yes
data	RechunkDocumentRequest	No

Returns: Promise<unknown>

Full reference →

---

updateChunk

plugin.knowledgeApi.updateChunk(chunkId: string, data: UpdateKnowledgeChunkRequest): Promise<unknown>

Parameter	Type	Required	Description
chunkId	string	Yes
data	UpdateKnowledgeChunkRequest	Yes

Returns: Promise<unknown>

Full reference →

---

updateCollection

plugin.knowledgeApi.updateCollection(id: string, data: UpdateKnowledgeCollectionRequest): Promise<KnowledgeCollection>

Parameter	Type	Required	Description
id	string	Yes
data	UpdateKnowledgeCollectionRequest	Yes

Returns: Promise<KnowledgeCollection>

Full reference →

---

updateSettings

plugin.knowledgeApi.updateSettings(id: string, data: UpdateKnowledgeSettingsRequest): Promise<KnowledgeCollectionSettings>

Parameter	Type	Required	Description
id	string	Yes
data	UpdateKnowledgeSettingsRequest	Yes

Returns: Promise<KnowledgeCollectionSettings>

Full reference →