Class PromptServiceImpl

Implements

PromptService

Index

Constructors

Properties

_builtInFragments _defaultVariantsMap _onPromptsChangeEmitter _onSelectedVariantChangeEmitter _promptVariantSetsMap customizationService logger onPromptsChange onSelectedVariantChange settingsService toolInvocationRegistry variableService

Constructors

constructor

new PromptServiceImpl(): PromptServiceImpl
Returns PromptServiceImpl

Properties

`Protected` _builtInFragments

_builtInFragments: BasePromptFragment[] = []

`Protected` _defaultVariantsMap

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

`Protected` _onPromptsChangeEmitter

_onPromptsChangeEmitter: Emitter<void> = ...

`Protected` _onSelectedVariantChangeEmitter

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

Type declaration

promptVariantSetId: string
variantId: string

`Protected` _promptVariantSetsMap

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

`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: string;
}> = ...

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

Type declaration

promptVariantSetId: string
variantId: string

`Protected` `Readonly` settingsService

settingsService: undefined | AISettingsService

`Protected` `Readonly` toolInvocationRegistry

toolInvocationRegistry: undefined | ToolInvocationRegistry

`Protected` `Readonly` variableService

variableService: undefined | AIVariableService

Methods

addBuiltInPromptFragment

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

`Protected` addFragmentVariant

addFragmentVariant(promptVariantSetId, variantId, isDefault?): 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 packages/ai-core/src/common/prompt-service.ts:853

createBuiltInCustomization

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

createCustomization

createCustomization(fragmentId): Promise<void>
The following methods delegate to the PromptFragmentCustomizationService
Parameters
- fragmentId: string
Returns Promise<void>
Implementation of PromptService.createCustomization
- Defined in packages/ai-core/src/common/prompt-service.ts:917

editBuiltInCustomization

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

editCustomization

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

`Protected` findBuiltInFragmentById

findBuiltInFragmentById(fragmentId): 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 packages/ai-core/src/common/prompt-service.ts:470

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 packages/ai-core/src/common/prompt-service.ts:716

getAllPromptFragments

getAllPromptFragments(): Map<string, PromptFragment[]>
Gets all known prompts, including variants and customizations

Returns Map<string, PromptFragment[]>
Map of fragment IDs to arrays of fragments
Implementation of PromptService.getAllPromptFragments
- Defined in packages/ai-core/src/common/prompt-service.ts:691

getBuiltInRawPrompt

getBuiltInRawPrompt(fragmentId): 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 packages/ai-core/src/common/prompt-service.ts:484

getCustomizationDescription

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

getCustomizationType

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

getDefaultVariantId

getDefaultVariantId(promptVariantSetId): 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 packages/ai-core/src/common/prompt-service.ts:795

getEffectiveVariantId

getEffectiveVariantId(fragmentId): Promise<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
- fragmentId: string
  The prompt variant set id
Returns Promise<undefined | string>
A valid variant ID if one exists, or undefined if no valid variant can be found
Implementation of PromptService.getEffectiveVariantId
- Defined in packages/ai-core/src/common/prompt-service.ts:522

getPromptFragment

getPromptFragment(fragmentId): 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 packages/ai-core/src/common/prompt-service.ts:488

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 packages/ai-core/src/common/prompt-service.ts:799

getRawPromptFragment

getRawPromptFragment(fragmentId): 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 packages/ai-core/src/common/prompt-service.ts:474

getResolvedPromptFragment

getResolvedPromptFragment(systemOrFragmentId, args?, context?): Promise<undefined | ResolvedPromptFragment>
Resolves a prompt fragment by replacing variables and function references
Parameters
- systemOrFragmentId: string
  The prompt fragment ID
- Optional args: {
  [key: string]: unknown;
  }
  Optional object with values for variable replacement
  - [key: string]: unknown
- Optional context: AIVariableContext
  Optional context for variable resolution
Returns Promise<undefined | ResolvedPromptFragment>
The resolved prompt fragment or undefined if not found
Implementation of PromptService.getResolvedPromptFragment
- Defined in packages/ai-core/src/common/prompt-service.ts:567

getResolvedPromptFragmentWithoutFunctions

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

getSelectedVariantId

getSelectedVariantId(fragmentId): Promise<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
- fragmentId: string
  The prompt variant set id
Returns Promise<undefined | string>
The selected variant ID from settings, or undefined if none is selected
Implementation of PromptService.getSelectedVariantId
- Defined in packages/ai-core/src/common/prompt-service.ts:509

getTemplateIDFromResource

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

getVariantIds

getVariantIds(variantSetId): 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 packages/ai-core/src/common/prompt-service.ts:770

`Protected` init

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

removeCustomization

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

`Protected` removeFragmentVariant

removeFragmentVariant(promptVariantSetId, variantId): 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 packages/ai-core/src/common/prompt-service.ts:873

removePromptFragment

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

resetAllToBuiltIn

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

resetToBuiltIn

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

resetToCustomization

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

`Protected` resolvePotentialSystemPrompt

resolvePotentialSystemPrompt(promptFragmentId): Promise<undefined | PromptFragment>
Parameters
- promptFragmentId: string
Returns Promise<undefined | PromptFragment>
- Defined in packages/ai-core/src/common/prompt-service.ts:553

`Protected` resolveVariablesAndArgs

resolveVariablesAndArgs(templateText, args?, context?, resolveVariable?): 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
- Optional args: {
  [key: string]: unknown;
  }
  the object with placeholders, mapping the placeholder key to the value
  - [key: string]: unknown
- Optional context: AIVariableContext
  the AIVariableContext to use during variable resolution
- Optional resolveVariable: ((variable) => Promise<undefined | ResolvedAIVariable>)
  the variable resolving method. Fall back to using the AIVariableService if not given.
  - - (variable): Promise<undefined | ResolvedAIVariable>
    - Parameters
      variable: AIVariableArg
      Returns Promise<undefined | ResolvedAIVariable>
Returns Promise<{
    replacements: {
        placeholder: string;
        value: string;
    }[];
    resolvedVariables: ResolvedAIVariable[];
}>
Object containing replacements and resolved variables
- Defined in packages/ai-core/src/common/prompt-service.ts:638

`Protected` stripComments

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

updateSelectedVariantId

updateSelectedVariantId(agentId, promptVariantSetId, newVariant): 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 packages/ai-core/src/common/prompt-service.ts:891

Class PromptServiceImpl

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns PromptServiceImpl

Properties

Protected _builtInFragments

Protected _defaultVariantsMap

Protected _onPromptsChangeEmitter

Protected _onSelectedVariantChangeEmitter

Type declaration

promptVariantSetId: string

variantId: string

Protected _promptVariantSetsMap

Protected Readonly customizationService

Protected Readonly logger

Readonly onPromptsChange

Readonly onSelectedVariantChange

Type declaration

promptVariantSetId: string

variantId: string

Protected Readonly settingsService

Protected Readonly toolInvocationRegistry

Protected Readonly variableService

Methods

addBuiltInPromptFragment

Parameters

Returns void

Protected addFragmentVariant

Parameters

Returns void

createBuiltInCustomization

Parameters

Returns Promise<void>

createCustomization

Parameters

Returns Promise<void>

editBuiltInCustomization

Parameters

Returns Promise<void>

editCustomization

Parameters

Returns Promise<void>

Protected findBuiltInFragmentById

Parameters

Returns undefined | BasePromptFragment

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 Promise<undefined | string>

getPromptFragment

Parameters

Returns undefined | PromptFragment

getPromptVariantSets

Returns Map<string, string[]>

getRawPromptFragment

Parameters

Returns undefined | PromptFragment

getResolvedPromptFragment

Parameters

[key: string]: unknown

`Protected` _builtInFragments

`Protected` _defaultVariantsMap

`Protected` _onPromptsChangeEmitter

`Protected` _onSelectedVariantChangeEmitter

`Protected` _promptVariantSetsMap

`Protected` `Readonly` customizationService

`Protected` `Readonly` logger

`Readonly` onPromptsChange

`Readonly` onSelectedVariantChange

`Protected` `Readonly` settingsService

`Protected` `Readonly` toolInvocationRegistry

`Protected` `Readonly` variableService

`Protected` addFragmentVariant

`Protected` findBuiltInFragmentById

`Protected` init

`Protected` removeFragmentVariant

`Protected` resolvePotentialSystemPrompt

`Protected` resolveVariablesAndArgs

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

`Protected` stripComments