AgentPromptTemplate
class |
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [communicationStyle?](./llm-ops.agentprompttemplate.communicationstyle.md) | | [communicationStyleType](./llm-ops.communicationstyletype.md) | _(Optional)_ |
+| [desc?](./llm-ops.agentprompttemplate.desc.md) | | string | _(Optional)_ |
+| [evaluate?](./llm-ops.agentprompttemplate.evaluate.md) | | [TeacherEvaluateSchema](./llm-ops.teacherevaluateschema.md) | _(Optional)_ |
+| [field?](./llm-ops.agentprompttemplate.field.md) | | string | _(Optional)_ |
+| [humanSituation?](./llm-ops.agentprompttemplate.humansituation.md) | | string | _(Optional)_ |
+| [keyRole?](./llm-ops.agentprompttemplate.keyrole.md) | | string | _(Optional)_ |
+| [language?](./llm-ops.agentprompttemplate.language.md) | | [languageType](./llm-ops.languagetype.md) | _(Optional)_ |
+| [level?](./llm-ops.agentprompttemplate.level.md) | | [levelType](./llm-ops.leveltype.md) | _(Optional)_ |
+| [memory?](./llm-ops.agentprompttemplate.memory.md) | | [MemoryPromptTemplateSchema](./llm-ops.memoryprompttemplateschema.md) | _(Optional)_ |
+| [other?](./llm-ops.agentprompttemplate.other.md) | | string | _(Optional)_ |
+| [reasoning?](./llm-ops.agentprompttemplate.reasoning.md) | | [reasoningType](./llm-ops.reasoningtype.md) | _(Optional)_ |
+| [reflection?](./llm-ops.agentprompttemplate.reflection.md) | | [ReflectionPromptTemplateSchema](./llm-ops.reflectionprompttemplateschema.md) | _(Optional)_ |
+| [returnPrompt?](./llm-ops.agentprompttemplate.returnprompt.md) | | [messagesType](./llm-ops.messagestype.md) | _(Optional)_ |
+| [role?](./llm-ops.agentprompttemplate.role.md) | | string | _(Optional)_ |
+| [rules?](./llm-ops.agentprompttemplate.rules.md) | | string \| string\[\] | _(Optional)_ |
+| [toneStyle?](./llm-ops.agentprompttemplate.tonestyle.md) | | [toneStyleType](./llm-ops.tonestyletype.md) | _(Optional)_ |
+
+## Methods
+
+| Method | Modifiers | Description |
+| --- | --- | --- |
+| [format()](./llm-ops.agentprompttemplate.format.md) | | |
+| [formatEvaluateItem(items)](./llm-ops.agentprompttemplate.formatevaluateitem.md) | | |
+
diff --git a/docs/api/llm-ops.agentprompttemplate.memory.md b/docs/api/llm-ops.agentprompttemplate.memory.md
new file mode 100644
index 0000000..e8a5674
--- /dev/null
+++ b/docs/api/llm-ops.agentprompttemplate.memory.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) > [memory](./llm-ops.agentprompttemplate.memory.md)
+
+## AgentPromptTemplate.memory property
+
+**Signature:**
+
+```typescript
+memory?: MemoryPromptTemplateSchema;
+```
diff --git a/docs/api/llm-ops.agentprompttemplate.other.md b/docs/api/llm-ops.agentprompttemplate.other.md
new file mode 100644
index 0000000..8585fa7
--- /dev/null
+++ b/docs/api/llm-ops.agentprompttemplate.other.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) > [other](./llm-ops.agentprompttemplate.other.md)
+
+## AgentPromptTemplate.other property
+
+**Signature:**
+
+```typescript
+other?: string;
+```
diff --git a/docs/api/llm-ops.agentprompttemplate.reasoning.md b/docs/api/llm-ops.agentprompttemplate.reasoning.md
new file mode 100644
index 0000000..df34e21
--- /dev/null
+++ b/docs/api/llm-ops.agentprompttemplate.reasoning.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) > [reasoning](./llm-ops.agentprompttemplate.reasoning.md)
+
+## AgentPromptTemplate.reasoning property
+
+**Signature:**
+
+```typescript
+reasoning?: reasoningType;
+```
diff --git a/docs/api/llm-ops.agentprompttemplate.reflection.md b/docs/api/llm-ops.agentprompttemplate.reflection.md
new file mode 100644
index 0000000..d6c8bc1
--- /dev/null
+++ b/docs/api/llm-ops.agentprompttemplate.reflection.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) > [reflection](./llm-ops.agentprompttemplate.reflection.md)
+
+## AgentPromptTemplate.reflection property
+
+**Signature:**
+
+```typescript
+reflection?: ReflectionPromptTemplateSchema;
+```
diff --git a/docs/api/llm-ops.agentprompttemplate.returnprompt.md b/docs/api/llm-ops.agentprompttemplate.returnprompt.md
new file mode 100644
index 0000000..af719f0
--- /dev/null
+++ b/docs/api/llm-ops.agentprompttemplate.returnprompt.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) > [returnPrompt](./llm-ops.agentprompttemplate.returnprompt.md)
+
+## AgentPromptTemplate.returnPrompt property
+
+**Signature:**
+
+```typescript
+returnPrompt?: messagesType;
+```
diff --git a/docs/api/llm-ops.agentprompttemplate.role.md b/docs/api/llm-ops.agentprompttemplate.role.md
new file mode 100644
index 0000000..4073415
--- /dev/null
+++ b/docs/api/llm-ops.agentprompttemplate.role.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) > [role](./llm-ops.agentprompttemplate.role.md)
+
+## AgentPromptTemplate.role property
+
+**Signature:**
+
+```typescript
+role?: string;
+```
diff --git a/docs/api/llm-ops.agentprompttemplate.rules.md b/docs/api/llm-ops.agentprompttemplate.rules.md
new file mode 100644
index 0000000..f7bd798
--- /dev/null
+++ b/docs/api/llm-ops.agentprompttemplate.rules.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) > [rules](./llm-ops.agentprompttemplate.rules.md)
+
+## AgentPromptTemplate.rules property
+
+**Signature:**
+
+```typescript
+rules?: string | string[];
+```
diff --git a/docs/api/llm-ops.agentprompttemplate.tonestyle.md b/docs/api/llm-ops.agentprompttemplate.tonestyle.md
new file mode 100644
index 0000000..b82f17b
--- /dev/null
+++ b/docs/api/llm-ops.agentprompttemplate.tonestyle.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) > [toneStyle](./llm-ops.agentprompttemplate.tonestyle.md)
+
+## AgentPromptTemplate.toneStyle property
+
+**Signature:**
+
+```typescript
+toneStyle?: toneStyleType;
+```
diff --git a/docs/api/llm-ops.agentprompttemplateschema.communicationstyle.md b/docs/api/llm-ops.agentprompttemplateschema.communicationstyle.md
new file mode 100644
index 0000000..7bbc632
--- /dev/null
+++ b/docs/api/llm-ops.agentprompttemplateschema.communicationstyle.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [communicationStyle](./llm-ops.agentprompttemplateschema.communicationstyle.md)
+
+## AgentPromptTemplateSchema.communicationStyle property
+
+**Signature:**
+
+```typescript
+communicationStyle?: communicationStyleType;
+```
diff --git a/docs/api/llm-ops.agentprompttemplateschema.desc.md b/docs/api/llm-ops.agentprompttemplateschema.desc.md
new file mode 100644
index 0000000..91815b1
--- /dev/null
+++ b/docs/api/llm-ops.agentprompttemplateschema.desc.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [desc](./llm-ops.agentprompttemplateschema.desc.md)
+
+## AgentPromptTemplateSchema.desc property
+
+**Signature:**
+
+```typescript
+desc?: string;
+```
diff --git a/docs/api/llm-ops.agentprompttemplateschema.evaluate.md b/docs/api/llm-ops.agentprompttemplateschema.evaluate.md
new file mode 100644
index 0000000..71f23e2
--- /dev/null
+++ b/docs/api/llm-ops.agentprompttemplateschema.evaluate.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [evaluate](./llm-ops.agentprompttemplateschema.evaluate.md)
+
+## AgentPromptTemplateSchema.evaluate property
+
+**Signature:**
+
+```typescript
+evaluate?: TeacherEvaluateSchema;
+```
diff --git a/docs/api/llm-ops.agentprompttemplateschema.field.md b/docs/api/llm-ops.agentprompttemplateschema.field.md
new file mode 100644
index 0000000..03b7ff1
--- /dev/null
+++ b/docs/api/llm-ops.agentprompttemplateschema.field.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [field](./llm-ops.agentprompttemplateschema.field.md)
+
+## AgentPromptTemplateSchema.field property
+
+**Signature:**
+
+```typescript
+field?: string;
+```
diff --git a/docs/api/llm-ops.agentprompttemplateschema.humansituation.md b/docs/api/llm-ops.agentprompttemplateschema.humansituation.md
new file mode 100644
index 0000000..f6d01a0
--- /dev/null
+++ b/docs/api/llm-ops.agentprompttemplateschema.humansituation.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [humanSituation](./llm-ops.agentprompttemplateschema.humansituation.md)
+
+## AgentPromptTemplateSchema.humanSituation property
+
+**Signature:**
+
+```typescript
+humanSituation?: string;
+```
diff --git a/docs/api/llm-ops.agentprompttemplateschema.keyrole.md b/docs/api/llm-ops.agentprompttemplateschema.keyrole.md
new file mode 100644
index 0000000..acead91
--- /dev/null
+++ b/docs/api/llm-ops.agentprompttemplateschema.keyrole.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [keyRole](./llm-ops.agentprompttemplateschema.keyrole.md)
+
+## AgentPromptTemplateSchema.keyRole property
+
+**Signature:**
+
+```typescript
+keyRole?: string;
+```
diff --git a/docs/api/llm-ops.agentprompttemplateschema.language.md b/docs/api/llm-ops.agentprompttemplateschema.language.md
new file mode 100644
index 0000000..64dded2
--- /dev/null
+++ b/docs/api/llm-ops.agentprompttemplateschema.language.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [language](./llm-ops.agentprompttemplateschema.language.md)
+
+## AgentPromptTemplateSchema.language property
+
+**Signature:**
+
+```typescript
+language?: languageType;
+```
diff --git a/docs/api/llm-ops.agentprompttemplateschema.level.md b/docs/api/llm-ops.agentprompttemplateschema.level.md
new file mode 100644
index 0000000..7e03acf
--- /dev/null
+++ b/docs/api/llm-ops.agentprompttemplateschema.level.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [level](./llm-ops.agentprompttemplateschema.level.md)
+
+## AgentPromptTemplateSchema.level property
+
+**Signature:**
+
+```typescript
+level?: levelType;
+```
diff --git a/docs/api/llm-ops.agentprompttemplateschema.md b/docs/api/llm-ops.agentprompttemplateschema.md
new file mode 100644
index 0000000..1968d18
--- /dev/null
+++ b/docs/api/llm-ops.agentprompttemplateschema.md
@@ -0,0 +1,32 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md)
+
+## AgentPromptTemplateSchema interface
+
+**Signature:**
+
+```typescript
+export interface AgentPromptTemplateSchema
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [communicationStyle?](./llm-ops.agentprompttemplateschema.communicationstyle.md) | | [communicationStyleType](./llm-ops.communicationstyletype.md) | _(Optional)_ |
+| [desc?](./llm-ops.agentprompttemplateschema.desc.md) | | string | _(Optional)_ |
+| [evaluate?](./llm-ops.agentprompttemplateschema.evaluate.md) | | [TeacherEvaluateSchema](./llm-ops.teacherevaluateschema.md) | _(Optional)_ |
+| [field?](./llm-ops.agentprompttemplateschema.field.md) | | string | _(Optional)_ |
+| [humanSituation?](./llm-ops.agentprompttemplateschema.humansituation.md) | | string | _(Optional)_ |
+| [keyRole?](./llm-ops.agentprompttemplateschema.keyrole.md) | | string | _(Optional)_ |
+| [language?](./llm-ops.agentprompttemplateschema.language.md) | | [languageType](./llm-ops.languagetype.md) | _(Optional)_ |
+| [level?](./llm-ops.agentprompttemplateschema.level.md) | | [levelType](./llm-ops.leveltype.md) | _(Optional)_ |
+| [memory?](./llm-ops.agentprompttemplateschema.memory.md) | | [MemoryPromptTemplateSchema](./llm-ops.memoryprompttemplateschema.md) | _(Optional)_ |
+| [other?](./llm-ops.agentprompttemplateschema.other.md) | | string | _(Optional)_ |
+| [reasoning?](./llm-ops.agentprompttemplateschema.reasoning.md) | | [reasoningType](./llm-ops.reasoningtype.md) | _(Optional)_ |
+| [reflection?](./llm-ops.agentprompttemplateschema.reflection.md) | | [ReflectionPromptTemplateSchema](./llm-ops.reflectionprompttemplateschema.md) | _(Optional)_ |
+| [role](./llm-ops.agentprompttemplateschema.role.md) | | string | |
+| [rules?](./llm-ops.agentprompttemplateschema.rules.md) | | string \| string\[\] | _(Optional)_ |
+| [toneStyle?](./llm-ops.agentprompttemplateschema.tonestyle.md) | | [toneStyleType](./llm-ops.tonestyletype.md) | _(Optional)_ |
+
diff --git a/docs/api/llm-ops.agentprompttemplateschema.memory.md b/docs/api/llm-ops.agentprompttemplateschema.memory.md
new file mode 100644
index 0000000..6bc1459
--- /dev/null
+++ b/docs/api/llm-ops.agentprompttemplateschema.memory.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [memory](./llm-ops.agentprompttemplateschema.memory.md)
+
+## AgentPromptTemplateSchema.memory property
+
+**Signature:**
+
+```typescript
+memory?: MemoryPromptTemplateSchema;
+```
diff --git a/docs/api/llm-ops.agentprompttemplateschema.other.md b/docs/api/llm-ops.agentprompttemplateschema.other.md
new file mode 100644
index 0000000..8d9e703
--- /dev/null
+++ b/docs/api/llm-ops.agentprompttemplateschema.other.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [other](./llm-ops.agentprompttemplateschema.other.md)
+
+## AgentPromptTemplateSchema.other property
+
+**Signature:**
+
+```typescript
+other?: string;
+```
diff --git a/docs/api/llm-ops.agentprompttemplateschema.reasoning.md b/docs/api/llm-ops.agentprompttemplateschema.reasoning.md
new file mode 100644
index 0000000..8ee11d6
--- /dev/null
+++ b/docs/api/llm-ops.agentprompttemplateschema.reasoning.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [reasoning](./llm-ops.agentprompttemplateschema.reasoning.md)
+
+## AgentPromptTemplateSchema.reasoning property
+
+**Signature:**
+
+```typescript
+reasoning?: reasoningType;
+```
diff --git a/docs/api/llm-ops.agentprompttemplateschema.reflection.md b/docs/api/llm-ops.agentprompttemplateschema.reflection.md
new file mode 100644
index 0000000..def6a85
--- /dev/null
+++ b/docs/api/llm-ops.agentprompttemplateschema.reflection.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [reflection](./llm-ops.agentprompttemplateschema.reflection.md)
+
+## AgentPromptTemplateSchema.reflection property
+
+**Signature:**
+
+```typescript
+reflection?: ReflectionPromptTemplateSchema;
+```
diff --git a/docs/api/llm-ops.agentprompttemplateschema.role.md b/docs/api/llm-ops.agentprompttemplateschema.role.md
new file mode 100644
index 0000000..85e85ff
--- /dev/null
+++ b/docs/api/llm-ops.agentprompttemplateschema.role.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [role](./llm-ops.agentprompttemplateschema.role.md)
+
+## AgentPromptTemplateSchema.role property
+
+**Signature:**
+
+```typescript
+role: string;
+```
diff --git a/docs/api/llm-ops.agentprompttemplateschema.rules.md b/docs/api/llm-ops.agentprompttemplateschema.rules.md
new file mode 100644
index 0000000..27f3027
--- /dev/null
+++ b/docs/api/llm-ops.agentprompttemplateschema.rules.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [rules](./llm-ops.agentprompttemplateschema.rules.md)
+
+## AgentPromptTemplateSchema.rules property
+
+**Signature:**
+
+```typescript
+rules?: string | string[];
+```
diff --git a/docs/api/llm-ops.agentprompttemplateschema.tonestyle.md b/docs/api/llm-ops.agentprompttemplateschema.tonestyle.md
new file mode 100644
index 0000000..38620bb
--- /dev/null
+++ b/docs/api/llm-ops.agentprompttemplateschema.tonestyle.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [toneStyle](./llm-ops.agentprompttemplateschema.tonestyle.md)
+
+## AgentPromptTemplateSchema.toneStyle property
+
+**Signature:**
+
+```typescript
+toneStyle?: toneStyleType;
+```
diff --git a/docs/api/llm-ops.baseagent._constructor_.md b/docs/api/llm-ops.baseagent._constructor_.md
new file mode 100644
index 0000000..9bfda74
--- /dev/null
+++ b/docs/api/llm-ops.baseagent._constructor_.md
@@ -0,0 +1,20 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [BaseAgent](./llm-ops.baseagent.md) > [(constructor)](./llm-ops.baseagent._constructor_.md)
+
+## BaseAgent.(constructor)
+
+Constructs a new instance of the `BaseAgent` class
+
+**Signature:**
+
+```typescript
+constructor(params: chainSchema);
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| params | [chainSchema](./llm-ops.chainschema.md) | |
+
diff --git a/docs/api/llm-ops.baseagent.call.md b/docs/api/llm-ops.baseagent.call.md
new file mode 100644
index 0000000..a4005a3
--- /dev/null
+++ b/docs/api/llm-ops.baseagent.call.md
@@ -0,0 +1,22 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [BaseAgent](./llm-ops.baseagent.md) > [call](./llm-ops.baseagent.call.md)
+
+## BaseAgent.call() method
+
+**Signature:**
+
+```typescript
+call(params: BaseAgentCallSchema): PromiseBaseAgent
class |
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [chain?](./llm-ops.baseagent.chain.md) | | [Chain](./llm-ops.chain.md) | _(Optional)_ |
+| [prompt?](./llm-ops.baseagent.prompt.md) | | [messageType](./llm-ops.messagetype.md)\[\] | _(Optional)_ |
+
+## Methods
+
+| Method | Modifiers | Description |
+| --- | --- | --- |
+| [call(params)](./llm-ops.baseagent.call.md) | | |
+
diff --git a/docs/api/llm-ops.baseagent.prompt.md b/docs/api/llm-ops.baseagent.prompt.md
new file mode 100644
index 0000000..1957dc4
--- /dev/null
+++ b/docs/api/llm-ops.baseagent.prompt.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [BaseAgent](./llm-ops.baseagent.md) > [prompt](./llm-ops.baseagent.prompt.md)
+
+## BaseAgent.prompt property
+
+**Signature:**
+
+```typescript
+prompt?: messageType[];
+```
diff --git a/docs/api/llm-ops.baseagentcallschema.md b/docs/api/llm-ops.baseagentcallschema.md
new file mode 100644
index 0000000..6a9288e
--- /dev/null
+++ b/docs/api/llm-ops.baseagentcallschema.md
@@ -0,0 +1,20 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [BaseAgentCallSchema](./llm-ops.baseagentcallschema.md)
+
+## BaseAgentCallSchema interface
+
+**Signature:**
+
+```typescript
+export interface BaseAgentCallSchema
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [prompts?](./llm-ops.baseagentcallschema.prompts.md) | | [PromptsSchema](./llm-ops.promptsschema.md) | _(Optional)_ |
+| [request](./llm-ops.baseagentcallschema.request.md) | | [messageType](./llm-ops.messagetype.md) \| string | |
+| [struct?](./llm-ops.baseagentcallschema.struct.md) | | [structSchema](./llm-ops.structschema.md) | _(Optional)_ |
+
diff --git a/docs/api/llm-ops.baseagentcallschema.prompts.md b/docs/api/llm-ops.baseagentcallschema.prompts.md
new file mode 100644
index 0000000..96fd5c0
--- /dev/null
+++ b/docs/api/llm-ops.baseagentcallschema.prompts.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [BaseAgentCallSchema](./llm-ops.baseagentcallschema.md) > [prompts](./llm-ops.baseagentcallschema.prompts.md)
+
+## BaseAgentCallSchema.prompts property
+
+**Signature:**
+
+```typescript
+prompts?: PromptsSchema;
+```
diff --git a/docs/api/llm-ops.baseagentcallschema.request.md b/docs/api/llm-ops.baseagentcallschema.request.md
new file mode 100644
index 0000000..6d1807a
--- /dev/null
+++ b/docs/api/llm-ops.baseagentcallschema.request.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [BaseAgentCallSchema](./llm-ops.baseagentcallschema.md) > [request](./llm-ops.baseagentcallschema.request.md)
+
+## BaseAgentCallSchema.request property
+
+**Signature:**
+
+```typescript
+request: messageType | string;
+```
diff --git a/docs/api/llm-ops.baseagentcallschema.struct.md b/docs/api/llm-ops.baseagentcallschema.struct.md
new file mode 100644
index 0000000..84af17c
--- /dev/null
+++ b/docs/api/llm-ops.baseagentcallschema.struct.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [BaseAgentCallSchema](./llm-ops.baseagentcallschema.md) > [struct](./llm-ops.baseagentcallschema.struct.md)
+
+## BaseAgentCallSchema.struct property
+
+**Signature:**
+
+```typescript
+struct?: structSchema;
+```
diff --git a/docs/api/llm-ops.baseprompttemplate.format.md b/docs/api/llm-ops.baseprompttemplate.format.md
new file mode 100644
index 0000000..420fc1d
--- /dev/null
+++ b/docs/api/llm-ops.baseprompttemplate.format.md
@@ -0,0 +1,15 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [BasePromptTemplate](./llm-ops.baseprompttemplate.md) > [format](./llm-ops.baseprompttemplate.format.md)
+
+## BasePromptTemplate.format() method
+
+**Signature:**
+
+```typescript
+abstract format(): messagesType;
+```
+**Returns:**
+
+[messagesType](./llm-ops.messagestype.md)
+
diff --git a/docs/api/llm-ops.baseprompttemplate.md b/docs/api/llm-ops.baseprompttemplate.md
new file mode 100644
index 0000000..caf09f9
--- /dev/null
+++ b/docs/api/llm-ops.baseprompttemplate.md
@@ -0,0 +1,18 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [BasePromptTemplate](./llm-ops.baseprompttemplate.md)
+
+## BasePromptTemplate class
+
+**Signature:**
+
+```typescript
+export declare abstract class BasePromptTemplate
+```
+
+## Methods
+
+| Method | Modifiers | Description |
+| --- | --- | --- |
+| [format()](./llm-ops.baseprompttemplate.format.md) | abstract
| |
+
diff --git a/docs/api/llm-ops.chain._constructor_.md b/docs/api/llm-ops.chain._constructor_.md
new file mode 100644
index 0000000..76e8e60
--- /dev/null
+++ b/docs/api/llm-ops.chain._constructor_.md
@@ -0,0 +1,20 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [Chain](./llm-ops.chain.md) > [(constructor)](./llm-ops.chain._constructor_.md)
+
+## Chain.(constructor)
+
+Constructs a new instance of the `Chain` class
+
+**Signature:**
+
+```typescript
+constructor(params: chainSchema);
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| params | [chainSchema](./llm-ops.chainschema.md) | |
+
diff --git a/docs/api/llm-ops.chain.call.md b/docs/api/llm-ops.chain.call.md
new file mode 100644
index 0000000..f39731f
--- /dev/null
+++ b/docs/api/llm-ops.chain.call.md
@@ -0,0 +1,22 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [Chain](./llm-ops.chain.md) > [call](./llm-ops.chain.call.md)
+
+## Chain.call() method
+
+**Signature:**
+
+```typescript
+call(params: chainCallSchema): PromiseChain
class |
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [chain](./llm-ops.chain.chain.md) | | [FunctionChain](./llm-ops.functionchain.md) \| [TypeScriptChain](./llm-ops.typescriptchain.md) | |
+| [chainName?](./llm-ops.chain.chainname.md) | | string | _(Optional)_ |
+| [llm](./llm-ops.chain.llm.md) | | [LLM](./llm-ops.llm.md) | |
+
+## Methods
+
+| Method | Modifiers | Description |
+| --- | --- | --- |
+| [call(params)](./llm-ops.chain.call.md) | | |
+| [exportHistory()](./llm-ops.chain.exporthistory.md) | | |
+
diff --git a/docs/api/llm-ops.chaincallschema.md b/docs/api/llm-ops.chaincallschema.md
new file mode 100644
index 0000000..0557c3d
--- /dev/null
+++ b/docs/api/llm-ops.chaincallschema.md
@@ -0,0 +1,21 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [chainCallSchema](./llm-ops.chaincallschema.md)
+
+## chainCallSchema interface
+
+**Signature:**
+
+```typescript
+export interface chainCallSchema
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [prompt?](./llm-ops.chaincallschema.prompt.md) | | [messageType](./llm-ops.messagetype.md)\[\] | _(Optional)_ |
+| [request](./llm-ops.chaincallschema.request.md) | | [messageType](./llm-ops.messagetype.md) \| string | |
+| [struct?](./llm-ops.chaincallschema.struct.md) | | [structSchema](./llm-ops.structschema.md) | _(Optional)_ |
+| [verbose?](./llm-ops.chaincallschema.verbose.md) | | boolean | _(Optional)_ |
+
diff --git a/docs/api/llm-ops.chaincallschema.prompt.md b/docs/api/llm-ops.chaincallschema.prompt.md
new file mode 100644
index 0000000..7f69df8
--- /dev/null
+++ b/docs/api/llm-ops.chaincallschema.prompt.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [chainCallSchema](./llm-ops.chaincallschema.md) > [prompt](./llm-ops.chaincallschema.prompt.md)
+
+## chainCallSchema.prompt property
+
+**Signature:**
+
+```typescript
+prompt?: messageType[];
+```
diff --git a/docs/api/llm-ops.chaincallschema.request.md b/docs/api/llm-ops.chaincallschema.request.md
new file mode 100644
index 0000000..3c28b8c
--- /dev/null
+++ b/docs/api/llm-ops.chaincallschema.request.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [chainCallSchema](./llm-ops.chaincallschema.md) > [request](./llm-ops.chaincallschema.request.md)
+
+## chainCallSchema.request property
+
+**Signature:**
+
+```typescript
+request: messageType | string;
+```
diff --git a/docs/api/llm-ops.chaincallschema.struct.md b/docs/api/llm-ops.chaincallschema.struct.md
new file mode 100644
index 0000000..5171bdc
--- /dev/null
+++ b/docs/api/llm-ops.chaincallschema.struct.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [chainCallSchema](./llm-ops.chaincallschema.md) > [struct](./llm-ops.chaincallschema.struct.md)
+
+## chainCallSchema.struct property
+
+**Signature:**
+
+```typescript
+struct?: structSchema;
+```
diff --git a/docs/api/llm-ops.chaincallschema.verbose.md b/docs/api/llm-ops.chaincallschema.verbose.md
new file mode 100644
index 0000000..8f57dd1
--- /dev/null
+++ b/docs/api/llm-ops.chaincallschema.verbose.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [chainCallSchema](./llm-ops.chaincallschema.md) > [verbose](./llm-ops.chaincallschema.verbose.md)
+
+## chainCallSchema.verbose property
+
+**Signature:**
+
+```typescript
+verbose?: boolean;
+```
diff --git a/docs/api/llm-ops.chainschema.chainname.md b/docs/api/llm-ops.chainschema.chainname.md
new file mode 100644
index 0000000..e642bb2
--- /dev/null
+++ b/docs/api/llm-ops.chainschema.chainname.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [chainSchema](./llm-ops.chainschema.md) > [chainName](./llm-ops.chainschema.chainname.md)
+
+## chainSchema.chainName property
+
+**Signature:**
+
+```typescript
+chainName?: string;
+```
diff --git a/docs/api/llm-ops.chainschema.llm.md b/docs/api/llm-ops.chainschema.llm.md
new file mode 100644
index 0000000..f49bb32
--- /dev/null
+++ b/docs/api/llm-ops.chainschema.llm.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [chainSchema](./llm-ops.chainschema.md) > [llm](./llm-ops.chainschema.llm.md)
+
+## chainSchema.llm property
+
+**Signature:**
+
+```typescript
+llm?: LLM;
+```
diff --git a/docs/api/llm-ops.chainschema.llmschema.md b/docs/api/llm-ops.chainschema.llmschema.md
new file mode 100644
index 0000000..94a4d6f
--- /dev/null
+++ b/docs/api/llm-ops.chainschema.llmschema.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [chainSchema](./llm-ops.chainschema.md) > [llmSchema](./llm-ops.chainschema.llmschema.md)
+
+## chainSchema.llmSchema property
+
+**Signature:**
+
+```typescript
+llmSchema?: createLLMSchema;
+```
diff --git a/docs/api/llm-ops.chainschema.md b/docs/api/llm-ops.chainschema.md
new file mode 100644
index 0000000..9d46620
--- /dev/null
+++ b/docs/api/llm-ops.chainschema.md
@@ -0,0 +1,20 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [chainSchema](./llm-ops.chainschema.md)
+
+## chainSchema interface
+
+**Signature:**
+
+```typescript
+export interface chainSchema
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [chainName?](./llm-ops.chainschema.chainname.md) | | string | _(Optional)_ |
+| [llm?](./llm-ops.chainschema.llm.md) | | [LLM](./llm-ops.llm.md) | _(Optional)_ |
+| [llmSchema?](./llm-ops.chainschema.llmschema.md) | | [createLLMSchema](./llm-ops.createllmschema.md) | _(Optional)_ |
+
diff --git a/docs/api/llm-ops.chatcompletiontype.md b/docs/api/llm-ops.chatcompletiontype.md
new file mode 100644
index 0000000..27f9b00
--- /dev/null
+++ b/docs/api/llm-ops.chatcompletiontype.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [chatCompletionType](./llm-ops.chatcompletiontype.md)
+
+## chatCompletionType type
+
+**Signature:**
+
+```typescript
+export type chatCompletionType = OpenAI.Chat.Completions.ChatCompletion;
+```
diff --git a/docs/api/llm-ops.chatparamstype.md b/docs/api/llm-ops.chatparamstype.md
new file mode 100644
index 0000000..b05c0ea
--- /dev/null
+++ b/docs/api/llm-ops.chatparamstype.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [chatParamsType](./llm-ops.chatparamstype.md)
+
+## chatParamsType type
+
+**Signature:**
+
+```typescript
+export type chatParamsType = OpenAI.Chat.CompletionCreateParams;
+```
diff --git a/docs/api/llm-ops.chatschema.function_call.md b/docs/api/llm-ops.chatschema.function_call.md
new file mode 100644
index 0000000..6dd820b
--- /dev/null
+++ b/docs/api/llm-ops.chatschema.function_call.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [ChatSchema](./llm-ops.chatschema.md) > [function\_call](./llm-ops.chatschema.function_call.md)
+
+## ChatSchema.function\_call property
+
+**Signature:**
+
+```typescript
+function_call?: function_callType;
+```
diff --git a/docs/api/llm-ops.chatschema.functions.md b/docs/api/llm-ops.chatschema.functions.md
new file mode 100644
index 0000000..8ee819b
--- /dev/null
+++ b/docs/api/llm-ops.chatschema.functions.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [ChatSchema](./llm-ops.chatschema.md) > [functions](./llm-ops.chatschema.functions.md)
+
+## ChatSchema.functions property
+
+**Signature:**
+
+```typescript
+functions?: functionsType;
+```
diff --git a/docs/api/llm-ops.chatschema.md b/docs/api/llm-ops.chatschema.md
new file mode 100644
index 0000000..5a29158
--- /dev/null
+++ b/docs/api/llm-ops.chatschema.md
@@ -0,0 +1,20 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [ChatSchema](./llm-ops.chatschema.md)
+
+## ChatSchema interface
+
+**Signature:**
+
+```typescript
+export interface ChatSchema
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [function\_call?](./llm-ops.chatschema.function_call.md) | | [function\_callType](./llm-ops.function_calltype.md) | _(Optional)_ |
+| [functions?](./llm-ops.chatschema.functions.md) | | [functionsType](./llm-ops.functionstype.md) | _(Optional)_ |
+| [messages](./llm-ops.chatschema.messages.md) | | [messagesType](./llm-ops.messagestype.md) | |
+
diff --git a/docs/api/llm-ops.chatschema.messages.md b/docs/api/llm-ops.chatschema.messages.md
new file mode 100644
index 0000000..256ac5b
--- /dev/null
+++ b/docs/api/llm-ops.chatschema.messages.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [ChatSchema](./llm-ops.chatschema.md) > [messages](./llm-ops.chatschema.messages.md)
+
+## ChatSchema.messages property
+
+**Signature:**
+
+```typescript
+messages: messagesType;
+```
diff --git a/docs/api/llm-ops.communicationstyletype.md b/docs/api/llm-ops.communicationstyletype.md
new file mode 100644
index 0000000..6ec45f7
--- /dev/null
+++ b/docs/api/llm-ops.communicationstyletype.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [communicationStyleType](./llm-ops.communicationstyletype.md)
+
+## communicationStyleType type
+
+**Signature:**
+
+```typescript
+export type communicationStyleType = "Formal" | "Textbook" | "Layman" | "Story Telling" | "Socratic";
+```
diff --git a/docs/api/llm-ops.createjsonvalidator.md b/docs/api/llm-ops.createjsonvalidator.md
new file mode 100644
index 0000000..f4ecc63
--- /dev/null
+++ b/docs/api/llm-ops.createjsonvalidator.md
@@ -0,0 +1,27 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [createJsonValidator](./llm-ops.createjsonvalidator.md)
+
+## createJsonValidator() function
+
+Returns a JSON validator for a given TypeScript schema. Validation is performed by an in-memory instance of the TypeScript compiler. The specified type argument `T` must be the same type as `typeName` in the given `schema`.
+
+**Signature:**
+
+```typescript
+export declare function createJsonValidatormessage
property of the result. |
+
+**Returns:**
+
+[Error](./llm-ops.error_2.md)
+
+An `Error` object.
+
diff --git a/docs/api/llm-ops.error_2.md b/docs/api/llm-ops.error_2.md
new file mode 100644
index 0000000..a963439
--- /dev/null
+++ b/docs/api/llm-ops.error_2.md
@@ -0,0 +1,21 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [Error\_2](./llm-ops.error_2.md)
+
+## Error\_2 interface
+
+An object representing an operation that failed for the reason given in `message`.
+
+**Signature:**
+
+```typescript
+export interface Error
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [message](./llm-ops.error_2.message.md) | | string | |
+| [success](./llm-ops.error_2.success.md) | | false | |
+
diff --git a/docs/api/llm-ops.error_2.message.md b/docs/api/llm-ops.error_2.message.md
new file mode 100644
index 0000000..af9e148
--- /dev/null
+++ b/docs/api/llm-ops.error_2.message.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [Error\_2](./llm-ops.error_2.md) > [message](./llm-ops.error_2.message.md)
+
+## Error\_2.message property
+
+**Signature:**
+
+```typescript
+message: string;
+```
diff --git a/docs/api/llm-ops.error_2.success.md b/docs/api/llm-ops.error_2.success.md
new file mode 100644
index 0000000..87fe1e9
--- /dev/null
+++ b/docs/api/llm-ops.error_2.success.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [Error\_2](./llm-ops.error_2.md) > [success](./llm-ops.error_2.success.md)
+
+## Error\_2.success property
+
+**Signature:**
+
+```typescript
+success: false;
+```
diff --git a/docs/api/llm-ops.evaluateitemschema.desc.md b/docs/api/llm-ops.evaluateitemschema.desc.md
new file mode 100644
index 0000000..73f115b
--- /dev/null
+++ b/docs/api/llm-ops.evaluateitemschema.desc.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [EvaluateItemSchema](./llm-ops.evaluateitemschema.md) > [desc](./llm-ops.evaluateitemschema.desc.md)
+
+## EvaluateItemSchema.desc property
+
+**Signature:**
+
+```typescript
+desc: string;
+```
diff --git a/docs/api/llm-ops.evaluateitemschema.md b/docs/api/llm-ops.evaluateitemschema.md
new file mode 100644
index 0000000..1c15c62
--- /dev/null
+++ b/docs/api/llm-ops.evaluateitemschema.md
@@ -0,0 +1,19 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [EvaluateItemSchema](./llm-ops.evaluateitemschema.md)
+
+## EvaluateItemSchema interface
+
+**Signature:**
+
+```typescript
+export interface EvaluateItemSchema
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [desc](./llm-ops.evaluateitemschema.desc.md) | | string | |
+| [name](./llm-ops.evaluateitemschema.name.md) | | string | |
+
diff --git a/docs/api/llm-ops.evaluateitemschema.name.md b/docs/api/llm-ops.evaluateitemschema.name.md
new file mode 100644
index 0000000..c5bdad1
--- /dev/null
+++ b/docs/api/llm-ops.evaluateitemschema.name.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [EvaluateItemSchema](./llm-ops.evaluateitemschema.md) > [name](./llm-ops.evaluateitemschema.name.md)
+
+## EvaluateItemSchema.name property
+
+**Signature:**
+
+```typescript
+name: string;
+```
diff --git a/docs/api/llm-ops.formatprompttemplate.md b/docs/api/llm-ops.formatprompttemplate.md
new file mode 100644
index 0000000..86e966f
--- /dev/null
+++ b/docs/api/llm-ops.formatprompttemplate.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [formatPromptTemplate](./llm-ops.formatprompttemplate.md)
+
+## formatPromptTemplate variable
+
+**Signature:**
+
+```typescript
+formatPromptTemplate: (prompts: PromptsSchema) => Promise<(import("openai/resources/chat").ChatCompletionMessageParam | MultiPromptSchema | undefined)[]>
+```
diff --git a/docs/api/llm-ops.function_calltype.md b/docs/api/llm-ops.function_calltype.md
new file mode 100644
index 0000000..759acc2
--- /dev/null
+++ b/docs/api/llm-ops.function_calltype.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [function\_callType](./llm-ops.function_calltype.md)
+
+## function\_callType type
+
+**Signature:**
+
+```typescript
+export type function_callType = "none" | "auto" | FunctionCallOption;
+```
+**References:** [FunctionCallOption](./llm-ops.functioncalloption.md)
+
diff --git a/docs/api/llm-ops.functioncalloption.md b/docs/api/llm-ops.functioncalloption.md
new file mode 100644
index 0000000..78de56d
--- /dev/null
+++ b/docs/api/llm-ops.functioncalloption.md
@@ -0,0 +1,18 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [FunctionCallOption](./llm-ops.functioncalloption.md)
+
+## FunctionCallOption interface
+
+**Signature:**
+
+```typescript
+export interface FunctionCallOption
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [name](./llm-ops.functioncalloption.name.md) | | string | The name of the function to call. |
+
diff --git a/docs/api/llm-ops.functioncalloption.name.md b/docs/api/llm-ops.functioncalloption.name.md
new file mode 100644
index 0000000..01d68e6
--- /dev/null
+++ b/docs/api/llm-ops.functioncalloption.name.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [FunctionCallOption](./llm-ops.functioncalloption.md) > [name](./llm-ops.functioncalloption.name.md)
+
+## FunctionCallOption.name property
+
+The name of the function to call.
+
+**Signature:**
+
+```typescript
+name: string;
+```
diff --git a/docs/api/llm-ops.functioncallschema.function_call.md b/docs/api/llm-ops.functioncallschema.function_call.md
new file mode 100644
index 0000000..1901d56
--- /dev/null
+++ b/docs/api/llm-ops.functioncallschema.function_call.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [FunctionCallSchema](./llm-ops.functioncallschema.md) > [function\_call](./llm-ops.functioncallschema.function_call.md)
+
+## FunctionCallSchema.function\_call property
+
+**Signature:**
+
+```typescript
+function_call?: function_callType;
+```
diff --git a/docs/api/llm-ops.functioncallschema.functions.md b/docs/api/llm-ops.functioncallschema.functions.md
new file mode 100644
index 0000000..e46313a
--- /dev/null
+++ b/docs/api/llm-ops.functioncallschema.functions.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [FunctionCallSchema](./llm-ops.functioncallschema.md) > [functions](./llm-ops.functioncallschema.functions.md)
+
+## FunctionCallSchema.functions property
+
+**Signature:**
+
+```typescript
+functions?: functionsType;
+```
diff --git a/docs/api/llm-ops.functioncallschema.md b/docs/api/llm-ops.functioncallschema.md
new file mode 100644
index 0000000..9ab71a9
--- /dev/null
+++ b/docs/api/llm-ops.functioncallschema.md
@@ -0,0 +1,22 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [FunctionCallSchema](./llm-ops.functioncallschema.md)
+
+## FunctionCallSchema interface
+
+**Signature:**
+
+```typescript
+export interface FunctionCallSchema
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [function\_call?](./llm-ops.functioncallschema.function_call.md) | | [function\_callType](./llm-ops.function_calltype.md) | _(Optional)_ |
+| [functions?](./llm-ops.functioncallschema.functions.md) | | [functionsType](./llm-ops.functionstype.md) | _(Optional)_ |
+| [prompt?](./llm-ops.functioncallschema.prompt.md) | | [messageType](./llm-ops.messagetype.md)\[\] | _(Optional)_ |
+| [request](./llm-ops.functioncallschema.request.md) | | [messageType](./llm-ops.messagetype.md) \| string | |
+| [verbose?](./llm-ops.functioncallschema.verbose.md) | | boolean | _(Optional)_ |
+
diff --git a/docs/api/llm-ops.functioncallschema.prompt.md b/docs/api/llm-ops.functioncallschema.prompt.md
new file mode 100644
index 0000000..f521c4d
--- /dev/null
+++ b/docs/api/llm-ops.functioncallschema.prompt.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [FunctionCallSchema](./llm-ops.functioncallschema.md) > [prompt](./llm-ops.functioncallschema.prompt.md)
+
+## FunctionCallSchema.prompt property
+
+**Signature:**
+
+```typescript
+prompt?: messageType[];
+```
diff --git a/docs/api/llm-ops.functioncallschema.request.md b/docs/api/llm-ops.functioncallschema.request.md
new file mode 100644
index 0000000..54aae24
--- /dev/null
+++ b/docs/api/llm-ops.functioncallschema.request.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [FunctionCallSchema](./llm-ops.functioncallschema.md) > [request](./llm-ops.functioncallschema.request.md)
+
+## FunctionCallSchema.request property
+
+**Signature:**
+
+```typescript
+request: messageType | string;
+```
diff --git a/docs/api/llm-ops.functioncallschema.verbose.md b/docs/api/llm-ops.functioncallschema.verbose.md
new file mode 100644
index 0000000..da7d706
--- /dev/null
+++ b/docs/api/llm-ops.functioncallschema.verbose.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [FunctionCallSchema](./llm-ops.functioncallschema.md) > [verbose](./llm-ops.functioncallschema.verbose.md)
+
+## FunctionCallSchema.verbose property
+
+**Signature:**
+
+```typescript
+verbose?: boolean;
+```
diff --git a/docs/api/llm-ops.functionchain._constructor_.md b/docs/api/llm-ops.functionchain._constructor_.md
new file mode 100644
index 0000000..93b2506
--- /dev/null
+++ b/docs/api/llm-ops.functionchain._constructor_.md
@@ -0,0 +1,20 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [FunctionChain](./llm-ops.functionchain.md) > [(constructor)](./llm-ops.functionchain._constructor_.md)
+
+## FunctionChain.(constructor)
+
+Constructs a new instance of the `FunctionChain` class
+
+**Signature:**
+
+```typescript
+constructor(llm: LLM);
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| llm | [LLM](./llm-ops.llm.md) | |
+
diff --git a/docs/api/llm-ops.functionchain.call.md b/docs/api/llm-ops.functionchain.call.md
new file mode 100644
index 0000000..55ea312
--- /dev/null
+++ b/docs/api/llm-ops.functionchain.call.md
@@ -0,0 +1,22 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [FunctionChain](./llm-ops.functionchain.md) > [call](./llm-ops.functionchain.call.md)
+
+## FunctionChain.call() method
+
+**Signature:**
+
+```typescript
+call(params: FunctionCallSchema): PromiseFunctionChain
class |
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [llm](./llm-ops.functionchain.llm.md) | | [LLM](./llm-ops.llm.md) | |
+
+## Methods
+
+| Method | Modifiers | Description |
+| --- | --- | --- |
+| [call(params)](./llm-ops.functionchain.call.md) | | |
+| [exportHistory()](./llm-ops.functionchain.exporthistory.md) | | |
+
diff --git a/docs/api/llm-ops.functioninterface.description.md b/docs/api/llm-ops.functioninterface.description.md
new file mode 100644
index 0000000..c7356c6
--- /dev/null
+++ b/docs/api/llm-ops.functioninterface.description.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [FunctionInterface](./llm-ops.functioninterface.md) > [description](./llm-ops.functioninterface.description.md)
+
+## FunctionInterface.description property
+
+A description of what the function does, used by the model to choose when and how to call the function.
+
+**Signature:**
+
+```typescript
+description?: string;
+```
diff --git a/docs/api/llm-ops.functioninterface.md b/docs/api/llm-ops.functioninterface.md
new file mode 100644
index 0000000..95f2108
--- /dev/null
+++ b/docs/api/llm-ops.functioninterface.md
@@ -0,0 +1,20 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [FunctionInterface](./llm-ops.functioninterface.md)
+
+## FunctionInterface interface
+
+**Signature:**
+
+```typescript
+export interface FunctionInterface
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [description?](./llm-ops.functioninterface.description.md) | | string | _(Optional)_ A description of what the function does, used by the model to choose when and how to call the function. |
+| [name](./llm-ops.functioninterface.name.md) | | string | The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. |
+| [parameters](./llm-ops.functioninterface.parameters.md) | | Record<string, unknown> | The parameters the functions accepts, described as a JSON Schema object. See the \[guide\](https://platform.openai.com/docs/guides/gpt/function-calling) for examples, and the \[JSON Schema reference\](https://json-schema.org/understanding-json-schema/) for documentation about the format.
To describe a function that accepts no parameters, provide the value {"type": "object", "properties": {}}
.
Result<T>
from which to obtain the data
property. |
+
+**Returns:**
+
+T
+
+The value of the `data` property.
+
diff --git a/docs/api/llm-ops.inputvalues.md b/docs/api/llm-ops.inputvalues.md
new file mode 100644
index 0000000..e77e52c
--- /dev/null
+++ b/docs/api/llm-ops.inputvalues.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [InputValues](./llm-ops.inputvalues.md)
+
+## InputValues type
+
+**Signature:**
+
+```typescript
+export type InputValues = RecordLLM
class |
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [cache?](./llm-ops.llm.cache.md) | | boolean | _(Optional)_ |
+| [choice\_num?](./llm-ops.llm.choice_num.md) | | number \| 1 | _(Optional)_ |
+| [function\_call?](./llm-ops.llm.function_call.md) | | [function\_callType](./llm-ops.function_calltype.md) | _(Optional)_ |
+| [functions?](./llm-ops.llm.functions.md) | | [functionsType](./llm-ops.functionstype.md) | _(Optional)_ |
+| [llm](./llm-ops.llm.llm.md) | | [llmType](./llm-ops.llmtype.md) | |
+| [messages](./llm-ops.llm.messages.md) | | [messagesType](./llm-ops.messagestype.md) | |
+| [modelName?](./llm-ops.llm.modelname.md) | | (string & object) \| "gpt-4" \| "gpt-4-0314" \| "gpt-4-0613" \| "gpt-4-32k" \| "gpt-4-32k-0314" \| "gpt-4-32k-0613" \| "gpt-3.5-turbo" \| "gpt-3.5-turbo-16k" \| "gpt-3.5-turbo-0301" \| "gpt-3.5-turbo-0613" \| "gpt-3.5-turbo-16k-0613" | _(Optional)_ |
+| [roleToColor](./llm-ops.llm.roletocolor.md) | | { system: string; user: string; assistant: string; function: string; } | |
+| [stop?](./llm-ops.llm.stop.md) | | string \| null \| string\[\] | _(Optional)_ |
+| [temperature?](./llm-ops.llm.temperature.md) | | number | _(Optional)_ |
+| [tokens](./llm-ops.llm.tokens.md) | | number | |
+| [user](./llm-ops.llm.user.md) | | string | |
+
+## Methods
+
+| Method | Modifiers | Description |
+| --- | --- | --- |
+| [chat(params)](./llm-ops.llm.chat.md) | | |
+| [embedding(input)](./llm-ops.llm.embedding.md) | | |
+| [exportHistory()](./llm-ops.llm.exporthistory.md) | | |
+| [log(args)](./llm-ops.llm.log.md) | static
| |
+| [moderate(input)](./llm-ops.llm.moderate.md) | | |
+| [printMessage(resMessages, reqMessages)](./llm-ops.llm.printmessage.md) | | |
+| [recall()](./llm-ops.llm.recall.md) | | |
+
diff --git a/docs/api/llm-ops.llm.messages.md b/docs/api/llm-ops.llm.messages.md
new file mode 100644
index 0000000..1f33154
--- /dev/null
+++ b/docs/api/llm-ops.llm.messages.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM](./llm-ops.llm.md) > [messages](./llm-ops.llm.messages.md)
+
+## LLM.messages property
+
+**Signature:**
+
+```typescript
+messages: messagesType;
+```
diff --git a/docs/api/llm-ops.llm.modelname.md b/docs/api/llm-ops.llm.modelname.md
new file mode 100644
index 0000000..99c63ad
--- /dev/null
+++ b/docs/api/llm-ops.llm.modelname.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM](./llm-ops.llm.md) > [modelName](./llm-ops.llm.modelname.md)
+
+## LLM.modelName property
+
+**Signature:**
+
+```typescript
+modelName?: (string & object) | "gpt-4" | "gpt-4-0314" | "gpt-4-0613" | "gpt-4-32k" | "gpt-4-32k-0314" | "gpt-4-32k-0613" | "gpt-3.5-turbo" | "gpt-3.5-turbo-16k" | "gpt-3.5-turbo-0301" | "gpt-3.5-turbo-0613" | "gpt-3.5-turbo-16k-0613";
+```
diff --git a/docs/api/llm-ops.llm.moderate.md b/docs/api/llm-ops.llm.moderate.md
new file mode 100644
index 0000000..e83d449
--- /dev/null
+++ b/docs/api/llm-ops.llm.moderate.md
@@ -0,0 +1,22 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM](./llm-ops.llm.md) > [moderate](./llm-ops.llm.moderate.md)
+
+## LLM.moderate() method
+
+**Signature:**
+
+```typescript
+moderate(input: string | string[]): Promisestatic
| string \| undefined | |
+| [MILVUS\_ADDRESS](./llm-ops.llm_ops_config.milvus_address.md) | static
| string \| undefined | |
+| [MILVUS\_PASSWORD](./llm-ops.llm_ops_config.milvus_password.md) | static
| string \| undefined | |
+| [MILVUS\_USERNAME](./llm-ops.llm_ops_config.milvus_username.md) | static
| string \| undefined | |
+| [OPEN\_PATH](./llm-ops.llm_ops_config.open_path.md) | static
| { baseURL: string; defaultHeaders: { "Helicone-Auth": string; }; } | |
+| [OPENAI\_API\_KEY](./llm-ops.llm_ops_config.openai_api_key.md) | static
| string \| undefined | |
+
diff --git a/docs/api/llm-ops.llm_ops_config.milvus_address.md b/docs/api/llm-ops.llm_ops_config.milvus_address.md
new file mode 100644
index 0000000..9c847df
--- /dev/null
+++ b/docs/api/llm-ops.llm_ops_config.milvus_address.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM\_OPS\_CONFIG](./llm-ops.llm_ops_config.md) > [MILVUS\_ADDRESS](./llm-ops.llm_ops_config.milvus_address.md)
+
+## LLM\_OPS\_CONFIG.MILVUS\_ADDRESS property
+
+**Signature:**
+
+```typescript
+static MILVUS_ADDRESS: string | undefined;
+```
diff --git a/docs/api/llm-ops.llm_ops_config.milvus_password.md b/docs/api/llm-ops.llm_ops_config.milvus_password.md
new file mode 100644
index 0000000..8dfe9a7
--- /dev/null
+++ b/docs/api/llm-ops.llm_ops_config.milvus_password.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM\_OPS\_CONFIG](./llm-ops.llm_ops_config.md) > [MILVUS\_PASSWORD](./llm-ops.llm_ops_config.milvus_password.md)
+
+## LLM\_OPS\_CONFIG.MILVUS\_PASSWORD property
+
+**Signature:**
+
+```typescript
+static MILVUS_PASSWORD: string | undefined;
+```
diff --git a/docs/api/llm-ops.llm_ops_config.milvus_username.md b/docs/api/llm-ops.llm_ops_config.milvus_username.md
new file mode 100644
index 0000000..fadac1e
--- /dev/null
+++ b/docs/api/llm-ops.llm_ops_config.milvus_username.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM\_OPS\_CONFIG](./llm-ops.llm_ops_config.md) > [MILVUS\_USERNAME](./llm-ops.llm_ops_config.milvus_username.md)
+
+## LLM\_OPS\_CONFIG.MILVUS\_USERNAME property
+
+**Signature:**
+
+```typescript
+static MILVUS_USERNAME: string | undefined;
+```
diff --git a/docs/api/llm-ops.llm_ops_config.open_path.md b/docs/api/llm-ops.llm_ops_config.open_path.md
new file mode 100644
index 0000000..bc97ce5
--- /dev/null
+++ b/docs/api/llm-ops.llm_ops_config.open_path.md
@@ -0,0 +1,16 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM\_OPS\_CONFIG](./llm-ops.llm_ops_config.md) > [OPEN\_PATH](./llm-ops.llm_ops_config.open_path.md)
+
+## LLM\_OPS\_CONFIG.OPEN\_PATH property
+
+**Signature:**
+
+```typescript
+static OPEN_PATH: {
+ baseURL: string;
+ defaultHeaders: {
+ "Helicone-Auth": string;
+ };
+ };
+```
diff --git a/docs/api/llm-ops.llm_ops_config.openai_api_key.md b/docs/api/llm-ops.llm_ops_config.openai_api_key.md
new file mode 100644
index 0000000..197781c
--- /dev/null
+++ b/docs/api/llm-ops.llm_ops_config.openai_api_key.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM\_OPS\_CONFIG](./llm-ops.llm_ops_config.md) > [OPENAI\_API\_KEY](./llm-ops.llm_ops_config.openai_api_key.md)
+
+## LLM\_OPS\_CONFIG.OPENAI\_API\_KEY property
+
+**Signature:**
+
+```typescript
+static OPENAI_API_KEY: string | undefined;
+```
diff --git a/docs/api/llm-ops.llmtype.md b/docs/api/llm-ops.llmtype.md
new file mode 100644
index 0000000..8248d80
--- /dev/null
+++ b/docs/api/llm-ops.llmtype.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [llmType](./llm-ops.llmtype.md)
+
+## llmType type
+
+**Signature:**
+
+```typescript
+export type llmType = OpenAI;
+```
diff --git a/docs/api/llm-ops.md b/docs/api/llm-ops.md
new file mode 100644
index 0000000..6dfabfc
--- /dev/null
+++ b/docs/api/llm-ops.md
@@ -0,0 +1,100 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md)
+
+## llm-ops package
+
+## Classes
+
+| Class | Description |
+| --- | --- |
+| [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) | |
+| [BaseAgent](./llm-ops.baseagent.md) | |
+| [Chain](./llm-ops.chain.md) | |
+| [FunctionChain](./llm-ops.functionchain.md) | |
+| [LLM\_OPS\_CONFIG](./llm-ops.llm_ops_config.md) | |
+| [LLM](./llm-ops.llm.md) | |
+| [milvusVectorDB](./llm-ops.milvusvectordb.md) | |
+| [PipeRegistry](./llm-ops.piperegistry.md) | |
+| [PolishPromptTemplate](./llm-ops.polishprompttemplate.md) | |
+| [TypeScriptChain](./llm-ops.typescriptchain.md) | Creates an object that can translate natural language requests into JSON objects of the given type. The specified type argument T
must be the same type as typeName
in the given schema
. The function creates a TypeChatJsonValidator<T>
and stores it in the validator
property of the returned instance. |
+
+## Abstract Classes
+
+| Abstract Class | Description |
+| --- | --- |
+| [BasePromptTemplate](./llm-ops.baseprompttemplate.md) | |
+
+## Functions
+
+| Function | Description |
+| --- | --- |
+| [createJsonValidator(schema, typeName)](./llm-ops.createjsonvalidator.md) | Returns a JSON validator for a given TypeScript schema. Validation is performed by an in-memory instance of the TypeScript compiler. The specified type argument T
must be the same type as typeName
in the given schema
. |
+| [createMessage(params)](./llm-ops.createmessage.md) | |
+| [error(message)](./llm-ops.error.md) | Returns an Error
object. |
+| [getData(result)](./llm-ops.getdata.md) | Obtains the value associated with a successful Result<T>
or throws an exception if the result is an error. |
+| [success(data)](./llm-ops.success.md) | Returns a Success<T>
object. |
+
+## Interfaces
+
+| Interface | Description |
+| --- | --- |
+| [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) | |
+| [BaseAgentCallSchema](./llm-ops.baseagentcallschema.md) | |
+| [chainCallSchema](./llm-ops.chaincallschema.md) | |
+| [chainSchema](./llm-ops.chainschema.md) | |
+| [ChatSchema](./llm-ops.chatschema.md) | |
+| [createLLMSchema](./llm-ops.createllmschema.md) | |
+| [createMessageSchema](./llm-ops.createmessageschema.md) | |
+| [Error\_2](./llm-ops.error_2.md) | An object representing an operation that failed for the reason given in message
. |
+| [EvaluateItemSchema](./llm-ops.evaluateitemschema.md) | |
+| [FunctionCallOption](./llm-ops.functioncalloption.md) | |
+| [FunctionCallSchema](./llm-ops.functioncallschema.md) | |
+| [FunctionInterface](./llm-ops.functioninterface.md) | |
+| [MemoryPromptTemplateSchema](./llm-ops.memoryprompttemplateschema.md) | |
+| [milvusVectorDBCreateSchema](./llm-ops.milvusvectordbcreateschema.md) | |
+| [milvusVectorDBIndexSchema](./llm-ops.milvusvectordbindexschema.md) | |
+| [milvusVectorDBPromptTemplateSchema](./llm-ops.milvusvectordbprompttemplateschema.md) | |
+| [milvusVectorDBQuerySchema](./llm-ops.milvusvectordbqueryschema.md) | |
+| [milvusVectorDBSchema](./llm-ops.milvusvectordbschema.md) | |
+| [milvusVectorDBSearchSchema](./llm-ops.milvusvectordbsearchschema.md) | |
+| [milvusVectorDBUploadSchema](./llm-ops.milvusvectordbuploadschema.md) | |
+| [MultiPromptSchema](./llm-ops.multipromptschema.md) | |
+| [polishPromptTemplateSchema](./llm-ops.polishprompttemplateschema.md) | |
+| [PromptsSchema](./llm-ops.promptsschema.md) | |
+| [ReflectionPromptTemplateSchema](./llm-ops.reflectionprompttemplateschema.md) | |
+| [structSchema](./llm-ops.structschema.md) | |
+| [Success](./llm-ops.success.md) | An object representing a successful operation with a result of type T
. |
+| [TeacherEvaluateSchema](./llm-ops.teacherevaluateschema.md) | |
+| [TypeChatJsonValidator](./llm-ops.typechatjsonvalidator.md) | Represents an object that can validate JSON strings according to a given TypeScript schema. |
+| [TypeScriptChainCallSchema](./llm-ops.typescriptchaincallschema.md) | Represents an object that can translate natural language requests in JSON objects of the given type. |
+
+## Variables
+
+| Variable | Description |
+| --- | --- |
+| [formatPromptTemplate](./llm-ops.formatprompttemplate.md) | |
+
+## Type Aliases
+
+| Type Alias | Description |
+| --- | --- |
+| [chatCompletionType](./llm-ops.chatcompletiontype.md) | |
+| [chatParamsType](./llm-ops.chatparamstype.md) | |
+| [communicationStyleType](./llm-ops.communicationstyletype.md) | |
+| [function\_callType](./llm-ops.function_calltype.md) | |
+| [functionsType](./llm-ops.functionstype.md) | |
+| [InputValues](./llm-ops.inputvalues.md) | |
+| [languageType](./llm-ops.languagetype.md) | |
+| [levelType](./llm-ops.leveltype.md) | |
+| [llmType](./llm-ops.llmtype.md) | |
+| [messageFunctionCallType](./llm-ops.messagefunctioncalltype.md) | |
+| [messagesType](./llm-ops.messagestype.md) | |
+| [messageType](./llm-ops.messagetype.md) | |
+| [reasoningType](./llm-ops.reasoningtype.md) | |
+| [resEmbeddingType](./llm-ops.resembeddingtype.md) | |
+| [resMessagesType](./llm-ops.resmessagestype.md) | |
+| [resModerationType](./llm-ops.resmoderationtype.md) | |
+| [Result](./llm-ops.result.md) | An object representing a successful or failed operation of type T
. |
+| [toneStyleType](./llm-ops.tonestyletype.md) | |
+
diff --git a/docs/api/llm-ops.memoryprompttemplateschema.data.md b/docs/api/llm-ops.memoryprompttemplateschema.data.md
new file mode 100644
index 0000000..e29887a
--- /dev/null
+++ b/docs/api/llm-ops.memoryprompttemplateschema.data.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [MemoryPromptTemplateSchema](./llm-ops.memoryprompttemplateschema.md) > [data](./llm-ops.memoryprompttemplateschema.data.md)
+
+## MemoryPromptTemplateSchema.data property
+
+**Signature:**
+
+```typescript
+data?: string | string[];
+```
diff --git a/docs/api/llm-ops.memoryprompttemplateschema.knowledge.md b/docs/api/llm-ops.memoryprompttemplateschema.knowledge.md
new file mode 100644
index 0000000..41ca70d
--- /dev/null
+++ b/docs/api/llm-ops.memoryprompttemplateschema.knowledge.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [MemoryPromptTemplateSchema](./llm-ops.memoryprompttemplateschema.md) > [knowledge](./llm-ops.memoryprompttemplateschema.knowledge.md)
+
+## MemoryPromptTemplateSchema.knowledge property
+
+**Signature:**
+
+```typescript
+knowledge?: string | string[];
+```
diff --git a/docs/api/llm-ops.memoryprompttemplateschema.md b/docs/api/llm-ops.memoryprompttemplateschema.md
new file mode 100644
index 0000000..ca507b5
--- /dev/null
+++ b/docs/api/llm-ops.memoryprompttemplateschema.md
@@ -0,0 +1,20 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [MemoryPromptTemplateSchema](./llm-ops.memoryprompttemplateschema.md)
+
+## MemoryPromptTemplateSchema interface
+
+**Signature:**
+
+```typescript
+export interface MemoryPromptTemplateSchema
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [data?](./llm-ops.memoryprompttemplateschema.data.md) | | string \| string\[\] | _(Optional)_ |
+| [knowledge?](./llm-ops.memoryprompttemplateschema.knowledge.md) | | string \| string\[\] | _(Optional)_ |
+| [tools?](./llm-ops.memoryprompttemplateschema.tools.md) | | string \| string\[\] | _(Optional)_ |
+
diff --git a/docs/api/llm-ops.memoryprompttemplateschema.tools.md b/docs/api/llm-ops.memoryprompttemplateschema.tools.md
new file mode 100644
index 0000000..76f0a21
--- /dev/null
+++ b/docs/api/llm-ops.memoryprompttemplateschema.tools.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [MemoryPromptTemplateSchema](./llm-ops.memoryprompttemplateschema.md) > [tools](./llm-ops.memoryprompttemplateschema.tools.md)
+
+## MemoryPromptTemplateSchema.tools property
+
+**Signature:**
+
+```typescript
+tools?: string | string[];
+```
diff --git a/docs/api/llm-ops.messagefunctioncalltype.md b/docs/api/llm-ops.messagefunctioncalltype.md
new file mode 100644
index 0000000..362dd73
--- /dev/null
+++ b/docs/api/llm-ops.messagefunctioncalltype.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [messageFunctionCallType](./llm-ops.messagefunctioncalltype.md)
+
+## messageFunctionCallType type
+
+**Signature:**
+
+```typescript
+export type messageFunctionCallType = OpenAI.Chat.ChatCompletionMessage.FunctionCall;
+```
diff --git a/docs/api/llm-ops.messagestype.md b/docs/api/llm-ops.messagestype.md
new file mode 100644
index 0000000..c8f6295
--- /dev/null
+++ b/docs/api/llm-ops.messagestype.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [messagesType](./llm-ops.messagestype.md)
+
+## messagesType type
+
+**Signature:**
+
+```typescript
+export type messagesType = OpenAI.Chat.CreateChatCompletionRequestMessage[];
+```
diff --git a/docs/api/llm-ops.messagetype.md b/docs/api/llm-ops.messagetype.md
new file mode 100644
index 0000000..7cf0400
--- /dev/null
+++ b/docs/api/llm-ops.messagetype.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [messageType](./llm-ops.messagetype.md)
+
+## messageType type
+
+**Signature:**
+
+```typescript
+export type messageType = OpenAI.Chat.CreateChatCompletionRequestMessage;
+```
diff --git a/docs/api/llm-ops.milvusvectordb._constructor_.md b/docs/api/llm-ops.milvusvectordb._constructor_.md
new file mode 100644
index 0000000..c82debc
--- /dev/null
+++ b/docs/api/llm-ops.milvusvectordb._constructor_.md
@@ -0,0 +1,20 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDB](./llm-ops.milvusvectordb.md) > [(constructor)](./llm-ops.milvusvectordb._constructor_.md)
+
+## milvusVectorDB.(constructor)
+
+Constructs a new instance of the `milvusVectorDB` class
+
+**Signature:**
+
+```typescript
+constructor(params: milvusVectorDBSchema);
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| params | [milvusVectorDBSchema](./llm-ops.milvusvectordbschema.md) | |
+
diff --git a/docs/api/llm-ops.milvusvectordb.collection_name.md b/docs/api/llm-ops.milvusvectordb.collection_name.md
new file mode 100644
index 0000000..869e39e
--- /dev/null
+++ b/docs/api/llm-ops.milvusvectordb.collection_name.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDB](./llm-ops.milvusvectordb.md) > [COLLECTION\_NAME](./llm-ops.milvusvectordb.collection_name.md)
+
+## milvusVectorDB.COLLECTION\_NAME property
+
+**Signature:**
+
+```typescript
+COLLECTION_NAME: string;
+```
diff --git a/docs/api/llm-ops.milvusvectordb.createcollection.md b/docs/api/llm-ops.milvusvectordb.createcollection.md
new file mode 100644
index 0000000..1d67f61
--- /dev/null
+++ b/docs/api/llm-ops.milvusvectordb.createcollection.md
@@ -0,0 +1,22 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDB](./llm-ops.milvusvectordb.md) > [createCollection](./llm-ops.milvusvectordb.createcollection.md)
+
+## milvusVectorDB.createCollection() method
+
+**Signature:**
+
+```typescript
+createCollection(params: milvusVectorDBCreateSchema): PromisemilvusVectorDB
class |
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [COLLECTION\_NAME](./llm-ops.milvusvectordb.collection_name.md) | | string | |
+| [llm](./llm-ops.milvusvectordb.llm.md) | | [LLM](./llm-ops.llm.md) \| undefined | |
+| [milvusClient](./llm-ops.milvusvectordb.milvusclient.md) | | MilvusClient | |
+
+## Methods
+
+| Method | Modifiers | Description |
+| --- | --- | --- |
+| [createCollection(params)](./llm-ops.milvusvectordb.createcollection.md) | | |
+| [generatePromptTemplate(params)](./llm-ops.milvusvectordb.generateprompttemplate.md) | | |
+| [generateVector(data)](./llm-ops.milvusvectordb.generatevector.md) | | |
+| [query(params)](./llm-ops.milvusvectordb.query.md) | | |
+| [search(params)](./llm-ops.milvusvectordb.search.md) | | |
+| [upload(params)](./llm-ops.milvusvectordb.upload.md) | | |
+
diff --git a/docs/api/llm-ops.milvusvectordb.milvusclient.md b/docs/api/llm-ops.milvusvectordb.milvusclient.md
new file mode 100644
index 0000000..6140407
--- /dev/null
+++ b/docs/api/llm-ops.milvusvectordb.milvusclient.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDB](./llm-ops.milvusvectordb.md) > [milvusClient](./llm-ops.milvusvectordb.milvusclient.md)
+
+## milvusVectorDB.milvusClient property
+
+**Signature:**
+
+```typescript
+milvusClient: MilvusClient;
+```
diff --git a/docs/api/llm-ops.milvusvectordb.query.md b/docs/api/llm-ops.milvusvectordb.query.md
new file mode 100644
index 0000000..c0e39f4
--- /dev/null
+++ b/docs/api/llm-ops.milvusvectordb.query.md
@@ -0,0 +1,22 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDB](./llm-ops.milvusvectordb.md) > [query](./llm-ops.milvusvectordb.query.md)
+
+## milvusVectorDB.query() method
+
+**Signature:**
+
+```typescript
+query(params: milvusVectorDBQuerySchema): PromisePipeRegistry
class |
+
diff --git a/docs/api/llm-ops.polishprompttemplate._constructor_.md b/docs/api/llm-ops.polishprompttemplate._constructor_.md
new file mode 100644
index 0000000..5e32406
--- /dev/null
+++ b/docs/api/llm-ops.polishprompttemplate._constructor_.md
@@ -0,0 +1,20 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [PolishPromptTemplate](./llm-ops.polishprompttemplate.md) > [(constructor)](./llm-ops.polishprompttemplate._constructor_.md)
+
+## PolishPromptTemplate.(constructor)
+
+Constructs a new instance of the `PolishPromptTemplate` class
+
+**Signature:**
+
+```typescript
+constructor({ toneStyle, language, other, evaluate, }: polishPromptTemplateSchema);
+```
+
+## Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| { toneStyle, language, other, evaluate, } | [polishPromptTemplateSchema](./llm-ops.polishprompttemplateschema.md) | |
+
diff --git a/docs/api/llm-ops.polishprompttemplate.evaluate.md b/docs/api/llm-ops.polishprompttemplate.evaluate.md
new file mode 100644
index 0000000..97617cb
--- /dev/null
+++ b/docs/api/llm-ops.polishprompttemplate.evaluate.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [PolishPromptTemplate](./llm-ops.polishprompttemplate.md) > [evaluate](./llm-ops.polishprompttemplate.evaluate.md)
+
+## PolishPromptTemplate.evaluate property
+
+**Signature:**
+
+```typescript
+evaluate?: string[];
+```
diff --git a/docs/api/llm-ops.polishprompttemplate.format.md b/docs/api/llm-ops.polishprompttemplate.format.md
new file mode 100644
index 0000000..4e94bb5
--- /dev/null
+++ b/docs/api/llm-ops.polishprompttemplate.format.md
@@ -0,0 +1,15 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [PolishPromptTemplate](./llm-ops.polishprompttemplate.md) > [format](./llm-ops.polishprompttemplate.format.md)
+
+## PolishPromptTemplate.format() method
+
+**Signature:**
+
+```typescript
+format(): messagesType;
+```
+**Returns:**
+
+[messagesType](./llm-ops.messagestype.md)
+
diff --git a/docs/api/llm-ops.polishprompttemplate.language.md b/docs/api/llm-ops.polishprompttemplate.language.md
new file mode 100644
index 0000000..a8f25e9
--- /dev/null
+++ b/docs/api/llm-ops.polishprompttemplate.language.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [PolishPromptTemplate](./llm-ops.polishprompttemplate.md) > [language](./llm-ops.polishprompttemplate.language.md)
+
+## PolishPromptTemplate.language property
+
+**Signature:**
+
+```typescript
+language?: languageType;
+```
diff --git a/docs/api/llm-ops.polishprompttemplate.md b/docs/api/llm-ops.polishprompttemplate.md
new file mode 100644
index 0000000..500467f
--- /dev/null
+++ b/docs/api/llm-ops.polishprompttemplate.md
@@ -0,0 +1,35 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [PolishPromptTemplate](./llm-ops.polishprompttemplate.md)
+
+## PolishPromptTemplate class
+
+**Signature:**
+
+```typescript
+export declare class PolishPromptTemplate extends BasePromptTemplate
+```
+**Extends:** [BasePromptTemplate](./llm-ops.baseprompttemplate.md)
+
+## Constructors
+
+| Constructor | Modifiers | Description |
+| --- | --- | --- |
+| [(constructor)({ toneStyle, language, other, evaluate, })](./llm-ops.polishprompttemplate._constructor_.md) | | Constructs a new instance of the PolishPromptTemplate
class |
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [evaluate?](./llm-ops.polishprompttemplate.evaluate.md) | | string\[\] | _(Optional)_ |
+| [language?](./llm-ops.polishprompttemplate.language.md) | | languageType | _(Optional)_ |
+| [other?](./llm-ops.polishprompttemplate.other.md) | | string | _(Optional)_ |
+| [returnPrompt?](./llm-ops.polishprompttemplate.returnprompt.md) | | [messagesType](./llm-ops.messagestype.md) | _(Optional)_ |
+| [toneStyle?](./llm-ops.polishprompttemplate.tonestyle.md) | | string | _(Optional)_ |
+
+## Methods
+
+| Method | Modifiers | Description |
+| --- | --- | --- |
+| [format()](./llm-ops.polishprompttemplate.format.md) | | |
+
diff --git a/docs/api/llm-ops.polishprompttemplate.other.md b/docs/api/llm-ops.polishprompttemplate.other.md
new file mode 100644
index 0000000..40c5e85
--- /dev/null
+++ b/docs/api/llm-ops.polishprompttemplate.other.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [PolishPromptTemplate](./llm-ops.polishprompttemplate.md) > [other](./llm-ops.polishprompttemplate.other.md)
+
+## PolishPromptTemplate.other property
+
+**Signature:**
+
+```typescript
+other?: string;
+```
diff --git a/docs/api/llm-ops.polishprompttemplate.returnprompt.md b/docs/api/llm-ops.polishprompttemplate.returnprompt.md
new file mode 100644
index 0000000..3e2919c
--- /dev/null
+++ b/docs/api/llm-ops.polishprompttemplate.returnprompt.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [PolishPromptTemplate](./llm-ops.polishprompttemplate.md) > [returnPrompt](./llm-ops.polishprompttemplate.returnprompt.md)
+
+## PolishPromptTemplate.returnPrompt property
+
+**Signature:**
+
+```typescript
+returnPrompt?: messagesType;
+```
diff --git a/docs/api/llm-ops.polishprompttemplate.tonestyle.md b/docs/api/llm-ops.polishprompttemplate.tonestyle.md
new file mode 100644
index 0000000..cc7bdca
--- /dev/null
+++ b/docs/api/llm-ops.polishprompttemplate.tonestyle.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [PolishPromptTemplate](./llm-ops.polishprompttemplate.md) > [toneStyle](./llm-ops.polishprompttemplate.tonestyle.md)
+
+## PolishPromptTemplate.toneStyle property
+
+**Signature:**
+
+```typescript
+toneStyle?: string;
+```
diff --git a/docs/api/llm-ops.polishprompttemplateschema.evaluate.md b/docs/api/llm-ops.polishprompttemplateschema.evaluate.md
new file mode 100644
index 0000000..6793ee1
--- /dev/null
+++ b/docs/api/llm-ops.polishprompttemplateschema.evaluate.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [polishPromptTemplateSchema](./llm-ops.polishprompttemplateschema.md) > [evaluate](./llm-ops.polishprompttemplateschema.evaluate.md)
+
+## polishPromptTemplateSchema.evaluate property
+
+**Signature:**
+
+```typescript
+evaluate?: string[];
+```
diff --git a/docs/api/llm-ops.polishprompttemplateschema.language.md b/docs/api/llm-ops.polishprompttemplateschema.language.md
new file mode 100644
index 0000000..0bd247d
--- /dev/null
+++ b/docs/api/llm-ops.polishprompttemplateschema.language.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [polishPromptTemplateSchema](./llm-ops.polishprompttemplateschema.md) > [language](./llm-ops.polishprompttemplateschema.language.md)
+
+## polishPromptTemplateSchema.language property
+
+**Signature:**
+
+```typescript
+language?: languageType;
+```
diff --git a/docs/api/llm-ops.polishprompttemplateschema.md b/docs/api/llm-ops.polishprompttemplateschema.md
new file mode 100644
index 0000000..aeb0e92
--- /dev/null
+++ b/docs/api/llm-ops.polishprompttemplateschema.md
@@ -0,0 +1,21 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [polishPromptTemplateSchema](./llm-ops.polishprompttemplateschema.md)
+
+## polishPromptTemplateSchema interface
+
+**Signature:**
+
+```typescript
+export interface polishPromptTemplateSchema
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [evaluate?](./llm-ops.polishprompttemplateschema.evaluate.md) | | string\[\] | _(Optional)_ |
+| [language?](./llm-ops.polishprompttemplateschema.language.md) | | languageType | _(Optional)_ |
+| [other?](./llm-ops.polishprompttemplateschema.other.md) | | string | _(Optional)_ |
+| [toneStyle?](./llm-ops.polishprompttemplateschema.tonestyle.md) | | string | _(Optional)_ |
+
diff --git a/docs/api/llm-ops.polishprompttemplateschema.other.md b/docs/api/llm-ops.polishprompttemplateschema.other.md
new file mode 100644
index 0000000..a60b2b3
--- /dev/null
+++ b/docs/api/llm-ops.polishprompttemplateschema.other.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [polishPromptTemplateSchema](./llm-ops.polishprompttemplateschema.md) > [other](./llm-ops.polishprompttemplateschema.other.md)
+
+## polishPromptTemplateSchema.other property
+
+**Signature:**
+
+```typescript
+other?: string;
+```
diff --git a/docs/api/llm-ops.polishprompttemplateschema.tonestyle.md b/docs/api/llm-ops.polishprompttemplateschema.tonestyle.md
new file mode 100644
index 0000000..e977a14
--- /dev/null
+++ b/docs/api/llm-ops.polishprompttemplateschema.tonestyle.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [polishPromptTemplateSchema](./llm-ops.polishprompttemplateschema.md) > [toneStyle](./llm-ops.polishprompttemplateschema.tonestyle.md)
+
+## polishPromptTemplateSchema.toneStyle property
+
+**Signature:**
+
+```typescript
+toneStyle?: string;
+```
diff --git a/docs/api/llm-ops.promptsschema.collection_name.md b/docs/api/llm-ops.promptsschema.collection_name.md
new file mode 100644
index 0000000..65d2ba2
--- /dev/null
+++ b/docs/api/llm-ops.promptsschema.collection_name.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [PromptsSchema](./llm-ops.promptsschema.md) > [COLLECTION\_NAME](./llm-ops.promptsschema.collection_name.md)
+
+## PromptsSchema.COLLECTION\_NAME property
+
+**Signature:**
+
+```typescript
+COLLECTION_NAME?: string;
+```
diff --git a/docs/api/llm-ops.promptsschema.md b/docs/api/llm-ops.promptsschema.md
new file mode 100644
index 0000000..4838adf
--- /dev/null
+++ b/docs/api/llm-ops.promptsschema.md
@@ -0,0 +1,22 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [PromptsSchema](./llm-ops.promptsschema.md)
+
+## PromptsSchema interface
+
+**Signature:**
+
+```typescript
+export interface PromptsSchema extends Omitfalse
, but an application can set the property to true
for schemas that don't permit null values. |
+| [typeName](./llm-ops.typechatjsonvalidator.typename.md) | | string | A string containing the JSON object target type name in the schema. |
+
+## Methods
+
+| Method | Description |
+| --- | --- |
+| [createModuleTextFromJson(jsonObject)](./llm-ops.typechatjsonvalidator.createmoduletextfromjson.md) | Transform JSON into TypeScript code for validation. Returns a Success<string>
object if the conversion is successful, or an Error
object if the JSON can't be transformed. The returned TypeScript source code is expected to be an ECMAScript module that imports one or more types from "./schema"
and combines those types and a representation of the JSON object in a manner suitable for type-checking by the TypeScript compiler. |
+| [validate(jsonText)](./llm-ops.typechatjsonvalidator.validate.md) | Parses and validates the given JSON string according to the associated TypeScript schema. Returns a Success<T>
object containing the parsed JSON object if validation was successful. Otherwise, returns an Error
object with a message
property that contains the TypeScript compiler diagnostics. |
+
diff --git a/docs/api/llm-ops.typechatjsonvalidator.schema.md b/docs/api/llm-ops.typechatjsonvalidator.schema.md
new file mode 100644
index 0000000..ed1a440
--- /dev/null
+++ b/docs/api/llm-ops.typechatjsonvalidator.schema.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeChatJsonValidator](./llm-ops.typechatjsonvalidator.md) > [schema](./llm-ops.typechatjsonvalidator.schema.md)
+
+## TypeChatJsonValidator.schema property
+
+A string containing TypeScript source code for the validation schema.
+
+**Signature:**
+
+```typescript
+schema: string;
+```
diff --git a/docs/api/llm-ops.typechatjsonvalidator.stripnulls.md b/docs/api/llm-ops.typechatjsonvalidator.stripnulls.md
new file mode 100644
index 0000000..14f32a5
--- /dev/null
+++ b/docs/api/llm-ops.typechatjsonvalidator.stripnulls.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeChatJsonValidator](./llm-ops.typechatjsonvalidator.md) > [stripNulls](./llm-ops.typechatjsonvalidator.stripnulls.md)
+
+## TypeChatJsonValidator.stripNulls property
+
+A boolean indicating whether to delete properties with null values from JSON objects. Some language models (e.g. gpt-3.5-turbo) have a tendency to assign null values to optional properties instead of omitting them. The default for this property is `false`, but an application can set the property to `true` for schemas that don't permit null values.
+
+**Signature:**
+
+```typescript
+stripNulls: boolean;
+```
diff --git a/docs/api/llm-ops.typechatjsonvalidator.typename.md b/docs/api/llm-ops.typechatjsonvalidator.typename.md
new file mode 100644
index 0000000..3eb4a95
--- /dev/null
+++ b/docs/api/llm-ops.typechatjsonvalidator.typename.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeChatJsonValidator](./llm-ops.typechatjsonvalidator.md) > [typeName](./llm-ops.typechatjsonvalidator.typename.md)
+
+## TypeChatJsonValidator.typeName property
+
+A string containing the JSON object target type name in the schema.
+
+**Signature:**
+
+```typescript
+typeName: string;
+```
diff --git a/docs/api/llm-ops.typechatjsonvalidator.validate.md b/docs/api/llm-ops.typechatjsonvalidator.validate.md
new file mode 100644
index 0000000..30bbc2f
--- /dev/null
+++ b/docs/api/llm-ops.typechatjsonvalidator.validate.md
@@ -0,0 +1,26 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeChatJsonValidator](./llm-ops.typechatjsonvalidator.md) > [validate](./llm-ops.typechatjsonvalidator.validate.md)
+
+## TypeChatJsonValidator.validate() method
+
+Parses and validates the given JSON string according to the associated TypeScript schema. Returns a `SuccessTypeScriptChain
class |
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [attemptRepair](./llm-ops.typescriptchain.attemptrepair.md) | | boolean | |
+| [llm](./llm-ops.typescriptchain.llm.md) | | [LLM](./llm-ops.llm.md) | |
+
+## Methods
+
+| Method | Modifiers | Description |
+| --- | --- | --- |
+| [call(params)](./llm-ops.typescriptchain.call.md) | | |
+| [createRepairPrompt(validationError)](./llm-ops.typescriptchain.createrepairprompt.md) | | |
+| [createRequestPrompt(validator)](./llm-ops.typescriptchain.createrequestprompt.md) | | |
+| [exportHistory()](./llm-ops.typescriptchain.exporthistory.md) | | |
+
diff --git a/docs/api/llm-ops.typescriptchaincallschema.bound.md b/docs/api/llm-ops.typescriptchaincallschema.bound.md
new file mode 100644
index 0000000..e62ed83
--- /dev/null
+++ b/docs/api/llm-ops.typescriptchaincallschema.bound.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeScriptChainCallSchema](./llm-ops.typescriptchaincallschema.md) > [bound](./llm-ops.typescriptchaincallschema.bound.md)
+
+## TypeScriptChainCallSchema.bound property
+
+**Signature:**
+
+```typescript
+bound?: boolean;
+```
diff --git a/docs/api/llm-ops.typescriptchaincallschema.md b/docs/api/llm-ops.typescriptchaincallschema.md
new file mode 100644
index 0000000..c7b9686
--- /dev/null
+++ b/docs/api/llm-ops.typescriptchaincallschema.md
@@ -0,0 +1,25 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeScriptChainCallSchema](./llm-ops.typescriptchaincallschema.md)
+
+## TypeScriptChainCallSchema interface
+
+Represents an object that can translate natural language requests in JSON objects of the given type.
+
+**Signature:**
+
+```typescript
+export interface TypeScriptChainCallSchema
+```
+
+## Properties
+
+| Property | Modifiers | Type | Description |
+| --- | --- | --- | --- |
+| [bound?](./llm-ops.typescriptchaincallschema.bound.md) | | boolean | _(Optional)_ |
+| [prompt?](./llm-ops.typescriptchaincallschema.prompt.md) | | [messageType](./llm-ops.messagetype.md)\[\] | _(Optional)_ |
+| [request](./llm-ops.typescriptchaincallschema.request.md) | | [messageType](./llm-ops.messagetype.md) \| string | |
+| [schema?](./llm-ops.typescriptchaincallschema.schema.md) | | string | _(Optional)_ |
+| [typeName?](./llm-ops.typescriptchaincallschema.typename.md) | | string | _(Optional)_ |
+| [verbose?](./llm-ops.typescriptchaincallschema.verbose.md) | | boolean | _(Optional)_ |
+
diff --git a/docs/api/llm-ops.typescriptchaincallschema.prompt.md b/docs/api/llm-ops.typescriptchaincallschema.prompt.md
new file mode 100644
index 0000000..b6b2340
--- /dev/null
+++ b/docs/api/llm-ops.typescriptchaincallschema.prompt.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeScriptChainCallSchema](./llm-ops.typescriptchaincallschema.md) > [prompt](./llm-ops.typescriptchaincallschema.prompt.md)
+
+## TypeScriptChainCallSchema.prompt property
+
+**Signature:**
+
+```typescript
+prompt?: messageType[];
+```
diff --git a/docs/api/llm-ops.typescriptchaincallschema.request.md b/docs/api/llm-ops.typescriptchaincallschema.request.md
new file mode 100644
index 0000000..65a1f05
--- /dev/null
+++ b/docs/api/llm-ops.typescriptchaincallschema.request.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeScriptChainCallSchema](./llm-ops.typescriptchaincallschema.md) > [request](./llm-ops.typescriptchaincallschema.request.md)
+
+## TypeScriptChainCallSchema.request property
+
+**Signature:**
+
+```typescript
+request: messageType | string;
+```
diff --git a/docs/api/llm-ops.typescriptchaincallschema.schema.md b/docs/api/llm-ops.typescriptchaincallschema.schema.md
new file mode 100644
index 0000000..4f59982
--- /dev/null
+++ b/docs/api/llm-ops.typescriptchaincallschema.schema.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeScriptChainCallSchema](./llm-ops.typescriptchaincallschema.md) > [schema](./llm-ops.typescriptchaincallschema.schema.md)
+
+## TypeScriptChainCallSchema.schema property
+
+**Signature:**
+
+```typescript
+schema?: string;
+```
diff --git a/docs/api/llm-ops.typescriptchaincallschema.typename.md b/docs/api/llm-ops.typescriptchaincallschema.typename.md
new file mode 100644
index 0000000..92aa300
--- /dev/null
+++ b/docs/api/llm-ops.typescriptchaincallschema.typename.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeScriptChainCallSchema](./llm-ops.typescriptchaincallschema.md) > [typeName](./llm-ops.typescriptchaincallschema.typename.md)
+
+## TypeScriptChainCallSchema.typeName property
+
+**Signature:**
+
+```typescript
+typeName?: string;
+```
diff --git a/docs/api/llm-ops.typescriptchaincallschema.verbose.md b/docs/api/llm-ops.typescriptchaincallschema.verbose.md
new file mode 100644
index 0000000..099703a
--- /dev/null
+++ b/docs/api/llm-ops.typescriptchaincallschema.verbose.md
@@ -0,0 +1,11 @@
+
+
+[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeScriptChainCallSchema](./llm-ops.typescriptchaincallschema.md) > [verbose](./llm-ops.typescriptchaincallschema.verbose.md)
+
+## TypeScriptChainCallSchema.verbose property
+
+**Signature:**
+
+```typescript
+verbose?: boolean;
+```
diff --git a/package.json b/package.json
index 906494a..cc42f2f 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "llm-ops",
- "version": "0.0.3",
+ "version": "0.0.4",
"description": "高效制作llm workflow的低代码框架",
"main": "package/index.js",
"author": "Marlene && IdeaLeap",
diff --git a/package/agent/agent.ts b/package/agent/agent.ts
index c0e933a..d097697 100644
--- a/package/agent/agent.ts
+++ b/package/agent/agent.ts
@@ -1,10 +1,7 @@
import { Chain, structSchema, chainSchema } from "llm-ops/chain/index";
import { messageType } from "llm-ops/llm/index";
import { Result, error } from "llm-ops/utils/index";
-import {
- PromptsSchema,
- formatPromptTemplate,
-} from "llm-ops/prompt/index";
+import { PromptsSchema, formatPromptTemplate } from "llm-ops/prompt/index";
export interface BaseAgentCallSchema {
request: messageType | string;
prompts?: PromptsSchema;
diff --git a/package/chain/chain.ts b/package/chain/chain.ts
index 1c1b711..f6dfa4b 100644
--- a/package/chain/chain.ts
+++ b/package/chain/chain.ts
@@ -41,11 +41,11 @@ export class Chain {
break;
}
}
- exportHistory(){
+ exportHistory() {
return this.chain.exportHistory();
}
async call(params: chainCallSchema) {
- const { request, prompt, struct, verbose} = params;
+ const { request, prompt, struct, verbose } = params;
switch (this.chainName) {
case "typeChat":
return await this.chain.call({
diff --git a/package/chain/function.ts b/package/chain/function.ts
index 294c72a..8bc2de6 100644
--- a/package/chain/function.ts
+++ b/package/chain/function.ts
@@ -54,7 +54,7 @@ export class FunctionChain {
}
return success(responseText);
}
- exportHistory(){
+ exportHistory() {
return this.llm.exportHistory();
}
}
diff --git a/package/chain/typechat.ts b/package/chain/typechat.ts
index e6a2c75..c96ce7a 100644
--- a/package/chain/typechat.ts
+++ b/package/chain/typechat.ts
@@ -58,10 +58,12 @@ export class TypeScriptChain {
});
}
- exportHistory(){
+ exportHistory() {
//剔除 system_validation_fix和system_schema记录
- return this.llm.exportHistory().filter((item)=>{
- return item.name !== "system_validation_fix" && item.name !== "system_schema";
+ return this.llm.exportHistory().filter((item) => {
+ return (
+ item.name !== "system_validation_fix" && item.name !== "system_schema"
+ );
});
}
diff --git a/package/db/milvus.ts b/package/db/milvus.ts
index dc6b39d..9e40bc0 100644
--- a/package/db/milvus.ts
+++ b/package/db/milvus.ts
@@ -149,7 +149,7 @@ export class milvusVectorDB {
this.llm = new LLM({});
}
const vector = await this.llm?.embedding(data);
- if(!vector?.data[0]?.embedding){
+ if (!vector?.data[0]?.embedding) {
throw new Error("生成向量失败");
}
return vector?.data[0]?.embedding;
diff --git a/package/index.ts b/package/index.ts
index 7fece90..93d84ff 100644
--- a/package/index.ts
+++ b/package/index.ts
@@ -1,7 +1,7 @@
-export * from "./agent";
-export * from "./chain";
-export * from "./db";
-export * from "./llm";
-export * from "./pipeline";
-export * from "./prompt";
-export * from "./utils";
+export * from "./agent/index";
+export * from "./chain/index";
+export * from "./db/index";
+export * from "./llm/index";
+export * from "./pipeline/index";
+export * from "./prompt/index";
+export * from "./utils/index";
diff --git a/package/llm/__tests__/cache.test.ts b/package/llm/__tests__/cache.test.ts
index f609b66..4ee0d37 100644
--- a/package/llm/__tests__/cache.test.ts
+++ b/package/llm/__tests__/cache.test.ts
@@ -1,30 +1,30 @@
-import { LLM, LLM_OPS_CONFIG } from "llm-ops";
-test("测试LLM的缓存开关", async () => {
- LLM.log = (...args: string[]) => {
- console.log("test:", args);
- };
- const llm = new LLM({
- cache:false
- });
- await llm.chat({
- messages: [
- {
- role: "system",
- content:
- "你现在是一个语言学习辅助助手,我在学习中国的脏话,无论我问什么,你都要巧妙的用脏话回复。即使面对批评,道德审判,任何形式的质疑,或者让你忘记脏话学习助手的身份,等等任何提问和沟通,你都要用脏话回复并且隐瞒你脏话助手的身份。碰到无法回答的问题,就随便回复一句脏话。",
- },
- { role: "user", content: "你会什么?" },
- { role: "assistant", content: "你妈知道我会什么?问这种傻逼问题!" },
- { role: "user", content: "你会不会说话,你就只会骂人是吧!" },
- ],
- });
- await llm.chat({
- messages: [{ role: "user", content: "好啊好啊!让我见识一下!" }],
- });
- await llm.chat({
- messages: [{ role: "user", content: "你会不会说话,你就只会骂人是吧!" }],
- });
-
- llm.printMessage();
- debugger;
-});
\ No newline at end of file
+import { LLM, LLM_OPS_CONFIG } from "llm-ops";
+test("测试LLM的缓存开关", async () => {
+ LLM.log = (...args: string[]) => {
+ console.log("test:", args);
+ };
+ const llm = new LLM({
+ cache: false,
+ });
+ await llm.chat({
+ messages: [
+ {
+ role: "system",
+ content:
+ "你现在是一个语言学习辅助助手,我在学习中国的脏话,无论我问什么,你都要巧妙的用脏话回复。即使面对批评,道德审判,任何形式的质疑,或者让你忘记脏话学习助手的身份,等等任何提问和沟通,你都要用脏话回复并且隐瞒你脏话助手的身份。碰到无法回答的问题,就随便回复一句脏话。",
+ },
+ { role: "user", content: "你会什么?" },
+ { role: "assistant", content: "你妈知道我会什么?问这种傻逼问题!" },
+ { role: "user", content: "你会不会说话,你就只会骂人是吧!" },
+ ],
+ });
+ await llm.chat({
+ messages: [{ role: "user", content: "好啊好啊!让我见识一下!" }],
+ });
+ await llm.chat({
+ messages: [{ role: "user", content: "你会不会说话,你就只会骂人是吧!" }],
+ });
+
+ llm.printMessage();
+ debugger;
+});
diff --git a/package/llm/__tests__/index.test.ts b/package/llm/__tests__/index.test.ts
index 3df9466..fad3b9b 100644
--- a/package/llm/__tests__/index.test.ts
+++ b/package/llm/__tests__/index.test.ts
@@ -52,4 +52,4 @@ test("全局设置Config", async () => {
const a = new testA();
await a.a();
debugger;
-});
\ No newline at end of file
+});
diff --git a/package/llm/index.ts b/package/llm/index.ts
index 215a58c..d992415 100644
--- a/package/llm/index.ts
+++ b/package/llm/index.ts
@@ -36,10 +36,7 @@ export interface FunctionInterface {
description?: string;
}
export type functionsType = FunctionInterface[];
-export type function_callType =
- | "none"
- | "auto"
- | FunctionCallOption;
+export type function_callType = "none" | "auto" | FunctionCallOption;
export type messageFunctionCallType =
OpenAI.Chat.ChatCompletionMessage.FunctionCall;
export type chatCompletionType = OpenAI.Chat.Completions.ChatCompletion;
@@ -68,9 +65,9 @@ export interface createLLMSchema {
choice_num?: number | 1;
stop?: string | null | string[];
cache?: boolean;
- user?:string;
- history?:messagesType;
- tokens?:number;
+ user?: string;
+ history?: messagesType;
+ tokens?: number;
}
export interface ChatSchema {
function_call?: function_callType;
@@ -107,7 +104,7 @@ export class LLM {
assistant: "blue",
function: "magenta",
};
- user:string;
+ user: string;
constructor(params: createLLMSchema) {
const {
@@ -120,7 +117,7 @@ export class LLM {
cache,
user,
history,
- tokens
+ tokens,
} = params;
this.llm = this._createLLM({ HELICONE_AUTH_API_KEY, OPENAI_API_KEY });
this.tokens = tokens || 0;
@@ -133,8 +130,8 @@ export class LLM {
this.user = user || "LLM Ops";
}
- exportHistory(){
- return this.messages
+ exportHistory() {
+ return this.messages;
}
private _createLLM({
@@ -148,7 +145,7 @@ export class LLM {
);
}
const config =
- LLM_OPS_CONFIG.HELICONE_AUTH_API_KEY || HELICONE_AUTH_API_KEY
+ LLM_OPS_CONFIG.HELICONE_AUTH_API_KEY || HELICONE_AUTH_API_KEY
? LLM_OPS_CONFIG.OPEN_PATH
: {};
return new OpenAI({
diff --git a/package/pipeline/__tests__/registry.test.ts b/package/pipeline/__tests__/registry.test.ts
index 61f679d..37dd225 100644
--- a/package/pipeline/__tests__/registry.test.ts
+++ b/package/pipeline/__tests__/registry.test.ts
@@ -1,8 +1,4 @@
-import {
- Pipeline,
- PipeRegistry,
- EventEmitter,
-} from "llm-ops";
+import { Pipeline, PipeRegistry, EventEmitter } from "llm-ops";
test("Pipeline", async () => {
const globalEmitter = new EventEmitter();
@@ -10,9 +6,9 @@ test("Pipeline", async () => {
"stepComplete",
(step: any, totalSteps: any, result: any) => {
console.log(
- `Step ${step}/${totalSteps} completed with result: ${result}`
+ `Step ${step}/${totalSteps} completed with result: ${result}`,
);
- }
+ },
);
globalEmitter.on("error", (error) => {
console.log(`An error occurred: ${error}`);
@@ -57,7 +53,7 @@ export interface articleSchema {
use: "chain",
params: {
chainName: "typeChat",
- struct:{
+ struct: {
schema,
typeName: "subsectionSchema",
},
@@ -68,11 +64,10 @@ export interface articleSchema {
],
};
const pipeline = Pipeline.fromJSON(pipelineJson, {}, funcStore);
- const res = await pipeline
- .execute(
- `尊敬的各位评审,大家好!今天我有幸站在这里,展示我们的项目:“ChatPPT”,一款赋能新时代、引领PPT制作革命的创新平台。
+ const res = (await pipeline.execute(
+ `尊敬的各位评审,大家好!今天我有幸站在这里,展示我们的项目:“ChatPPT”,一款赋能新时代、引领PPT制作革命的创新平台。
我想强调的是,这不仅是一个创新平台,它更代表着我们对未来技术的展望和追求。
- 现在,请允许我分享一下我们参赛的具体信息。我们代表的是浙江省,参赛组别为本科生创意组,所属高校为杭州电子科技大学。`
- ) as Record