KnowledgeOS API Reference
Preparing search index...
sdk/typescript/src
SearchQuery
Interface SearchQuery
interface
SearchQuery
{
execute
()
:
Promise
<
SDKResponse
<
SearchResponseDTO
>
>
;
executeRaw
()
:
Promise
<
ApiResponse
<
SearchResponseDTO
>
>
;
fields
(
fields
:
string
[]
)
:
SearchQuery
;
fuzzy
(
enabled
?:
boolean
)
:
SearchQuery
;
highlight
(
enabled
?:
boolean
)
:
SearchQuery
;
maxResults
(
n
:
number
)
:
SearchQuery
;
offset
(
n
:
number
)
:
SearchQuery
;
orderBy
(
field
:
"score"
|
"relevance"
|
"freshness"
)
:
SearchQuery
;
}
Hierarchy (
View Summary
)
QueryBuilder
<
SearchResponseDTO
>
SearchQuery
Index
Methods
execute
execute
Raw
fields
fuzzy
highlight
max
Results
offset
order
By
Methods
execute
execute
()
:
Promise
<
SDKResponse
<
SearchResponseDTO
>
>
Returns
Promise
<
SDKResponse
<
SearchResponseDTO
>
>
execute
Raw
executeRaw
()
:
Promise
<
ApiResponse
<
SearchResponseDTO
>
>
Returns
Promise
<
ApiResponse
<
SearchResponseDTO
>
>
fields
fields
(
fields
:
string
[]
)
:
SearchQuery
Parameters
fields
:
string
[]
Returns
SearchQuery
fuzzy
fuzzy
(
enabled
?:
boolean
)
:
SearchQuery
Parameters
Optional
enabled
:
boolean
Returns
SearchQuery
highlight
highlight
(
enabled
?:
boolean
)
:
SearchQuery
Parameters
Optional
enabled
:
boolean
Returns
SearchQuery
max
Results
maxResults
(
n
:
number
)
:
SearchQuery
Parameters
n
:
number
Returns
SearchQuery
offset
offset
(
n
:
number
)
:
SearchQuery
Parameters
n
:
number
Returns
SearchQuery
order
By
orderBy
(
field
:
"score"
|
"relevance"
|
"freshness"
)
:
SearchQuery
Parameters
field
:
"score"
|
"relevance"
|
"freshness"
Returns
SearchQuery
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
Methods
execute
execute
Raw
fields
fuzzy
highlight
max
Results
offset
order
By
KnowledgeOS API Reference
Loading...