Class: HarmonyChatWrapper

Defined in: chatWrappers/HarmonyChatWrapper.ts:16

Extends

• ChatWrapper

Constructors

Constructor

new HarmonyChatWrapper(options: {
  modelIdentity?: null | string;
  cuttingKnowledgeDate?:   | null
     | string
     | number
     | Date
     | () => Date;
  todayDate?:   | null
     | string
     | number
     | Date
     | () => Date;
  reasoningEffort?: null | "medium" | "high" | "low";
  requiredChannels?: {
     analysis?: boolean;
     commentary?: boolean;
     final?: boolean;
  };
  keepOnlyLastThought?: boolean;
}): HarmonyChatWrapper;

Defined in: chatWrappers/HarmonyChatWrapper.ts:59

Parameters

Parameter	Type	Description
options	{ modelIdentity?: null | string; cuttingKnowledgeDate?: | null | string | number | Date | () => Date; todayDate?: | null | string | number | Date | () => Date; reasoningEffort?: null | "medium" | "high" | "low"; requiredChannels?: { analysis?: boolean; commentary?: boolean; final?: boolean; }; keepOnlyLastThought?: boolean; }	-
options.modelIdentity?	null | string	The model identity to use in the internal system message. Set to null to disable. Defaults to "You are ChatGPT, a large language model trained by OpenAI."
options.cuttingKnowledgeDate?	| null | string | number | Date | () => Date	Set to null to disable Defaults to new Date("2024-06-01T00:00:00Z")
options.todayDate?	| null | string | number | Date | () => Date	Set to null to disable Defaults to the current date
options.reasoningEffort?	null | "medium" | "high" | "low"	The amount of reasoning to instruct the model to use. Not enforced, it's up to the model to follow this instruction. Set to null to omit the instruction. Defaults to "medium".
options.requiredChannels?	{ analysis?: boolean; commentary?: boolean; final?: boolean; }	-
options.requiredChannels.analysis?	boolean	Defaults to true
options.requiredChannels.commentary?	boolean	Defaults to true
options.requiredChannels.final?	boolean	Defaults to true
options.keepOnlyLastThought?	boolean	Whether to keep only the chain of thought from the last model response. Setting this to false will keep all the chain of thoughts from the model responses in the context state. Defaults to true.

Returns

HarmonyChatWrapper

Overrides

ChatWrapper.constructor

Properties

defaultSettings

static defaultSettings: ChatWrapperSettings;

Defined in: ChatWrapper.ts:14

Inherited from

ChatWrapper.defaultSettings

---

wrapperName

readonly wrapperName: string = "Harmony";

Defined in: chatWrappers/HarmonyChatWrapper.ts:17

Overrides

ChatWrapper.wrapperName

---

modelIdentity

readonly modelIdentity: null | string;

Defined in: chatWrappers/HarmonyChatWrapper.ts:19

---

cuttingKnowledgeDate?

readonly optional cuttingKnowledgeDate: 
  | null
  | Date
  | () => Date;

Defined in: chatWrappers/HarmonyChatWrapper.ts:20

---

todayDate

readonly todayDate: 
  | null
  | Date
  | () => Date;

Defined in: chatWrappers/HarmonyChatWrapper.ts:21

---

reasoningEffort

readonly reasoningEffort: null | "medium" | "high" | "low";

Defined in: chatWrappers/HarmonyChatWrapper.ts:22

---

requiredChannels

readonly requiredChannels: {
  analysis: boolean;
  commentary: boolean;
  final: boolean;
};

Defined in: chatWrappers/HarmonyChatWrapper.ts:23

analysis

analysis: boolean;

commentary

commentary: boolean;

final

final: boolean;

---

keepOnlyLastThought

readonly keepOnlyLastThought: boolean;

Defined in: chatWrappers/HarmonyChatWrapper.ts:28

---

settings

readonly settings: ChatWrapperSettings;

Defined in: chatWrappers/HarmonyChatWrapper.ts:32

Overrides

ChatWrapper.settings

Methods

generateFunctionCallsAndResults()

generateFunctionCallsAndResults(functionCalls: ChatModelFunctionCall[], useRawCall: boolean): LlamaText;

Defined in: ChatWrapper.ts:60

Parameters

Parameter	Type	Default value
functionCalls	ChatModelFunctionCall[]	undefined
useRawCall	boolean	true

Returns

LlamaText

Inherited from

ChatWrapper.generateFunctionCallsAndResults

---

addAvailableFunctionsSystemMessageToHistory()

addAvailableFunctionsSystemMessageToHistory(
   history: readonly ChatHistoryItem[], 
   availableFunctions?: ChatModelFunctions, 
   __namedParameters?: {
  documentParams?: boolean;
}): readonly ChatHistoryItem[];

Defined in: ChatWrapper.ts:257

Parameters

Parameter	Type
history	readonly ChatHistoryItem[]
availableFunctions?	ChatModelFunctions
__namedParameters?	{ documentParams?: boolean; }
__namedParameters.documentParams?	boolean

Returns

readonly ChatHistoryItem[]

Inherited from

ChatWrapper.addAvailableFunctionsSystemMessageToHistory

---

generateInitialChatHistory()

generateInitialChatHistory(__namedParameters: ChatWrapperGenerateInitialHistoryOptions): ChatHistoryItem[];

Defined in: ChatWrapper.ts:278

Parameters

Parameter	Type
__namedParameters	ChatWrapperGenerateInitialHistoryOptions

Returns

ChatHistoryItem[]

Inherited from

ChatWrapper.generateInitialChatHistory

---

generateContextState()

generateContextState(__namedParameters: ChatWrapperGenerateContextStateOptions): ChatWrapperGeneratedContextState;

Defined in: chatWrappers/HarmonyChatWrapper.ts:165

Parameters

Parameter	Type
__namedParameters	ChatWrapperGenerateContextStateOptions

Returns

ChatWrapperGeneratedContextState

Overrides

ChatWrapper.generateContextState

---

generateFunctionCall()

generateFunctionCall(name: string, params: any): LlamaText;

Defined in: chatWrappers/HarmonyChatWrapper.ts:317

Parameters

Parameter	Type
name	string
params	any

Returns

LlamaText

Overrides

ChatWrapper.generateFunctionCall

---

generateFunctionCallResult()

generateFunctionCallResult(
   functionName: string, 
   functionParams: any, 
   result: any): LlamaText;

Defined in: chatWrappers/HarmonyChatWrapper.ts:332

Parameters

Parameter	Type
functionName	string
functionParams	any
result	any

Returns

LlamaText

Overrides

ChatWrapper.generateFunctionCallResult

---

generateModelResponseText()

generateModelResponseText(modelResponse: (
  | string
  | ChatModelFunctionCall
  | ChatModelSegment)[], useRawValues: boolean): LlamaText;

Defined in: chatWrappers/HarmonyChatWrapper.ts:346

Parameters

Parameter	Type	Default value
modelResponse	( | string | ChatModelFunctionCall | ChatModelSegment)[]	undefined
useRawValues	boolean	true

Returns

LlamaText

Overrides

ChatWrapper.generateModelResponseText

---

generateAvailableFunctionsSystemText()

generateAvailableFunctionsSystemText(availableFunctions: ChatModelFunctions, __namedParameters: {
  documentParams?: boolean;
}): LlamaText;

Defined in: chatWrappers/HarmonyChatWrapper.ts:367

Parameters

Parameter	Type
availableFunctions	ChatModelFunctions
__namedParameters	{ documentParams?: boolean; }
__namedParameters.documentParams?	boolean

Returns

LlamaText

Overrides

ChatWrapper.generateAvailableFunctionsSystemText