Skip to main content

SearchOptions

@nuclia/core • Docs

@nuclia/core / SearchOptions

Interface: SearchOptions

Extends​

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:81

debug?​

optional debug: boolean

Inherited from​

BaseSearchOptions.debug

Defined in​

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

extracted?​

optional extracted: ExtractedDataTypes[]

Deprecated​

Inherited from​

BaseSearchOptions.extracted

Defined in​

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

faceted?​

optional faceted: string[]

Defined in​

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

features?​

optional features: Features[]

Defined in​

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

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:74

fields?​

optional fields: string[]

Inherited from​

BaseSearchOptions.fields

Defined in​

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

filter_expression?​

optional filter_expression: FilterExpression

Inherited from​

BaseSearchOptions.filter_expression

Defined in​

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

filters?​

optional filters: string[] | Filter[]

Inherited from​

BaseSearchOptions.filters

Defined in​

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

highlight?​

optional highlight: boolean

Inherited from​

BaseSearchOptions.highlight

Defined in​

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

keyword_filters?​

optional keyword_filters: string[] | Filter[]

Inherited from​

BaseSearchOptions.keyword_filters

Defined in​

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

min_score?​

optional min_score: number | MinScore

Inherited from​

BaseSearchOptions.min_score

Defined in​

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

page_number?​

optional page_number: number

Deprecated​

use top_k

Defined in​

libs/sdk-core/src/lib/db/search/search.models.ts:136

page_size?​

optional page_size: number

Deprecated​

use top_k

Defined in​

libs/sdk-core/src/lib/db/search/search.models.ts:140

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:68

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:67

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:70

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:69

rank_fusion?​

optional rank_fusion: RankFusion

Inherited from​

BaseSearchOptions.rank_fusion

Defined in​

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

rephrase?​

optional rephrase: boolean

Inherited from​

BaseSearchOptions.rephrase

Defined in​

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

rephrase_prompt?​

optional rephrase_prompt: string

Defined in​

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

reranker?​

optional reranker: Reranker

Inherited from​

BaseSearchOptions.reranker

Defined in​

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

resource_filters?​

optional resource_filters: string[]

Inherited from​

BaseSearchOptions.resource_filters

Defined in​

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

search_configuration?​

optional search_configuration: string

Inherited from​

BaseSearchOptions.search_configuration

Defined in​

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

security?​

optional security: object

groups​

groups: string[]

Inherited from​

BaseSearchOptions.security

Defined in​

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

show?​

optional show: ResourceProperties[]

Inherited from​

BaseSearchOptions.show

Defined in​

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

show_hidden?​

optional show_hidden: boolean

Inherited from​

BaseSearchOptions.show_hidden

Defined in​

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

sort?​

optional sort: SortOption

Defined in​

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

top_k?​

optional top_k: number

Inherited from​

BaseSearchOptions.top_k

Defined in​

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

vectorset?​

optional vectorset: string

Inherited from​

BaseSearchOptions.vectorset

Defined in​

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

with_duplicates?​

optional with_duplicates: boolean

Defined in​

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

with_status?​

optional with_status: ResourceStatus

Defined in​

libs/sdk-core/src/lib/db/search/search.models.ts:141

with_synonyms?​

optional with_synonyms: boolean

Defined in​

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