Skip to main content

IDb

@nuclia/core

@nuclia/core / IDb

Interface: IDb

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

Methods​

addModelToKb()​

addModelToKb(modelId, accountId, kbId, zone): Observable<void>

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

Parameters​

modelId​

string

accountId​

string

kbId​

string

zone​

string

Returns​

Observable<void>

createAccount()​

createAccount(account): Observable<Account>

Defined in: libs/sdk-core/src/lib/models.ts:154

Parameters​

account​

AccountCreation

Returns​

Observable<Account>

createKnowledgeBox()​

createKnowledgeBox(accountId, knowledgeBox, zone?): Observable<WritableKnowledgeBox>

Defined in: libs/sdk-core/src/lib/models.ts:176

Parameters​

accountId​

string

knowledgeBox​

KnowledgeBoxCreation

zone?​

string

Returns​

Observable<WritableKnowledgeBox>

createModelConfiguration()​

createModelConfiguration(model, accountId, zone): Observable<{ id: string; }>

Defined in: libs/sdk-core/src/lib/models.ts:247

Parameters​

model​

ModelConfigurationCreation

accountId​

string

zone​

string

Returns​

Observable<{ id: string; }>

createNUAClient()​

Call Signature​

createNUAClient(accountId, data): Observable<NUAClientResponse>

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

Parameters​
accountId​

string

data​

NUAClientPayload

Returns​

Observable<NUAClientResponse>

Call Signature​

createNUAClient(accountId, data, zone): Observable<NUAClientResponse>

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

Parameters​
accountId​

string

data​

NUAClientPayload

zone​

string

Returns​

Observable<NUAClientResponse>

createNuaGuardPolicy()​

createNuaGuardPolicy(accountId, zone, data): Observable<NuaGuardPolicy>

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

Parameters​

accountId​

string

zone​

string

data​

NuaGuardPolicyPayload

Returns​

Observable<NuaGuardPolicy>

createRetrievalAgent()​

createRetrievalAgent(accountId, retrievalAgent, zone): Observable<RetrievalAgent>

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

Parameters​

accountId​

string

retrievalAgent​

RetrievalAgentCreation

zone​

string

Returns​

Observable<RetrievalAgent>

deleteAccount()​

deleteAccount(accountSlug, otpCode?): Observable<void>

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

Parameters​

accountSlug​

string

otpCode?​

string

Returns​

Observable<void>

deleteAccountInvitation()​

deleteAccountInvitation(accountId, email): Observable<void>

Defined in: libs/sdk-core/src/lib/models.ts:240

Parameters​

accountId​

string

email​

string

Returns​

Observable<void>

deleteModelConfiguration()​

deleteModelConfiguration(modelId, accountId, zone): Observable<void>

Defined in: libs/sdk-core/src/lib/models.ts:258

Parameters​

modelId​

string

accountId​

string

zone​

string

Returns​

Observable<void>

deleteModelFromKb()​

deleteModelFromKb(modelId, accountId, kbId, zone): Observable<void>

Defined in: libs/sdk-core/src/lib/models.ts:244

Parameters​

modelId​

string

accountId​

string

kbId​

string

zone​

string

Returns​

Observable<void>

deleteNUAClient()​

Call Signature​

deleteNUAClient(accountId, internalId): Observable<void>

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

Parameters​
accountId​

string

internalId​

string

Returns​

Observable<void>

Call Signature​

deleteNUAClient(accountId, internalId, zone): Observable<void>

Defined in: libs/sdk-core/src/lib/models.ts:222

Parameters​
accountId​

string

internalId​

string

zone​

string

Returns​

Observable<void>

deleteNuaGuardPolicy()​

deleteNuaGuardPolicy(guardId, accountId, zone): Observable<void>

Defined in: libs/sdk-core/src/lib/models.ts:270

Parameters​

guardId​

string

accountId​

string

zone​

string

Returns​

Observable<void>

editNUAClient()​

editNUAClient(accountId, internalId, data, zone): Observable<NUAClient>

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

Parameters​

accountId​

string

internalId​

string

data​

NUAClientEditPayload

zone​

string

Returns​

Observable<NUAClient>

editNuaGuardPolicy()​

editNuaGuardPolicy(guardId, accountId, zone, data): Observable<NuaGuardPolicy>

Defined in: libs/sdk-core/src/lib/models.ts:264

Parameters​

guardId​

string

accountId​

string

zone​

string

data​

Partial<NuaGuardPolicyPayload>

Returns​

Observable<NuaGuardPolicy>

getAccount()​

Call Signature​

getAccount(): Observable<Account>

Defined in: libs/sdk-core/src/lib/models.ts:160

Returns​

Observable<Account>

Call Signature​

getAccount(accountIdOrSlug?): Observable<Account>

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

Parameters​
accountIdOrSlug?​

string

Returns​

Observable<Account>

getAccountInvitations()​

getAccountInvitations(accountId): Observable<PendingInvitation[]>

Defined in: libs/sdk-core/src/lib/models.ts:239

Parameters​

accountId​

string

Returns​

Observable<PendingInvitation[]>

getAccounts()​

getAccounts(): Observable<Account[]>

Defined in: libs/sdk-core/src/lib/models.ts:152

Returns​

Observable<Account[]>

getAccountStatus()​

getAccountStatus(accountSlug): Observable<AccountStatus>

Defined in: libs/sdk-core/src/lib/models.ts:155

Parameters​

accountSlug​

string

Returns​

Observable<AccountStatus>

getAccountUser()​

getAccountUser(accountSlug, userId): Observable<Partial<FullAccountUser>>

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

Parameters​

accountSlug​

string

userId​

string

Returns​

Observable<Partial<FullAccountUser>>

getAccountUsers()​

getAccountUsers(accountSlug): Observable<FullAccountUser[]>

Defined in: libs/sdk-core/src/lib/models.ts:236

Parameters​

accountSlug​

string

Returns​

Observable<FullAccountUser[]>

getKbIndexes()​

getKbIndexes(accountSlug): Observable<KbIndex[]>

Defined in: libs/sdk-core/src/lib/models.ts:153

Parameters​

accountSlug​

string

Returns​

Observable<KbIndex[]>

getKnowledgeBox()​

Call Signature​

getKnowledgeBox(): Observable<WritableKnowledgeBox>

Defined in: libs/sdk-core/src/lib/models.ts:174

Returns​

Observable<WritableKnowledgeBox>

Call Signature​

getKnowledgeBox(accountId, knowledgeBoxId, zone?): Observable<WritableKnowledgeBox>

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

Parameters​
accountId​

string

knowledgeBoxId​

string

zone?​

string

Returns​

Observable<WritableKnowledgeBox>

getKnowledgeBoxes()​

Call Signature​

getKnowledgeBoxes(): Observable<IKnowledgeBoxItem[]>

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

Returns​

Observable<IKnowledgeBoxItem[]>

Call Signature​

getKnowledgeBoxes(accountSlug, accountId, includeSearchConfigs?): Observable<IKnowledgeBoxItem[]>

Defined in: libs/sdk-core/src/lib/models.ts:164

Parameters​
accountSlug​

string

accountId​

string

includeSearchConfigs?​

boolean

Returns​

Observable<IKnowledgeBoxItem[]>

getKnowledgeBoxesForZone()​

getKnowledgeBoxesForZone(accountId, zone, includeSearchConfigs?): Observable<IKnowledgeBoxItem[]>

Defined in: libs/sdk-core/src/lib/models.ts:169

Parameters​

accountId​

string

zone​

string

includeSearchConfigs?​

boolean

Returns​

Observable<IKnowledgeBoxItem[]>

getLearningSchema()​

getLearningSchema(accountId, zone): Observable<LearningConfigurations>

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

Parameters​

accountId​

string

zone​

string

Returns​

Observable<LearningConfigurations>

getModel()​

getModel(modelId, accountId, zone): Observable<CustomModel>

Defined in: libs/sdk-core/src/lib/models.ts:242

Parameters​

modelId​

string

accountId​

string

zone​

string

Returns​

Observable<CustomModel>

getModelConfiguration()​

getModelConfiguration(modelId, accountId, zone): Observable<ModelConfiguration>

Defined in: libs/sdk-core/src/lib/models.ts:246

Parameters​

modelId​

string

accountId​

string

zone​

string

Returns​

Observable<ModelConfiguration>

getModelConfigurations()​

getModelConfigurations(accountId, zone): Observable<ModelConfigurationItem[]>

Defined in: libs/sdk-core/src/lib/models.ts:245

Parameters​

accountId​

string

zone​

string

Returns​

Observable<ModelConfigurationItem[]>

getModels()​

getModels(accountId, zone): Observable<CustomModelItem[]>

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

Parameters​

accountId​

string

zone​

string

Returns​

Observable<CustomModelItem[]>

getNUAActivity()​

getNUAActivity(accountId, client_id, zoneSlug, pageIndex?): Observable<EventList>

Defined in: libs/sdk-core/src/lib/models.ts:224

Parameters​

accountId​

string

client_id​

string

zoneSlug​

string

pageIndex?​

number

Returns​

Observable<EventList>

getNUAClient()​

getNUAClient(accountId, client_id, zone): Observable<NUAClient>

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

Parameters​

accountId​

string

client_id​

string

zone​

string

Returns​

Observable<NUAClient>

getNUAClients()​

getNUAClients(accountId): Observable<NUAClient[]>

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

Parameters​

accountId​

string

Returns​

Observable<NUAClient[]>

getNUAClientsForZone()​

getNUAClientsForZone(accountId, zoneSlug): Observable<NUAClient[]>

Defined in: libs/sdk-core/src/lib/models.ts:214

Parameters​

accountId​

string

zoneSlug​

string

Returns​

Observable<NUAClient[]>

getNuaGuardPolicies()​

getNuaGuardPolicies(accountId): Observable<NuaGuardPolicy[]>

Defined in: libs/sdk-core/src/lib/models.ts:260

Parameters​

accountId​

string

Returns​

Observable<NuaGuardPolicy[]>

getNuaGuardPoliciesForZone()​

getNuaGuardPoliciesForZone(accountId, zone): Observable<NuaGuardPolicy[]>

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

Parameters​

accountId​

string

zone​

string

Returns​

Observable<NuaGuardPolicy[]>

getNuaGuardPolicy()​

getNuaGuardPolicy(guardId, accountId, zone): Observable<NuaGuardPolicy | undefined>

Defined in: libs/sdk-core/src/lib/models.ts:262

Parameters​

guardId​

string

accountId​

string

zone​

string

Returns​

Observable<NuaGuardPolicy | undefined>

getRetrievalAgent()​

Call Signature​

getRetrievalAgent(): Observable<RetrievalAgent>

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

Returns​

Observable<RetrievalAgent>

Call Signature​

getRetrievalAgent(accountId, retrievalAgentId, zone?): Observable<RetrievalAgent>

Defined in: libs/sdk-core/src/lib/models.ts:196

Parameters​
accountId​

string

retrievalAgentId​

string

zone?​

string

Returns​

Observable<RetrievalAgent>

getRetrievalAgents()​

Call Signature​

getRetrievalAgents(): Observable<IKnowledgeBoxItem[]>

Defined in: libs/sdk-core/src/lib/models.ts:182

Returns​

Observable<IKnowledgeBoxItem[]>

Call Signature​

getRetrievalAgents(accountSlug, accountId, mode?, includeSearchConfigs?): Observable<IKnowledgeBoxItem[]>

Defined in: libs/sdk-core/src/lib/models.ts:183

Parameters​
accountSlug​

string

accountId​

string

mode?​

KnowledgeBoxMode

includeSearchConfigs?​

boolean

Returns​

Observable<IKnowledgeBoxItem[]>

getRetrievalAgentsForZone()​

getRetrievalAgentsForZone(accountId, zone, mode?, includeSearchConfigs?): Observable<IKnowledgeBoxItem[]>

Defined in: libs/sdk-core/src/lib/models.ts:189

Parameters​

accountId​

string

zone​

string

mode?​

KnowledgeBoxMode

includeSearchConfigs?​

boolean

Returns​

Observable<IKnowledgeBoxItem[]>

getSignupInfo()​

getSignupInfo(signup_token): Observable<SignUpInfo>

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

Parameters​

signup_token​

string

Returns​

Observable<SignUpInfo>

getStandaloneKbs()​

getStandaloneKbs(): Observable<IStandaloneKb[]>

Defined in: libs/sdk-core/src/lib/models.ts:162

Returns​

Observable<IStandaloneKb[]>

getUsage()​

getUsage(accountId, from, to?, knowledgeBox?, aggregation?, nuaKeyId?): Observable<UsagePoint[]>

Defined in: libs/sdk-core/src/lib/models.ts:203

Parameters​

accountId​

string

from​

string

to?​

string

knowledgeBox?​

string

aggregation?​

UsageAggregation

nuaKeyId?​

string

Returns​

Observable<UsagePoint[]>

getWelcome()​

getWelcome(): Observable<Welcome>

Defined in: libs/sdk-core/src/lib/models.ts:158

Returns​

Observable<Welcome>

hasNUAClient()​

hasNUAClient(): boolean

Defined in: libs/sdk-core/src/lib/models.ts:223

Returns​

boolean

inviteToAccount()​

inviteToAccount(accountSlug, data): Observable<void>

Defined in: libs/sdk-core/src/lib/models.ts:238

Parameters​

accountSlug​

string

data​

InviteAccountUserPayload

Returns​

Observable<void>

modifyAccount()​

modifyAccount(accountSlug, data): Observable<void>

Defined in: libs/sdk-core/src/lib/models.ts:156

Parameters​

accountSlug​

string

data​

AccountModification

Returns​

Observable<void>

predictAnswer()​

predictAnswer(question, context, model?): Observable<string>

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

Parameters​

question​

string

context​

string[]

model?​

string

Returns​

Observable<string>

predictQuery()​

predictQuery(text, rephrase?, model?, rephrase_prompt?): Observable<QueryInfo>

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

Parameters​

text​

string

rephrase?​

boolean

model?​

string

rephrase_prompt?​

string

Returns​

Observable<QueryInfo>

predictSummarize()​

predictSummarize(text, user_prompt?, model?, summary_kind?): Observable<string>

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

Parameters​

text​

string

user_prompt?​

string

model?​

string

summary_kind?​

"simple" | "extended"

Returns​

Observable<string>

predictTokens()​

predictTokens(text): Observable<PredictedToken[]>

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

Parameters​

text​

string

Returns​

Observable<PredictedToken[]>

pull()​

pull(): Observable<ProcessingPullResponse>

Defined in: libs/sdk-core/src/lib/models.ts:212

Returns​

Observable<ProcessingPullResponse>

renewNUAClient()​

Call Signature​

renewNUAClient(accountId, internalId): Observable<NUAClientResponse>

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

Parameters​
accountId​

string

internalId​

string

Returns​

Observable<NUAClientResponse>

Call Signature​

renewNUAClient(accountId, internalId, zone): Observable<NUAClientResponse>

Defined in: libs/sdk-core/src/lib/models.ts:220

Parameters​
accountId​

string

internalId​

string

zone​

string

Returns​

Observable<NUAClientResponse>

setAccountUsers()​

setAccountUsers(accountSlug, users): Observable<void>

Defined in: libs/sdk-core/src/lib/models.ts:237

Parameters​

accountSlug​

string

users​

AccountUsersPayload

Returns​

Observable<void>

updateModelConfiguration()​

updateModelConfiguration(model, modelId, accountId, zone): Observable<void>

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

Parameters​

model​

ModelConfigurationCreation

modelId​

string

accountId​

string

zone​

string

Returns​

Observable<void>

upload()​

upload(file): Observable<ProcessingPushResponse>

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

Parameters​

file​

File

Returns​

Observable<ProcessingPushResponse>