@orkestrel/agent 0.0.20 → 0.0.22
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -13
- package/dist/src/core/index.cjs +1357 -352
- package/dist/src/core/index.cjs.map +1 -1
- package/dist/src/core/index.d.cts +1715 -739
- package/dist/src/core/index.d.ts +1715 -739
- package/dist/src/core/index.js +1332 -355
- package/dist/src/core/index.js.map +1 -1
- package/package.json +24 -23
package/README.md
CHANGED
|
@@ -1,14 +1,17 @@
|
|
|
1
1
|
# @orkestrel/agent
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
3
|
+
> The conversation runtime for the `@orkestrel` line: the `ProviderInterface` inference
|
|
4
|
+
> boundary with the host-independent HTTP engine and browser relay that implement it, the
|
|
5
|
+
> conversation layer that feeds it — messages, compaction, instructions, scopes, and prompt
|
|
6
|
+
> assembly — and the bounded context → provider → tools → repeat loop that carries a turn to
|
|
7
|
+
> its end.
|
|
8
|
+
|
|
9
|
+
Build an agent with the `createAgent` function over a `ProviderInterface` implementation,
|
|
10
|
+
seed the conversation through `agent.context.messages`, then run the turn as a one-shot
|
|
11
|
+
`generate` or a live `stream`. Extend the `AgentProvider` class to reach a new wire, or
|
|
12
|
+
compose the `createRelayProvider` and `createRelay` functions to reach a model through your
|
|
13
|
+
own server. Callable tools come from `@orkestrel/tool` and documents from
|
|
14
|
+
`@orkestrel/workspace`. Part of the `@orkestrel` line.
|
|
12
15
|
|
|
13
16
|
## Install
|
|
14
17
|
|
|
@@ -50,10 +53,10 @@ const result = await stream.result // { content, usage?, partial }
|
|
|
50
53
|
## Guide
|
|
51
54
|
|
|
52
55
|
[`guides/agent.md`](guides/agent.md) documents the agent-owned surface:
|
|
53
|
-
the provider boundary,
|
|
54
|
-
jobs, the loop, and `AgentContext`. The
|
|
55
|
-
alongside it — [`guides/tool.md`](guides/tool.md)
|
|
56
|
-
[`guides/workspace.md`](guides/workspace.md) for files.
|
|
56
|
+
the provider boundary, the `AgentProvider` HTTP engine, the relay, conversations,
|
|
57
|
+
instructions, scopes, authority, durable jobs, the loop, and `AgentContext`. The
|
|
58
|
+
packages it consumes are mirrored alongside it — [`guides/tool.md`](guides/tool.md)
|
|
59
|
+
for callable tools and [`guides/workspace.md`](guides/workspace.md) for files.
|
|
57
60
|
|
|
58
61
|
## Package
|
|
59
62
|
|