@nuclia/core / Exports / SearchOptions
Interface: SearchOptions
Hierarchy
-
↳
SearchOptions
Table of contents
Properties
- audit_metadata
- autofilter
- debug
- extracted
- faceted
- field_type_filter
- fields
- filters
- highlight
- keyword_filters
- min_score
- page_number
- page_size
- range_creation_end
- range_creation_start
- range_modification_end
- range_modification_start
- rephrase
- rephrase_prompt
- reranker
- resource_filters
- shards
- show
- show_hidden
- sort
- top_k
- vectorset
- with_duplicates
- with_status
- with_synonyms
Properties
audit_metadata
• Optional audit_metadata: Object
Index signature
▪ [key: string]: string
Inherited from
BaseSearchOptions.audit_metadata
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:67
autofilter
• Optional autofilter: boolean
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:61
debug
• Optional debug: boolean
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:65
extracted
• Optional extracted: ExtractedDataTypes[]
Deprecated
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:57
faceted
• Optional faceted: string[]
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:93
field_type_filter
• Optional field_type_filter: FIELD_TYPE[]
Inherited from
BaseSearchOptions.field_type_filter
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:58
fields
• Optional fields: string[]
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:47
filters
• Optional filters: string[] | Filter[]
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:48
highlight
• Optional highlight: boolean
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:62
keyword_filters
• Optional keyword_filters: string[] | Filter[]
Inherited from
BaseSearchOptions.keyword_filters
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:49
min_score
• Optional min_score: number
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:50
page_number
• Optional page_number: number
Deprecated
use top_k
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:98
page_size
• Optional page_size: number
Deprecated
use top_k
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:102
range_creation_end
• Optional range_creation_end: string
Inherited from
BaseSearchOptions.range_creation_end
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:52
range_creation_start
• Optional range_creation_start: string
Inherited from
BaseSearchOptions.range_creation_start
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:51
range_modification_end
• Optional range_modification_end: string
Inherited from
BaseSearchOptions.range_modification_end
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:54
range_modification_start
• Optional range_modification_start: string
Inherited from
BaseSearchOptions.range_modification_start
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:53
rephrase
• Optional rephrase: boolean
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:63
rephrase_prompt
• Optional rephrase_prompt: string
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:106
reranker
• Optional reranker: Reranker
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:69
resource_filters
• Optional resource_filters: string[]
Inherited from
BaseSearchOptions.resource_filters
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:59
shards
• Optional shards: string[]
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:60
show
• Optional show: ResourceProperties[]
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:55
show_hidden
• Optional show_hidden: boolean
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:66
sort
• Optional sort: SortOption
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:94
top_k
• Optional top_k: number
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:68
vectorset
• Optional vectorset: string
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:64
with_duplicates
• Optional with_duplicates: boolean
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:104
with_status
• Optional with_status: ResourceStatus
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:103
with_synonyms
• Optional with_synonyms: boolean