Class: KnowledgeHandle

Defined in: packages/sdk/src/backend/knowledge.ts:86

A handle bound to one knowledge base.

Constructors

Constructor

new KnowledgeHandle(base, headers, name): KnowledgeHandle

Defined in: packages/sdk/src/backend/knowledge.ts:87

Parameters

base

string

headers

Record<string, string>

name

string

Returns

KnowledgeHandle

Properties

name

readonly name: string

Defined in: packages/sdk/src/backend/knowledge.ts:90

Methods

chat()

chat(messages, opts?): Promise<ChatResult>

Defined in: packages/sdk/src/backend/knowledge.ts:197

Grounded chat: answer the messages using the KB, with citations.

Parameters

messages

ChatMessage[]

opts?

topK?

number

Returns

Promise<ChatResult>

---

context()

context(query, opts?): Promise<RetrievedChunk[]>

Defined in: packages/sdk/src/backend/knowledge.ts:184

Retrieve the top-k relevant chunks (no LLM).

Parameters

query

string

opts?

filter?

Record<string, unknown>

topK?

number

Returns

Promise<RetrievedChunk[]>

---

deleteDocument()

deleteDocument(id): Promise<{ deleted: string; }>

Defined in: packages/sdk/src/backend/knowledge.ts:159

Parameters

id

string

Returns

Promise<{ deleted: string; }>

---

getDocument()

getDocument(id): Promise<DocumentInfo>

Defined in: packages/sdk/src/backend/knowledge.ts:152

Parameters

id

string

Returns

Promise<DocumentInfo>

---

listDocuments()

listDocuments(): Promise<DocumentInfo[]>

Defined in: packages/sdk/src/backend/knowledge.ts:145

Returns

Promise<DocumentInfo[]>

---

uploadFile()

uploadFile(filePath): Promise<DocumentInfo>

Defined in: packages/sdk/src/backend/knowledge.ts:131

Upload a local file (multipart).

Parameters

filePath

string

Returns

Promise<DocumentInfo>

---

uploadText()

uploadText(opts): Promise<DocumentInfo>

Defined in: packages/sdk/src/backend/knowledge.ts:115

Add a raw-text document.

Parameters

opts

text

string

title?

string

Returns

Promise<DocumentInfo>

---

uploadUrl()

uploadUrl(url): Promise<DocumentInfo>

Defined in: packages/sdk/src/backend/knowledge.ts:126

Add a document by URL (fetched + parsed server-side).

Parameters

url

string

Returns

Promise<DocumentInfo>

---

waitUntilReady()

waitUntilReady(opts?): Promise<DocumentInfo[]>

Defined in: packages/sdk/src/backend/knowledge.ts:167

Poll until every document is ready or failed (or timeout).

Parameters

opts?

intervalMs?

number

timeoutMs?

number

Returns

Promise<DocumentInfo[]>