@nuclia/core / Exports / NucliaOptions
Interface: NucliaOptions
Table of contents
Properties
- account
- accountId
- accountType
- apiKey
- backend
- client
- kbSlug
- knowledgeBox
- modifyHeaders
- nuaKey
- proxy
- public
- standalone
- zone
Properties
account
• Optional account: string
The Nuclia account slug.
Example: my-account
Defined in
libs/sdk-core/src/lib/models.ts:212
accountId
• Optional accountId: string
The Nuclia account id.
Defined in
libs/sdk-core/src/lib/models.ts:217
accountType
• Optional accountType: AccountTypes
Defined in
libs/sdk-core/src/lib/models.ts:213
apiKey
• Optional apiKey: string
Allows you to make calls to a private Knowledge Box.
It can be used in a server-side app, but never in a web app.
Defined in
libs/sdk-core/src/lib/models.ts:202
backend
• backend: string
The Nuclia backend to use.
Example: https://nuclia.cloud/api
Defined in
libs/sdk-core/src/lib/models.ts:191
client
• Optional client: string
Defined in
libs/sdk-core/src/lib/models.ts:228
kbSlug
• Optional kbSlug: string
The Knowledge Box slug.
Example: my-kb
Defined in
libs/sdk-core/src/lib/models.ts:227
knowledgeBox
• Optional knowledgeBox: string
The Nuclia Knowledge Box unique id.
Example: 17815eb2-06a5-40ee-a5aa-b2f9dbc5da70
Defined in
libs/sdk-core/src/lib/models.ts:222
modifyHeaders
• Optional modifyHeaders: (headers: { [key: string]: string; }) => { [key: string]: string; }
Type declaration
▸ (headers): Object
Allow to modify the headers for the REST calls.
Parameters
| Name | Type |
|---|---|
headers | Object |
Returns
Object
Defined in
libs/sdk-core/src/lib/models.ts:242
nuaKey
• Optional nuaKey: string
Allows you to make calls the NUA processing.
Defined in
libs/sdk-core/src/lib/models.ts:206
proxy
• Optional proxy: boolean
Indicates if you are using a proxy.
Defined in
libs/sdk-core/src/lib/models.ts:232
public
• Optional public: boolean
Indicates if the Knowledge Box is public or not.
Set it to false when using a private Knowledge Box.
Defined in
libs/sdk-core/src/lib/models.ts:238
standalone
• Optional standalone: boolean
Indicates if you are using a local NucliaDB instance.
Defined in
libs/sdk-core/src/lib/models.ts:230
zone
• Optional zone: string
The geographical zone for the regional API calls.
Example: europe-1