Class ConversationCallableFunctions`Internal`

Holds the callable functions of a Conversation.

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

Hierarchy

ConversationCallableFunctions

Index

Constructors

constructor

new ConversationCallableFunctions(pluginService, options?): ConversationCallableFunctions
Parameters
- pluginService: ConversationPluginService<ConversationPlugin<string, any, any>[]>
- options: {
  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 ConversationCallableFunctions
- Defined in packages/lib/src/classes/ConversationCallableFunctions.ts:27

Properties

`Private` addCallableFunctionEvents

addCallableFunctionEvents: EventManager<AddCallableFunctionListener> = ...

`Private` functions

functions: CallableFunction[]

`Private` `Readonly` pluginService

pluginService: ConversationPluginService<ConversationPlugin<string, any, any>[]>

`Private` removeCallableFunctionEvents

removeCallableFunctionEvents: EventManager<RemoveCallableFunctionListener> = ...

Methods

addFunction

addFunction(fn): void
Adds a function to the conversation. This function can be "called" by the assistant, generating a function call message.
Parameters
- fn: {
      description?: string;
      id?: string;
      name: string;
      parameters?: {
          $comment?: string;
          additionalProperties?: boolean | JsonSchema;
          default?: any;
          deprecated?: boolean;
          description?: string;
          examples?: any[];
          maxProperties?: number;
          minProperties?: number;
          patternProperties?: Record<string, JsonSchema>;
          properties?: Record<string, JsonSchema>;
          readOnly?: boolean;
          required?: string[];
          title?: string;
          type: "object";
          unevaluatedProperties?: boolean;
          writeOnly?: boolean;
      };
  } | CallableFunction
  
  The function to add to the conversation.
Returns void
- Defined in packages/lib/src/classes/ConversationCallableFunctions.ts:82

clearFunctions

clearFunctions(): void
Removes all functions from the conversation.

Returns void
- Defined in packages/lib/src/classes/ConversationCallableFunctions.ts:73

getCreateChatCompletionFunctions

getCreateChatCompletionFunctions(): undefined | CreateChatCompletionFunction[]
Gets the functions in a format the OpenAI Chat Completion API can understand.

Returns undefined | CreateChatCompletionFunction[]
- Defined in packages/lib/src/classes/ConversationCallableFunctions.ts:107

getFunctions

getFunctions(): CallableFunction[]
Get the functions in the conversation.

Returns CallableFunction[]
A shallow copy of the functions array.
- Defined in packages/lib/src/classes/ConversationCallableFunctions.ts:100

offCallableFunctionAdded

offCallableFunctionAdded(listener): void
Removes a listener function from the list of listeners that was previously added with onCallableFunctionAdded.
Parameters
- listener: AddCallableFunctionListener
  
  The function to remove from the list of listeners.
Returns void
- Defined in packages/lib/src/classes/ConversationCallableFunctions.ts:137

offCallableFunctionRemoved

offCallableFunctionRemoved(listener): void
Removes a listener function from the list of listeners that was previously added with onCallableFunctionRemoved.
Parameters
- listener: RemoveCallableFunctionListener
  
  The function to remove from the list of listeners.
Returns void
- Defined in packages/lib/src/classes/ConversationCallableFunctions.ts:168

onCallableFunctionAdded

onCallableFunctionAdded(listener): (() => void)
Adds a listener function that is called whenever a callableFunction is added to the conversation.
Parameters
- listener: AddCallableFunctionListener
  
  The function to call when a callableFunction is added to the conversation.
Returns (() => void)
A function that removes the listener from the list of listeners.
- - (): void
  - Returns void
- Defined in packages/lib/src/classes/ConversationCallableFunctions.ts:118

onCallableFunctionRemoved

onCallableFunctionRemoved(listener): (() => void)
Adds a listener function that is called whenever a callableFunction is removed to the conversation.
Parameters
- listener: RemoveCallableFunctionListener
  
  The function to call when a callableFunction is removed to the conversation.
Returns (() => void)
A function that removes the listener from the list of listeners.
- - (): void
  - Returns void
- Defined in packages/lib/src/classes/ConversationCallableFunctions.ts:147

onceCallableFunctionAdded

onceCallableFunctionAdded(listener): (() => void)
Adds a listener function that is called only once whenever a callableFunction is added to the conversation.
Parameters
- listener: AddCallableFunctionListener
  
  The function to call when a callableFunction is added to the conversation.
Returns (() => void)
A function that removes the listener from the list of listeners.
- - (): void
  - Returns void
- Defined in packages/lib/src/classes/ConversationCallableFunctions.ts:128

onceCallableFunctionRemoved

onceCallableFunctionRemoved(listener): (() => void)
Adds a listener function that is called only once whenever a callableFunction is removed to the conversation.
Parameters
- listener: RemoveCallableFunctionListener
  
  The function to call when a callableFunction is removed to the conversation.
Returns (() => void)
A function that removes the listener from the list of listeners.
- - (): void
  - Returns void
- Defined in packages/lib/src/classes/ConversationCallableFunctions.ts:157

removeFunction

removeFunction(idOrFn): void
Removes a callable function from the conversation.
Parameters
- idOrFn: string | {
      description?: string;
      id?: string;
      name: string;
      parameters?: {
          $comment?: string;
          additionalProperties?: boolean | JsonSchema;
          default?: any;
          deprecated?: boolean;
          description?: string;
          examples?: any[];
          maxProperties?: number;
          minProperties?: number;
          patternProperties?: Record<string, JsonSchema>;
          properties?: Record<string, JsonSchema>;
          readOnly?: boolean;
          required?: string[];
          title?: string;
          type: "object";
          unevaluatedProperties?: boolean;
          writeOnly?: boolean;
      };
  } | CallableFunction
  
  Either the ID of the function, the function itself, or the function model.
Returns void
- Defined in packages/lib/src/classes/ConversationCallableFunctions.ts:60

toJSON

toJSON(): {
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; })[];
}
Internal
Serializes the ConversationCallableFunctions to JSON.

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; })[];
}
A JSON representation of the ConversationCallableFunctions instance.

This method is used internally by the library and is not meant to be used by consumers of the library.
- 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/ConversationCallableFunctions.ts:43

Class ConversationCallableFunctionsInternal

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

pluginService: ConversationPluginService<ConversationPlugin<string, any, any>[]>

Returns ConversationCallableFunctions

Properties

Private addCallableFunctionEvents

Private functions

Private Readonly pluginService

Private removeCallableFunctionEvents

Methods

addFunction

Parameters

Returns void

clearFunctions

Returns void

getCreateChatCompletionFunctions

Returns undefined | CreateChatCompletionFunction[]

getFunctions

Returns CallableFunction[]

offCallableFunctionAdded

Parameters

listener: AddCallableFunctionListener

Returns void

offCallableFunctionRemoved

Parameters

listener: RemoveCallableFunctionListener

Returns void

onCallableFunctionAdded

Parameters

listener: AddCallableFunctionListener

Returns (() => void)

Returns void

onCallableFunctionRemoved

Parameters

listener: RemoveCallableFunctionListener

Returns (() => void)

Returns void

onceCallableFunctionAdded

Parameters

listener: AddCallableFunctionListener

Returns (() => void)

Returns void

onceCallableFunctionRemoved

Parameters

listener: RemoveCallableFunctionListener

Returns (() => void)

Returns void

removeFunction

Parameters

Returns void

toJSON

Settings

Member Visibility

Theme

On This Page

Class ConversationCallableFunctions`Internal`

`Private` addCallableFunctionEvents

`Private` functions

`Private` `Readonly` pluginService

`Private` removeCallableFunctionEvents