@nuclia/core / Exports / ChatOptions
Interface: ChatOptions
Hierarchy
-
↳
ChatOptions
Table of contents
Properties
- answer_json_schema
- audit_metadata
- autofilter
- citation_threshold
- citations
- debug
- extra_context
- extracted
- field_type_filter
- fields
- filters
- generative_model
- highlight
- keyword_filters
- max_tokens
- min_score
- prefer_markdown
- prompt
- rag_images_strategies
- rag_strategies
- range_creation_end
- range_creation_start
- range_modification_end
- range_modification_start
- rephrase
- reranker
- resource_filters
- shards
- show
- show_hidden
- synchronous
- top_k
- vectorset
Properties
answer_json_schema
• Optional answer_json_schema: object
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:86
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:66
autofilter
• Optional autofilter: boolean
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:60
citation_threshold
• Optional citation_threshold: number
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:88
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:77
debug
• Optional debug: boolean
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:64
extra_context
• Optional extra_context: string[]
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:87
extracted
• Optional extracted: ExtractedDataTypes[]
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:56
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:57
fields
• Optional fields: string[]
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:47
filters
• Optional filters: string[] | Filter[]
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:48
generative_model
• Optional generative_model: string
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:80
highlight
• Optional highlight: boolean
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:61
keyword_filters
• Optional keyword_filters: string[] | Filter[]
Inherited from
BaseSearchOptions.keyword_filters
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:49
max_tokens
• Optional max_tokens: number | { answer?: number ; context?: number }
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:84
min_score
• Optional min_score: number
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:50
prefer_markdown
• Optional prefer_markdown: boolean
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:85
prompt
• Optional prompt: string | Prompts
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:73
rag_images_strategies
• Optional rag_images_strategies: RAGImageStrategy[]
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:79
rag_strategies
• Optional rag_strategies: RAGStrategy[]
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:78
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:52
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:51
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:54
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:53
rephrase
• Optional rephrase: boolean
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:62
reranker
• Optional reranker: Reranker
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:68
resource_filters
• Optional resource_filters: string[]
Inherited from
BaseSearchOptions.resource_filters
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:58
shards
• Optional shards: string[]
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:59
show
• Optional show: ResourceProperties[]
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:55
show_hidden
• Optional show_hidden: boolean
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:65
synchronous
• Optional synchronous: boolean
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:72
top_k
• Optional top_k: number
Inherited from
Defined in
libs/sdk-core/src/lib/db/search/search.models.ts:67
vectorset
• Optional vectorset: string