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:69
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:885
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:87
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:401
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:930
createNUAClient()
createNUAClient(accountId, data)
createNUAClient(
accountId,data):Observable<NUAClientResponse>
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
Defined in
libs/sdk-core/src/lib/db/db.ts:610
createNUAClient(accountId, data, zone)
createNUAClient(
accountId,data,zone):Observable<NUAClientResponse>
Parameters
• accountId: string
• data: NUAClientPayload
• zone: string
Returns
Observable<NUAClientResponse>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:611
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:436](https://github.com/nuclia/frontend/blob/ac5686c31474cdc9e830cd28361f63ae5160d985/libs/sdk-core/src/lib/db/db.ts#L436)
***
### deleteAccount()
> **deleteAccount**(`accountSlug`, `otpCode`?): `Observable`\<`void`\>
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)
#### Defined in
[libs/sdk-core/src/lib/db/db.ts:111](https://github.com/nuclia/frontend/blob/ac5686c31474cdc9e830cd28361f63ae5160d985/libs/sdk-core/src/lib/db/db.ts#L111)
***
### 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:864](https://github.com/nuclia/frontend/blob/ac5686c31474cdc9e830cd28361f63ae5160d985/libs/sdk-core/src/lib/db/db.ts#L864)
***
### 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:963](https://github.com/nuclia/frontend/blob/ac5686c31474cdc9e830cd28361f63ae5160d985/libs/sdk-core/src/lib/db/db.ts#L963)
***
### 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:899](https://github.com/nuclia/frontend/blob/ac5686c31474cdc9e830cd28361f63ae5160d985/libs/sdk-core/src/lib/db/db.ts#L899)
***
### deleteNUAClient()
#### deleteNUAClient(accountId, internalId)
> **deleteNUAClient**(`accountId`, `internalId`): `Observable`\<`void`\>
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)
##### Defined in
[libs/sdk-core/src/lib/db/db.ts:681](https://github.com/nuclia/frontend/blob/ac5686c31474cdc9e830cd28361f63ae5160d985/libs/sdk-core/src/lib/db/db.ts#L681)
#### deleteNUAClient(accountId, internalId, zone)
> **deleteNUAClient**(`accountId`, `internalId`, `zone`): `Observable`\<`void`\>
##### Parameters
• **accountId**: `string`
• **internalId**: `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:682](https://github.com/nuclia/frontend/blob/ac5686c31474cdc9e830cd28361f63ae5160d985/libs/sdk-core/src/lib/db/db.ts#L682)
***
### editNUAClient()
> **editNUAClient**(`accountId`, `internalId`, `data`, `zone`): `Observable`\<[`NUAClient`](../interfaces/NUAClient.md)\>
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)
#### Defined in
[libs/sdk-core/src/lib/db/db.ts:644](https://github.com/nuclia/frontend/blob/ac5686c31474cdc9e830cd28361f63ae5160d985/libs/sdk-core/src/lib/db/db.ts#L644)
***
### 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:158](https://github.com/nuclia/frontend/blob/ac5686c31474cdc9e830cd28361f63ae5160d985/libs/sdk-core/src/lib/db/db.ts#L158)
***
### 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:855](https://github.com/nuclia/frontend/blob/ac5686c31474cdc9e830cd28361f63ae5160d985/libs/sdk-core/src/lib/db/db.ts#L855)
***
### 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:74](https://github.com/nuclia/frontend/blob/ac5686c31474cdc9e830cd28361f63ae5160d985/libs/sdk-core/src/lib/db/db.ts#L74)
***
### 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:129
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:816
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:824
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:82
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:315
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:316
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:250
getKnowledgeBoxes(accountSlug, accountId, includeSearchConfigs)
getKnowledgeBoxes(
accountSlug,accountId,includeSearchConfigs?):Observable<IKnowledgeBoxItem[]>
Parameters
• accountSlug: string
• accountId: string
• includeSearchConfigs?: boolean
Returns
Observable<IKnowledgeBoxItem[]>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:251
getKnowledgeBoxesForZone()
getKnowledgeBoxesForZone(
accountId,zone,includeSearchConfigs):Observable<IKnowledgeBoxItem[]>
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
Defined in
libs/sdk-core/src/lib/db/db.ts:269
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:692
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:693
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:878
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:918
getModelConfigurations()
getModelConfigurations(
accountId,zone):Observable<ModelConfigurationItem[]>
Get the list of model configurations of an account
Parameters
• accountId: string
• zone: string
Returns
Observable<ModelConfigurationItem[]>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:906
getModels()
getModels(
accountId,zone):Observable<CustomModelItem[]>
Get the list of custom models of an account
Parameters
• accountId: string
• zone: string
Returns
Observable<CustomModelItem[]>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:871
getNUAActivity()
getNUAActivity(
accountId,client_id,zoneSlug,pageIndex):Observable<EventList>
Parameters
• accountId: string
• client_id: string
• zoneSlug: string
• pageIndex: number = 0
Returns
Observable<EventList>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:541
getNUAClient()
getNUAClient(
accountId,internalId,zone):Observable<NUAClient>
Parameters
• accountId: string
• internalId: string
• zone: string
Returns
Observable<NUAClient>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:581
getNUAClients()
getNUAClients(
accountId):Observable<NUAClient[]>
Parameters
• accountId: string
Returns
Observable<NUAClient[]>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:568
getNUAClientsForZone()
getNUAClientsForZone(
accountId,zoneSlug):Observable<NUAClient[]>
Returns the list of NUA clients for the given account and zone.
Parameters
• accountId: string
• zoneSlug: string
Returns
Observable<NUAClient[]>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:551
getNUAHeader()
getNUAHeader():
object
Returns
object
x-nuclia-nuakey
x-nuclia-nuakey:
string
Defined in
libs/sdk-core/src/lib/db/db.ts:598
getNUAKey()
getNUAKey():
string
Returns
string
Defined in
libs/sdk-core/src/lib/db/db.ts:594
getRetrievalAgent()
getRetrievalAgent()
getRetrievalAgent():
Observable<RetrievalAgent>
Returns
Observable<RetrievalAgent>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:353
getRetrievalAgent(accountId, retrievalAgentId, zone)
getRetrievalAgent(
accountId,retrievalAgentId,zone?):Observable<RetrievalAgent>
Parameters
• accountId: string
• retrievalAgentId: string
• zone?: string
Returns
Observable<RetrievalAgent>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:354
getRetrievalAgents()
getRetrievalAgents()
getRetrievalAgents():
Observable<IKnowledgeBoxItem[]>
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
Defined in
libs/sdk-core/src/lib/db/db.ts:280
getRetrievalAgents(accountSlug, accountId, mode, includeSearchConfigs)
getRetrievalAgents(
accountSlug,accountId,mode?,includeSearchConfigs?):Observable<IKnowledgeBoxItem[]>
Parameters
• accountSlug: string
• accountId: string
• mode?: KnowledgeBoxMode
• includeSearchConfigs?: boolean
Returns
Observable<IKnowledgeBoxItem[]>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:281
getRetrievalAgentsForZone()
getRetrievalAgentsForZone(
accountId,zone,mode?,includeSearchConfigs?):Observable<IKnowledgeBoxItem[]>
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
Defined in
libs/sdk-core/src/lib/db/db.ts:301
getSignupInfo()
getSignupInfo(
signup_token):Observable<SignUpInfo>
Returns sign up information.
Parameters
• signup_token: string
Returns
Observable<SignUpInfo>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:150
getStandaloneKbs()
getStandaloneKbs():
Observable<IStandaloneKb[]>
Returns
Observable<IStandaloneKb[]>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:167
getUsage()
getUsage(
accountId,from,to?,knowledgeBoxId?,aggregation?,nuaKeyId?):Observable<UsagePoint[]>
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
Defined in
libs/sdk-core/src/lib/db/db.ts:470
getWelcome()
getWelcome():
Observable<Welcome>
Returns user information.
Example:
nuclia.db.getWelcome().subscribe((welcome) => {
console.log(`Welcome ${welcome.preferences.name}`);
});
Returns
Observable<Welcome>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:143
hasNUAClient()
hasNUAClient():
boolean
Returns
boolean
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:590
inviteToAccount()
inviteToAccount(
accountSlug,data):Observable<void>
Invite a user to an account
Parameters
• accountSlug: string
• data: InviteAccountUserPayload
Returns
Observable<void>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:843
modifyAccount()
modifyAccount(
accountSlug,data):Observable<void>
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
Defined in
libs/sdk-core/src/lib/db/db.ts:106
predictAnswer()
predictAnswer(
question,context,model?):Observable<string>
Generate an answer from a question and a context.
Parameters
• question: string
• context: string[]
• model?: string
Returns
Observable<string>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:725
predictQuery()
predictQuery(
text,rephrase?,model?,rephrase_prompt?):Observable<QueryInfo>
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
Defined in
libs/sdk-core/src/lib/db/db.ts:750
predictSummarize()
predictSummarize(
text,user_prompt?,model?,summary_kind?):Observable<string>
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" = 'simple'
Returns
Observable<string>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:774
predictTokens()
predictTokens(
text):Observable<PredictedToken[]>
Extract NER tokens from a text.
Parameters
• text: string
Returns
Observable<PredictedToken[]>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:710
pull()
pull():
Observable<ProcessingPullResponse>
Pulls the latest data from Nuclia Understanding API.
Requires a NUA token.
Returns
Observable<ProcessingPullResponse>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:534
renewNUAClient()
renewNUAClient(accountId, internalId)
renewNUAClient(
accountId,internalId):Observable<NUAClientResponse>
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
Defined in
libs/sdk-core/src/lib/db/db.ts:664
renewNUAClient(accountId, internalId, zone)
renewNUAClient(
accountId,internalId,zone):Observable<NUAClientResponse>
Parameters
• accountId: string
• internalId: string
• zone: string
Returns
Observable<NUAClientResponse>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:665
setAccountUsers()
setAccountUsers(
accountSlug,users):Observable<void>
Add and/or delete users from an account
Parameters
• accountSlug: string
• users: AccountUsersPayload
Returns
Observable<void>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:833
updateModelConfiguration()
updateModelConfiguration(
model,modelId,accountId,zone):Observable<void>
Updates a model configuration
Parameters
• model: ModelConfigurationCreation
• modelId: string
• accountId: string
• zone: string
Returns
Observable<void>
Implementation of
Defined in
libs/sdk-core/src/lib/db/db.ts:944
upload()
upload(
file):Observable<ProcessingPushResponse>
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>