Skip to main content

NucliaOptions

@nuclia/core

@nuclia/core / NucliaOptions

Interface: NucliaOptions

Defined in: libs/sdk-core/src/lib/models.ts:273

Properties​

account?​

optional account?: string

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

The Nuclia account slug.

Example: my-account

accountId?​

optional accountId?: string

Defined in: libs/sdk-core/src/lib/models.ts:309

The Nuclia account id.

accountType?​

optional accountType?: AccountTypes

Defined in: libs/sdk-core/src/lib/models.ts:305

apiKey?​

optional apiKey?: string

Defined in: libs/sdk-core/src/lib/models.ts:294

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.

backend​

backend: string

Defined in: libs/sdk-core/src/lib/models.ts:278

The Nuclia backend to use.

Example: https://accounts.progress.cloud/api

client?​

optional client?: string

Defined in: libs/sdk-core/src/lib/models.ts:320

kbSlug?​

optional kbSlug?: string

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

The Knowledge Box slug.

Example: my-kb

knowledgeBox?​

optional knowledgeBox?: string

Defined in: libs/sdk-core/src/lib/models.ts:314

The Nuclia Knowledge Box unique id.

Example: 17815eb2-06a5-40ee-a5aa-b2f9dbc5da70

modifyHeaders?​

optional modifyHeaders?: (headers) => object

Defined in: libs/sdk-core/src/lib/models.ts:338

Allow to modify the headers for the REST calls.

Parameters​

headers​

Returns​

object

nuaKey?​

optional nuaKey?: string

Defined in: libs/sdk-core/src/lib/models.ts:298

Allows you to make calls the NUA processing.

oauth?​

optional oauth?: object

Defined in: libs/sdk-core/src/lib/models.ts:332

OAuth parameters.

client_id​

client_id: string

proxy?​

optional proxy?: boolean

Defined in: libs/sdk-core/src/lib/models.ts:322

Indicates if you are using a proxy.

public?​

optional public?: boolean

Defined in: libs/sdk-core/src/lib/models.ts:328

Indicates if the Knowledge Box is public or not.

Set it to false when using a private Knowledge Box.

regionalPrefix?​

optional regionalPrefix?: string

Defined in: libs/sdk-core/src/lib/models.ts:288

The regional base doamin prefix.

Example: europe-1

zone?​

optional zone?: string

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

The geographical zone for the regional API calls.

Example: europe-1