IRetrievalAgent
@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?
optionalactivityMonitor?:ActivityMonitor
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:228
Inherited from
IWritableKnowledgeBox.activityMonitor
admin?
optionaladmin?:boolean
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:226
Inherited from
allowed_ip_addresses?
optionalallowed_ip_addresses?:string[] |null
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:41
Inherited from
IKnowledgeBoxBase.allowed_ip_addresses
allowed_origins?
optionalallowed_origins?:string[] |null
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:40
Inherited from
IKnowledgeBoxBase.allowed_origins
contrib?
optionalcontrib?:boolean
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:227
Inherited from
created?
optionalcreated?:string
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:39
Inherited from
description?
optionaldescription?:string
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:37
Inherited from
enforce_security?
optionalenforce_security?:boolean
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:45
Inherited from
IKnowledgeBoxBase.enforce_security
external_index_provider?
optionalexternal_index_provider?:string
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:46
Inherited from
IKnowledgeBoxBase.external_index_provider
fullpath
fullpath:
string
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:103
Inherited from
hidden_resources_enabled?
optionalhidden_resources_enabled?:boolean
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:43
Inherited from
IKnowledgeBoxBase.hidden_resources_enabled
hidden_resources_hide_on_creation?
optionalhidden_resources_hide_on_creation?:boolean
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:44
Inherited from
IKnowledgeBoxBase.hidden_resources_hide_on_creation
id
id:
string
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:33
Inherited from
path
path:
string
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:101
Inherited from
search_configs?
optionalsearch_configs?:object
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:42
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:34
Inherited from
state?
optionalstate?:KBStates
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:36
Inherited from
syncManager
syncManager:
SyncManager
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:230
Inherited from
IWritableKnowledgeBox.syncManager
taskManager
taskManager:
TaskManager
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:229
Inherited from
IWritableKnowledgeBox.taskManager
title
title:
string
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:35
Inherited from
zone
zone:
string
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:38
Inherited from
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
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
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
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
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
workflowId?
string
Returns
Observable<{ id: string; }>
addVectorset()
addVectorset(
model):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:278
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:123
Parameters
query
string
context?
features?
Features[]
options?
Returns
Observable<Answer | IErrorResponse>
Inherited from
Call Signature
ask(
query,context?,features?,options?,callback?):Observable<Answer|IErrorResponse>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:129
Parameters
query
string
context?
features?
Features[]
options?
callback?
(answer) => void
Returns
Observable<Answer | IErrorResponse>
Inherited from
askViaWS()
askViaWS(
agenticConfigId,question,keepOpen?,searchConfiguration?,groups?,chatHistory?):Observable<IErrorResponse|AragResponse>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:137
Parameters
agenticConfigId
string
question
string
keepOpen?
boolean
searchConfiguration?
string
groups?
string[]
chatHistory?
Returns
Observable<IErrorResponse | AragResponse>
Inherited from
batchUpload()
batchUpload(
files):Observable<UploadStatus>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:258
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:176
Parameters
query
string
options?
Returns
Observable<IErrorResponse | Results>
Inherited from
counters()
counters():
Observable<Counters>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:187
Returns
Observable<Counters>
Inherited from
createAgenticConfig()
createAgenticConfig(
id,config):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:296
Parameters
id
string
config
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:302
Parameters
id
string
source
Returns
Observable<void>
Inherited from
IWritableKnowledgeBox.createAgenticSource
createExtractStrategy()
createExtractStrategy(
config):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:282
Parameters
config
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:268
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:266
Parameters
data
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:244
Parameters
link
metadata?
synchronous?
boolean
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:242
Parameters
resource
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:290
Parameters
id
string
config
Returns
Observable<void>
Inherited from
IWritableKnowledgeBox.createSearchConfig
createServiceAccount()
createServiceAccount(
data):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:262
Parameters
data
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
Returns
Observable<SessionCreationResponse>
createSplitStrategy()
createSplitStrategy(
strategy):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:286
Parameters
strategy
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
Returns
Observable<void>
delete()
delete():
Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:236
Returns
Observable<void>
Inherited from
deleteAgenticConfig()
deleteAgenticConfig(
id):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:300
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:306
Parameters
id
string
Returns
Observable<void>
Inherited from
IWritableKnowledgeBox.deleteAgenticSource
deleteAllResources()
deleteAllResources(
filter):Observable<DeletedResources>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:312
Parameters
filter
Returns
Observable<DeletedResources>
Inherited from
IWritableKnowledgeBox.deleteAllResources
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:284
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:270
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:310
Returns
Observable<void>
Inherited from
IWritableKnowledgeBox.deleteProcessingHook
deleteSearchConfig()
deleteSearchConfig(
id):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:294
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:264
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:288
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:185
Parameters
answerId
string
good
boolean
feedback?
string
text_block_id?
string
Returns
Observable<void>
Inherited from
find()
find(
query,features?,options?):Observable<FindResults|IErrorResponse>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:146
Parameters
query
string
features?
Features[]
options?
Returns
Observable<FindResults | IErrorResponse>
Inherited from
generate()
generate(
question,context):Observable<{answer:string;cannotAnswer:boolean; }>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:164
Parameters
question
string
context
string[]
Returns
Observable<{ answer: string; cannotAnswer: boolean; }>
Inherited from
generateJSON()
generateJSON(
question,json_schema,context):Observable<{answer:object;success:boolean; }>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:166
Parameters
question
string
json_schema
object
context
string[]
Returns
Observable<{ answer: object; success: boolean; }>
Inherited from
getAgenticConfig()
getAgenticConfig(
id):Observable<AgenticConfig>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:217
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:219
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:194
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?
Returns
Observable<Driver[]>
getExtractStrategies()
getExtractStrategies():
Observable<ExtractStrategies>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:212
Returns
Observable<ExtractStrategies>
Inherited from
IKnowledgeBox.getExtractStrategies
getFacets()
getFacets(
facets):Observable<FacetsResult>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:109
Parameters
facets
string[]
Returns
Observable<FacetsResult>
Inherited from
getFullResource()
getFullResource(
uuid):Observable<IResource>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:115
Parameters
uuid
string
Returns
Observable<IResource>
Inherited from
getFullResourceBySlug()
getFullResourceBySlug(
slug):Observable<IResource>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:119
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:196
Returns
Observable<GenerativeProviders>
Inherited from
IKnowledgeBox.getGenerativeProviders
getLearningSchema()
getLearningSchema():
Observable<LearningConfigurations>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:195
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:222
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:113
Parameters
uuid
string
show?
extracted?
Returns
Observable<IResource>
Inherited from
getResourceBySlug()
getResourceBySlug(
slug,show?,extracted?):Observable<IResource>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:117
Parameters
slug
string
show?
extracted?
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:210
Parameters
id
string
Returns
Observable<SearchConfig>
Inherited from
getSearchConfigs()
getSearchConfigs():
Observable<SearchConfigs>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:216
Returns
Observable<SearchConfigs>
Inherited from
IKnowledgeBox.getSearchConfigs
getServiceAccounts()
getServiceAccounts():
Observable<ServiceAccount[]>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:260
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?
extracted?
Returns
Observable<IResource>
getSplitStrategies()
getSplitStrategies():
Observable<SplitStrategies>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:214
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:192
Parameters
payload?
any
ignoreExpiration?
boolean
Returns
Observable<string>
Inherited from
getUsers()
getUsers(
accountSlug):Observable<FullKbUser[]>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:198
Parameters
accountSlug
string
Returns
Observable<FullKbUser[]>
Inherited from
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
Returns
Observable<void>
inviteToKb()
inviteToKb(
data):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:276
Parameters
data
Returns
Observable<void>
Inherited from
IWritableKnowledgeBox.inviteToKb
listAgenticConfigs()
listAgenticConfigs():
Observable<AgenticConfigs>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:218
Returns
Observable<AgenticConfigs>
Inherited from
IKnowledgeBox.listAgenticConfigs
listAgenticSources()
listAgenticSources():
Observable<AgenticSources>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:220
Returns
Observable<AgenticSources>
Inherited from
IKnowledgeBox.listAgenticSources
listenToAllNotifications()
listenToAllNotifications():
Observable<NotificationMessage[]>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:200
Returns
Observable<NotificationMessage[]>
Inherited from
IKnowledgeBox.listenToAllNotifications
listenToProcessingNotifications()
listenToProcessingNotifications():
Observable<ResourceBaseNotification[]>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:201
Returns
Observable<ResourceBaseNotification[]>
Inherited from
IKnowledgeBox.listenToProcessingNotifications
listenToResourceOperationNotifications()
listenToResourceOperationNotifications():
Observable<ResourceOperationNotification[]>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:202
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:189
Parameters
page?
number
size?
number
Returns
Observable<ResourceList>
Inherited from
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:232
Parameters
data
Partial<IKnowledgeBox>
Returns
Observable<void>
Inherited from
patchContext()
patchContext(
agent,workflowId?):Observable<void>
Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:90
Parameters
agent
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
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
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
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
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:162
Parameters
question
string
options?
Returns
Observable<Answer | IErrorResponse>
Inherited from
processingStatus()
processingStatus(
cursor?,scheduled?,limit?):Observable<{cursor:string;results:ProcessingStatus[]; }>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:205
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:234
Parameters
published
boolean
Returns
Observable<void>
Inherited from
removeVectorset()
removeVectorset(
model):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:280
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:172
Parameters
question
string
user_context?
string[]
rephrase_prompt?
string
Returns
Observable<string>
Inherited from
requestActivityDownload()
requestActivityDownload(
options):Observable<DownloadStatus>
Defined in: libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:106
Parameters
options
Returns
Observable<DownloadStatus>
search()
search(
query,features?,options?):Observable<IErrorResponse|Results>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:152
Parameters
query
string
features?
Features[]
options?
Returns
Observable<IErrorResponse | Results>
Inherited from
setConfiguration()
setConfiguration(
config):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:272
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:203
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:178
Parameters
query
string
inTitleOnly?
boolean
features?
options?
Returns
Observable<IErrorResponse | Suggestions>
Inherited from
summarize()
summarize(
ressourceIds):Observable<string>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:158
Parameters
ressourceIds
string[]
Returns
Observable<string>
Inherited from
tokens()
tokens(
text):Observable<SentenceToken[]>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:160
Parameters
text
string
Returns
Observable<SentenceToken[]>
Inherited from
updateAgenticConfig()
updateAgenticConfig(
id,config):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:298
Parameters
id
string
config
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:304
Parameters
id
string
source
Returns
Observable<void>
Inherited from
IWritableKnowledgeBox.updateAgenticSource
updateProcessingHook()
updateProcessingHook(
data):Observable<ProcessingHook>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:308
Parameters
data
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:292
Parameters
id
string
config
Returns
Observable<void>
Inherited from
IWritableKnowledgeBox.updateSearchConfig
updateUsers()
updateUsers(
data):Observable<void>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:274
Parameters
data
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:251
Parameters
file
File | FileWithMetadata
TUS?
boolean
metadata?
Returns
Observable<UploadResponse>
Inherited from
Call Signature
upload(
buffer,TUS?,metadata?):Observable<UploadResponse>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:252
Parameters
buffer
ArrayBuffer
TUS?
boolean
metadata?
Returns
Observable<UploadResponse>
Inherited from
Call Signature
upload(
data,TUS?,metadata?):Observable<UploadResponse>
Defined in: libs/sdk-core/src/lib/db/kb/kb.models.ts:253
Parameters
data
File | FileWithMetadata | ArrayBuffer
TUS?
boolean
metadata?
Returns
Observable<UploadResponse>