Db

@nuclia/core

@nuclia/core / Db

Class: Db

Defined in: libs/sdk-core/src/lib/db/db.ts:69

Allows you to access Nuclia accounts and/or Nuclia Knowledge Boxes.

Implements

IDb

Constructors

Constructor

new Db(nuclia): Db

Defined in: libs/sdk-core/src/lib/db/db.ts:72

Parameters

nuclia

INuclia

Returns

Db

Methods

addModelToKb()

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

Defined in: libs/sdk-core/src/lib/db/db.ts:1003

Add a custom model to a Knowledge Box

Parameters

modelId

string

accountId

string

kbId

string

zone

string

Returns

Observable<void>

Implementation of

IDb.addModelToKb

createAccount()

createAccount(account): Observable<Account>

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

Creates a new account.

Parameters

account

AccountCreation

Returns

Observable<Account>

Implementation of

IDb.createAccount

createKnowledgeBox()

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

Defined in: libs/sdk-core/src/lib/db/db.ts:402

Creates a new Knowledge Box. Zone parameter is mandatory. Example:

const knowledgeBox = {
  slug: 'my-kb',
  title: 'My knowledge box',
};
nuclia.db.createKnowledgeBox('my-account-id', 'europe-1', knowledgeBox).subscribe((knowledgeBox) => {
  console.log('knowledge box', knowledgeBox);
});

Parameters

accountId

string

knowledgeBox

KnowledgeBoxCreation

zone

string

Returns

Observable<WritableKnowledgeBox>

Implementation of

IDb.createKnowledgeBox

createModelConfiguration()

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

Defined in: libs/sdk-core/src/lib/db/db.ts:1048

Creates a new model configuration

Parameters

model

ModelConfigurationCreation

accountId

string

zone

string

Returns

Observable<{ id: string; }>

Implementation of

IDb.createModelConfiguration

createNUAClient()

Call Signature

createNUAClient(accountId, data): Observable<NUAClientResponse>

Defined in: libs/sdk-core/src/lib/db/db.ts:606

Creates a NUA client and a NUA token. Zone parameter must be provided except when working with a local NucliaDB instance.

Parameters

accountId

string

Account identifier

data

NUAClientPayload

NUA client data

Returns

Observable<NUAClientResponse>

Implementation of

IDb.createNUAClient

Call Signature

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

Defined in: libs/sdk-core/src/lib/db/db.ts:607

Creates a NUA client and a NUA token. Zone parameter must be provided except when working with a local NucliaDB instance.

Parameters

accountId

string

Account identifier

data

NUAClientPayload

NUA client data

zone

string

Returns

Observable<NUAClientResponse>

Implementation of

IDb.createNUAClient

createNuaGuardPolicy()

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

Defined in: libs/sdk-core/src/lib/db/db.ts:749

Create a NUA guardrail policy on the given account and zone.

Parameters

accountId

string

zone

string

createRetrievalAgent()

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

Defined in: libs/sdk-core/src/lib/db/db.ts:432

Creates a new Retrieval Agent.

const retrievalAgent = {
  slug: 'my-arag',
  title: 'My retrieval agent',
  mode: 'agent'
};
nuclia.db.createRetrievalAgent('my-account-id', 'europe-1', retrievalAgent).subscribe((retrievalAgent) => {
  console.log('retrieval agent', retrievalAgent);
});

#### Parameters

##### accountId

`string`

##### retrievalAgent

[`RetrievalAgentCreation`](../interfaces/RetrievalAgentCreation.md)

##### zone

`string`

#### Returns

`Observable`\<[`RetrievalAgent`](RetrievalAgent.md)\>

#### Implementation of

[`IDb`](../interfaces/IDb.md).[`createRetrievalAgent`](../interfaces/IDb.md#createretrievalagent)

***

### deleteAccount()

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

Defined in: [libs/sdk-core/src/lib/db/db.ts:114](https://github.com/nuclia/frontend/blob/34fcc11c24afd5eb43692b1aa5de58c7d2c9e449/libs/sdk-core/src/lib/db/db.ts#L114)

Deletes an account. Optionally pass an OTP code (from email verification) via the x-otp-email header.

#### Parameters

##### accountSlug

`string`

##### otpCode?

`string`

#### Returns

`Observable`\<`void`\>

#### Implementation of

[`IDb`](../interfaces/IDb.md).[`deleteAccount`](../interfaces/IDb.md#deleteaccount)

***

### deleteAccountInvitation()

> **deleteAccountInvitation**(`accountId`, `email`): `Observable`\<`void`\>

Defined in: [libs/sdk-core/src/lib/db/db.ts:982](https://github.com/nuclia/frontend/blob/34fcc11c24afd5eb43692b1aa5de58c7d2c9e449/libs/sdk-core/src/lib/db/db.ts#L982)

Delete account invitation

#### Parameters

##### accountId

`string`

##### email

`string`

#### Returns

`Observable`\<`void`\>

#### Implementation of

[`IDb`](../interfaces/IDb.md).[`deleteAccountInvitation`](../interfaces/IDb.md#deleteaccountinvitation)

***

### deleteModelConfiguration()

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

Defined in: [libs/sdk-core/src/lib/db/db.ts:1081](https://github.com/nuclia/frontend/blob/34fcc11c24afd5eb43692b1aa5de58c7d2c9e449/libs/sdk-core/src/lib/db/db.ts#L1081)

Deletes a model configuration

#### Parameters

##### modelId

`string`

##### accountId

`string`

##### zone

`string`

#### Returns

`Observable`\<`void`\>

#### Implementation of

[`IDb`](../interfaces/IDb.md).[`deleteModelConfiguration`](../interfaces/IDb.md#deletemodelconfiguration)

***

### deleteModelFromKb()

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

Defined in: [libs/sdk-core/src/lib/db/db.ts:1017](https://github.com/nuclia/frontend/blob/34fcc11c24afd5eb43692b1aa5de58c7d2c9e449/libs/sdk-core/src/lib/db/db.ts#L1017)

Add a custom model to a Knowledge Box

#### Parameters

##### modelId

`string`

##### accountId

`string`

##### kbId

`string`

##### zone

`string`

#### Returns

`Observable`\<`void`\>

#### Implementation of

[`IDb`](../interfaces/IDb.md).[`deleteModelFromKb`](../interfaces/IDb.md#deletemodelfromkb)

***

### deleteNUAClient()

#### Call Signature

> **deleteNUAClient**(`accountId`, `internalId`): `Observable`\<`void`\>

Defined in: [libs/sdk-core/src/lib/db/db.ts:677](https://github.com/nuclia/frontend/blob/34fcc11c24afd5eb43692b1aa5de58c7d2c9e449/libs/sdk-core/src/lib/db/db.ts#L677)

Deletes a NUA client.
Zone parameter must be provided except when working with a local NucliaDB instance.

##### Parameters

###### accountId

`string`

###### internalId

`string`

##### Returns

`Observable`\<`void`\>

##### Implementation of

[`IDb`](../interfaces/IDb.md).[`deleteNUAClient`](../interfaces/IDb.md#deletenuaclient)

#### Call Signature

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

Defined in: [libs/sdk-core/src/lib/db/db.ts:678](https://github.com/nuclia/frontend/blob/34fcc11c24afd5eb43692b1aa5de58c7d2c9e449/libs/sdk-core/src/lib/db/db.ts#L678)

Deletes a NUA client.
Zone parameter must be provided except when working with a local NucliaDB instance.

##### Parameters

###### accountId

`string`

###### internalId

`string`

###### zone

`string`

##### Returns

`Observable`\<`void`\>

##### Implementation of

[`IDb`](../interfaces/IDb.md).[`deleteNUAClient`](../interfaces/IDb.md#deletenuaclient)

***

### deleteNuaGuardPolicy()

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

Defined in: [libs/sdk-core/src/lib/db/db.ts:807](https://github.com/nuclia/frontend/blob/34fcc11c24afd5eb43692b1aa5de58c7d2c9e449/libs/sdk-core/src/lib/db/db.ts#L807)

Delete a NUA guardrail policy from the given account and zone.

#### Parameters

##### guardId

`string`

##### accountId

`string`

##### zone

`string`

#### Returns

`Observable`\<`void`\>

#### Implementation of

[`IDb`](../interfaces/IDb.md).[`deleteNuaGuardPolicy`](../interfaces/IDb.md#deletenuaguardpolicy)

***

### editNUAClient()

> **editNUAClient**(`accountId`, `internalId`, `data`, `zone`): `Observable`\<[`NUAClient`](../interfaces/NUAClient.md)\>

Defined in: [libs/sdk-core/src/lib/db/db.ts:640](https://github.com/nuclia/frontend/blob/34fcc11c24afd5eb43692b1aa5de58c7d2c9e449/libs/sdk-core/src/lib/db/db.ts#L640)

Edit a NUA key

#### Parameters

##### accountId

`string`

Account identifier

##### internalId

`string`

NUA client internal identifier

##### data

[`NUAClientEditPayload`](../interfaces/NUAClientEditPayload.md)

##### zone

`string`

#### Returns

`Observable`\<[`NUAClient`](../interfaces/NUAClient.md)\>

#### Implementation of

[`IDb`](../interfaces/IDb.md).[`editNUAClient`](../interfaces/IDb.md#editnuaclient)

***

### editNuaGuardPolicy()

> **editNuaGuardPolicy**(`guardId`, `accountId`, `zone`, `data`): `Observable`\<[`NuaGuardPolicy`](../interfaces/NuaGuardPolicy.md)\>

Defined in: [libs/sdk-core/src/lib/db/db.ts:776](https://github.com/nuclia/frontend/blob/34fcc11c24afd5eb43692b1aa5de58c7d2c9e449/libs/sdk-core/src/lib/db/db.ts#L776)

Edit the NUA guardrail matching the given identifier and the given account and zone.

#### Parameters

##### guardId

`string`

##### accountId

`string`

##### zone

`string`

##### data

`Partial`\<[`NuaGuardPolicyPayload`](../type-aliases/NuaGuardPolicyPayload.md)\>

#### Returns

`Observable`\<[`NuaGuardPolicy`](../interfaces/NuaGuardPolicy.md)\>

#### Implementation of

[`IDb`](../interfaces/IDb.md).[`editNuaGuardPolicy`](../interfaces/IDb.md#editnuaguardpolicy)

***

### getAccount()

> **getAccount**(): `Observable`\<[`Account`](../interfaces/Account.md)\>

Defined in: [libs/sdk-core/src/lib/db/db.ts:161](https://github.com/nuclia/frontend/blob/34fcc11c24afd5eb43692b1aa5de58c7d2c9e449/libs/sdk-core/src/lib/db/db.ts#L161)

Returns the account with the given id or slug, or the one defined in the Nuclia options
if no id nor slug is provided.

#### Returns

`Observable`\<[`Account`](../interfaces/Account.md)\>

#### Implementation of

[`IDb`](../interfaces/IDb.md).[`getAccount`](../interfaces/IDb.md#getaccount)

***

### getAccountInvitations()

> **getAccountInvitations**(`accountId`): `Observable`\<[`PendingInvitation`](../interfaces/PendingInvitation.md)[]\>

Defined in: [libs/sdk-core/src/lib/db/db.ts:973](https://github.com/nuclia/frontend/blob/34fcc11c24afd5eb43692b1aa5de58c7d2c9e449/libs/sdk-core/src/lib/db/db.ts#L973)

List pending account invitations

#### Parameters

##### accountId

`string`

#### Returns

`Observable`\<[`PendingInvitation`](../interfaces/PendingInvitation.md)[]\>

#### Implementation of

[`IDb`](../interfaces/IDb.md).[`getAccountInvitations`](../interfaces/IDb.md#getaccountinvitations)

***

### getAccounts()

> **getAccounts**(): `Observable`\<[`Account`](../interfaces/Account.md)[]\>

Defined in: [libs/sdk-core/src/lib/db/db.ts:77](https://github.com/nuclia/frontend/blob/34fcc11c24afd5eb43692b1aa5de58c7d2c9e449/libs/sdk-core/src/lib/db/db.ts#L77)

Returns a list of all the accounts which are accessible for the current authenticated user.

#### Returns

`Observable`\<[`Account`](../interfaces/Account.md)[]\>

#### Implementation of

[`IDb`](../interfaces/IDb.md).[`getAccounts`](../interfaces/IDb.md#getaccounts)

***

### getAccountStatus()

> **getAccountStatus**(`accountSlug`): `Observable`\<[`AccountStatus`](../interfaces/AccountStatus.md)\>

Defined in: [libs/sdk-core/src/lib/db/db.ts:132](https://github.com/nuclia/frontend/blob/34fcc11c24afd5eb43692b1aa5de58c7d2c9e449/libs/sdk-core/src/lib/db/db.ts#L132)

Returns account status.

Example:
```ts
nuclia.db
  .getAccountStatus('my-account')
  .pipe(filter((status) => status.available))
  .subscribe((status) => {
    console.log('account ready');
  });

Parameters

accountSlug

string

Returns

Observable<AccountStatus>

Implementation of

IDb.getAccountStatus

getAccountUser()

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

Defined in: libs/sdk-core/src/lib/db/db.ts:934

Get an account user by their id

Parameters

accountSlug

string

userId

string

Returns

Observable<Partial<FullAccountUser>>

Implementation of

IDb.getAccountUser

getAccountUsers()

getAccountUsers(accountSlug): Observable<FullAccountUser[]>

Defined in: libs/sdk-core/src/lib/db/db.ts:942

Get the list of all users of an account

Parameters

accountSlug

string

Returns

Observable<FullAccountUser[]>

Implementation of

IDb.getAccountUsers

getKbIndexes()

getKbIndexes(accountSlug): Observable<KbIndex[]>

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

Returns a list of all the KB indexes (account id, kb id, zone id) for the provided account slug.

Parameters

accountSlug

string

Returns

Observable<KbIndex[]>

Implementation of

IDb.getKbIndexes

getKnowledgeBox()

Call Signature

getKnowledgeBox(): Observable<WritableKnowledgeBox>

Defined in: libs/sdk-core/src/lib/db/db.ts:318

Returns the Knowledge Box corresponding to the account id, Knowledge Box id and zone provided as parameters or the ones defined in the Nuclia options if no parameters are provided. Zone is mandatory except if the Knowledge Box is from a local NucliaDB instance.

Returns

Observable<WritableKnowledgeBox>

Implementation of

IDb.getKnowledgeBox

Call Signature

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

Defined in: libs/sdk-core/src/lib/db/db.ts:319

Parameters

accountId

string

knowledgeBoxId

string

zone?

string

Returns

Observable<WritableKnowledgeBox>

Implementation of

IDb.getKnowledgeBox

getKnowledgeBoxes()

Call Signature

getKnowledgeBoxes(): Observable<IKnowledgeBoxItem[]>

Defined in: libs/sdk-core/src/lib/db/db.ts:253

Returns a list of all the Knowledge Boxes for the given account. Account slug and id can be provided in the Nuclia options or as parameters.

Returns

Observable<IKnowledgeBoxItem[]>

Implementation of

IDb.getKnowledgeBoxes

Call Signature

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

Defined in: libs/sdk-core/src/lib/db/db.ts:254

Returns a list of all the Knowledge Boxes for the given account. Account slug and id can be provided in the Nuclia options or as parameters.

Parameters

accountSlug

string

accountId

string

includeSearchConfigs?

boolean

Returns

Observable<IKnowledgeBoxItem[]>

Implementation of

IDb.getKnowledgeBoxes

getKnowledgeBoxesForZone()

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

Defined in: libs/sdk-core/src/lib/db/db.ts:272

Returns the list of Knowledge Boxes for the given account id and zone.

Parameters

accountId

string

zone

string

includeSearchConfigs?

boolean = true

Returns

Observable<IKnowledgeBoxItem[]>

Implementation of

IDb.getKnowledgeBoxesForZone

getLearningSchema()

getLearningSchema(accountId, zone): Observable<LearningConfigurations>

Defined in: libs/sdk-core/src/lib/db/db.ts:815

Get learning configuration schema. This method is requiring account id and zone parameters.

Parameters

accountId

string

zone

string

Returns

Observable<LearningConfigurations>

Implementation of

IDb.getLearningSchema

getModel()

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

Defined in: libs/sdk-core/src/lib/db/db.ts:996

Get a custom models

Parameters

modelId

string

accountId

string

zone

string

Returns

Observable<CustomModel>

Implementation of

IDb.getModel

getModelConfiguration()

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

Defined in: libs/sdk-core/src/lib/db/db.ts:1036

Get a model configuration

Parameters

modelId

string

accountId

string

zone

string

Returns

Observable<ModelConfiguration>

Implementation of

IDb.getModelConfiguration

getModelConfigurations()

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

Defined in: libs/sdk-core/src/lib/db/db.ts:1024

Get the list of model configurations of an account

Parameters

accountId

string

zone

string

Returns

Observable<ModelConfigurationItem[]>

Implementation of

IDb.getModelConfigurations

getModels()

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

Defined in: libs/sdk-core/src/lib/db/db.ts:989

Get the list of custom models of an account

Parameters

accountId

string

zone

string

Returns

Observable<CustomModelItem[]>

Implementation of

IDb.getModels

getNUAActivity()

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

Defined in: libs/sdk-core/src/lib/db/db.ts:537

Parameters

accountId

string

client_id

string

zoneSlug

string

pageIndex?

number = 0

Returns

Observable<EventList>

Implementation of

IDb.getNUAActivity

getNUAClient()

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

Defined in: libs/sdk-core/src/lib/db/db.ts:577

Parameters

accountId

string

internalId

string

zone

string

Returns

Observable<NUAClient>

Implementation of

IDb.getNUAClient

getNUAClients()

getNUAClients(accountId): Observable<NUAClient[]>

Defined in: libs/sdk-core/src/lib/db/db.ts:564

Parameters

accountId

string

Returns

Observable<NUAClient[]>

Implementation of

IDb.getNUAClients

getNUAClientsForZone()

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

Defined in: libs/sdk-core/src/lib/db/db.ts:547

Returns the list of NUA clients for the given account and zone.

Parameters

accountId

string

zoneSlug

string

Returns

Observable<NUAClient[]>

Implementation of

IDb.getNUAClientsForZone

getNuaGuardPolicies()

getNuaGuardPolicies(accountId): Observable<NuaGuardPolicy[]>

Defined in: libs/sdk-core/src/lib/db/db.ts:688

Get NUA guardrail policies for the given account.

Parameters

accountId

string

Returns

Observable<NuaGuardPolicy[]>

Implementation of

IDb.getNuaGuardPolicies

getNuaGuardPoliciesForZone()

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

Defined in: libs/sdk-core/src/lib/db/db.ts:707

Get NUA guardrail policies for the given account and zone.

Parameters

accountId

string

zone

string

Returns

Observable<NuaGuardPolicy[]>

Implementation of

IDb.getNuaGuardPoliciesForZone

getNuaGuardPolicy()

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

Defined in: libs/sdk-core/src/lib/db/db.ts:726

Get the NUA guardrail policy matching the given guardrail ID on the given account and zone.

Parameters

guardId

string

accountId

string

zone

string

Returns

Observable<NuaGuardPolicy | undefined>

Implementation of

IDb.getNuaGuardPolicy

getNUAHeader()

getNUAHeader(): object

Defined in: libs/sdk-core/src/lib/db/db.ts:594

Returns

object

x-nuclia-nuakey

x-nuclia-nuakey: string

getNUAKey()

getNUAKey(): string

Defined in: libs/sdk-core/src/lib/db/db.ts:590

Returns

string

getRetrievalAgent()

Call Signature

getRetrievalAgent(): Observable<RetrievalAgent>

Defined in: libs/sdk-core/src/lib/db/db.ts:354

Returns

Observable<RetrievalAgent>

Implementation of

IDb.getRetrievalAgent

Call Signature

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

Defined in: libs/sdk-core/src/lib/db/db.ts:355

Parameters

accountId

string

retrievalAgentId

string

zone?

string

Returns

Observable<RetrievalAgent>

Implementation of

IDb.getRetrievalAgent

getRetrievalAgents()

Call Signature

getRetrievalAgents(): Observable<IKnowledgeBoxItem[]>

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

Returns a list of all the Retrieval Agents for the given account. Account slug and id can be provided in the Nuclia options or as parameters.

Returns

Observable<IKnowledgeBoxItem[]>

Implementation of

IDb.getRetrievalAgents

Call Signature

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

Defined in: libs/sdk-core/src/lib/db/db.ts:284

Returns a list of all the Retrieval Agents for the given account. Account slug and id can be provided in the Nuclia options or as parameters.

Parameters

accountSlug

string

accountId

string

mode?

KnowledgeBoxMode

includeSearchConfigs?

boolean

Returns

Observable<IKnowledgeBoxItem[]>

Implementation of

IDb.getRetrievalAgents

getRetrievalAgentsForZone()

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

Defined in: libs/sdk-core/src/lib/db/db.ts:304

Returns the list of Retrieval Agents for the given account id and zone.

Parameters

accountId

string

zone

string

mode?

KnowledgeBoxMode

includeSearchConfigs?

boolean = true

Returns

Observable<IKnowledgeBoxItem[]>

Implementation of

IDb.getRetrievalAgentsForZone

getSignupInfo()

getSignupInfo(signup_token): Observable<SignUpInfo>

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

Returns sign up information.

Parameters

signup_token

string

Returns

Observable<SignUpInfo>

Implementation of

IDb.getSignupInfo

getStandaloneKbs()

getStandaloneKbs(): Observable<IStandaloneKb[]>

Defined in: libs/sdk-core/src/lib/db/db.ts:170

Returns

Observable<IStandaloneKb[]>

Implementation of

IDb.getStandaloneKbs

getUsage()

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

Defined in: libs/sdk-core/src/lib/db/db.ts:466

Get usage metric for the account.

Parameters

accountId

string

Account identifier

from

string

Timestamp of the moment from which we want the metrics.

to?

string

Timestamp of the moment until which we want the metrics. When not provided, the metrics are returned "until now".

knowledgeBoxId?

string

Knowledge Box identifier to get the metrics for a specific Knowledge Box (returns the metrics aggregated for all the Knowledge Boxes of the account by default)

aggregation?

UsageAggregation

Define how the metrics are aggregated. By default, the endpoint returns only one point aggregating all the data for the specified date range. But you can have one point by:

"hour"
"day"
"week"
"month"
"quarter"
"year"
"millennium" (used by default)

nuaKeyId?

string

NUA key identifier to get the metrics for a specific NUA key.

Returns

Observable<UsagePoint[]>

Implementation of

IDb.getUsage

getWelcome()

getWelcome(): Observable<Welcome>

Defined in: libs/sdk-core/src/lib/db/db.ts:146

Returns user information.

Example:

nuclia.db.getWelcome().subscribe((welcome) => {
  console.log(`Welcome ${welcome.preferences.name}`);
});

Returns

Observable<Welcome>

Implementation of

IDb.getWelcome

hasNUAClient()

hasNUAClient(): boolean

Defined in: libs/sdk-core/src/lib/db/db.ts:586

Returns

boolean

Implementation of

IDb.hasNUAClient

inviteToAccount()

inviteToAccount(accountSlug, data): Observable<void>

Defined in: libs/sdk-core/src/lib/db/db.ts:961

Invite a user to an account

Parameters

accountSlug

string

data

InviteAccountUserPayload

Returns

Observable<void>

Implementation of

IDb.inviteToAccount

modifyAccount()

modifyAccount(accountSlug, data): Observable<void>

Defined in: libs/sdk-core/src/lib/db/db.ts:109

Modifies account properties.

Example:

nuclia.db.modifyAccount('my-account', { title: 'My account' }).subscribe({
  next: () => {
    console.log('account modified');
  },
  error: (error) => {
    console.error(error);
  },
});

Parameters

accountSlug

string

data

AccountModification

Returns

Observable<void>

Implementation of

IDb.modifyAccount

predictAnswer()

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

Defined in: libs/sdk-core/src/lib/db/db.ts:843

Generate an answer from a question and a context.

Parameters

question

string

context

string[]

model?

string

Returns

Observable<string>

Implementation of

IDb.predictAnswer

predictQuery()

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

Defined in: libs/sdk-core/src/lib/db/db.ts:868

Analyse a sentence, returning the language, the entities intent and the embeddings.

Parameters

text

string

rephrase?

boolean

model?

string

rephrase_prompt?

string

Returns

Observable<QueryInfo>

Implementation of

IDb.predictQuery

predictSummarize()

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

Defined in: libs/sdk-core/src/lib/db/db.ts:892

Generate a summary from a text.

The optional user_prompt parameter allows you to provide a custom prompt to the model, it must use the {text} placeholder to indicate where the resource text should be inserted (example: 'Make a one-line summary of the following text: {text}').

Parameters

text

string

user_prompt?

string

model?

string = 'chatgpt-azure-4o'

summary_kind?

"simple" | "extended"

Returns

Observable<string>

Implementation of

IDb.predictSummarize

predictTokens()

predictTokens(text): Observable<PredictedToken[]>

Defined in: libs/sdk-core/src/lib/db/db.ts:828

Extract NER tokens from a text.

Parameters

text

string

Returns

Observable<PredictedToken[]>

Implementation of

IDb.predictTokens

pull()

pull(): Observable<ProcessingPullResponse>

Defined in: libs/sdk-core/src/lib/db/db.ts:530

Pulls the latest data from Nuclia Understanding API.

Requires a NUA token.

Returns

Observable<ProcessingPullResponse>

Implementation of

IDb.pull

renewNUAClient()

Call Signature

renewNUAClient(accountId, internalId): Observable<NUAClientResponse>

Defined in: libs/sdk-core/src/lib/db/db.ts:660

Renews a NUA token. Zone parameter must be provided except when working with a local NucliaDB instance.

Parameters

accountId

string

internalId

string

Returns

Observable<NUAClientResponse>

Implementation of

IDb.renewNUAClient

Call Signature

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

Defined in: libs/sdk-core/src/lib/db/db.ts:661

Renews a NUA token. Zone parameter must be provided except when working with a local NucliaDB instance.

Parameters

accountId

string

internalId

string

zone

string

Returns

Observable<NUAClientResponse>

Implementation of

IDb.renewNUAClient

setAccountUsers()

setAccountUsers(accountSlug, users): Observable<void>

Defined in: libs/sdk-core/src/lib/db/db.ts:951

Add and/or delete users from an account

Parameters

accountSlug

string

users

AccountUsersPayload

Returns

Observable<void>

Implementation of

IDb.setAccountUsers

updateModelConfiguration()

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

Defined in: libs/sdk-core/src/lib/db/db.ts:1062

Updates a model configuration

Parameters

model

ModelConfigurationCreation

modelId

string

accountId

string

zone

string

Returns

Observable<void>

Implementation of

IDb.updateModelConfiguration

upload()

upload(file): Observable<ProcessingPushResponse>

Defined in: libs/sdk-core/src/lib/db/db.ts:508

Uploads and pushes a file to Nuclia Understanding API.

Requires a NUA token.

Example:

const file = input.files[0];
nuclia.db.upload(file).subscribe({
next: (response) => {
  console.log('file uploaded', response);
},
error: (error) => {
  console.error(error);
},
});

Parameters

file

FileWithMetadata

Returns

Observable<ProcessingPushResponse>

Implementation of

IDb.upload

Class: Db

Implements​

Constructors​

Constructor​

Parameters​

nuclia​

Returns​

Methods​

addModelToKb()​

Parameters​

modelId​

accountId​

kbId​

zone​

Returns​

Implementation of​

createAccount()​

Parameters​

account​

Returns​

Implementation of​

createKnowledgeBox()​

Parameters​

accountId​

knowledgeBox​

zone​

Returns​

Implementation of​

createModelConfiguration()​

Parameters​

model​

accountId​

zone​

Returns​

Implementation of​

createNUAClient()​

Call Signature​

Parameters​

accountId​

data​

Returns​

Implementation of​

Call Signature​

Parameters​

accountId​

data​

zone​

Returns​

Implementation of​

createNuaGuardPolicy()​

Parameters​

accountId​

zone​

data​

Returns​

Implementation of​

createRetrievalAgent()​

Parameters​

accountSlug​

Returns​

Implementation of​

getAccountUser()​

Parameters​

accountSlug​

userId​

Returns​

Implementation of​

getAccountUsers()​

Parameters​

accountSlug​

Returns​

Implementation of​

getKbIndexes()​

Parameters​

accountSlug​

Returns​

Implementation of​

getKnowledgeBox()​

Call Signature​

Returns​

Implements

Constructors

Constructor

Parameters

nuclia

Returns

Methods

addModelToKb()

Parameters

modelId

accountId

kbId

zone

Returns

Implementation of

createAccount()

Parameters

account

Returns

Implementation of

createKnowledgeBox()

Parameters

accountId

knowledgeBox

zone

Returns

Implementation of

createModelConfiguration()

Parameters

model

accountId

zone

Returns

Implementation of

createNUAClient()

Call Signature

Parameters

accountId

data

Returns

Implementation of

Call Signature

Parameters

accountId

data

zone

Returns

Implementation of

createNuaGuardPolicy()

Parameters

accountId

zone

data

Returns

Implementation of

createRetrievalAgent()

Parameters

accountSlug

Returns

Implementation of

getAccountUser()

Parameters

accountSlug

userId

Returns

Implementation of

getAccountUsers()

Parameters

accountSlug

Returns

Implementation of

getKbIndexes()

Parameters

accountSlug

Returns

Implementation of

getKnowledgeBox()

Call Signature

Returns

Implementation of