Class ConversationPluginService<TPluginCreators>`Internal`

Manages the plugins of a conversation and acts as a bridge between the plugins and the conversation.

Remarks

Most of these methods are not documented (with TypeDocs). In most cases, this is because they just call the equivalent method on each plugin. Refer to the documentation of the ConversationPluginCreatorDefinitionBase interface for their documentation.

This class is used internally by the library and is not meant to be instantiated by consumers of the library.

Type Parameters

TPluginCreators extends ConversationPlugin[] = ConversationPlugin[]

Hierarchy

ConversationPluginService

Index

Constructors

constructor

new ConversationPluginService<TPluginCreators>(pluginCreators): ConversationPluginService<TPluginCreators>
Type Parameters
- TPluginCreators extends ConversationPlugin<string, any, any>[] = ConversationPlugin<string, any, any>[]
Parameters
- pluginCreators: TPluginCreators
Returns ConversationPluginService<TPluginCreators>
- Defined in packages/lib/src/classes/ConversationPluginService.ts:29

Properties

`Private` `Readonly` pluginCreators

pluginCreators: TPluginCreators

`Private` plugins

plugins: ConversationPluginDefinition[] = []

Methods

getPlugins

getPlugins(): ConversationPluginDefinition[]
Returns ConversationPluginDefinition[]
- Defined in packages/lib/src/classes/ConversationPluginService.ts:31

getPluginsData

getPluginsData(): Record<string, any>
Returns Record<string, any>
- Defined in packages/lib/src/classes/ConversationPluginService.ts:154

onChatCompletion

onChatCompletion(message): Promise<void>
Parameters
- message: Message
Returns Promise<void>
- Defined in packages/lib/src/classes/ConversationPluginService.ts:121

onFunctionPrompt

onFunctionPrompt(message): Promise<void>
Parameters
- message: Message
Returns Promise<void>
- Defined in packages/lib/src/classes/ConversationPluginService.ts:135

onFunctionPromptError

onFunctionPromptError(error): Promise<void>
Parameters
- error: unknown
Returns Promise<void>
- Defined in packages/lib/src/classes/ConversationPluginService.ts:141

onInit

onInit(properties, pluginsData?): void
Parameters
- properties: ConversationPluginProperties
- Optional pluginsData: Record<string, any>
Returns void
- Defined in packages/lib/src/classes/ConversationPluginService.ts:35

onModeration

onModeration(message): Promise<void>
Parameters
- message: Message
Returns Promise<void>
- Defined in packages/lib/src/classes/ConversationPluginService.ts:166

onPostInit

onPostInit(): void
Returns void
- Defined in packages/lib/src/classes/ConversationPluginService.ts:57

onUserPrompt

onUserPrompt(message): Promise<void>
Parameters
- message: Message
Returns Promise<void>
- Defined in packages/lib/src/classes/ConversationPluginService.ts:102

onUserPromptError

onUserPromptError(error): Promise<void>
Parameters
- error: unknown
Returns Promise<void>
- Defined in packages/lib/src/classes/ConversationPluginService.ts:108

transformConversationCallableFunctionsJson

transformConversationCallableFunctionsJson(json): {
functions?: ({ name: string; id?: string | undefined; description?: string | undefined; parameters?: { type: "object"; title?: string | undefined; description?: string | undefined; default?: any; examples?: any[] | undefined; ... 10 more ...; additionalProperties?: boolean | ... 1 more ... | undefined; } | undefined; })[];
}
Parameters
- json: {
  functions?: ({ name: string; id?: string | undefined; description?: string | undefined; parameters?: { type: "object"; title?: string | undefined; description?: string | undefined; default?: any; examples?: any[] | undefined; ... 10 more ...; additionalProperties?: boolean | ... 1 more ... | undefined; } | undefined; })[];
  }
  - Optional functions?: ({ name: string; id?: string | undefined; description?: string | undefined; parameters?: { type: "object"; title?: string | undefined; description?: string | undefined; default?: any; examples?: any[] | undefined; ... 10 more ...; additionalProperties?: boolean | ... 1 more ... | undefined; } | undefined; })[]
Returns {
functions?: ({ name: string; id?: string | undefined; description?: string | undefined; parameters?: { type: "object"; title?: string | undefined; description?: string | undefined; default?: any; examples?: any[] | undefined; ... 10 more ...; additionalProperties?: boolean | ... 1 more ... | undefined; } | undefined; })[];
}
- Optional functions?: ({ name: string; id?: string | undefined; description?: string | undefined; parameters?: { type: "object"; title?: string | undefined; description?: string | undefined; default?: any; examples?: any[] | undefined; ... 10 more ...; additionalProperties?: boolean | ... 1 more ... | undefined; } | undefined; })[]
- Defined in packages/lib/src/classes/ConversationPluginService.ts:68

transformConversationConfigJson

transformConversationConfigJson(json): {
    apiKey?: string;
    context?: string;
    disableModeration?: boolean | "soft";
    dry?: boolean;
    frequency_penalty?: number;
    function_call?: "none" | "auto" | ({ name: string; });
    logit_bias?: Record<string, number>;
    max_tokens?: number;
    model?: string;
    presence_penalty?: number;
    stop?: null | string | string[];
    stream?: boolean;
    temperature?: number;
    top_p?: number;
    user?: string;
}
Parameters
- json: {
      apiKey?: string;
      context?: string;
      disableModeration?: boolean | "soft";
      dry?: boolean;
      frequency_penalty?: number;
      function_call?: "none" | "auto" | ({ name: string; });
      logit_bias?: Record<string, number>;
      max_tokens?: number;
      model?: string;
      presence_penalty?: number;
      stop?: null | string | string[];
      stream?: boolean;
      temperature?: number;
      top_p?: number;
      user?: string;
  }
  - Optional apiKey?: string
  - Optional context?: string
  - Optional disableModeration?: boolean | "soft"
  - Optional dry?: boolean
  - Optional frequency_penalty?: number
  - Optional function_call?: "none" | "auto" | ({ name: string; })
  - Optional logit_bias?: Record<string, number>
  - Optional max_tokens?: number
  - Optional model?: string
  - Optional presence_penalty?: number
  - Optional stop?: null | string | string[]
  - Optional stream?: boolean
  - Optional temperature?: number
  - Optional top_p?: number
  - Optional user?: string
Returns {
    apiKey?: string;
    context?: string;
    disableModeration?: boolean | "soft";
    dry?: boolean;
    frequency_penalty?: number;
    function_call?: "none" | "auto" | ({ name: string; });
    logit_bias?: Record<string, number>;
    max_tokens?: number;
    model?: string;
    presence_penalty?: number;
    stop?: null | string | string[];
    stream?: boolean;
    temperature?: number;
    top_p?: number;
    user?: string;
}
- Optional apiKey?: string
- Optional context?: string
- Optional disableModeration?: boolean | "soft"
- Optional dry?: boolean
- Optional frequency_penalty?: number
- Optional function_call?: "none" | "auto" | ({ name: string; })
- Optional logit_bias?: Record<string, number>
- Optional max_tokens?: number
- Optional model?: string
- Optional presence_penalty?: number
- Optional stop?: null | string | string[]
- Optional stream?: boolean
- Optional temperature?: number
- Optional top_p?: number
- Optional user?: string
- Defined in packages/lib/src/classes/ConversationPluginService.ts:78

transformConversationHistoryJson

transformConversationHistoryJson(json): {
messages?: ({ role: "function" | "user" | "assistant" | "system"; content: string | null; id?: string | undefined; name?: string | undefined; function_call?: { name: string; arguments: Record<string, any>; } | undefined; model?: string | undefined; flags?: string[] | ... 1 more ... | undefined; })[];
}
Parameters
- json: {
  messages?: ({ role: "function" | "user" | "assistant" | "system"; content: string | null; id?: string | undefined; name?: string | undefined; function_call?: { name: string; arguments: Record<string, any>; } | undefined; model?: string | undefined; flags?: string[] | ... 1 more ... | undefined; })[];
  }
  - Optional messages?: ({ role: "function" | "user" | "assistant" | "system"; content: string | null; id?: string | undefined; name?: string | undefined; function_call?: { name: string; arguments: Record<string, any>; } | undefined; model?: string | undefined; flags?: string[] | ... 1 more ... | undefined; })[]
Returns {
messages?: ({ role: "function" | "user" | "assistant" | "system"; content: string | null; id?: string | undefined; name?: string | undefined; function_call?: { name: string; arguments: Record<string, any>; } | undefined; model?: string | undefined; flags?: string[] | ... 1 more ... | undefined; })[];
}
- Optional messages?: ({ role: "function" | "user" | "assistant" | "system"; content: string | null; id?: string | undefined; name?: string | undefined; function_call?: { name: string; arguments: Record<string, any>; } | undefined; model?: string | undefined; flags?: string[] | ... 1 more ... | undefined; })[]
- Defined in packages/lib/src/classes/ConversationPluginService.ts:85

transformConversationJson

transformConversationJson(json): {
    callableFunctions?: { functions?: { name: string; id?: string | undefined; description?: string | undefined; parameters?: { type: "object"; title?: string | undefined; description?: string | undefined; default?: any; ... 11 more ...; additionalProperties?: boolean | ... 1 more ... | undefined; } | undefined; }[] | undefined; };
    config?: { context?: string | undefined; dry?: boolean | undefined; disableModeration?: boolean | "soft" | undefined; apiKey?: string | undefined; model?: string | undefined; temperature?: number | undefined; ... 8 more ...; function_call?: "none" | ... 2 more ... | undefined; };
    history?: { messages?: { role: "function" | "user" | "assistant" | "system"; content: string | null; id?: string | undefined; name?: string | undefined; function_call?: { name: string; arguments: Record<...>; } | undefined; model?: string | undefined; flags?: string[] | ... 1 more ... | undefined; }[] | undefined; };
    id?: string;
    pluginsData?: Record<string, any>;
    requestOptions?: { headers?: Record<string, string> | undefined; proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; } | undefined; };
}
Parameters
- json: {
      callableFunctions?: { functions?: { name: string; id?: string | undefined; description?: string | undefined; parameters?: { type: "object"; title?: string | undefined; description?: string | undefined; default?: any; ... 11 more ...; additionalProperties?: boolean | ... 1 more ... | undefined; } | undefined; }[] | undefined; };
      config?: { context?: string | undefined; dry?: boolean | undefined; disableModeration?: boolean | "soft" | undefined; apiKey?: string | undefined; model?: string | undefined; temperature?: number | undefined; ... 8 more ...; function_call?: "none" | ... 2 more ... | undefined; };
      history?: { messages?: { role: "function" | "user" | "assistant" | "system"; content: string | null; id?: string | undefined; name?: string | undefined; function_call?: { name: string; arguments: Record<...>; } | undefined; model?: string | undefined; flags?: string[] | ... 1 more ... | undefined; }[] | undefined; };
      id?: string;
      pluginsData?: Record<string, any>;
      requestOptions?: { headers?: Record<string, string> | undefined; proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; } | undefined; };
  }
  - Optional callableFunctions?: { functions?: { name: string; id?: string | undefined; description?: string | undefined; parameters?: { type: "object"; title?: string | undefined; description?: string | undefined; default?: any; ... 11 more ...; additionalProperties?: boolean | ... 1 more ... | undefined; } | undefined; }[] | undefined; }
  - Optional config?: { context?: string | undefined; dry?: boolean | undefined; disableModeration?: boolean | "soft" | undefined; apiKey?: string | undefined; model?: string | undefined; temperature?: number | undefined; ... 8 more ...; function_call?: "none" | ... 2 more ... | undefined; }
  - Optional history?: { messages?: { role: "function" | "user" | "assistant" | "system"; content: string | null; id?: string | undefined; name?: string | undefined; function_call?: { name: string; arguments: Record<...>; } | undefined; model?: string | undefined; flags?: string[] | ... 1 more ... | undefined; }[] | undefined; }
  - Optional id?: string
  - Optional pluginsData?: Record<string, any>
  - Optional requestOptions?: { headers?: Record<string, string> | undefined; proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; } | undefined; }
Returns {
    callableFunctions?: { functions?: { name: string; id?: string | undefined; description?: string | undefined; parameters?: { type: "object"; title?: string | undefined; description?: string | undefined; default?: any; ... 11 more ...; additionalProperties?: boolean | ... 1 more ... | undefined; } | undefined; }[] | undefined; };
    config?: { context?: string | undefined; dry?: boolean | undefined; disableModeration?: boolean | "soft" | undefined; apiKey?: string | undefined; model?: string | undefined; temperature?: number | undefined; ... 8 more ...; function_call?: "none" | ... 2 more ... | undefined; };
    history?: { messages?: { role: "function" | "user" | "assistant" | "system"; content: string | null; id?: string | undefined; name?: string | undefined; function_call?: { name: string; arguments: Record<...>; } | undefined; model?: string | undefined; flags?: string[] | ... 1 more ... | undefined; }[] | undefined; };
    id?: string;
    pluginsData?: Record<string, any>;
    requestOptions?: { headers?: Record<string, string> | undefined; proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; } | undefined; };
}
- Optional callableFunctions?: { functions?: { name: string; id?: string | undefined; description?: string | undefined; parameters?: { type: "object"; title?: string | undefined; description?: string | undefined; default?: any; ... 11 more ...; additionalProperties?: boolean | ... 1 more ... | undefined; } | undefined; }[] | undefined; }
- Optional config?: { context?: string | undefined; dry?: boolean | undefined; disableModeration?: boolean | "soft" | undefined; apiKey?: string | undefined; model?: string | undefined; temperature?: number | undefined; ... 8 more ...; function_call?: "none" | ... 2 more ... | undefined; }
- Optional history?: { messages?: { role: "function" | "user" | "assistant" | "system"; content: string | null; id?: string | undefined; name?: string | undefined; function_call?: { name: string; arguments: Record<...>; } | undefined; model?: string | undefined; flags?: string[] | ... 1 more ... | undefined; }[] | undefined; }
- Optional id?: string
- Optional pluginsData?: Record<string, any>
- Optional requestOptions?: { headers?: Record<string, string> | undefined; proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; } | undefined; }
- Defined in packages/lib/src/classes/ConversationPluginService.ts:61

transformConversationRequestOptionsJson

transformConversationRequestOptionsJson(json): {
headers?: Record<string, string>;
proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; };
}
Parameters
- json: {
  headers?: Record<string, string>;
  proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; };
  }
  - Optional headers?: Record<string, string>
  - Optional proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; }
Returns {
headers?: Record<string, string>;
proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; };
}
- Optional headers?: Record<string, string>
- Optional proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; }
- Defined in packages/lib/src/classes/ConversationPluginService.ts:92

transformFunctionResult

transformFunctionResult(result): Promise<any>
Parameters
- result: any
Returns Promise<any>
- Defined in packages/lib/src/classes/ConversationPluginService.ts:127

Class ConversationPluginService<TPluginCreators>Internal

Remarks

Type Parameters

TPluginCreators extends ConversationPlugin[] = ConversationPlugin[]

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

TPluginCreators extends ConversationPlugin<string, any, any>[] = ConversationPlugin<string, any, any>[]

Parameters

pluginCreators: TPluginCreators

Returns ConversationPluginService<TPluginCreators>

Properties

Private Readonly pluginCreators

Private plugins

Methods

getPlugins

Returns ConversationPluginDefinition[]

getPluginsData

Returns Record<string, any>

onChatCompletion

Parameters

message: Message

Returns Promise<void>

onFunctionPrompt

Parameters

message: Message

Returns Promise<void>

onFunctionPromptError

Parameters

error: unknown

Returns Promise<void>

onInit

Parameters

properties: ConversationPluginProperties

Optional pluginsData: Record<string, any>

Returns void

onModeration

Parameters

message: Message

Returns Promise<void>

onPostInit

Returns void

onUserPrompt

Parameters

message: Message

Returns Promise<void>

onUserPromptError

Parameters

error: unknown

Returns Promise<void>

transformConversationCallableFunctionsJson

Parameters

transformConversationConfigJson

Parameters

Optional apiKey?: string

Optional context?: string

Optional disableModeration?: boolean | "soft"

Optional dry?: boolean

Optional frequency_penalty?: number

Optional function_call?: "none" | "auto" | ({ name: string; })

Optional logit_bias?: Record<string, number>

Optional max_tokens?: number

Optional model?: string

Optional presence_penalty?: number

Optional stop?: null | string | string[]

Optional stream?: boolean

Optional temperature?: number

Optional top_p?: number

Optional user?: string

Optional apiKey?: string

Optional context?: string

Optional disableModeration?: boolean | "soft"

Optional dry?: boolean

Optional frequency_penalty?: number

Optional function_call?: "none" | "auto" | ({ name: string; })

Class ConversationPluginService<TPluginCreators>`Internal`

`Private` `Readonly` pluginCreators

`Private` plugins

`Optional` pluginsData: Record<string, any>

`Optional` apiKey?: string

`Optional` context?: string

`Optional` disableModeration?: boolean | "soft"

`Optional` dry?: boolean

`Optional` frequency_penalty?: number

`Optional` function_call?: "none" | "auto" | ({ name: string; })

`Optional` logit_bias?: Record<string, number>

`Optional` max_tokens?: number

`Optional` model?: string

`Optional` presence_penalty?: number

`Optional` stop?: null | string | string[]

`Optional` stream?: boolean

`Optional` temperature?: number

`Optional` top_p?: number

`Optional` user?: string

`Optional` apiKey?: string

`Optional` context?: string

`Optional` disableModeration?: boolean | "soft"

`Optional` dry?: boolean

`Optional` frequency_penalty?: number

`Optional` function_call?: "none" | "auto" | ({ name: string; })

`Optional` logit_bias?: Record<string, number>

`Optional` max_tokens?: number

`Optional` model?: string

`Optional` presence_penalty?: number

`Optional` stop?: null | string | string[]

`Optional` stream?: boolean

`Optional` temperature?: number

`Optional` top_p?: number

`Optional` user?: string

`Optional` config?: { context?: string | undefined; dry?: boolean | undefined; disableModeration?: boolean | "soft" | undefined; apiKey?: string | undefined; model?: string | undefined; temperature?: number | undefined; ... 8 more ...; function_call?: "none" | ... 2 more ... | undefined; }

`Optional` id?: string

`Optional` pluginsData?: Record<string, any>

`Optional` requestOptions?: { headers?: Record<string, string> | undefined; proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; } | undefined; }

`Optional` config?: { context?: string | undefined; dry?: boolean | undefined; disableModeration?: boolean | "soft" | undefined; apiKey?: string | undefined; model?: string | undefined; temperature?: number | undefined; ... 8 more ...; function_call?: "none" | ... 2 more ... | undefined; }

`Optional` id?: string

`Optional` pluginsData?: Record<string, any>

`Optional` requestOptions?: { headers?: Record<string, string> | undefined; proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; } | undefined; }

json: {
headers?: Record<string, string>;
proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; };
}

`Optional` headers?: Record<string, string>

`Optional` proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; }

Returns {
headers?: Record<string, string>;
proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; };
}

`Optional` headers?: Record<string, string>

`Optional` proxy?: { host: string; port?: number | undefined; protocol?: "http" | "https" | undefined; auth?: { username: string; password: string; } | undefined; }