FluxbaseKnowledgeBase

FluxbaseKnowledgeBase provides knowledge base management for RAG applications

Example

// List knowledge bases
const { data: kbs } = await client.knowledgeBase.list()

// Create a knowledge base
const { data: kb } = await client.knowledgeBase.create({
  name: 'Product Docs',
  description: 'Product documentation for RAG'
})

// Add a document
const { data } = await client.knowledgeBase.addDocument(kb.id, {
  title: 'Getting Started',
  content: 'Welcome to our product...'
})

// Search the knowledge base
const { data: results } = await client.knowledgeBase.search(kb.id, {
  query: 'How to get started?'
})

Constructors

Constructor

new FluxbaseKnowledgeBase(fetch): FluxbaseKnowledgeBase

Parameters

Parameter	Type
fetch	FluxbaseFetch

Returns

FluxbaseKnowledgeBase

Methods

addDocument()

addDocument(kbId, request): Promise<FluxbaseResponse<AddDocumentResponse>>

Add a document with text content

Parameters

Parameter	Type	Description
kbId	string	Knowledge base ID
request	AddDocumentRequest	Document content and metadata

Returns

Promise<FluxbaseResponse<AddDocumentResponse>>

Example

const { data } = await client.knowledgeBase.addDocument(kbId, {
  title: 'API Reference',
  content: 'The API supports REST and GraphQL...',
  metadata: { category: 'reference' },
  tags: ['api', 'reference']
})

---

create()

create(request): Promise<FluxbaseResponse<KnowledgeBase>>

Create a new knowledge base

Parameters

Parameter	Type	Description
request	CreateKnowledgeBaseRequest	Knowledge base configuration

Returns

Promise<FluxbaseResponse<KnowledgeBase>>

Example

const { data, error } = await client.knowledgeBase.create({
  name: 'Product Docs',
  description: 'Product documentation',
  embedding_model: 'text-embedding-3-small',
  chunk_size: 1000,
  chunk_overlap: 200
})

---

delete()

delete(id): Promise<{ data: boolean; error: Error | null; }>

Delete a knowledge base

Parameters

Parameter	Type	Description
id	string	Knowledge base ID

Returns

Promise<{ data: boolean; error: Error | null; }>

---

deleteDocument()

deleteDocument(kbId, docId): Promise<{ data: boolean; error: Error | null; }>

Delete a document

Parameters

Parameter	Type	Description
kbId	string	Knowledge base ID
docId	string	Document ID

Returns

Promise<{ data: boolean; error: Error | null; }>

---

deleteDocumentsByFilter()

deleteDocumentsByFilter(kbId, filter): Promise<FluxbaseResponse<DeleteDocumentsByFilterResponse>>

Delete documents matching a filter (bulk operation)

Parameters

Parameter	Type	Description
kbId	string	Knowledge base ID
filter	DeleteDocumentsByFilterRequest	Filter criteria (by tags and/or metadata)

Returns

Promise<FluxbaseResponse<DeleteDocumentsByFilterResponse>>

---

get()

get(id): Promise<FluxbaseResponse<KnowledgeBase>>

Get a knowledge base by ID

Parameters

Parameter	Type	Description
id	string	Knowledge base ID

Returns

Promise<FluxbaseResponse<KnowledgeBase>>

---

getDocument()

getDocument(kbId, docId): Promise<FluxbaseResponse<KnowledgeBaseDocument>>

Get a single document

Parameters

Parameter	Type	Description
kbId	string	Knowledge base ID
docId	string	Document ID

Returns

Promise<FluxbaseResponse<KnowledgeBaseDocument>>

---

getEntityRelationships()

getEntityRelationships(kbId, entityId): Promise<FluxbaseResponse<AIEntityRelationship[]>>

Get relationships for an entity

Parameters

Parameter	Type	Description
kbId	string	Knowledge base ID
entityId	string	Entity ID

Returns

Promise<FluxbaseResponse<AIEntityRelationship[]>>

---

getKnowledgeGraph()

getKnowledgeGraph(kbId): Promise<FluxbaseResponse<KnowledgeGraphData>>

Get the full knowledge graph for a knowledge base

Returns all entities and relationships for visualization.

Parameters

Parameter	Type	Description
kbId	string	Knowledge base ID

Returns

Promise<FluxbaseResponse<KnowledgeGraphData>>

---

list()

list(): Promise<FluxbaseResponse<KnowledgeBaseSummary[]>>

List all knowledge bases the user has access to

Returns

Promise<FluxbaseResponse<KnowledgeBaseSummary[]>>

Example

const { data, error } = await client.knowledgeBase.list()

---

listDocuments()

listDocuments(kbId): Promise<FluxbaseResponse<KnowledgeBaseDocument[]>>

List documents in a knowledge base

Parameters

Parameter	Type	Description
kbId	string	Knowledge base ID

Returns

Promise<FluxbaseResponse<KnowledgeBaseDocument[]>>

---

listEntities()

listEntities(kbId, type?): Promise<FluxbaseResponse<AIEntity[]>>

List entities in a knowledge base

Parameters

Parameter	Type	Description
kbId	string	Knowledge base ID
type?	AIEntityType	Optional entity type filter

Returns

Promise<FluxbaseResponse<AIEntity[]>>

---

search()

search(kbId, request): Promise<FluxbaseResponse<SearchKnowledgeBaseResponse>>

Search a knowledge base using semantic similarity

Automatically embeds the query text and returns matching chunks.

Parameters

Parameter	Type	Description
kbId	string	Knowledge base ID
request	SearchKnowledgeBaseRequest	Search parameters

Returns

Promise<FluxbaseResponse<SearchKnowledgeBaseResponse>>

Example

const { data, error } = await client.knowledgeBase.search(kbId, {
  query: 'How to configure authentication?',
  max_chunks: 5,
  threshold: 0.8
})

data.results.forEach(result => {
  console.log(result.document_title, result.similarity)
  console.log(result.content)
})

---

searchEntities()

searchEntities(kbId, query): Promise<FluxbaseResponse<AIEntity[]>>

Search entities by name

Parameters

Parameter	Type	Description
kbId	string	Knowledge base ID
query	string	Search query

Returns

Promise<FluxbaseResponse<AIEntity[]>>

---

update()

update(id, updates): Promise<FluxbaseResponse<KnowledgeBase>>

Update a knowledge base

Parameters

Parameter	Type	Description
id	string	Knowledge base ID
updates	UpdateKnowledgeBaseRequest	Fields to update

Returns

Promise<FluxbaseResponse<KnowledgeBase>>

---

updateDocument()

updateDocument(kbId, docId, updates): Promise<FluxbaseResponse<KnowledgeBaseDocument>>

Update a document’s metadata

Parameters

Parameter	Type	Description
kbId	string	Knowledge base ID
docId	string	Document ID
updates	UpdateDocumentRequest	Fields to update

Returns

Promise<FluxbaseResponse<KnowledgeBaseDocument>>

---

uploadDocument()

uploadDocument(kbId, file, filename, metadata?): Promise<FluxbaseResponse<UploadDocumentResponse>>

Upload a file as a document

Supports: PDF, TXT, MD, HTML, CSV, DOCX, XLSX, RTF, EPUB, JSON (max 50MB)

Parameters

Parameter	Type	Description
kbId	string	Knowledge base ID
file	ArrayBuffer | Blob | File	File to upload (File, Blob, or ArrayBuffer)
filename	string	Name of the file
metadata?	Record<string, string>	Optional metadata

Returns

Promise<FluxbaseResponse<UploadDocumentResponse>>

Example

const file = new File(['content'], 'guide.pdf', { type: 'application/pdf' })
const { data } = await client.knowledgeBase.uploadDocument(kbId, file, 'guide.pdf')