Skip to content

Commit

Permalink
release: v0.0.4
Browse files Browse the repository at this point in the history
  • Loading branch information
MarleneJiang committed Sep 23, 2023
1 parent fc82d23 commit 8cfb12b
Show file tree
Hide file tree
Showing 273 changed files with 3,991 additions and 98 deletions.
4 changes: 1 addition & 3 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,7 @@ export default defineConfig({
"/guide": [
{
text: "LLM Ops",
items: [
{ text: "model", link: "/guide/model" },
],
items: [{ text: "model", link: "/guide/model" }],
},
],
},
Expand Down
12 changes: 12 additions & 0 deletions docs/api/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md)

## API Reference

## Packages

| Package | Description |
| --- | --- |
| [llm-ops](./llm-ops.md) | |

20 changes: 20 additions & 0 deletions docs/api/llm-ops.agentprompttemplate._constructor_.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [llm-ops](./llm-ops.md) &gt; [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) &gt; [(constructor)](./llm-ops.agentprompttemplate._constructor_.md)

## AgentPromptTemplate.(constructor)

Constructs a new instance of the `AgentPromptTemplate` class

**Signature:**

```typescript
constructor({ role, desc, toneStyle, communicationStyle, level, field, keyRole, reasoning, rules, reflection, memory, humanSituation, language, other, evaluate, }: AgentPromptTemplateSchema);
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| { role, desc, toneStyle, communicationStyle, level, field, keyRole, reasoning, rules, reflection, memory, humanSituation, language, other, evaluate, } | [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) | |

11 changes: 11 additions & 0 deletions docs/api/llm-ops.agentprompttemplate.communicationstyle.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [llm-ops](./llm-ops.md) &gt; [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) &gt; [communicationStyle](./llm-ops.agentprompttemplate.communicationstyle.md)

## AgentPromptTemplate.communicationStyle property

**Signature:**

```typescript
communicationStyle?: communicationStyleType;
```
11 changes: 11 additions & 0 deletions docs/api/llm-ops.agentprompttemplate.desc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [llm-ops](./llm-ops.md) &gt; [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) &gt; [desc](./llm-ops.agentprompttemplate.desc.md)

## AgentPromptTemplate.desc property

**Signature:**

```typescript
desc?: string;
```
11 changes: 11 additions & 0 deletions docs/api/llm-ops.agentprompttemplate.evaluate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [llm-ops](./llm-ops.md) &gt; [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) &gt; [evaluate](./llm-ops.agentprompttemplate.evaluate.md)

## AgentPromptTemplate.evaluate property

**Signature:**

```typescript
evaluate?: TeacherEvaluateSchema;
```
11 changes: 11 additions & 0 deletions docs/api/llm-ops.agentprompttemplate.field.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [llm-ops](./llm-ops.md) &gt; [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) &gt; [field](./llm-ops.agentprompttemplate.field.md)

## AgentPromptTemplate.field property

**Signature:**

```typescript
field?: string;
```
15 changes: 15 additions & 0 deletions docs/api/llm-ops.agentprompttemplate.format.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [llm-ops](./llm-ops.md) &gt; [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) &gt; [format](./llm-ops.agentprompttemplate.format.md)

## AgentPromptTemplate.format() method

**Signature:**

```typescript
format(): messagesType;
```
**Returns:**

[messagesType](./llm-ops.messagestype.md)

22 changes: 22 additions & 0 deletions docs/api/llm-ops.agentprompttemplate.formatevaluateitem.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [llm-ops](./llm-ops.md) &gt; [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) &gt; [formatEvaluateItem](./llm-ops.agentprompttemplate.formatevaluateitem.md)

## AgentPromptTemplate.formatEvaluateItem() method

**Signature:**

```typescript
formatEvaluateItem(items: EvaluateItemSchema[]): string;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| items | [EvaluateItemSchema](./llm-ops.evaluateitemschema.md)<!-- -->\[\] | |

**Returns:**

string

11 changes: 11 additions & 0 deletions docs/api/llm-ops.agentprompttemplate.humansituation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [llm-ops](./llm-ops.md) &gt; [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) &gt; [humanSituation](./llm-ops.agentprompttemplate.humansituation.md)

## AgentPromptTemplate.humanSituation property

**Signature:**

```typescript
humanSituation?: string;
```
11 changes: 11 additions & 0 deletions docs/api/llm-ops.agentprompttemplate.keyrole.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [llm-ops](./llm-ops.md) &gt; [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) &gt; [keyRole](./llm-ops.agentprompttemplate.keyrole.md)

## AgentPromptTemplate.keyRole property

**Signature:**

```typescript
keyRole?: string;
```
11 changes: 11 additions & 0 deletions docs/api/llm-ops.agentprompttemplate.language.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [llm-ops](./llm-ops.md) &gt; [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) &gt; [language](./llm-ops.agentprompttemplate.language.md)

## AgentPromptTemplate.language property

**Signature:**

```typescript
language?: languageType;
```
11 changes: 11 additions & 0 deletions docs/api/llm-ops.agentprompttemplate.level.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [llm-ops](./llm-ops.md) &gt; [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) &gt; [level](./llm-ops.agentprompttemplate.level.md)

## AgentPromptTemplate.level property

**Signature:**

```typescript
level?: levelType;
```
47 changes: 47 additions & 0 deletions docs/api/llm-ops.agentprompttemplate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [llm-ops](./llm-ops.md) &gt; [AgentPromptTemplate](./llm-ops.agentprompttemplate.md)

## AgentPromptTemplate class

**Signature:**

```typescript
export declare class AgentPromptTemplate extends BasePromptTemplate
```
**Extends:** [BasePromptTemplate](./llm-ops.baseprompttemplate.md)
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)({ role, desc, toneStyle, communicationStyle, level, field, keyRole, reasoning, rules, reflection, memory, humanSituation, language, other, evaluate, })](./llm-ops.agentprompttemplate._constructor_.md) | | Constructs a new instance of the <code>AgentPromptTemplate</code> 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) | | |
11 changes: 11 additions & 0 deletions docs/api/llm-ops.agentprompttemplate.memory.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [llm-ops](./llm-ops.md) &gt; [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) &gt; [memory](./llm-ops.agentprompttemplate.memory.md)

## AgentPromptTemplate.memory property

**Signature:**

```typescript
memory?: MemoryPromptTemplateSchema;
```
11 changes: 11 additions & 0 deletions docs/api/llm-ops.agentprompttemplate.other.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [llm-ops](./llm-ops.md) &gt; [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) &gt; [other](./llm-ops.agentprompttemplate.other.md)

## AgentPromptTemplate.other property

**Signature:**

```typescript
other?: string;
```
11 changes: 11 additions & 0 deletions docs/api/llm-ops.agentprompttemplate.reasoning.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [llm-ops](./llm-ops.md) &gt; [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) &gt; [reasoning](./llm-ops.agentprompttemplate.reasoning.md)

## AgentPromptTemplate.reasoning property

**Signature:**

```typescript
reasoning?: reasoningType;
```
11 changes: 11 additions & 0 deletions docs/api/llm-ops.agentprompttemplate.reflection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [llm-ops](./llm-ops.md) &gt; [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) &gt; [reflection](./llm-ops.agentprompttemplate.reflection.md)

## AgentPromptTemplate.reflection property

**Signature:**

```typescript
reflection?: ReflectionPromptTemplateSchema;
```
11 changes: 11 additions & 0 deletions docs/api/llm-ops.agentprompttemplate.returnprompt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [llm-ops](./llm-ops.md) &gt; [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) &gt; [returnPrompt](./llm-ops.agentprompttemplate.returnprompt.md)

## AgentPromptTemplate.returnPrompt property

**Signature:**

```typescript
returnPrompt?: messagesType;
```
11 changes: 11 additions & 0 deletions docs/api/llm-ops.agentprompttemplate.role.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [llm-ops](./llm-ops.md) &gt; [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) &gt; [role](./llm-ops.agentprompttemplate.role.md)

## AgentPromptTemplate.role property

**Signature:**

```typescript
role?: string;
```
11 changes: 11 additions & 0 deletions docs/api/llm-ops.agentprompttemplate.rules.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [llm-ops](./llm-ops.md) &gt; [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) &gt; [rules](./llm-ops.agentprompttemplate.rules.md)

## AgentPromptTemplate.rules property

**Signature:**

```typescript
rules?: string | string[];
```
11 changes: 11 additions & 0 deletions docs/api/llm-ops.agentprompttemplate.tonestyle.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [llm-ops](./llm-ops.md) &gt; [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) &gt; [toneStyle](./llm-ops.agentprompttemplate.tonestyle.md)

## AgentPromptTemplate.toneStyle property

**Signature:**

```typescript
toneStyle?: toneStyleType;
```
11 changes: 11 additions & 0 deletions docs/api/llm-ops.agentprompttemplateschema.communicationstyle.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [llm-ops](./llm-ops.md) &gt; [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) &gt; [communicationStyle](./llm-ops.agentprompttemplateschema.communicationstyle.md)

## AgentPromptTemplateSchema.communicationStyle property

**Signature:**

```typescript
communicationStyle?: communicationStyleType;
```
11 changes: 11 additions & 0 deletions docs/api/llm-ops.agentprompttemplateschema.desc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [llm-ops](./llm-ops.md) &gt; [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) &gt; [desc](./llm-ops.agentprompttemplateschema.desc.md)

## AgentPromptTemplateSchema.desc property

**Signature:**

```typescript
desc?: string;
```
11 changes: 11 additions & 0 deletions docs/api/llm-ops.agentprompttemplateschema.evaluate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [llm-ops](./llm-ops.md) &gt; [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) &gt; [evaluate](./llm-ops.agentprompttemplateschema.evaluate.md)

## AgentPromptTemplateSchema.evaluate property

**Signature:**

```typescript
evaluate?: TeacherEvaluateSchema;
```
11 changes: 11 additions & 0 deletions docs/api/llm-ops.agentprompttemplateschema.field.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [llm-ops](./llm-ops.md) &gt; [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) &gt; [field](./llm-ops.agentprompttemplateschema.field.md)

## AgentPromptTemplateSchema.field property

**Signature:**

```typescript
field?: string;
```
11 changes: 11 additions & 0 deletions docs/api/llm-ops.agentprompttemplateschema.humansituation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [llm-ops](./llm-ops.md) &gt; [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) &gt; [humanSituation](./llm-ops.agentprompttemplateschema.humansituation.md)

## AgentPromptTemplateSchema.humanSituation property

**Signature:**

```typescript
humanSituation?: string;
```
11 changes: 11 additions & 0 deletions docs/api/llm-ops.agentprompttemplateschema.keyrole.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [llm-ops](./llm-ops.md) &gt; [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) &gt; [keyRole](./llm-ops.agentprompttemplateschema.keyrole.md)

## AgentPromptTemplateSchema.keyRole property

**Signature:**

```typescript
keyRole?: string;
```
Loading

0 comments on commit 8cfb12b

Please sign in to comment.