Db
@nuclia/core • Docs
@nuclia/core / Db
Class: Db
Allows you to access Nuclia accounts and/or Nuclia Knowledge Boxes.
Implements
Constructors
new Db()
new Db(
nuclia
):Db
Parameters
• nuclia: INuclia
Returns
Defined in
libs/sdk-core/src/lib/db/db.ts:65
Methods
addModelToKb()
addModelToKb(
modelId
,accountId
,kbId
,zone
):Observable
<void
>
Add a custom model to a Knowledge Box
Parameters
• modelId: string
• accountId: string
• kbId: string
• zone: string
Returns
Observable
<void
>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:801
createAccount()
createAccount(
account
):Observable
<Account
>
Creates a new account.
Parameters
• account: AccountCreation
Returns
Observable
<Account
>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:83
createKnowledgeBox()
createKnowledgeBox(
accountId
,knowledgeBox
,zone
?):Observable
<WritableKnowledgeBox
>
Creates a new Knowledge Box. Zone parameter is mandatory except if the Knowledge Box is from a local NucliaDB instance. 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
Defined in
libs/sdk-core/src/lib/db/db.ts:335
createModelConfiguration()
createModelConfiguration(
model
,accountId
,zone
):Observable
<object
>
Creates a new model configuration
Parameters
• model: ModelConfigurationCreation
• accountId: string
• zone: string
Returns
Observable
<object
>
id
id:
string
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:846
createNUAClient()
createNUAClient(accountId, data)
createNUAClient(
accountId
,data
):Observable
<object
>
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
<object
>
client_id
client_id:
string
token
token:
string
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:526
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
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:527
createRetrievalAgent()
createRetrievalAgent(
accountId
,retrievalAgent
,zone
):Observable
<RetrievalAgent
>
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)
#### Defined in
[libs/sdk-core/src/lib/db/db.ts:370](https://github.com/nuclia/frontend/blob/0a858556231ff049b4c22dbf0d7824e43f97ba1a/libs/sdk-core/src/lib/db/db.ts#L370)
***
### deleteAccount()
> **deleteAccount**(`accountSlug`): `Observable`\<`void`\>
Deletes an account.
#### Parameters
• **accountSlug**: `string`
#### Returns
`Observable`\<`void`\>
#### Implementation of
[`IDb`](../interfaces/IDb.md).[`deleteAccount`](../interfaces/IDb.md#deleteaccount)
#### Defined in
[libs/sdk-core/src/lib/db/db.ts:107](https://github.com/nuclia/frontend/blob/0a858556231ff049b4c22dbf0d7824e43f97ba1a/libs/sdk-core/src/lib/db/db.ts#L107)
***
### deleteAccountInvitation()
> **deleteAccountInvitation**(`accountId`, `email`): `Observable`\<`void`\>
Delete account invitation
#### Parameters
• **accountId**: `string`
• **email**: `string`
#### Returns
`Observable`\<`void`\>
#### Implementation of
[`IDb`](../interfaces/IDb.md).[`deleteAccountInvitation`](../interfaces/IDb.md#deleteaccountinvitation)
#### Defined in
[libs/sdk-core/src/lib/db/db.ts:780](https://github.com/nuclia/frontend/blob/0a858556231ff049b4c22dbf0d7824e43f97ba1a/libs/sdk-core/src/lib/db/db.ts#L780)
***
### deleteModelConfiguration()
> **deleteModelConfiguration**(`modelId`, `accountId`, `zone`): `Observable`\<`void`\>
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)
#### Defined in
[libs/sdk-core/src/lib/db/db.ts:860](https://github.com/nuclia/frontend/blob/0a858556231ff049b4c22dbf0d7824e43f97ba1a/libs/sdk-core/src/lib/db/db.ts#L860)
***
### deleteModelFromKb()
> **deleteModelFromKb**(`modelId`, `accountId`, `kbId`, `zone`): `Observable`\<`void`\>
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)
#### Defined in
[libs/sdk-core/src/lib/db/db.ts:815](https://github.com/nuclia/frontend/blob/0a858556231ff049b4c22dbf0d7824e43f97ba1a/libs/sdk-core/src/lib/db/db.ts#L815)
***
### deleteNUAClient()
#### deleteNUAClient(accountId, client_id)
> **deleteNUAClient**(`accountId`, `client_id`): `Observable`\<`void`\>
Deletes a NUA client.
Zone parameter must be provided except when working with a local NucliaDB instance.
##### Parameters
• **accountId**: `string`
• **client\_id**: `string`
##### Returns
`Observable`\<`void`\>
##### Implementation of
[`IDb`](../interfaces/IDb.md).[`deleteNUAClient`](../interfaces/IDb.md#deletenuaclient)
##### Defined in
[libs/sdk-core/src/lib/db/db.ts:600](https://github.com/nuclia/frontend/blob/0a858556231ff049b4c22dbf0d7824e43f97ba1a/libs/sdk-core/src/lib/db/db.ts#L600)
#### deleteNUAClient(accountId, client_id, zone)
> **deleteNUAClient**(`accountId`, `client_id`, `zone`): `Observable`\<`void`\>
##### Parameters
• **accountId**: `string`
• **client\_id**: `string`
• **zone**: `string`
##### Returns
`Observable`\<`void`\>
##### Implementation of
[`IDb`](../interfaces/IDb.md).[`deleteNUAClient`](../interfaces/IDb.md#deletenuaclient)
##### Defined in
[libs/sdk-core/src/lib/db/db.ts:601](https://github.com/nuclia/frontend/blob/0a858556231ff049b4c22dbf0d7824e43f97ba1a/libs/sdk-core/src/lib/db/db.ts#L601)
***
### getAccount()
> **getAccount**(): `Observable`\<[`Account`](../interfaces/Account.md)\>
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)
#### Defined in
[libs/sdk-core/src/lib/db/db.ts:146](https://github.com/nuclia/frontend/blob/0a858556231ff049b4c22dbf0d7824e43f97ba1a/libs/sdk-core/src/lib/db/db.ts#L146)
***
### getAccountInvitations()
> **getAccountInvitations**(`accountId`): `Observable`\<[`PendingInvitation`](../interfaces/PendingInvitation.md)[]\>
List pending account invitations
#### Parameters
• **accountId**: `string`
#### Returns
`Observable`\<[`PendingInvitation`](../interfaces/PendingInvitation.md)[]\>
#### Implementation of
[`IDb`](../interfaces/IDb.md).[`getAccountInvitations`](../interfaces/IDb.md#getaccountinvitations)
#### Defined in
[libs/sdk-core/src/lib/db/db.ts:771](https://github.com/nuclia/frontend/blob/0a858556231ff049b4c22dbf0d7824e43f97ba1a/libs/sdk-core/src/lib/db/db.ts#L771)
***
### getAccounts()
> **getAccounts**(): `Observable`\<[`Account`](../interfaces/Account.md)[]\>
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)
#### Defined in
[libs/sdk-core/src/lib/db/db.ts:70](https://github.com/nuclia/frontend/blob/0a858556231ff049b4c22dbf0d7824e43f97ba1a/libs/sdk-core/src/lib/db/db.ts#L70)
***
### getAccountStatus()
> **getAccountStatus**(`accountSlug`): `Observable`\<[`AccountStatus`](../interfaces/AccountStatus.md)\>
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
Defined in
libs/sdk-core/src/lib/db/db.ts:124
getAccountUser()
getAccountUser(
accountSlug
,userId
):Observable
<Partial
<FullAccountUser
>>
Get an account user by their id
Parameters
• accountSlug: string
• userId: string
Returns
Observable
<Partial
<FullAccountUser
>>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:735
getAccountUsers()
getAccountUsers(
accountSlug
):Observable
<FullAccountUser
[]>
Get the list of all users of an account
Parameters
• accountSlug: string
Returns
Observable
<FullAccountUser
[]>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:743
getKbIndexes()
getKbIndexes(
accountSlug
):Observable
<KbIndex
[]>
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
Defined in
libs/sdk-core/src/lib/db/db.ts:78
getKnowledgeBox()
getKnowledgeBox()
getKnowledgeBox():
Observable
<WritableKnowledgeBox
>
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
Defined in
libs/sdk-core/src/lib/db/db.ts:250
getKnowledgeBox(accountId, knowledgeBoxId, zone)
getKnowledgeBox(
accountId
,knowledgeBoxId
,zone
?):Observable
<WritableKnowledgeBox
>
Parameters
• accountId: string
• knowledgeBoxId: string
• zone?: string
Returns
Observable
<WritableKnowledgeBox
>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:251
getKnowledgeBoxes()
getKnowledgeBoxes()
getKnowledgeBoxes():
Observable
<IKnowledgeBoxItem
[]>
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
Defined in
libs/sdk-core/src/lib/db/db.ts:212
getKnowledgeBoxes(accountSlug, accountId)
getKnowledgeBoxes(
accountSlug
,accountId
):Observable
<IKnowledgeBoxItem
[]>
Parameters
• accountSlug: string
• accountId: string
Returns
Observable
<IKnowledgeBoxItem
[]>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:213
getKnowledgeBoxesForZone()
getKnowledgeBoxesForZone(
accountId
,zone
):Observable
<IKnowledgeBoxItem
[]>
Returns the list of Knowledge Boxes for the given account id and zone.
Parameters
• accountId: string
• zone: string
Returns
Observable
<IKnowledgeBoxItem
[]>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:223
getLearningSchema()
getLearningSchema()
getLearningSchema():
Observable
<LearningConfigurations
>
Get learning configuration schema. When used on Cloud account, this method is requiring account id and zone parameters. When used on standalone, this method doesn't take any parameter
Returns
Observable
<LearningConfigurations
>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:611
getLearningSchema(accountId, zone)
getLearningSchema(
accountId
,zone
):Observable
<LearningConfigurations
>
Parameters
• accountId: string
• zone: string
Returns
Observable
<LearningConfigurations
>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:612
getModel()
getModel(
modelId
,accountId
,zone
):Observable
<CustomModel
>
Get a custom models
Parameters
• modelId: string
• accountId: string
• zone: string
Returns
Observable
<CustomModel
>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:794
getModelConfiguration()
getModelConfiguration(
modelId
,accountId
,zone
):Observable
<ModelConfiguration
>
Get a model configuration
Parameters
• modelId: string
• accountId: string
• zone: string
Returns
Observable
<ModelConfiguration
>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:834
getModelConfigurations()
getModelConfigurations(
accountId
,zone
):Observable
<ModelConfigurationItem
[]>
Get the list of model configurations of an account
Parameters
• accountId: string
• zone: string
Returns
Observable
<ModelConfigurationItem
[]>