IRetrievalAgent

@nuclia/core

---

@nuclia/core / IRetrievalAgent

Interface: IRetrievalAgent

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:51

Extends

• Omit<IWritableKnowledgeBox, "getEntities" | "getEntitiesGroup" | "getLabels" | "createAgenticRAGPipeline" | "generateRandomQuestionAboutResource" | "setLabelSet" | "deleteLabelSet">

Properties

activityMonitor?

optional activityMonitor?: ActivityMonitor

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:227

Inherited from

IWritableKnowledgeBox.activityMonitor

---

admin?

optional admin?: boolean

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:225

Inherited from

IWritableKnowledgeBox.admin

---

allowed_ip_addresses?

optional allowed_ip_addresses?: string[] | null

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:40

Inherited from

IKnowledgeBoxBase.allowed_ip_addresses

---

allowed_origins?

optional allowed_origins?: string[] | null

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:39

Inherited from

IKnowledgeBoxBase.allowed_origins

---

contrib?

optional contrib?: boolean

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:226

Inherited from

IWritableKnowledgeBox.contrib

---

created?

optional created?: string

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:38

Inherited from

IKnowledgeBoxBase.created

---

description?

optional description?: string

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:36

Inherited from

IKnowledgeBoxBase.description

---

enforce_security?

optional enforce_security?: boolean

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:44

Inherited from

IKnowledgeBoxBase.enforce_security

---

external_index_provider?

optional external_index_provider?: string

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:45

Inherited from

IKnowledgeBoxBase.external_index_provider

---

fullpath

fullpath: string

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:102

Inherited from

IKnowledgeBox.fullpath

---

hidden_resources_enabled?

optional hidden_resources_enabled?: boolean

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:42

Inherited from

IKnowledgeBoxBase.hidden_resources_enabled

---

hidden_resources_hide_on_creation?

optional hidden_resources_hide_on_creation?: boolean

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:43

Inherited from

IKnowledgeBoxBase.hidden_resources_hide_on_creation

---

id

id: string

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:32

Inherited from

IKnowledgeBoxBase.id

---

path

path: string

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:100

Inherited from

IKnowledgeBox.path

---

search_configs?

optional search_configs?: object

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:41

Index Signature

[key: string]: any

Inherited from

IKnowledgeBoxBase.search_configs

---

slug

slug: string

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:33

Inherited from

IKnowledgeBoxBase.slug

---

state?

optional state?: KBStates

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:35

Inherited from

IKnowledgeBoxBase.state

---

syncManager

syncManager: SyncManager

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:229

Inherited from

IWritableKnowledgeBox.syncManager

---

taskManager

taskManager: TaskManager

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:228

Inherited from

IWritableKnowledgeBox.taskManager

---

title

title: string

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:34

Inherited from

IKnowledgeBoxBase.title

---

zone

zone: string

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:37

Inherited from

IKnowledgeBoxBase.zone

Methods

addContext()

addContext(agent, workflowId?): Observable<{ id: string; }>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:89

Parameters

agent

ContextAgentCreation

workflowId?

string

Returns

Observable<{ id: string; }>

---

addDriver()

addDriver(driver): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:76

Parameters

driver

DriverCreation

Returns

Observable<void>

---

addGeneration()

addGeneration(agent, workflowId?): Observable<{ id: string; }>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:94

Parameters

agent

GenerationAgentCreation

workflowId?

string

Returns

Observable<{ id: string; }>

---

addPostprocess()

addPostprocess(agent, workflowId?): Observable<{ id: string; }>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:99

Parameters

agent

PostprocessAgentCreation

workflowId?

string

Returns

Observable<{ id: string; }>

---

addPreprocess()

addPreprocess(agent, workflowId?): Observable<{ id: string; }>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:84

Parameters

agent

PreprocessAgentCreation

workflowId?

string

Returns

Observable<{ id: string; }>

---

addVectorset()

addVectorset(model): Observable<void>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:277

Parameters

model

string

Returns

Observable<void>

Inherited from

IWritableKnowledgeBox.addVectorset

---

ask()

Call Signature

ask(query, context?, features?, options?): Observable<Answer | IErrorResponse>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:122

Parameters

query

string

context?

ContextEntry[]

features?

Features[]

options?

ChatOptions

Returns

Observable<Answer | IErrorResponse>

Inherited from

IKnowledgeBox.ask

Call Signature

ask(query, context?, features?, options?, callback?): Observable<Answer | IErrorResponse>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:128

Parameters

query

string

context?

ContextEntry[]

features?

Features[]

options?

ChatOptions

callback?

(answer) => void

Returns

Observable<Answer | IErrorResponse>

Inherited from

IKnowledgeBox.ask

---

askViaWS()

askViaWS(agenticConfigId, question, keepOpen?, searchConfiguration?, groups?, chatHistory?): Observable<IErrorResponse | AragResponse>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:136

Parameters

agenticConfigId

string

question

string

keepOpen?

boolean

searchConfiguration?

string

groups?

string[]

chatHistory?

HistoryEntry[]

Returns

Observable<IErrorResponse | AragResponse>

Inherited from

IKnowledgeBox.askViaWS

---

batchUpload()

batchUpload(files): Observable<UploadStatus>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:257

Parameters

files

FileList | File[] | FileWithMetadata[]

Returns

Observable<UploadStatus>

Inherited from

IWritableKnowledgeBox.batchUpload

---

catalog()

catalog(query, options?): Observable<IErrorResponse | Results>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:175

Parameters

query

string

options?

CatalogOptions

Returns

Observable<IErrorResponse | Results>

Inherited from

IKnowledgeBox.catalog

---

counters()

counters(): Observable<Counters>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:186

Returns

Observable<Counters>

Inherited from

IKnowledgeBox.counters

---

createAgenticConfig()

createAgenticConfig(id, config): Observable<void>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:295

Parameters

id

string

config

AgenticConfig

Returns

Observable<void>

Inherited from

IWritableKnowledgeBox.createAgenticConfig

---

createAgenticSource()

createAgenticSource(id, source): Observable<void>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:301

Parameters

id

string

source

AgenticSource

Returns

Observable<void>

Inherited from

IWritableKnowledgeBox.createAgenticSource

---

createExtractStrategy()

createExtractStrategy(config): Observable<void>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:281

Parameters

config

ExtractConfig

Returns

Observable<void>

Inherited from

IWritableKnowledgeBox.createExtractStrategy

---

createKey()

createKey(serviceAccountId, expires): Observable<{ token: string; }>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:267

Parameters

serviceAccountId

string

expires

string

Returns

Observable<{ token: string; }>

Inherited from

IWritableKnowledgeBox.createKey

---

createKeyForService()

createKeyForService(data, expires): Observable<{ token: string; }>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:265

Parameters

data

ServiceAccountCreation

expires

string

Returns

Observable<{ token: string; }>

Inherited from

IWritableKnowledgeBox.createKeyForService

---

createLinkResource()

createLinkResource(link, metadata?, synchronous?, origin?): Observable<{ uuid: string; }>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:243

Parameters

link

LinkField

metadata?

UserMetadata

synchronous?

boolean

origin?

Origin

Returns

Observable<{ uuid: string; }>

Inherited from

IWritableKnowledgeBox.createLinkResource

---

createResource()

createResource(resource, synchronous): Observable<{ uuid: string; }>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:241

Parameters

resource

IResource

synchronous

boolean

Returns

Observable<{ uuid: string; }>

Inherited from

IWritableKnowledgeBox.createResource

---

createSearchConfig()

createSearchConfig(id, config): Observable<void>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:289

Parameters

id

string

config

SearchConfig

Returns

Observable<void>

Inherited from

IWritableKnowledgeBox.createSearchConfig

---

createServiceAccount()

createServiceAccount(data): Observable<void>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:261

Parameters

data

ServiceAccountCreation

Returns

Observable<void>

Inherited from

IWritableKnowledgeBox.createServiceAccount

---

createSession()

createSession(session): Observable<SessionCreationResponse>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:63

Parameters

session

SessionCreation

Returns

Observable<SessionCreationResponse>

---

createSplitStrategy()

createSplitStrategy(strategy): Observable<void>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:285

Parameters

strategy

SplitStrategy

Returns

Observable<void>

Inherited from

IWritableKnowledgeBox.createSplitStrategy

---

createWorkflow()

createWorkflow(data): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:111

Parameters

data

Workflow

Returns

Observable<void>

---

delete()

delete(): Observable<void>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:235

Returns

Observable<void>

Inherited from

IWritableKnowledgeBox.delete

---

deleteAgenticConfig()

deleteAgenticConfig(id): Observable<void>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:299

Parameters

id

string

Returns

Observable<void>

Inherited from

IWritableKnowledgeBox.deleteAgenticConfig

---

deleteAgenticSource()

deleteAgenticSource(id): Observable<void>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:305

Parameters

id

string

Returns

Observable<void>

Inherited from

IWritableKnowledgeBox.deleteAgenticSource

---

deleteContext()

deleteContext(agentId, workflowId?): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:91

Parameters

agentId

string

workflowId?

string

Returns

Observable<void>

---

deleteDriver()

deleteDriver(driverId): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:78

Parameters

driverId

string

Returns

Observable<void>

---

deleteExtractStrategy()

deleteExtractStrategy(id): Observable<void>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:283

Parameters

id

string

Returns

Observable<void>

Inherited from

IWritableKnowledgeBox.deleteExtractStrategy

---

deleteGeneration()

deleteGeneration(agentId, workflowId?): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:96

Parameters

agentId

string

workflowId?

string

Returns

Observable<void>

---

deleteKey()

deleteKey(serviceAccountId, serviceAccountKeyId): Observable<void>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:269

Parameters

serviceAccountId

string

serviceAccountKeyId

string

Returns

Observable<void>

Inherited from

IWritableKnowledgeBox.deleteKey

---

deletePostprocess()

deletePostprocess(agentId, workflowId?): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:101

Parameters

agentId

string

workflowId?

string

Returns

Observable<void>

---

deletePreprocess()

deletePreprocess(agentId, workflowId?): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:86

Parameters

agentId

string

workflowId?

string

Returns

Observable<void>

---

deleteProcessingHook()

deleteProcessingHook(): Observable<void>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:309

Returns

Observable<void>

Inherited from

IWritableKnowledgeBox.deleteProcessingHook

---

deleteSearchConfig()

deleteSearchConfig(id): Observable<void>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:293

Parameters

id

string

Returns

Observable<void>

Inherited from

IWritableKnowledgeBox.deleteSearchConfig

---

deleteServiceAccount()

deleteServiceAccount(serviceAccountId): Observable<void>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:263

Parameters

serviceAccountId

string

Returns

Observable<void>

Inherited from

IWritableKnowledgeBox.deleteServiceAccount

---

deleteSplitStrategy()

deleteSplitStrategy(id): Observable<void>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:287

Parameters

id

string

Returns

Observable<void>

Inherited from

IWritableKnowledgeBox.deleteSplitStrategy

---

deleteWorkflow()

deleteWorkflow(workflowId): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:113

Parameters

workflowId

string

Returns

Observable<void>

---

feedback()

feedback(answerId, good, feedback?, text_block_id?): Observable<void>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:184

Parameters

answerId

string

good

boolean

feedback?

string

text_block_id?

string

Returns

Observable<void>

Inherited from

IKnowledgeBox.feedback

---

find()

find(query, features?, options?): Observable<FindResults | IErrorResponse>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:145

Parameters

query

string

features?

Features[]

options?

SearchOptions

Returns

Observable<FindResults | IErrorResponse>

Inherited from

IKnowledgeBox.find

---

generate()

generate(question, context): Observable<{ answer: string; cannotAnswer: boolean; }>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:163

Parameters

question

string

context

string[]

Returns

Observable<{ answer: string; cannotAnswer: boolean; }>

Inherited from

IKnowledgeBox.generate

---

generateJSON()

generateJSON(question, json_schema, context): Observable<{ answer: object; success: boolean; }>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:165

Parameters

question

string

json_schema

object

context

string[]

Returns

Observable<{ answer: object; success: boolean; }>

Inherited from

IKnowledgeBox.generateJSON

---

getAgenticConfig()

getAgenticConfig(id): Observable<AgenticConfig>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:216

Parameters

id

string

Returns

Observable<AgenticConfig>

Inherited from

IKnowledgeBox.getAgenticConfig

---

getAgenticSource()

getAgenticSource(id): Observable<AgenticSource>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:218

Parameters

id

string

Returns

Observable<AgenticSource>

Inherited from

IKnowledgeBox.getAgenticSource

---

getConfiguration()

getConfiguration(): Observable<{[id: string]: any; }>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:193

Returns

Observable<{[id: string]: any; }>

Inherited from

IKnowledgeBox.getConfiguration

---

getContext()

getContext(workflowId?): Observable<ContextAgent[]>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:88

Parameters

workflowId?

string

Returns

Observable<ContextAgent[]>

---

getDownload()

getDownload(requestId): Observable<DownloadStatus>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:108

Parameters

requestId

string

Returns

Observable<DownloadStatus>

---

getDownloads()

getDownloads(): Observable<DownloadStatus[]>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:107

Returns

Observable<DownloadStatus[]>

---

getDrivers()

getDrivers(provider?): Observable<Driver[]>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:75

Parameters

provider?

ProviderType

Returns

Observable<Driver[]>

---

getExtractStrategies()

getExtractStrategies(): Observable<ExtractStrategies>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:211

Returns

Observable<ExtractStrategies>

Inherited from

IKnowledgeBox.getExtractStrategies

---

getFacets()

getFacets(facets): Observable<FacetsResult>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:108

Parameters

facets

string[]

Returns

Observable<FacetsResult>

Inherited from

IKnowledgeBox.getFacets

---

getFullResource()

getFullResource(uuid): Observable<IResource>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:114

Parameters

uuid

string

Returns

Observable<IResource>

Inherited from

IKnowledgeBox.getFullResource

---

getFullResourceBySlug()

getFullResourceBySlug(slug): Observable<IResource>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:118

Parameters

slug

string

Returns

Observable<IResource>

Inherited from

IKnowledgeBox.getFullResourceBySlug

---

getFullSchemas()

getFullSchemas(): Observable<JSONSchema4>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:104

Returns

Observable<JSONSchema4>

---

getGeneration()

getGeneration(workflowId?): Observable<GenerationAgent[]>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:93

Parameters

workflowId?

string

Returns

Observable<GenerationAgent[]>

---

getGenerativeProviders()

getGenerativeProviders(): Observable<GenerativeProviders>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:195

Returns

Observable<GenerativeProviders>

Inherited from

IKnowledgeBox.getGenerativeProviders

---

getLearningSchema()

getLearningSchema(): Observable<LearningConfigurations>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:194

Returns

Observable<LearningConfigurations>

Inherited from

IKnowledgeBox.getLearningSchema

---

getPostprocess()

getPostprocess(workflowId?): Observable<PostprocessAgent[]>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:98

Parameters

workflowId?

string

Returns

Observable<PostprocessAgent[]>

---

getPreprocess()

getPreprocess(workflowId?): Observable<PreprocessAgent[]>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:83

Parameters

workflowId?

string

Returns

Observable<PreprocessAgent[]>

---

getProcessingHook()

getProcessingHook(): Observable<ProcessingHook | undefined>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:221

Returns

Observable<ProcessingHook | undefined>

Inherited from

IKnowledgeBox.getProcessingHook

---

getResource()

getResource(uuid, show?, extracted?): Observable<IResource>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:112

Parameters

uuid

string

show?

ResourceProperties[]

extracted?

ExtractedDataTypes[]

Returns

Observable<IResource>

Inherited from

IKnowledgeBox.getResource

---

getResourceBySlug()

getResourceBySlug(slug, show?, extracted?): Observable<IResource>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:116

Parameters

slug

string

show?

ResourceProperties[]

extracted?

ExtractedDataTypes[]

Returns

Observable<IResource>

Inherited from

IKnowledgeBox.getResourceBySlug

---

getRules()

getRules(workflowId?): Observable<(string | Rule)[]>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:80

Parameters

workflowId?

string

Returns

Observable<(string | Rule)[]>

---

getSchemas()

getSchemas(): Observable<ARAGSchemas>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:103

Returns

Observable<ARAGSchemas>

---

getSearchConfig()

getSearchConfig(id): Observable<SearchConfig>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:209

Parameters

id

string

Returns

Observable<SearchConfig>

Inherited from

IKnowledgeBox.getSearchConfig

---

getSearchConfigs()

getSearchConfigs(): Observable<SearchConfigs>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:215

Returns

Observable<SearchConfigs>

Inherited from

IKnowledgeBox.getSearchConfigs

---

getServiceAccounts()

getServiceAccounts(): Observable<ServiceAccount[]>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:259

Returns

Observable<ServiceAccount[]>

Inherited from

IWritableKnowledgeBox.getServiceAccounts

---

getSession()

getSession(uuid, show?, extracted?): Observable<IResource>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:61

Parameters

uuid

string

show?

ResourceProperties[]

extracted?

ExtractedDataTypes[]

Returns

Observable<IResource>

---

getSplitStrategies()

getSplitStrategies(): Observable<SplitStrategies>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:213

Returns

Observable<SplitStrategies>

Inherited from

IKnowledgeBox.getSplitStrategies

---

getTempToken()

getTempToken(payload?, ignoreExpiration?): Observable<string>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:191

Parameters

payload?

any

ignoreExpiration?

boolean

Returns

Observable<string>

Inherited from

IKnowledgeBox.getTempToken

---

getUsers()

getUsers(accountSlug): Observable<FullKbUser[]>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:197

Parameters

accountSlug

string

Returns

Observable<FullKbUser[]>

Inherited from

IKnowledgeBox.getUsers

---

getWorkflows()

getWorkflows(): Observable<Workflow[]>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:110

Returns

Observable<Workflow[]>

---

interact()

interact(sessionId, question, workflowId?, method?, headers?): Observable<IErrorResponse | { answer: AragAnswer; type: "answer"; }>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:64

Parameters

sessionId

string

question

string

workflowId?

string

method?

"POST" | "WS"

headers?

Returns

Observable<IErrorResponse | { answer: AragAnswer; type: "answer"; }>

---

inviteToAgent()

inviteToAgent(data): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:73

Parameters

data

InviteKbData

Returns

Observable<void>

---

inviteToKb()

inviteToKb(data): Observable<void>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:275

Parameters

data

InviteKbData

Returns

Observable<void>

Inherited from

IWritableKnowledgeBox.inviteToKb

---

listAgenticConfigs()

listAgenticConfigs(): Observable<AgenticConfigs>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:217

Returns

Observable<AgenticConfigs>

Inherited from

IKnowledgeBox.listAgenticConfigs

---

listAgenticSources()

listAgenticSources(): Observable<AgenticSources>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:219

Returns

Observable<AgenticSources>

Inherited from

IKnowledgeBox.listAgenticSources

---

listenToAllNotifications()

listenToAllNotifications(): Observable<NotificationMessage[]>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:199

Returns

Observable<NotificationMessage[]>

Inherited from

IKnowledgeBox.listenToAllNotifications

---

listenToProcessingNotifications()

listenToProcessingNotifications(): Observable<ResourceBaseNotification[]>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:200

Returns

Observable<ResourceBaseNotification[]>

Inherited from

IKnowledgeBox.listenToProcessingNotifications

---

listenToResourceOperationNotifications()

listenToResourceOperationNotifications(): Observable<ResourceOperationNotification[]>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:201

Returns

Observable<ResourceOperationNotification[]>

Inherited from

IKnowledgeBox.listenToResourceOperationNotifications

---

listResources()

listResources(page?, size?): Observable<ResourceList>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:188

Parameters

page?

number

size?

number

Returns

Observable<ResourceList>

Inherited from

IKnowledgeBox.listResources

---

listSessions()

listSessions(page?, size?): Observable<SessionList>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:62

Parameters

page?

number

size?

number

Returns

Observable<SessionList>

---

modify()

modify(data): Observable<void>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:231

Parameters

data

Partial<IKnowledgeBox>

Returns

Observable<void>

Inherited from

IWritableKnowledgeBox.modify

---

patchContext()

patchContext(agent, workflowId?): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:90

Parameters

agent

ContextAgent

workflowId?

string

Returns

Observable<void>

---

patchDriver()

patchDriver(driver): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:77

Parameters

driver

Driver

Returns

Observable<void>

---

patchGeneration()

patchGeneration(agent, workflowId?): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:95

Parameters

agent

GenerationAgent

workflowId?

string

Returns

Observable<void>

---

patchPostprocess()

patchPostprocess(agent, workflowId?): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:100

Parameters

agent

PostprocessAgent

workflowId?

string

Returns

Observable<void>

---

patchPreprocess()

patchPreprocess(agent, workflowId?): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:85

Parameters

agent

PreprocessAgent

workflowId?

string

Returns

Observable<void>

---

patchWorkflow()

patchWorkflow(workflowId, data): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:112

Parameters

workflowId

string

data

Omit<Workflow, "id">

Returns

Observable<void>

---

predictAnswer()

predictAnswer(question, options?): Observable<Answer | IErrorResponse>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:161

Parameters

question

string

options?

PredictAnswerOptions

Returns

Observable<Answer | IErrorResponse>

Inherited from

IKnowledgeBox.predictAnswer

---

processingStatus()

processingStatus(cursor?, scheduled?, limit?): Observable<{ cursor: string; results: ProcessingStatus[]; }>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:204

Parameters

cursor?

string

scheduled?

boolean

limit?

number

Returns

Observable<{ cursor: string; results: ProcessingStatus[]; }>

Inherited from

IKnowledgeBox.processingStatus

---

publish()

publish(published): Observable<void>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:233

Parameters

published

boolean

Returns

Observable<void>

Inherited from

IWritableKnowledgeBox.publish

---

removeVectorset()

removeVectorset(model): Observable<void>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:279

Parameters

model

string

Returns

Observable<void>

Inherited from

IWritableKnowledgeBox.removeVectorset

---

rephrase()

rephrase(question, user_context?, rephrase_prompt?): Observable<string>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:171

Parameters

question

string

user_context?

string[]

rephrase_prompt?

string

Returns

Observable<string>

Inherited from

IKnowledgeBox.rephrase

---

requestActivityDownload()

requestActivityDownload(options): Observable<DownloadStatus>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:106

Parameters

options

DownloadOptions

Returns

Observable<DownloadStatus>

---

search()

search(query, features?, options?): Observable<IErrorResponse | Results>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:151

Parameters

query

string

features?

Features[]

options?

SearchOptions

Returns

Observable<IErrorResponse | Results>

Inherited from

IKnowledgeBox.search

---

setConfiguration()

setConfiguration(config): Observable<void>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:271

Parameters

config

Returns

Observable<void>

Inherited from

IWritableKnowledgeBox.setConfiguration

---

setRules()

setRules(rules, workflowId?): Observable<void>

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:81

Parameters

rules

string[]

workflowId?

string

Returns

Observable<void>

---

stopInteraction()

stopInteraction(sessionId): void

Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:71

Parameters

sessionId

string

Returns

void

---

stopListeningToNotifications()

stopListeningToNotifications(): void

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:202

Returns

void

Inherited from

IKnowledgeBox.stopListeningToNotifications

---

suggest()

suggest(query, inTitleOnly?, features?, options?): Observable<IErrorResponse | Suggestions>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:177

Parameters

query

string

inTitleOnly?

boolean

features?

SuggestionFeatures[]

options?

SuggestOptions

Returns

Observable<IErrorResponse | Suggestions>

Inherited from

IKnowledgeBox.suggest

---

summarize()

summarize(ressourceIds): Observable<string>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:157

Parameters

ressourceIds

string[]

Returns

Observable<string>

Inherited from

IKnowledgeBox.summarize

---

tokens()

tokens(text): Observable<SentenceToken[]>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:159

Parameters

text

string

Returns

Observable<SentenceToken[]>

Inherited from

IKnowledgeBox.tokens

---

updateAgenticConfig()

updateAgenticConfig(id, config): Observable<void>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:297

Parameters

id

string

config

AgenticConfig

Returns

Observable<void>

Inherited from

IWritableKnowledgeBox.updateAgenticConfig

---

updateAgenticSource()

updateAgenticSource(id, source): Observable<void>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:303

Parameters

id

string

source

AgenticSource

Returns

Observable<void>

Inherited from

IWritableKnowledgeBox.updateAgenticSource

---

updateProcessingHook()

updateProcessingHook(data): Observable<ProcessingHook>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:307

Parameters

data

ProcessingHook

Returns

Observable<ProcessingHook>

Inherited from

IWritableKnowledgeBox.updateProcessingHook

---

updateSearchConfig()

updateSearchConfig(id, config): Observable<void>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:291

Parameters

id

string

config

SearchConfig

Returns

Observable<void>

Inherited from

IWritableKnowledgeBox.updateSearchConfig

---

updateUsers()

updateUsers(data): Observable<void>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:273

Parameters

data

KbUserPayload

Returns

Observable<void>

Inherited from

IWritableKnowledgeBox.updateUsers

---

upload()

Call Signature

upload(file, TUS?, metadata?): Observable<UploadResponse>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:250

Parameters

file

File | FileWithMetadata

TUS?

boolean

metadata?

FileMetadata

Returns

Observable<UploadResponse>

Inherited from

IWritableKnowledgeBox.upload

Call Signature

upload(buffer, TUS?, metadata?): Observable<UploadResponse>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:251

Parameters

buffer

ArrayBuffer

TUS?

boolean

metadata?

FileMetadata

Returns

Observable<UploadResponse>

Inherited from

IWritableKnowledgeBox.upload

Call Signature

upload(data, TUS?, metadata?): Observable<UploadResponse>

Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:252

Parameters

data

File | FileWithMetadata | ArrayBuffer

TUS?

boolean

metadata?

FileMetadata

Returns

Observable<UploadResponse>

Inherited from

IWritableKnowledgeBox.upload