Class PromptEngine

Index

Constructors

Methods

executePrompt ExecutePrompt executePromptsParallel ExecutePromptsParallel initialize Initialize setGuardrailCheck SetGuardrailCheck

Constructors

constructor

new PromptEngine(config: AIConfig, promptsDir: string): PromptEngine
Parameters
- config: AIConfig
- promptsDir: string
Returns PromptEngine
- Defined in packages/DBAutoDoc/src/prompts/PromptEngine.ts:20

Methods

executePrompt

executePrompt<T>(
    promptName: string,
    context: any,
    options?: {
        effortLevelOverride?: number;
        maxTokens?: number;
        modelOverride?: string;
        responseFormat?: "JSON" | "Text";
        systemPrompt?: string;
        temperature?: number;
    },
): Promise<PromptExecutionResult<T>>
Type Parameters
- T
Parameters
- promptName: string
- context: any
- Optionaloptions: {
      effortLevelOverride?: number;
      maxTokens?: number;
      modelOverride?: string;
      responseFormat?: "JSON" | "Text";
      systemPrompt?: string;
      temperature?: number;
  }
  - OptionaleffortLevelOverride?: number
    Override effort level for this specific call
  - OptionalmaxTokens?: number
  - OptionalmodelOverride?: string
    Override the model for this specific call (e.g., use a stronger model for FK pruning)
  - OptionalresponseFormat?: "JSON" | "Text"
  - OptionalsystemPrompt?: string
  - Optionaltemperature?: number
Returns Promise<PromptExecutionResult<T>>
Deprecated
Use ExecutePrompt.
- Defined in packages/DBAutoDoc/src/prompts/PromptEngine.ts:254

ExecutePrompt

ExecutePrompt<T>(
    promptName: string,
    context: any,
    options?: {
        effortLevelOverride?: number;
        maxTokens?: number;
        modelOverride?: string;
        responseFormat?: "JSON" | "Text";
        systemPrompt?: string;
        temperature?: number;
    },
): Promise<PromptExecutionResult<T>>
Execute a prompt with AI/Core Main entry point for DBAutoDoc analysis
Type Parameters
- T
Parameters
- promptName: string
- context: any
- Optionaloptions: {
      effortLevelOverride?: number;
      maxTokens?: number;
      modelOverride?: string;
      responseFormat?: "JSON" | "Text";
      systemPrompt?: string;
      temperature?: number;
  }
  - OptionaleffortLevelOverride?: number
    Override effort level for this specific call
  - OptionalmaxTokens?: number
  - OptionalmodelOverride?: string
    Override the model for this specific call (e.g., use a stronger model for FK pruning)
  - OptionalresponseFormat?: "JSON" | "Text"
  - OptionalsystemPrompt?: string
  - Optionaltemperature?: number
Returns Promise<PromptExecutionResult<T>>
- Defined in packages/DBAutoDoc/src/prompts/PromptEngine.ts:137

executePromptsParallel

executePromptsParallel<T>(
    requests: {
        context: any;
        options?: {
            maxTokens?: number;
            responseFormat?: "JSON" | "Text";
            systemPrompt?: string;
            temperature?: number;
        };
        promptName: string;
    }[],
): Promise<PromptExecutionResult<T>[]>
Type Parameters
- T
Parameters
- requests: {
      context: any;
      options?: {
          maxTokens?: number;
          responseFormat?: "JSON" | "Text";
          systemPrompt?: string;
          temperature?: number;
      };
      promptName: string;
  }[]
Returns Promise<PromptExecutionResult<T>[]>
Deprecated
Use ExecutePromptsParallel.
- Defined in packages/DBAutoDoc/src/prompts/PromptEngine.ts:361

ExecutePromptsParallel

ExecutePromptsParallel<T>(
    requests: {
        context: any;
        options?: {
            maxTokens?: number;
            responseFormat?: "JSON" | "Text";
            systemPrompt?: string;
            temperature?: number;
        };
        promptName: string;
    }[],
): Promise<PromptExecutionResult<T>[]>
Execute multiple prompts in parallel Uses AI/Core's ChatCompletions for efficiency
Type Parameters
- T
Parameters
- requests: {
      context: any;
      options?: {
          maxTokens?: number;
          responseFormat?: "JSON" | "Text";
          systemPrompt?: string;
          temperature?: number;
      };
      promptName: string;
  }[]
Returns Promise<PromptExecutionResult<T>[]>
- Defined in packages/DBAutoDoc/src/prompts/PromptEngine.ts:275

initialize

initialize(): Promise<void>
Returns Promise<void>
Deprecated
Use Initialize.
- Defined in packages/DBAutoDoc/src/prompts/PromptEngine.ts:63

Initialize

Initialize(): Promise<void>
Initialize the prompt loader

Returns Promise<void>
- Defined in packages/DBAutoDoc/src/prompts/PromptEngine.ts:54

setGuardrailCheck

setGuardrailCheck(checkFn: GuardrailCheckFn): void
Parameters
- checkFn: GuardrailCheckFn
Returns void
Deprecated
Use SetGuardrailCheck.
- Defined in packages/DBAutoDoc/src/prompts/PromptEngine.ts:47

SetGuardrailCheck

SetGuardrailCheck(checkFn: GuardrailCheckFn): void
Set guardrail checking callback This will be called before every LLM execution to check if we should continue
Parameters
- checkFn: GuardrailCheckFn
Returns void
- Defined in packages/DBAutoDoc/src/prompts/PromptEngine.ts:42

Class PromptEngine

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns PromptEngine

Methods

executePrompt

Type Parameters

Parameters

OptionaleffortLevelOverride?: number

OptionalmaxTokens?: number

OptionalmodelOverride?: string

OptionalresponseFormat?: "JSON" | "Text"

OptionalsystemPrompt?: string

Optionaltemperature?: number

Returns Promise<PromptExecutionResult<T>>

Deprecated

ExecutePrompt

Type Parameters

Parameters

OptionaleffortLevelOverride?: number

OptionalmaxTokens?: number

OptionalmodelOverride?: string

OptionalresponseFormat?: "JSON" | "Text"

OptionalsystemPrompt?: string

Optionaltemperature?: number

Returns Promise<PromptExecutionResult<T>>

executePromptsParallel

Type Parameters

Parameters

Returns Promise<PromptExecutionResult<T>[]>

Deprecated

ExecutePromptsParallel

Type Parameters

Parameters

Returns Promise<PromptExecutionResult<T>[]>

initialize

Returns Promise<void>

Deprecated

Initialize

Returns Promise<void>

setGuardrailCheck

Parameters

Returns void

Deprecated

SetGuardrailCheck

Parameters

Returns void

Settings

On This Page

`Optional`effortLevelOverride?: number

`Optional`maxTokens?: number

`Optional`modelOverride?: string

`Optional`responseFormat?: "JSON" | "Text"

`Optional`systemPrompt?: string

`Optional`temperature?: number

`Optional`effortLevelOverride?: number

`Optional`maxTokens?: number

`Optional`modelOverride?: string

`Optional`responseFormat?: "JSON" | "Text"

`Optional`systemPrompt?: string

`Optional`temperature?: number