NucliaOptions
@nuclia/core • Docs
@nuclia/core / NucliaOptions
Interface: NucliaOptions
Properties
account?
optionalaccount:string
The Nuclia account slug.
Example: my-account
Defined in
libs/sdk-core/src/lib/models.ts:266
accountId?
optionalaccountId:string
The Nuclia account id.
Defined in
libs/sdk-core/src/lib/models.ts:271
accountType?
optionalaccountType:AccountTypes
Defined in
libs/sdk-core/src/lib/models.ts:267
apiKey?
optionalapiKey: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:256
backend
backend:
string
The Nuclia backend to use.
Example: https://rag.progress.cloud/api
Defined in
libs/sdk-core/src/lib/models.ts:245
client?
optionalclient:string
Defined in
libs/sdk-core/src/lib/models.ts:282
kbSlug?
optionalkbSlug:string
The Knowledge Box slug.
Example: my-kb
Defined in
libs/sdk-core/src/lib/models.ts:281
knowledgeBox?
optionalknowledgeBox:string
The Nuclia Knowledge Box unique id.
Example: 17815eb2-06a5-40ee-a5aa-b2f9dbc5da70
Defined in
libs/sdk-core/src/lib/models.ts:276
modifyHeaders()?
optionalmodifyHeaders: (headers) =>object
Allow to modify the headers for the REST calls.
Parameters
• headers
Returns
object
Defined in
libs/sdk-core/src/lib/models.ts:296
nuaKey?
optionalnuaKey:string
Allows you to make calls the NUA processing.
Defined in
libs/sdk-core/src/lib/models.ts:260
proxy?
optionalproxy:boolean
Indicates if you are using a proxy.
Defined in
libs/sdk-core/src/lib/models.ts:286
public?
optionalpublic: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:292
standalone?
optionalstandalone:boolean
Indicates if you are using a local NucliaDB instance.
Defined in
libs/sdk-core/src/lib/models.ts:284
zone?
optionalzone:string
The geographical zone for the regional API calls.
Example: europe-1