Skip to main content

NucliaOptions

@nuclia/core • Docs

@nuclia/core / NucliaOptions

Interface: NucliaOptions

Properties​

account?​

optional account: string

The Nuclia account slug.

Example: my-account

Defined in​

libs/sdk-core/src/lib/models.ts:277

accountId?​

optional accountId: string

The Nuclia account id.

Defined in​

libs/sdk-core/src/lib/models.ts:282

accountType?​

optional accountType: AccountTypes

Defined in​

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

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:267

backend​

backend: string

The Nuclia backend to use.

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

Defined in​

libs/sdk-core/src/lib/models.ts:251

client?​

optional client: string

Defined in​

libs/sdk-core/src/lib/models.ts:293

kbSlug?​

optional kbSlug: string

The Knowledge Box slug.

Example: my-kb

Defined in​

libs/sdk-core/src/lib/models.ts:292

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:287

modifyHeaders()?​

optional modifyHeaders: (headers) => object

Allow to modify the headers for the REST calls.

Parameters​

• headers

Returns​

object

Defined in​

libs/sdk-core/src/lib/models.ts:313

nuaKey?​

optional nuaKey: string

Allows you to make calls the NUA processing.

Defined in​

libs/sdk-core/src/lib/models.ts:271

oauth?​

optional oauth: object

OAuth parameters.

client_id​

client_id: string

Defined in​

libs/sdk-core/src/lib/models.ts:307

proxy?​

optional proxy: boolean

Indicates if you are using a proxy.

Defined in​

libs/sdk-core/src/lib/models.ts:297

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:303

regionalPrefix?​

optional regionalPrefix: string

The regional base doamin prefix.

Example: europe-1

Defined in​

libs/sdk-core/src/lib/models.ts:261

standalone?​

optional standalone: boolean

Indicates if you are using a local NucliaDB instance.

Defined in​

libs/sdk-core/src/lib/models.ts:295

zone?​

optional zone: string

The geographical zone for the regional API calls.

Example: europe-1

Defined in​

libs/sdk-core/src/lib/models.ts:256