prompt

Workspace API

---

Workspace API / types/prompt

types/prompt

Interfaces

AgentPrompt

Defined in: types/prompt.ts:11

Agent prompt configuration from database

Properties

agentId

agentId: string

Defined in: types/prompt.ts:13

Agent identifier (e.g., "legal-analyst")

version

version: string

Defined in: types/prompt.ts:15

Version string (e.g., "legal-analyst-v1.0")

systemPrompt

systemPrompt: string

Defined in: types/prompt.ts:17

Full system prompt text

userPromptTemplate?

optional userPromptTemplate: string

Defined in: types/prompt.ts:19

Optional Jinja2 template for user message

description?

optional description: string

Defined in: types/prompt.ts:21

Description of the agent

changelog?

optional changelog: string

Defined in: types/prompt.ts:23

Changelog for this version

allowedScopes

allowedScopes: RAGScope[]

Defined in: types/prompt.ts:25

Array of allowed scopes (organization, project, documents)

defaultTemperature

defaultTemperature: number

Defined in: types/prompt.ts:27

Default temperature for LLM generation

defaultMaxTokens

defaultMaxTokens: number

Defined in: types/prompt.ts:29

Default max tokens for LLM generation

fallbackMessage?

optional fallbackMessage: string

Defined in: types/prompt.ts:31

Fallback message to use when no chunks are retrieved

isActive

isActive: boolean

Defined in: types/prompt.ts:33

Whether this version is currently active

createdAt

createdAt: Date

Defined in: types/prompt.ts:35

Creation timestamp

createdBy?

optional createdBy: string

Defined in: types/prompt.ts:37

User who created this version

updatedAt?

optional updatedAt: Date

Defined in: types/prompt.ts:39

Last updated timestamp

---

AgentPromptRow

Defined in: types/prompt.ts:45

Database row format for agent prompts

Properties

agent_id

agent_id: string

Defined in: types/prompt.ts:46

version

version: string

Defined in: types/prompt.ts:47

system_prompt

system_prompt: string

Defined in: types/prompt.ts:48

user_prompt_template

user_prompt_template: string | null

Defined in: types/prompt.ts:49

description

description: string | null

Defined in: types/prompt.ts:50

changelog

changelog: string | null

Defined in: types/prompt.ts:51

allowed_scopes

allowed_scopes: string[] | null

Defined in: types/prompt.ts:52

default_temperature

default_temperature: string | number

Defined in: types/prompt.ts:53

default_max_tokens

default_max_tokens: number

Defined in: types/prompt.ts:54

fallback_message

fallback_message: string | null

Defined in: types/prompt.ts:55

is_active

is_active: boolean

Defined in: types/prompt.ts:56

created_at

created_at: Date

Defined in: types/prompt.ts:57

created_by

created_by: string | null

Defined in: types/prompt.ts:58

updated_at

updated_at: Date | null

Defined in: types/prompt.ts:59

Variables

DEFAULT_FALLBACK_PROMPT

const DEFAULT_FALLBACK_PROMPT: AgentPrompt

Defined in: types/prompt.ts:89

Default fallback prompt for when database lookup fails

Functions

toAgentPrompt()

toAgentPrompt(row): AgentPrompt

Defined in: types/prompt.ts:65

Convert database row to AgentPrompt

Parameters

row

AgentPromptRow

Returns

AgentPrompt