Skip to main content

ChatOptions

@nuclia/core • Docs

@nuclia/core / ChatOptions

Interface: ChatOptions

Extends​

Properties​

answer_json_schema?​

optional answer_json_schema: object

Defined in​

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

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

autofilter?​

optional autofilter: boolean

Inherited from​

BaseSearchOptions.autofilter

Defined in​

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

citation_threshold?​

optional citation_threshold: number

Defined in​

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

citations?​

optional citations: boolean

It will return the text blocks that have been effectively used to build each section of the answer.

Defined in​

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

debug?​

optional debug: boolean

Inherited from​

BaseSearchOptions.debug

Defined in​

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

extra_context?​

optional extra_context: string[]

Defined in​

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

extra_context_images?​

optional extra_context_images: object[]

Defined in​

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

extracted?​

optional extracted: ExtractedDataTypes[]

Deprecated​

Inherited from​

BaseSearchOptions.extracted

Defined in​

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

features?​

optional features: Features[]

Defined in​

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

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

generative_model?​

optional generative_model: string

Defined in​

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

highlight?​

optional highlight: boolean

Inherited from​

BaseSearchOptions.highlight

Defined in​

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

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

max_tokens?​

optional max_tokens: number | object

Defines the maximum number of tokens that the model will take as context.

Defined in​

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

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

prefer_markdown?​

optional prefer_markdown: boolean

Defined in​

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

prompt?​

optional prompt: string | Prompts

Defined in​

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

rag_images_strategies?​

optional rag_images_strategies: RAGImageStrategy[]

Defined in​

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

rag_strategies?​

optional rag_strategies: RAGStrategy[]

Defined in​

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

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

rephrase?​

optional rephrase: boolean

Inherited from​

BaseSearchOptions.rephrase

Defined in​

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

reranker?​

optional reranker: Reranker

Inherited from​

BaseSearchOptions.reranker

Defined in​

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

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

security?​

optional security: object

groups​

groups: string[]

Inherited from​

BaseSearchOptions.security

Defined in​

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

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

synchronous?​

optional synchronous: boolean

Defined in​

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

top_k?​

optional top_k: number

Inherited from​

BaseSearchOptions.top_k

Defined in​

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

vectorset?​

optional vectorset: string

Inherited from​

BaseSearchOptions.vectorset

Defined in​

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