Skip to main content

ChatOptions

@nuclia/core

@nuclia/core / ChatOptions

Interface: ChatOptions

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

Extends​

Properties​

agentic_config_id?​

optional agentic_config_id?: string

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

answer_json_schema?​

optional answer_json_schema?: object

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

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

citation_threshold?​

optional citation_threshold?: number

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

citations?​

optional citations?: boolean | "none" | "default" | "llm_footnotes"

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

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

debug?​

optional debug?: boolean

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

Inherited from​

BaseSearchOptions.debug

extra_context?​

optional extra_context?: string[]

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

extra_context_images?​

optional extra_context_images?: object[]

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

b64encoded​

b64encoded: string

content_type​

content_type: string

extracted?​

optional extracted?: ExtractedDataTypes[]

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

Deprecated​

Inherited from​

BaseSearchOptions.extracted

features?​

optional features?: Features[]

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

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

generative_model?​

optional generative_model?: string

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

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

max_tokens?​

optional max_tokens?: number | { answer?: number; context?: number; }

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

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

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

prefer_markdown?​

optional prefer_markdown?: boolean

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

prompt?​

optional prompt?: string | Prompts

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

query_image?​

optional query_image?: object

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

b64encoded​

b64encoded: string

content_type​

content_type: string

rag_images_strategies?​

optional rag_images_strategies?: RAGImageStrategy[]

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

rag_strategies?​

optional rag_strategies?: RAGStrategy[]

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

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

reasoning?​

optional reasoning?: ReasoningParam

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

rephrase?​

optional rephrase?: boolean

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

Inherited from​

BaseSearchOptions.rephrase

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_consumption?​

optional show_consumption?: boolean

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

show_hidden?​

optional show_hidden?: boolean

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

Inherited from​

BaseSearchOptions.show_hidden

synchronous?​

optional synchronous?: boolean

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

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