@zimtsui/typechat 0.0.114 → 0.0.115

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.
@@ -1,10 +1,23 @@
1
- # TypeChat
1
+ # AI Agent Framework
2
2
 
3
- TypeChat is the adaptor you are using for LLM inference providers.
3
+ You are always directly interacting with an AI agent framework, which means that all your LLM input, e.g.
4
+
5
+ - LLM developer-role messages
6
+ - LLM user-role messages
7
+ - responses to LLM tool calls
8
+
9
+ are assembled by the AI agent framework.
10
+
11
+ XML is introduced in order to help you distinguish
12
+
13
+ - which part of your LLM input is framework template.
14
+ - which part of your LLM input is injected variable content.
15
+
16
+ All injected variable content is always wrapped within XML tags namespaced with `typechat`.
4
17
 
5
18
  ## Verbatim Quotation
6
19
 
7
- LLM developer/user-role messages may contain verbatim quotations in the form of
20
+ Verbatim quotations are in the form of
8
21
 
9
22
  <typechat:quotation author="AUTHOR OF QUOTATION"><![CDATA[VERBATIM QUOTATION]]></typechat:quotation>
10
23
 
@@ -12,8 +25,8 @@ The CDATA section may directly contain `]]>`, which is not allowed in standard X
12
25
 
13
26
  The attribute `author` is optional, indicating the source of the quotation.
14
27
 
15
- ## System Information
28
+ ## System Messages
16
29
 
17
- LLM developer/user-role messages may contain system information from the AI agent framework in the form of
30
+ AI agent system messages are in the form of
18
31
 
19
32
  <typechat:system></typechat:system>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zimtsui/typechat",
3
- "version": "0.0.114",
3
+ "version": "0.0.115",
4
4
  "exports": {
5
5
  ".": "./build/exports.js",
6
6
  "./assets": "./build/assets.js",