Class LLMProviderRegistry

Persisted registry of provider profiles available to the agent.

Hierarchy (View Summary)

UserProjectSettingsBase<LLMProviderRegistry>
- LLMProviderRegistry

Index

Constructors

Properties

Accessors

Methods

addProfile assign createCustomProfile duplicateProfile ensureBuiltInProfiles exportProfileToJSON findProfile getActiveProfile getDefaultProfile importProfileFromJSON markAsDirty markDirtyForAutoSave removeCustomProfile resetBuiltInProfile

Events

Constructors

constructor

new LLMProviderRegistry(): LLMProviderRegistry

Returns LLMProviderRegistry

Inherited from UserProjectSettingsBase.constructor

Properties

`Readonly`profiles

profiles: LLMProviderProfile[]

Persisted provider profiles available in this project.

Accessors

isGlobal

get isGlobal(): boolean

Gets the settings.

Returns boolean

Overrides UserProjectSettingsBase.isGlobal

Methods

addProfile

addProfile(profile: LLMProviderProfile): void
Adds a provider profile to the registry.
Parameters
- profile: LLMProviderProfile
Returns void

assign

assign(other: Readonly<T>): void
Copies all properties defined by the prototype of other to this instance.
Parameters
- other: Readonly<T>
Returns void

Inherited from UserProjectSettingsBase.assign

createCustomProfile

createCustomProfile(name?: string): LLMProviderProfile
Creates and registers a custom provider profile.
Parameters
- Optionalname: string
Returns LLMProviderProfile

duplicateProfile

duplicateProfile(profileId: UUID): LLMProviderProfile
Duplicates an existing profile as a new editable custom profile.
Parameters
- profileId: UUID
Returns LLMProviderProfile

ensureBuiltInProfiles

ensureBuiltInProfiles(): boolean

Ensures every built-in provider profile exists without overwriting user-edited fields.

Returns boolean

exportProfileToJSON

exportProfileToJSON(profileId: UUID): string
Serializes the selected provider profile into clipboard JSON.
Parameters
- profileId: UUID
Returns string

findProfile

findProfile(profileId: UUID): LLMProviderProfile
Finds a provider profile by id, if one exists.
Parameters
- profileId: UUID
Returns LLMProviderProfile

getActiveProfile

getActiveProfile(activeProviderId: UUID): LLMProviderProfile
Gets the selected provider profile or the default profile when the id is missing.
Parameters
- activeProviderId: UUID
Returns LLMProviderProfile

getDefaultProfile

getDefaultProfile(): LLMProviderProfile

Gets the default built-in provider profile.

Returns LLMProviderProfile

importProfileFromJSON

importProfileFromJSON(jsonText: string): LLMProviderProfile
Imports clipboard JSON as a new editable custom provider profile.
Parameters
- jsonText: string
Returns LLMProviderProfile

markAsDirty

markAsDirty(): void

Marks the settings as dirty and invokes the onDirty event handler.

Returns void

Note
This method should be invoked after making a change, so subsystems such as a viewport cna be updated. If the settings are the shared editor settings, the editor settings will be marked for autosave.

Inherited from UserProjectSettingsBase.markAsDirty

markDirtyForAutoSave

markDirtyForAutoSave(justification: string): void
Marks the registry dirty without requiring inspector interaction.
Parameters
- justification: string
Returns void

removeCustomProfile

removeCustomProfile(profileId: UUID): boolean
Removes a custom provider profile and leaves built-in profiles intact.
Parameters
- profileId: UUID
Returns boolean

resetBuiltInProfile

resetBuiltInProfile(profileId: UUID): boolean
Resets an editable built-in profile to engine defaults while preserving its API key.
Parameters
- profileId: UUID
Returns boolean

Events

`Readonly`onDirty

onDirty: Event<[LLMProviderRegistry], void>

Invoked when the settings changed.

Warning

This is an internal event. Do not subscribe directly to it, use UserProjectSettings.onSettingsChanged.