Class PromptServiceImpl

Implements

PromptService

Index

Constructors

Properties

_builtInFragments _defaultVariantsMap _onPromptsChangeEmitter _onSelectedVariantChangeEmitter _promptVariantSetsMap _selectedVariantsMap customizationService logger onPromptsChange onSelectedVariantChange promptChangeDebounceTimer? settingsService toDispose toolInvocationRegistry variableService

Constructors

constructor

new PromptServiceImpl(): PromptServiceImpl
Returns PromptServiceImpl

Properties

`Protected`_builtInFragments

_builtInFragments: BasePromptFragment[] = []

Collection of built-in prompt fragments

`Protected`_defaultVariantsMap

_defaultVariantsMap: Map<string, string> = ...

Map to store default variant for each prompt variant set (key: promptVariantSetId, value: variantId)

`Protected`_onPromptsChangeEmitter

_onPromptsChangeEmitter: Emitter<void> = ...

Event emitter for prompt changes

`Protected`_onSelectedVariantChangeEmitter

_onSelectedVariantChangeEmitter: Emitter<
{ promptVariantSetId: string; variantId: undefined
| string },
> = ...

Event emitter for selected variant changes

`Protected`_promptVariantSetsMap

_promptVariantSetsMap: Map<string, string[]> = ...

Map to store prompt variants sets (key: promptVariantSetId, value: array of variantIds)

`Protected`_selectedVariantsMap

_selectedVariantsMap: Map<string, string> = ...

Map to store selected variant for each prompt variant set (key: promptVariantSetId, value: variantId)

`Protected` `Readonly`customizationService

customizationService: undefined | PromptFragmentCustomizationService

`Protected` `Readonly`logger

logger: ILogger

`Readonly`onPromptsChange

onPromptsChange: Event<void> = ...

Event fired when the prompts change

`Readonly`onSelectedVariantChange

onSelectedVariantChange: Event<
{ promptVariantSetId: string; variantId: undefined
| string },
> = ...

Event fired when the selected variant for a prompt variant set changes

`Protected` `Optional`promptChangeDebounceTimer

promptChangeDebounceTimer?: Timeout

`Protected` `Readonly`settingsService

settingsService: undefined | AISettingsService

`Protected`toDispose

toDispose: DisposableCollection = ...

`Protected` `Readonly`toolInvocationRegistry

toolInvocationRegistry: undefined | ToolInvocationRegistry

`Protected` `Readonly`variableService

variableService: undefined | AIVariableService

Methods

addBuiltInPromptFragment

addBuiltInPromptFragment(
    promptFragment: BasePromptFragment,
    promptVariantSetId?: string,
    isDefault?: boolean,
): void
Adds a prompt fragment to the service
Parameters
- promptFragment: BasePromptFragment
  The fragment to store
- OptionalpromptVariantSetId: string
  Optional ID of the prompt variant set this is a variant of
- isDefault: boolean = false
Returns void
Implementation of PromptService.addBuiltInPromptFragment
- Defined in ai-core/src/common/prompt-service.ts:881

`Protected`addFragmentVariant

addFragmentVariant(
    promptVariantSetId: string,
    variantId: string,
    isDefault?: boolean,
): void
Adds a variant ID to the fragment variants map
Parameters
- promptVariantSetId: string
  The prompt variant set id
- variantId: string
  The variant ID to add
- isDefault: boolean = false
  Whether this variant should be the default for the prompt variant set (defaults to false)
Returns void
- Defined in ai-core/src/common/prompt-service.ts:907

createBuiltInCustomization

createBuiltInCustomization(fragmentId: string): Promise<void>
Parameters
- fragmentId: string
Returns Promise<void>
Implementation of PromptService.createBuiltInCustomization
- Defined in ai-core/src/common/prompt-service.ts:977

createCustomization

createCustomization(fragmentId: string): Promise<void>
===== Customization Service Delegation Methods =====
Parameters
- fragmentId: string
Returns Promise<void>
Implementation of PromptService.createCustomization
- Defined in ai-core/src/common/prompt-service.ts:971

editBuiltInCustomization

editBuiltInCustomization(fragmentId: string): Promise<void>
Parameters
- fragmentId: string
Returns Promise<void>
Implementation of PromptService.editBuiltInCustomization
- Defined in ai-core/src/common/prompt-service.ts:1039

editCustomization

editCustomization(fragmentId: string, customizationId: string): Promise<void>
Parameters
- fragmentId: string
- customizationId: string
Returns Promise<void>
Implementation of PromptService.editCustomization
- Defined in ai-core/src/common/prompt-service.ts:984

`Protected`findBuiltInFragmentById

findBuiltInFragmentById(fragmentId: string): undefined | BasePromptFragment
Finds a built-in fragment by its ID
Parameters
- fragmentId: string
  The ID of the fragment to find
Returns undefined | BasePromptFragment
The built-in fragment or undefined if not found
- Defined in ai-core/src/common/prompt-service.ts:533

`Protected`fireOnPromptsChangeDebounced

fireOnPromptsChangeDebounced(): void
Returns void
- Defined in ai-core/src/common/prompt-service.ts:459

getActivePromptFragments

getActivePromptFragments(): PromptFragment[]
Gets all active prompts (highest priority version of each fragment)

Returns PromptFragment[]
Array of active prompt fragments
Implementation of PromptService.getActivePromptFragments
- Defined in ai-core/src/common/prompt-service.ts:770

getAllPromptFragments

getAllPromptFragments(): Map<string, PromptFragment[]>
===== Fragment Collection Management Methods =====

Returns Map<string, PromptFragment[]>
Implementation of PromptService.getAllPromptFragments
- Defined in ai-core/src/common/prompt-service.ts:745

getBuiltInRawPrompt

getBuiltInRawPrompt(fragmentId: string): undefined | PromptFragment
Gets the built-in raw prompt fragment (before any customizations)
Parameters
- fragmentId: string
  The prompt fragment ID
Returns undefined | PromptFragment
The built-in fragment or undefined if not found
Implementation of PromptService.getBuiltInRawPrompt
- Defined in ai-core/src/common/prompt-service.ts:547

getCustomizationDescription

getCustomizationDescription(
fragmentId: string,
customizationId: string,
): Promise<undefined | string>
Parameters
- fragmentId: string
- customizationId: string
Returns Promise<undefined | string>
Implementation of PromptService.getCustomizationDescription
- Defined in ai-core/src/common/prompt-service.ts:1018

getCustomizationType

getCustomizationType(
fragmentId: string,
customizationId: string,
): Promise<undefined | string>
Parameters
- fragmentId: string
- customizationId: string
Returns Promise<undefined | string>
Implementation of PromptService.getCustomizationType
- Defined in ai-core/src/common/prompt-service.ts:1025

getDefaultVariantId

getDefaultVariantId(promptVariantSetId: string): undefined | string
Gets the default variant ID of the given set
Parameters
- promptVariantSetId: string
  The prompt variant set id
Returns undefined | string
The default variant ID or undefined if no default is set
Implementation of PromptService.getDefaultVariantId
- Defined in ai-core/src/common/prompt-service.ts:849

getEffectiveVariantId

getEffectiveVariantId(variantSetId: string): undefined | string
Gets the effective variant ID that is guaranteed to be valid if one exists. This checks if the selected variant ID is valid, and falls back to the default variant if it isn't.
Parameters
- variantSetId: string
  The prompt variant set id
Returns undefined | string
A valid variant ID if one exists, or undefined if no valid variant can be found
Implementation of PromptService.getEffectiveVariantId
- Defined in ai-core/src/common/prompt-service.ts:576

getPromptFragment

getPromptFragment(fragmentId: string): undefined | PromptFragment
Gets the raw prompt fragment without comments
Parameters
- fragmentId: string
  The prompt fragment ID
Returns undefined | PromptFragment
The raw prompt fragment or undefined if not found
Implementation of PromptService.getPromptFragment
- Defined in ai-core/src/common/prompt-service.ts:551

getPromptVariantSets

getPromptVariantSets(): Map<string, string[]>
Gets all prompt variant sets and their variants

Returns Map<string, string[]>
Map of prompt variant set IDs to arrays of variant IDs
Implementation of PromptService.getPromptVariantSets
- Defined in ai-core/src/common/prompt-service.ts:853

getRawPromptFragment

getRawPromptFragment(fragmentId: string): undefined | PromptFragment
Gets the raw prompt fragment with comments
Parameters
- fragmentId: string
  The prompt fragment ID
Returns undefined | PromptFragment
The raw prompt fragment or undefined if not found
Implementation of PromptService.getRawPromptFragment
- Defined in ai-core/src/common/prompt-service.ts:537

getResolvedPromptFragment

getResolvedPromptFragment(
    systemOrFragmentId: string,
    args?: { [key: string]: unknown },
    context?: AIVariableContext,
): Promise<undefined | ResolvedPromptFragment>
===== Fragment Resolution Methods =====
Parameters
- systemOrFragmentId: string
- Optionalargs: { [key: string]: unknown }
- Optionalcontext: AIVariableContext
Returns Promise<undefined | ResolvedPromptFragment>
Implementation of PromptService.getResolvedPromptFragment
- Defined in ai-core/src/common/prompt-service.ts:621

getResolvedPromptFragmentWithoutFunctions

getResolvedPromptFragmentWithoutFunctions(
    systemOrFragmentId: string,
    args?: { [key: string]: unknown },
    context?: AIVariableContext,
    resolveVariable?: (
        variable: AIVariableArg,
    ) => Promise<undefined | ResolvedAIVariable>,
): Promise<undefined | Omit<ResolvedPromptFragment, "functionDescriptions">>
Resolves a prompt fragment by replacing variables but preserving function references
Parameters
- systemOrFragmentId: string
  The prompt fragment ID
- Optionalargs: { [key: string]: unknown }
  Optional object with values for variable replacement
- Optionalcontext: AIVariableContext
  Optional context for variable resolution
- OptionalresolveVariable: (variable: AIVariableArg) => Promise<undefined | ResolvedAIVariable>
  Optional custom variable resolution function
Returns Promise<undefined | Omit<ResolvedPromptFragment, "functionDescriptions">>
The partially resolved prompt fragment or undefined if not found
Implementation of PromptService.getResolvedPromptFragmentWithoutFunctions
- Defined in ai-core/src/common/prompt-service.ts:660

getSelectedVariantId

getSelectedVariantId(variantSetId: string): undefined | string
Gets the explicitly selected variant ID for a prompt fragment from settings. This returns only the variant that was explicitly selected in settings, not the default.
Parameters
- variantSetId: string
  The prompt variant set id
Returns undefined | string
The selected variant ID from settings, or undefined if none is selected
Implementation of PromptService.getSelectedVariantId
- Defined in ai-core/src/common/prompt-service.ts:572

getTemplateIDFromResource

getTemplateIDFromResource(resourceId: unknown): undefined | string
Parameters
- resourceId: unknown
Returns undefined | string
Implementation of PromptService.getTemplateIDFromResource
- Defined in ai-core/src/common/prompt-service.ts:1032

getVariantIds

getVariantIds(variantSetId: string): string[]
Returns all IDs of all prompt fragments of the given set
Parameters
- variantSetId: string
  The prompt variant set id
Returns string[]
Array of variant IDs
Implementation of PromptService.getVariantIds
- Defined in ai-core/src/common/prompt-service.ts:824

`Protected`init

init(): void
Returns void
- Defined in ai-core/src/common/prompt-service.ts:469

`Protected`recalculateSelectedVariantsMap

recalculateSelectedVariantsMap(): Promise<void>
Recalculates the selected variants map for all variant sets and fires the onSelectedVariantChangeEmitter if the selectedVariants field has changed.

Returns Promise<void>
- Defined in ai-core/src/common/prompt-service.ts:494

removeCustomization

removeCustomization(fragmentId: string, customizationId: string): Promise<void>
Parameters
- fragmentId: string
- customizationId: string
Returns Promise<void>
Implementation of PromptService.removeCustomization
- Defined in ai-core/src/common/prompt-service.ts:990

`Protected`removeFragmentVariant

removeFragmentVariant(promptVariantSetId: string, variantId: string): void
Removes a variant ID from the fragment variants map
Parameters
- promptVariantSetId: string
  The prompt variant set id
- variantId: string
  The variant ID to remove
Returns void
- Defined in ai-core/src/common/prompt-service.ts:927

removePromptFragment

removePromptFragment(fragmentId: string): void
Removes a prompt fragment from the service
Parameters
- fragmentId: string
  The fragment ID to remove
Returns void
Implementation of PromptService.removePromptFragment
- Defined in ai-core/src/common/prompt-service.ts:796

resetAllToBuiltIn

resetAllToBuiltIn(): Promise<void>
Returns Promise<void>
Implementation of PromptService.resetAllToBuiltIn
- Defined in ai-core/src/common/prompt-service.ts:996

resetToBuiltIn

resetToBuiltIn(fragmentId: string): Promise<void>
Parameters
- fragmentId: string
Returns Promise<void>
Implementation of PromptService.resetToBuiltIn
- Defined in ai-core/src/common/prompt-service.ts:1004

resetToCustomization

resetToCustomization(fragmentId: string, customizationId: string): Promise<void>
Parameters
- fragmentId: string
- customizationId: string
Returns Promise<void>
Implementation of PromptService.resetToCustomization
- Defined in ai-core/src/common/prompt-service.ts:1012

`Protected`resolvePotentialSystemPrompt

resolvePotentialSystemPrompt(
promptFragmentId: string,
): undefined | PromptFragment
Parameters
- promptFragmentId: string
Returns undefined | PromptFragment
- Defined in ai-core/src/common/prompt-service.ts:607

`Protected`resolveVariablesAndArgs

resolveVariablesAndArgs(
    templateText: string,
    args?: { [key: string]: unknown },
    context?: AIVariableContext,
    resolveVariable?: (
        variable: AIVariableArg,
    ) => Promise<undefined | ResolvedAIVariable>,
): Promise<
    {
        replacements: { placeholder: string; value: string }[];
        resolvedVariables: ResolvedAIVariable[];
    },
>
Calculates all variable and argument replacements for an unresolved template.
Parameters
- templateText: string
  the unresolved template text
- Optionalargs: { [key: string]: unknown }
  the object with placeholders, mapping the placeholder key to the value
- Optionalcontext: AIVariableContext
  the AIVariableContext to use during variable resolution
- OptionalresolveVariable: (variable: AIVariableArg) => Promise<undefined | ResolvedAIVariable>
  the variable resolving method. Fall back to using the AIVariableService if not given.
Returns Promise<
    {
        replacements: { placeholder: string; value: string }[];
        resolvedVariables: ResolvedAIVariable[];
    },
>
Object containing replacements and resolved variables
- Defined in ai-core/src/common/prompt-service.ts:692

`Protected`stripComments

stripComments(templateText: string): string
Strips comments from a template string
Parameters
- templateText: string
  The template text to process
Returns string
Template text with comments removed
- Defined in ai-core/src/common/prompt-service.ts:567

updateSelectedVariantId

updateSelectedVariantId(
    agentId: string,
    promptVariantSetId: string,
    newVariant: string,
): Promise<void>
Updates the selected variant for a prompt variant set
Parameters
- agentId: string
  The ID of the agent to update
- promptVariantSetId: string
  The prompt variant set ID
- newVariant: string
  The new variant ID to set as selected
Returns Promise<void>
Implementation of PromptService.updateSelectedVariantId
- Defined in ai-core/src/common/prompt-service.ts:945

Class PromptServiceImpl

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns PromptServiceImpl

Properties

Protected_builtInFragments

Protected_defaultVariantsMap

Protected_onPromptsChangeEmitter

Protected_onSelectedVariantChangeEmitter

Protected_promptVariantSetsMap

Protected_selectedVariantsMap

Protected ReadonlycustomizationService

Protected Readonlylogger

ReadonlyonPromptsChange

ReadonlyonSelectedVariantChange

Protected OptionalpromptChangeDebounceTimer

Protected ReadonlysettingsService

ProtectedtoDispose

Protected ReadonlytoolInvocationRegistry

Protected ReadonlyvariableService

Methods

addBuiltInPromptFragment

Parameters

Returns void

ProtectedaddFragmentVariant

Parameters

Returns void

createBuiltInCustomization

Parameters

Returns Promise<void>

createCustomization

Parameters

Returns Promise<void>

editBuiltInCustomization

Parameters

Returns Promise<void>

editCustomization

Parameters

Returns Promise<void>

ProtectedfindBuiltInFragmentById

Parameters

Returns undefined | BasePromptFragment

ProtectedfireOnPromptsChangeDebounced

Returns void

getActivePromptFragments

Returns PromptFragment[]

getAllPromptFragments

Returns Map<string, PromptFragment[]>

getBuiltInRawPrompt

Parameters

Returns undefined | PromptFragment

getCustomizationDescription

Parameters

Returns Promise<undefined | string>

getCustomizationType

Parameters

Returns Promise<undefined | string>

getDefaultVariantId

Parameters

Returns undefined | string

getEffectiveVariantId

Parameters

Returns undefined | string

getPromptFragment

Parameters

Returns undefined | PromptFragment

getPromptVariantSets

Returns Map<string, string[]>

getRawPromptFragment

Parameters

Returns undefined | PromptFragment

getResolvedPromptFragment

Parameters

Returns Promise<undefined | ResolvedPromptFragment>

getResolvedPromptFragmentWithoutFunctions

`Protected`_builtInFragments

`Protected`_defaultVariantsMap

`Protected`_onPromptsChangeEmitter

`Protected`_onSelectedVariantChangeEmitter

`Protected`_promptVariantSetsMap

`Protected`_selectedVariantsMap

`Protected` `Readonly`customizationService

`Protected` `Readonly`logger

`Readonly`onPromptsChange

`Readonly`onSelectedVariantChange

`Protected` `Optional`promptChangeDebounceTimer

`Protected` `Readonly`settingsService

`Protected`toDispose

`Protected` `Readonly`toolInvocationRegistry

`Protected` `Readonly`variableService

`Protected`addFragmentVariant

`Protected`findBuiltInFragmentById

`Protected`fireOnPromptsChangeDebounced

`Protected`init

`Protected`recalculateSelectedVariantsMap

`Protected`removeFragmentVariant

`Protected`resolvePotentialSystemPrompt

`Protected`resolveVariablesAndArgs

Returns Promise<
{
replacements: { placeholder: string; value: string }[];
resolvedVariables: ResolvedAIVariable[];
},
>

`Protected`stripComments