KnowledgeOS API Reference
Preparing search index...
search/src
SearchAPI
Class SearchAPI
Index
Constructors
constructor
Accessors
index
state
Methods
build
Index
clear
Index
count
handle
Event
health
initialize
rebuild
Index
remove
Index
resume
search
search
Health
shutdown
statistics
subscribe
subscribe
All
suggest
suspend
Constructors
constructor
new
SearchAPI
(
runtime
?:
SearchRuntime
)
:
SearchAPI
Parameters
Optional
runtime
:
SearchRuntime
Returns
SearchAPI
Accessors
index
get
index
()
:
SearchIndex
|
null
Returns
SearchIndex
|
null
state
get
state
()
:
SearchRuntimeState
Returns
SearchRuntimeState
Methods
build
Index
buildIndex
(
adapter
:
GraphReadAdapter
)
:
void
Parameters
adapter
:
GraphReadAdapter
Returns
void
clear
Index
clearIndex
()
:
number
Returns
number
count
count
(
query
:
CountQuery
)
:
number
Parameters
query
:
CountQuery
Returns
number
handle
Event
handleEvent
(
event
:
SearchEvent
)
:
void
Parameters
event
:
SearchEvent
Returns
void
health
health
()
:
{
indexCount
:
number
;
initialized
:
boolean
;
status
:
string
}
Returns
{
indexCount
:
number
;
initialized
:
boolean
;
status
:
string
}
initialize
initialize
(
config
:
SearchConfig
,
graphAdapter
:
GraphReadAdapter
)
:
SearchIndex
Parameters
config
:
SearchConfig
graphAdapter
:
GraphReadAdapter
Returns
SearchIndex
rebuild
Index
rebuildIndex
()
:
void
Returns
void
remove
Index
removeIndex
()
:
void
Returns
void
resume
resume
()
:
void
Returns
void
search
search
(
query
:
SearchQuery
,
)
:
{
metadata
:
SearchMetadata
;
results
:
SearchResult
[]
}
Parameters
query
:
SearchQuery
Returns
{
metadata
:
SearchMetadata
;
results
:
SearchResult
[]
}
search
Health
searchHealth
()
:
{
indexCount
:
number
;
initialized
:
boolean
;
queueDepth
:
number
;
uptime
:
number
;
}
Returns
{
indexCount
:
number
;
initialized
:
boolean
;
queueDepth
:
number
;
uptime
:
number
}
shutdown
shutdown
()
:
void
Returns
void
statistics
statistics
()
:
{
averageQueryTimeMs
:
number
;
averageResultsPerQuery
:
number
;
indexCount
:
number
;
totalDocuments
:
number
;
totalQueries
:
number
;
totalResults
:
number
;
totalTokens
:
number
;
}
Returns
{
averageQueryTimeMs
:
number
;
averageResultsPerQuery
:
number
;
indexCount
:
number
;
totalDocuments
:
number
;
totalQueries
:
number
;
totalResults
:
number
;
totalTokens
:
number
;
}
subscribe
subscribe
(
type
:
string
,
handler
:
(
event
:
SearchEvent
)
=>
void
)
:
()
=>
void
Parameters
type
:
string
handler
:
(
event
:
SearchEvent
)
=>
void
Returns
()
=>
void
subscribe
All
subscribeAll
(
handler
:
(
event
:
SearchEvent
)
=>
void
)
:
()
=>
void
Parameters
handler
:
(
event
:
SearchEvent
)
=>
void
Returns
()
=>
void
suggest
suggest
(
query
:
SuggestQuery
)
:
Suggestion
[]
Parameters
query
:
SuggestQuery
Returns
Suggestion
[]
suspend
suspend
()
:
void
Returns
void
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Accessors
index
state
Methods
build
Index
clear
Index
count
handle
Event
health
initialize
rebuild
Index
remove
Index
resume
search
search
Health
shutdown
statistics
subscribe
subscribe
All
suggest
suspend
KnowledgeOS API Reference
Loading...