Skip to main content

AskAgent

@nuclia/coreDocs


@nuclia/core / AskAgent

Interface: AskAgent

Extends

Properties

after?

optional after: number

Inherited from

AskAgentCreation.after

Defined in

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:264


optional ai_parameter_search: boolean

Inherited from

AskAgentCreation.ai_parameter_search

Defined in

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:273


before?

optional before: number

Inherited from

AskAgentCreation.before

Defined in

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:263


configuration_json_model?

optional configuration_json_model: string

Inherited from

AskAgentCreation.configuration_json_model

Defined in

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:272


configuration_model?

optional configuration_model: string

Inherited from

AskAgentCreation.configuration_model

Defined in

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:271


date_range_enabled?

optional date_range_enabled: boolean

Inherited from

AskAgentCreation.date_range_enabled

Defined in

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:262


extra_fields

extra_fields: string[]

Inherited from

AskAgentCreation.extra_fields

Defined in

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:265


fallback?

optional fallback: null | BaseContextAgent

Inherited from

AskAgentCreation.fallback

Defined in

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:253


filters?

optional filters: string[]

Inherited from

AskAgentCreation.filters

Defined in

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:256


full_resource

full_resource: boolean

Inherited from

AskAgentCreation.full_resource

Defined in

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:266


id

id: string

Inherited from

ContextAgent.id

Defined in

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


keywords_custom_prompt?

optional keywords_custom_prompt: string

Inherited from

AskAgentCreation.keywords_custom_prompt

Defined in

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:260


model?

optional model: string

Inherited from

ContextAgent.model

Defined in

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:113


module

module: "ask"

Overrides

AskAgentCreation.module

Defined in

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:398


pre_queries?

optional pre_queries: string[]

Inherited from

AskAgentCreation.pre_queries

Defined in

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:254


query_entities?

optional query_entities: object[]

Inherited from

AskAgentCreation.query_entities

Defined in

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:269


rephrase_lexical_custom_prompt?

optional rephrase_lexical_custom_prompt: string

Inherited from

AskAgentCreation.rephrase_lexical_custom_prompt

Defined in

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:259


rephrase_semantic_custom_prompt?

optional rephrase_semantic_custom_prompt: string

Inherited from

AskAgentCreation.rephrase_semantic_custom_prompt

Defined in

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:258


optional retrieve_related: string

Inherited from

AskAgentCreation.retrieve_related

Defined in

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:270


rules?

optional rules: null | string[]

Inherited from

ContextAgent.rules

Defined in

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:111


security_groups?

optional security_groups: string[]

Inherited from

AskAgentCreation.security_groups

Defined in

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:257


sources

sources: string[]

Inherited from

AskAgentCreation.sources

Defined in

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:252


title?

optional title: string

Inherited from

ContextAgent.title

Defined in

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:112


validate_model?

optional validate_model: string

Inherited from

ContextAgent.validate_model

Defined in

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:114


visual_enable_prompt?

optional visual_enable_prompt: string

Inherited from

AskAgentCreation.visual_enable_prompt

Defined in

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:261


vllm

vllm: boolean

Inherited from

AskAgentCreation.vllm

Defined in

libs/sdk-core/src/lib/db/retrieval-agent/retrieval-agent.models.ts:267