Skip to main content

IDb

@nuclia/core • Docs

@nuclia/core / IDb

Interface: IDb

Methods​

addModelToKb()​

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

Parameters​

• modelId: string

• accountId: string

• kbId: string

• zone: string

Returns​

Observable<void>

Defined in​

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

createAccount()​

createAccount(account): Observable<Account>

Parameters​

• account: AccountCreation

Returns​

Observable<Account>

Defined in​

libs/sdk-core/src/lib/models.ts:149

createKnowledgeBox()​

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

Parameters​

• accountId: string

• knowledgeBox: KnowledgeBoxCreation

• zone?: string

Returns​

Observable<WritableKnowledgeBox>

Defined in​

libs/sdk-core/src/lib/models.ts:171

createModelConfiguration()​

createModelConfiguration(model, accountId, zone): Observable<object>

Parameters​

• model: ModelConfigurationCreation

• accountId: string

• zone: string

Returns​

Observable<object>

id​

id: string

Defined in​

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

createNUAClient()​

createNUAClient(accountId, data)​

createNUAClient(accountId, data): Observable<object>

Parameters​

• accountId: string

• data: NUAClientPayload

Returns​

Observable<object>

client_id​

client_id: string

token​

token: string

Defined in​

libs/sdk-core/src/lib/models.ts:209

createNUAClient(accountId, data, zone)​

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

Parameters​

• accountId: string

• data: NUAClientPayload

• zone: string

Returns​

Observable<object>

client_id​

client_id: string

token​

token: string

Defined in​

libs/sdk-core/src/lib/models.ts:210

createRetrievalAgent()​

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

Parameters​

• accountId: string

• retrievalAgent: RetrievalAgentCreation

• zone: string

Returns​

Observable<RetrievalAgent>

Defined in​

libs/sdk-core/src/lib/models.ts:192

deleteAccount()​

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

Parameters​

• accountSlug: string

• otpCode?: string

Returns​

Observable<void>

Defined in​

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

deleteAccountInvitation()​

deleteAccountInvitation(accountId, email): Observable<void>

Parameters​

• accountId: string

• email: string

Returns​

Observable<void>

Defined in​

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

deleteModelConfiguration()​

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

Parameters​

• modelId: string

• accountId: string

• zone: string

Returns​

Observable<void>

Defined in​

libs/sdk-core/src/lib/models.ts:255

deleteModelFromKb()​

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

Parameters​

• modelId: string

• accountId: string

• kbId: string

• zone: string

Returns​

Observable<void>

Defined in​

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

deleteNUAClient()​

deleteNUAClient(accountId, client_id)​

deleteNUAClient(accountId, client_id): Observable<void>

Parameters​

• accountId: string

• client_id: string

Returns​

Observable<void>

Defined in​

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

deleteNUAClient(accountId, client_id, zone)​

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

Parameters​

• accountId: string

• client_id: string

• zone: string

Returns​

Observable<void>

Defined in​

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

getAccount()​

getAccount()​

getAccount(): Observable<Account>

Returns​

Observable<Account>

Defined in​

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

getAccount(accountIdOrSlug)​

getAccount(accountIdOrSlug?): Observable<Account>

Parameters​

• accountIdOrSlug?: string

Returns​

Observable<Account>

Defined in​

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

getAccountInvitations()​

getAccountInvitations(accountId): Observable<PendingInvitation[]>

Parameters​

• accountId: string

Returns​

Observable<PendingInvitation[]>

Defined in​

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

getAccounts()​

getAccounts(): Observable<Account[]>

Returns​

Observable<Account[]>

Defined in​

libs/sdk-core/src/lib/models.ts:147

getAccountStatus()​

getAccountStatus(accountSlug): Observable<AccountStatus>

Parameters​

• accountSlug: string

Returns​

Observable<AccountStatus>

Defined in​

libs/sdk-core/src/lib/models.ts:150

getAccountUser()​

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

Parameters​

• accountSlug: string

• userId: string

Returns​

Observable<Partial<FullAccountUser>>

Defined in​

libs/sdk-core/src/lib/models.ts:232

getAccountUsers()​

getAccountUsers(accountSlug): Observable<FullAccountUser[]>

Parameters​

• accountSlug: string

Returns​

Observable<FullAccountUser[]>

Defined in​

libs/sdk-core/src/lib/models.ts:233

getKbIndexes()​

getKbIndexes(accountSlug): Observable<KbIndex[]>

Parameters​

• accountSlug: string

Returns​

Observable<KbIndex[]>

Defined in​

libs/sdk-core/src/lib/models.ts:148

getKnowledgeBox()​

getKnowledgeBox()​

getKnowledgeBox(): Observable<WritableKnowledgeBox>

Returns​

Observable<WritableKnowledgeBox>

Defined in​

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

getKnowledgeBox(accountId, knowledgeBoxId, zone)​

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

Parameters​

• accountId: string

• knowledgeBoxId: string

• zone?: string

Returns​

Observable<WritableKnowledgeBox>

Defined in​

libs/sdk-core/src/lib/models.ts:170

getKnowledgeBoxes()​

getKnowledgeBoxes()​

getKnowledgeBoxes(): Observable<IKnowledgeBoxItem[]>

Returns​

Observable<IKnowledgeBoxItem[]>

Defined in​

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

getKnowledgeBoxes(accountSlug, accountId, includeSearchConfigs)​

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

Parameters​

• accountSlug: string

• accountId: string

• includeSearchConfigs?: boolean

Returns​

Observable<IKnowledgeBoxItem[]>

Defined in​

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

getKnowledgeBoxesForZone()​

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

Parameters​

• accountId: string

• zone: string

• includeSearchConfigs?: boolean

Returns​

Observable<IKnowledgeBoxItem[]>

Defined in​

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

getLearningSchema()​

getLearningSchema()​

getLearningSchema(): Observable<LearningConfigurations>

Returns​

Observable<LearningConfigurations>

Defined in​

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

getLearningSchema(accountId, zone)​

getLearningSchema(accountId, zone): Observable<LearningConfigurations>

Parameters​

• accountId: string

• zone: string

Returns​

Observable<LearningConfigurations>

Defined in​

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

getModel()​

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

Parameters​

• modelId: string

• accountId: string

• zone: string

Returns​

Observable<CustomModel>

Defined in​

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

getModelConfiguration()​

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

Parameters​

• modelId: string

• accountId: string

• zone: string

Returns​

Observable<ModelConfiguration>

Defined in​

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

getModelConfigurations()​

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

Parameters​

• accountId: string

• zone: string

Returns​

Observable<ModelConfigurationItem[]>

Defined in​

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

getModels()​

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

Parameters​

• accountId: string

• zone: string

Returns​

Observable<CustomModelItem[]>

Defined in​

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

getNUAActivity()​

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

Parameters​

• accountId: string

• client_id: string

• zoneSlug: string

• pageIndex?: number

Returns​

Observable<EventList>

Defined in​

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

getNUAClient()​

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

Parameters​

• accountId: string

• client_id: string

• zone: string

Returns​

Observable<NUAClient>

Defined in​

libs/sdk-core/src/lib/models.ts:208

getNUAClients()​

getNUAClients(accountId): Observable<NUAClient[]>

Parameters​

• accountId: string

Returns​

Observable<NUAClient[]>

Defined in​

libs/sdk-core/src/lib/models.ts:207

getRetrievalAgent()​

getRetrievalAgent()​

getRetrievalAgent(): Observable<RetrievalAgent>

Returns​

Observable<RetrievalAgent>

Defined in​

libs/sdk-core/src/lib/models.ts:190

getRetrievalAgent(accountId, retrievalAgentId, zone)​

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

Parameters​

• accountId: string

• retrievalAgentId: string

• zone?: string

Returns​

Observable<RetrievalAgent>

Defined in​

libs/sdk-core/src/lib/models.ts:191

getRetrievalAgents()​

getRetrievalAgents()​

getRetrievalAgents(): Observable<IKnowledgeBoxItem[]>

Returns​

Observable<IKnowledgeBoxItem[]>

Defined in​

libs/sdk-core/src/lib/models.ts:177

getRetrievalAgents(accountSlug, accountId, mode, includeSearchConfigs)​

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

Parameters​

• accountSlug: string

• accountId: string

• mode?: KnowledgeBoxMode

• includeSearchConfigs?: boolean

Returns​

Observable<IKnowledgeBoxItem[]>

Defined in​

libs/sdk-core/src/lib/models.ts:178

getRetrievalAgentsForZone()​

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

Parameters​

• accountId: string

• zone: string

• mode?: KnowledgeBoxMode

• includeSearchConfigs?: boolean

Returns​

Observable<IKnowledgeBoxItem[]>

Defined in​

libs/sdk-core/src/lib/models.ts:184

getSignupInfo()​

getSignupInfo(signup_token): Observable<SignUpInfo>

Parameters​

• signup_token: string

Returns​

Observable<SignUpInfo>

Defined in​

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

getStandaloneKbs()​

getStandaloneKbs(): Observable<IStandaloneKb[]>

Returns​

Observable<IStandaloneKb[]>

Defined in​

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

getUsage()​

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

Parameters​

• accountId: string

• from: string

• to?: string

• knowledgeBox?: string

• aggregation?: UsageAggregation

Returns​

Observable<UsagePoint[]>

Defined in​

libs/sdk-core/src/lib/models.ts:198

getWelcome()​

getWelcome(): Observable<Welcome>

Returns​

Observable<Welcome>

Defined in​

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

hasNUAClient()​

hasNUAClient(): boolean

Returns​

boolean

Defined in​

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

inviteToAccount()​

inviteToAccount(accountSlug, data): Observable<void>

Parameters​

• accountSlug: string

• data: InviteAccountUserPayload

Returns​

Observable<void>

Defined in​

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

modifyAccount()​

modifyAccount(accountSlug, data): Observable<void>

Parameters​

• accountSlug: string

• data: AccountModification

Returns​

Observable<void>

Defined in​

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

predictAnswer()​

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

Parameters​

• question: string

• context: string[]

• model?: string

Returns​

Observable<string>

Defined in​

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

predictQuery()​

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

Parameters​

• text: string

• rephrase?: boolean

• model?: string

• rephrase_prompt?: string

Returns​

Observable<QueryInfo>

Defined in​

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

predictSummarize()​

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

Parameters​

• text: string

• user_prompt?: string

• model?: string

• summary_kind?: "simple" | "extended"

Returns​

Observable<string>

Defined in​

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

predictTokens()​

predictTokens(text): Observable<PredictedToken[]>

Parameters​

• text: string

Returns​

Observable<PredictedToken[]>

Defined in​

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

pull()​

pull(): Observable<ProcessingPullResponse>

Returns​

Observable<ProcessingPullResponse>

Defined in​

libs/sdk-core/src/lib/models.ts:206

renewNUAClient()​

renewNUAClient(accountId, client_id)​

renewNUAClient(accountId, client_id): Observable<object>

Parameters​

• accountId: string

• client_id: string

Returns​

Observable<object>

client_id​

client_id: string

token​

token: string

Defined in​

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

renewNUAClient(accountId, client_id, zone)​

renewNUAClient(accountId, client_id, zone): Observable<object>

Parameters​

• accountId: string

• client_id: string

• zone: string

Returns​

Observable<object>

client_id​

client_id: string

token​

token: string

Defined in​

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

setAccountUsers()​

setAccountUsers(accountSlug, users): Observable<void>

Parameters​

• accountSlug: string

• users: AccountUsersPayload

Returns​

Observable<void>

Defined in​

libs/sdk-core/src/lib/models.ts:234

updateModelConfiguration()​

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

Parameters​

• model: ModelConfigurationCreation

• modelId: string

• accountId: string

• zone: string

Returns​

Observable<void>

Defined in​

libs/sdk-core/src/lib/models.ts:249

upload()​

upload(file): Observable<ProcessingPushResponse>

Parameters​

• file: File

Returns​

Observable<ProcessingPushResponse>

Defined in​

libs/sdk-core/src/lib/models.ts:205