SearchOptions

@nuclia/core

---

@nuclia/core / SearchOptions

Interface: SearchOptions

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:131

Extends

• BaseSearchOptions

Properties

audit_metadata?

optional audit_metadata?: object

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:81

Index Signature

[key: string]: string

Inherited from

BaseSearchOptions.audit_metadata

---

debug?

optional debug?: boolean

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:79

Inherited from

BaseSearchOptions.debug

---

extracted?

optional extracted?: ExtractedDataTypes[]

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:73

Deprecated

Inherited from

BaseSearchOptions.extracted

---

faceted?

optional faceted?: string[]

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:132

---

features?

optional features?: Features[]

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:146

---

field_type_filter?

optional field_type_filter?: FIELD_TYPE[]

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:74

Inherited from

BaseSearchOptions.field_type_filter

---

fields?

optional fields?: string[]

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:62

Inherited from

BaseSearchOptions.fields

---

filter_expression?

optional filter_expression?: FilterExpression

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:64

Inherited from

BaseSearchOptions.filter_expression

---

filters?

optional filters?: string[] | Filter[]

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:63

Inherited from

BaseSearchOptions.filters

---

highlight?

optional highlight?: boolean

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:76

Inherited from

BaseSearchOptions.highlight

---

keyword_filters?

optional keyword_filters?: string[] | Filter[]

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:65

Inherited from

BaseSearchOptions.keyword_filters

---

min_score?

optional min_score?: number | MinScore

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:66

Inherited from

BaseSearchOptions.min_score

---

offset?

optional offset?: number

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:134

---

page_number?

optional page_number?: number

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:138

Deprecated

use top_k

---

page_size?

optional page_size?: number

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:142

Deprecated

use top_k

---

range_creation_end?

optional range_creation_end?: string

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:68

Inherited from

BaseSearchOptions.range_creation_end

---

range_creation_start?

optional range_creation_start?: string

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:67

Inherited from

BaseSearchOptions.range_creation_start

---

range_modification_end?

optional range_modification_end?: string

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:70

Inherited from

BaseSearchOptions.range_modification_end

---

range_modification_start?

optional range_modification_start?: string

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:69

Inherited from

BaseSearchOptions.range_modification_start

---

rank_fusion?

optional rank_fusion?: RankFusion

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:84

Inherited from

BaseSearchOptions.rank_fusion

---

rephrase?

optional rephrase?: boolean

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:77

Inherited from

BaseSearchOptions.rephrase

---

rephrase_prompt?

optional rephrase_prompt?: string

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:145

---

reranker?

optional reranker?: Reranker

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:83

Inherited from

BaseSearchOptions.reranker

---

resource_filters?

optional resource_filters?: string[]

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:75

Inherited from

BaseSearchOptions.resource_filters

---

search_configuration?

optional search_configuration?: string

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:86

Inherited from

BaseSearchOptions.search_configuration

---

security?

optional security?: object

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:85

groups

groups: string[]

Inherited from

BaseSearchOptions.security

---

show?

optional show?: ResourceProperties[]

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:71

Inherited from

BaseSearchOptions.show

---

show_hidden?

optional show_hidden?: boolean

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:80

Inherited from

BaseSearchOptions.show_hidden

---

sort?

optional sort?: SortOption

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:133

---

top_k?

optional top_k?: number

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:82

Inherited from

BaseSearchOptions.top_k

---

vectorset?

optional vectorset?: string

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:78

Inherited from

BaseSearchOptions.vectorset

---

with_duplicates?

optional with_duplicates?: boolean

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:144

---

with_status?

optional with_status?: ResourceStatus

Defined in: libs/sdk-core/src/lib/db/search/search.models.ts:143