KnowledgeOS API Reference
Preparing search index...
search/src
IndexStore
Class IndexStore
Index
Constructors
constructor
Methods
add
Document
clear
get
All
Documents
get
Document
get
Document
By
Entity
get
Document
Count
get
Field
Entries
get
Field
Index
Size
get
Field
Names
get
Inverted
Entries
get
Inverted
Index
Size
has
Document
remove
Document
search
Field
search
Inverted
Constructors
constructor
new
IndexStore
()
:
IndexStore
Returns
IndexStore
Methods
add
Document
addDocument
(
doc
:
SearchDocument
)
:
void
Parameters
doc
:
SearchDocument
Returns
void
clear
clear
()
:
number
Returns
number
get
All
Documents
getAllDocuments
()
:
SearchDocument
[]
Returns
SearchDocument
[]
get
Document
getDocument
(
docId
:
string
)
:
SearchDocument
|
undefined
Parameters
docId
:
string
Returns
SearchDocument
|
undefined
get
Document
By
Entity
getDocumentByEntity
(
entityId
:
string
)
:
SearchDocument
|
undefined
Parameters
entityId
:
string
Returns
SearchDocument
|
undefined
get
Document
Count
getDocumentCount
()
:
number
Returns
number
get
Field
Entries
getFieldEntries
()
:
FieldIndexEntry
[]
Returns
FieldIndexEntry
[]
get
Field
Index
Size
getFieldIndexSize
()
:
number
Returns
number
get
Field
Names
getFieldNames
()
:
string
[]
Returns
string
[]
get
Inverted
Entries
getInvertedEntries
()
:
InvertedIndexEntry
[]
Returns
InvertedIndexEntry
[]
get
Inverted
Index
Size
getInvertedIndexSize
()
:
number
Returns
number
has
Document
hasDocument
(
docId
:
string
)
:
boolean
Parameters
docId
:
string
Returns
boolean
remove
Document
removeDocument
(
docId
:
string
)
:
SearchDocument
|
undefined
Parameters
docId
:
string
Returns
SearchDocument
|
undefined
search
Field
searchField
(
fieldName
:
string
,
fieldValue
:
string
)
:
FieldIndexEntry
|
undefined
Parameters
fieldName
:
string
fieldValue
:
string
Returns
FieldIndexEntry
|
undefined
search
Inverted
searchInverted
(
tokenText
:
string
)
:
InvertedIndexEntry
|
undefined
Parameters
tokenText
:
string
Returns
InvertedIndexEntry
|
undefined
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
add
Document
clear
get
All
Documents
get
Document
get
Document
By
Entity
get
Document
Count
get
Field
Entries
get
Field
Index
Size
get
Field
Names
get
Inverted
Entries
get
Inverted
Index
Size
has
Document
remove
Document
search
Field
search
Inverted
KnowledgeOS API Reference
Loading...