Skip to content

Commit c991e4d

Browse files
authored
Merge pull request #70 from chatbotkit/next
- docs(changeset): New options and fixed iterator loops.
2 parents 0fb2275 + 9332259 commit c991e4d

37 files changed

+1264
-1032
lines changed

.changeset/gold-eels-cheer.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@chatbotkit/agent': patch
3+
---
4+
5+
New options and fixed iterator loops.

packages/agent/docs/agent/README.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,8 @@
88

99
## Type Aliases
1010

11-
- [ChatBotKit](type-aliases/ChatBotKit.md)
12-
- [ExitEvent](type-aliases/ExitEvent.md)
13-
- [ExitResult](type-aliases/ExitResult.md)
14-
- [IterationEvent](type-aliases/IterationEvent.md)
15-
- [ToolCallEndEvent](type-aliases/ToolCallEndEvent.md)
16-
- [ToolCallErrorEvent](type-aliases/ToolCallErrorEvent.md)
17-
- [ToolCallStartEvent](type-aliases/ToolCallStartEvent.md)
18-
- [ToolDefinition](type-aliases/ToolDefinition.md)
19-
- [Tools](type-aliases/Tools.md)
20-
- [ZodObject](type-aliases/ZodObject.md)
11+
- [AgentDefinition](type-aliases/AgentDefinition.md)
2112

2213
## Functions
2314

24-
- [complete](functions/complete.md)
25-
- [execute](functions/execute.md)
15+
- [loadAgent](functions/loadAgent.md)

packages/agent/docs/agent/functions/complete.md

Lines changed: 0 additions & 24 deletions
This file was deleted.

packages/agent/docs/agent/functions/execute.md

Lines changed: 0 additions & 46 deletions
This file was deleted.
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
[**@chatbotkit/agent**](../../README.md)
2+
3+
***
4+
5+
[@chatbotkit/agent](../../modules.md) / [agent](../README.md) / loadAgent
6+
7+
# Function: loadAgent()
8+
9+
> **loadAgent**(`filePath`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`AgentDefinition`](../type-aliases/AgentDefinition.md)\>
10+
11+
Defined in: [agent/src/agent.js:57](https://github.com/chatbotkit/node-sdk/blob/main/sdks/node/packages/agent/src/agent.js#L57)
12+
13+
Loads an agent definition from a markdown file. The file may contain an
14+
optional YAML front matter block with `backstory`, `model`, `name`, and
15+
`description` fields. The markdown body is appended to `backstory` (if any)
16+
to form the final backstory string.
17+
18+
## Parameters
19+
20+
### filePath
21+
22+
`string`
23+
24+
Path to the agent markdown file (absolute or relative to cwd)
25+
26+
## Returns
27+
28+
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`AgentDefinition`](../type-aliases/AgentDefinition.md)\>
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
[**@chatbotkit/agent**](../../README.md)
2+
3+
***
4+
5+
[@chatbotkit/agent](../../modules.md) / [agent](../README.md) / AgentDefinition
6+
7+
# Type Alias: AgentDefinition
8+
9+
> **AgentDefinition**\<\> = `object`
10+
11+
Defined in: [agent/src/agent.js:14](https://github.com/chatbotkit/node-sdk/blob/main/sdks/node/packages/agent/src/agent.js#L14)
12+
13+
## Type Parameters
14+
15+
## Type Declaration
16+
17+
### backstory?
18+
19+
> `optional` **backstory**: `string`
20+
21+
### botId?
22+
23+
> `optional` **botId**: `string`
24+
25+
### datasetId?
26+
27+
> `optional` **datasetId**: `string`
28+
29+
### description?
30+
31+
> `optional` **description**: `string`
32+
33+
### model?
34+
35+
> `optional` **model**: `string`
36+
37+
### name?
38+
39+
> `optional` **name**: `string`
40+
41+
### skillsetId?
42+
43+
> `optional` **skillsetId**: `string`

packages/agent/docs/agent/type-aliases/ChatBotKit.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

packages/agent/docs/agent/type-aliases/ExitEvent.md

Lines changed: 0 additions & 23 deletions
This file was deleted.

packages/agent/docs/agent/type-aliases/ExitResult.md

Lines changed: 0 additions & 23 deletions
This file was deleted.

packages/agent/docs/agent/type-aliases/IterationEvent.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

0 commit comments

Comments
 (0)