@nuclia/core / Exports / IKnowledgeBox
Interface: IKnowledgeBox
Hierarchy
-
↳
IKnowledgeBox
↳↳
KnowledgeBox
Implemented by
Table of contents
Properties
- allowed_origins
- description
- external_index_provider
- hidden_resources_enabled
- hidden_resources_hide_on_creation
- id
- search_configs
- slug
- state
- title
- uuid
- zone
Accessors
Methods
- ask
- catalog
- counters
- createAgenticRAGPipeline
- downloadActivity
- feedback
- find
- generate
- generateJSON
- generateRandomQuestionAboutResource
- getConfiguration
- getEntities
- getEntitiesGroup
- getFullResource
- getFullResourceBySlug
- getLabels
- getLearningSchema
- getResource
- getResourceBySlug
- getSynonyms
- getTempToken
- getUsers
- listActivity
- listActivityDownloads
- listFeedback
- listResources
- listenToAllNotifications
- listenToProcessingNotifications
- listenToResourceOperationNotifications
- processingStatus
- rephrase
- search
- stopListeningToNotifications
- suggest
- summarize
- tokens
Properties
allowed_origins
• Optional
allowed_origins: null
| string
[]
Inherited from
IKnowledgeBoxCreation.allowed_origins
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:40
description
• Optional
description: string
Inherited from
IKnowledgeBoxCreation.description
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:37
external_index_provider
• Optional
external_index_provider: "pinecone"
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:85
hidden_resources_enabled
• Optional
hidden_resources_enabled: boolean
Inherited from
IKnowledgeBoxCreation.hidden_resources_enabled
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:42
hidden_resources_hide_on_creation
• Optional
hidden_resources_hide_on_creation: boolean
Inherited from
IKnowledgeBoxCreation.hidden_resources_hide_on_creation
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:43
id
• id: string
Inherited from
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:33
search_configs
• Optional
search_configs: Object
Index signature
▪ [key: string
]: any
Inherited from
IKnowledgeBoxCreation.search_configs
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:41
slug
• slug: string
Inherited from
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:34
state
• Optional
state: KBStates
Inherited from
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:36
title
• title: string
Inherited from
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:35
uuid
• Optional
uuid: string
Inherited from
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:39
zone
• zone: string
Inherited from
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:38
Accessors
fullpath
• get
fullpath(): string
Returns
string
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:89
path
• get
path(): string
Returns
string
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:87
Methods
ask
▸ ask(query
, context?
, features?
, options?
): Observable
<IErrorResponse
| Answer
>
Parameters
Name | Type |
---|---|
query | string |
context? | ContextEntry [] |
features? | Features [] |
options? | ChatOptions |
Returns
Observable
<IErrorResponse
| Answer
>
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:109
▸ ask(query
, context?
, features?
, options?
, callback?
): Observable
<IErrorResponse
| Answer
>
Parameters
Name | Type |
---|---|
query | string |
context? | ContextEntry [] |
features? | Features [] |
options? | ChatOptions |
callback? | (answer : IErrorResponse | Answer ) => void |
Returns
Observable
<IErrorResponse
| Answer
>
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:115
catalog
▸ catalog(query
, options?
): Observable
<Results
| IErrorResponse
>
Parameters
Name | Type |
---|---|
query | string |
options? | SearchOptions |
Returns
Observable
<Results
| IErrorResponse
>
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:151
counters
▸ counters(): Observable
<Counters
>
Returns
Observable
<Counters
>
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:158
createAgenticRAGPipeline
▸ createAgenticRAGPipeline(steps
): Pipeline
Parameters
Name | Type |
---|---|
steps | Steps |
Returns
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:107
downloadActivity
▸ downloadActivity(type
, month
): Observable
<Blob
>
Parameters
Name | Type |
---|---|
type | EventType |
month | string |
Returns
Observable
<Blob
>
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:168
feedback
▸ feedback(answerId
, good
): Observable
<void
>
Parameters
Name | Type |
---|---|
answerId | string |
good | boolean |
Returns
Observable
<void
>
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:155
find
▸ find(query
, features?
, options?
): Observable
<FindResults
| IErrorResponse
>
Parameters
Name | Type |
---|---|
query | string |
features? | Features [] |
options? | SearchOptions |
Returns
Observable
<FindResults
| IErrorResponse
>
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:123
generate
▸ generate(question
, context
): Observable
<{ answer
: string
; cannotAnswer
: boolean
}>
Parameters
Name | Type |
---|---|
question | string |
context | string [] |
Returns
Observable
<{ answer
: string
; cannotAnswer
: boolean
}>
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:139
generateJSON
▸ generateJSON(question
, json_schema
, context
): Observable
<{ answer
: object
; success
: boolean
}>
Parameters
Name | Type |
---|---|
question | string |
json_schema | object |
context | string [] |
Returns
Observable
<{ answer
: object
; success
: boolean
}>
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:141
generateRandomQuestionAboutResource
▸ generateRandomQuestionAboutResource(resource
): Observable
<string
>
Parameters
Name | Type |
---|---|
resource | Resource |
Returns
Observable
<string
>
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:149
getConfiguration
▸ getConfiguration(): Observable
<{ [id: string]
: any
; }>
Returns
Observable
<{ [id: string]
: any
; }>
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:170
getEntities
▸ getEntities(): Observable
<Entities
>
Returns
Observable
<Entities
>
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:91
getEntitiesGroup
▸ getEntitiesGroup(groupId
): Observable
<EntitiesGroup
>
Parameters
Name | Type |
---|---|
groupId | string |
Returns
Observable
<EntitiesGroup
>
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:93
getFullResource
▸ getFullResource(uuid
): Observable
<IResource
>
Parameters
Name | Type |
---|---|
uuid | string |
Returns
Observable
<IResource
>
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:101
getFullResourceBySlug
▸ getFullResourceBySlug(slug
): Observable
<IResource
>
Parameters
Name | Type |
---|---|
slug | string |
Returns
Observable
<IResource
>
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:105
getLabels
▸ getLabels(): Observable
<LabelSets
>
Returns
Observable
<LabelSets
>
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:97
getLearningSchema
▸ getLearningSchema(): Observable
<LearningConfigurations
>
Returns
Observable
<LearningConfigurations
>
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:171
getResource
▸ getResource(uuid
, show?
, extracted?
): Observable
<IResource
>
Parameters
Name | Type |
---|---|
uuid | string |
show? | ResourceProperties [] |
extracted? | ExtractedDataTypes [] |
Returns
Observable
<IResource
>
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:99
getResourceBySlug
▸ getResourceBySlug(slug
, show?
, extracted?
): Observable
<IResource
>
Parameters
Name | Type |
---|---|
slug | string |
show? | ResourceProperties [] |
extracted? | ExtractedDataTypes [] |
Returns
Observable
<IResource
>
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:103
getSynonyms
▸ getSynonyms(): Observable
<Synonyms
>
Returns
Observable
<Synonyms
>
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:95
getTempToken
▸ getTempToken(): Observable
<string
>
Returns
Observable
<string
>
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:162
getUsers
▸ getUsers(accountSlug
): Observable
<FullKbUser
[]>
Parameters
Name | Type |
---|---|
accountSlug | string |
Returns
Observable
<FullKbUser
[]>
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:173
listActivity
▸ listActivity(type?
, page?
, size?
): Observable
<EventList
>
Parameters
Name | Type |
---|---|
type? | EventType |
page? | number |
size? | number |
Returns
Observable
<EventList
>
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:164
listActivityDownloads
▸ listActivityDownloads(type
): Observable
<ActivityDownloadList
>
Parameters
Name | Type |
---|---|
type | EventType |
Returns
Observable
<ActivityDownloadList
>
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:166
listFeedback
▸ listFeedback(): Observable
<string
[]>
Returns
Observable
<string
[]>
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:156
listResources
▸ listResources(page?
, size?
): Observable
<ResourceList
>
Parameters
Name | Type |
---|---|
page? | number |
size? | number |
Returns
Observable
<ResourceList
>
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:160
listenToAllNotifications
▸ listenToAllNotifications(): Observable
<NotificationMessage
[]>
Returns
Observable
<NotificationMessage
[]>
Defined in
libs/sdk-core/src/lib/db/kb/kb.models.ts:175