ChatOptions
@nuclia/core • Docs
@nuclia/core / ChatOptions
Interface: ChatOptions
Extends
Properties
agentic_config_id?
optionalagentic_config_id:string
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:128
answer_json_schema?
optionalanswer_json_schema:object
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:114
audit_metadata?
optionalaudit_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
citation_threshold?
optionalcitation_threshold:number
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:116
citations?
optionalcitations:boolean|"none"|"default"|"llm_footnotes"
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:105
debug?
optionaldebug:boolean
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:79
extra_context?
optionalextra_context:string[]
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:115
extra_context_images?
optionalextra_context_images:object[]
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:118
extracted?
optionalextracted:ExtractedDataTypes[]
Deprecated
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:73
features?
optionalfeatures:Features[]
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:117
field_type_filter?
optionalfield_type_filter:FIELD_TYPE[]
Inherited from
BaseSearchOptions.field_type_filter
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:74
fields?
optionalfields:string[]
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:62
filter_expression?
optionalfilter_expression:FilterExpression
Inherited from
BaseSearchOptions.filter_expression
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:64
filters?
optionalfilters:string[] |Filter[]
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:63
generative_model?
optionalgenerative_model:string
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:108
highlight?
optionalhighlight:boolean
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:76
keyword_filters?
optionalkeyword_filters:string[] |Filter[]
Inherited from
BaseSearchOptions.keyword_filters
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:65
max_tokens?
optionalmax_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:112
min_score?
optionalmin_score:number|MinScore
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:66
prefer_markdown?
optionalprefer_markdown:boolean
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:113
prompt?
optionalprompt:string|Prompts
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:101
query_image?
optionalquery_image:object
b64encoded
b64encoded:
string
content_type
content_type:
string
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:122
rag_images_strategies?
optionalrag_images_strategies:RAGImageStrategy[]
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:107
rag_strategies?
optionalrag_strategies:RAGStrategy[]
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:106
range_creation_end?
optionalrange_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?
optionalrange_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?
optionalrange_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?
optionalrange_modification_start:string
Inherited from
BaseSearchOptions.range_modification_start
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:69
rank_fusion?
optionalrank_fusion:RankFusion
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:84
reasoning?
optionalreasoning:ReasoningParam
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:126
rephrase?
optionalrephrase:boolean
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:77
reranker?
optionalreranker:Reranker
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:83
resource_filters?
optionalresource_filters:string[]
Inherited from
BaseSearchOptions.resource_filters
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:75
search_configuration?
optionalsearch_configuration:string
Inherited from
BaseSearchOptions.search_configuration
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:86
security?
optionalsecurity:object
groups
groups:
string[]
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:85
show?
optionalshow:ResourceProperties[]
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:71
show_consumption?
optionalshow_consumption:boolean
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:127
show_hidden?
optionalshow_hidden:boolean
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:80
synchronous?
optionalsynchronous:boolean
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:100
top_k?
optionaltop_k:number
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:82
vectorset?
optionalvectorset:string