@dxos/assistant 0.8.2-main.5885341 → 0.8.2-main.600d381

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.
Files changed (157) hide show
  1. package/dist/lib/browser/{chunk-DEIGOD4U.mjs → chunk-YSYP7S4W.mjs} +706 -242
  2. package/dist/lib/browser/chunk-YSYP7S4W.mjs.map +7 -0
  3. package/dist/lib/browser/index.mjs +4 -443
  4. package/dist/lib/browser/index.mjs.map +4 -4
  5. package/dist/lib/browser/meta.json +1 -1
  6. package/dist/lib/browser/testing/index.mjs +64 -27
  7. package/dist/lib/browser/testing/index.mjs.map +4 -4
  8. package/dist/lib/node/{chunk-7VH7NMIM.cjs → chunk-FTIDW4BA.cjs} +716 -259
  9. package/dist/lib/node/chunk-FTIDW4BA.cjs.map +7 -0
  10. package/dist/lib/node/index.cjs +34 -470
  11. package/dist/lib/node/index.cjs.map +4 -4
  12. package/dist/lib/node/meta.json +1 -1
  13. package/dist/lib/node/testing/index.cjs +53 -18
  14. package/dist/lib/node/testing/index.cjs.map +4 -4
  15. package/dist/lib/node-esm/{chunk-7JI4MDGL.mjs → chunk-GCJNPQDJ.mjs} +706 -242
  16. package/dist/lib/node-esm/chunk-GCJNPQDJ.mjs.map +7 -0
  17. package/dist/lib/node-esm/index.mjs +4 -443
  18. package/dist/lib/node-esm/index.mjs.map +4 -4
  19. package/dist/lib/node-esm/meta.json +1 -1
  20. package/dist/lib/node-esm/testing/index.mjs +64 -27
  21. package/dist/lib/node-esm/testing/index.mjs.map +4 -4
  22. package/dist/types/src/ai-service/parser.d.ts.map +1 -1
  23. package/dist/types/src/ai-service/stream.d.ts.map +1 -1
  24. package/dist/types/src/ai-service/testing/test-stream.d.ts.map +1 -1
  25. package/dist/types/src/ai-service/types.d.ts +130 -130
  26. package/dist/types/src/ai-service/types.d.ts.map +1 -1
  27. package/dist/types/src/ai-service/util/sse.d.ts.map +1 -1
  28. package/dist/types/src/{conversation → experimental/conversation}/conversation.d.ts +2 -18
  29. package/dist/types/src/experimental/conversation/conversation.d.ts.map +1 -0
  30. package/dist/types/src/experimental/conversation/conversation.test.d.ts.map +1 -0
  31. package/dist/types/src/experimental/conversation/index.d.ts.map +1 -0
  32. package/dist/types/src/{conversation → experimental/conversation}/types.d.ts +9 -9
  33. package/dist/types/src/experimental/conversation/types.d.ts.map +1 -0
  34. package/dist/types/src/experimental/cypher/ast.d.ts.map +1 -0
  35. package/dist/types/src/experimental/cypher/combinators.d.ts.map +1 -0
  36. package/dist/types/src/experimental/cypher/combinators.test.d.ts.map +1 -0
  37. package/dist/types/src/experimental/cypher/echo-data-source.d.ts.map +1 -0
  38. package/dist/types/src/experimental/cypher/execution-plan.d.ts.map +1 -0
  39. package/dist/types/src/experimental/cypher/execution-plan.test.d.ts.map +1 -0
  40. package/dist/types/src/experimental/cypher/index.d.ts.map +1 -0
  41. package/dist/types/src/experimental/cypher/parjs.d.ts.map +1 -0
  42. package/dist/types/src/experimental/cypher/parser.d.ts.map +1 -0
  43. package/dist/types/src/experimental/cypher/query-executor.d.ts.map +1 -0
  44. package/dist/types/src/experimental/cypher/query-executor.test.d.ts.map +1 -0
  45. package/dist/types/src/experimental/cypher/schema.d.ts.map +1 -0
  46. package/dist/types/src/experimental/cypher/schema.test.d.ts.map +1 -0
  47. package/dist/types/src/experimental/index.d.ts +3 -0
  48. package/dist/types/src/experimental/index.d.ts.map +1 -0
  49. package/dist/types/src/experimental/ner/ner.test.d.ts +2 -0
  50. package/dist/types/src/experimental/ner/ner.test.d.ts.map +1 -0
  51. package/dist/types/src/experimental/research/exa.d.ts +6 -0
  52. package/dist/types/src/experimental/research/exa.d.ts.map +1 -0
  53. package/dist/types/src/experimental/research/research.test.d.ts +2 -0
  54. package/dist/types/src/experimental/research/research.test.d.ts.map +1 -0
  55. package/dist/types/src/index.d.ts +1 -2
  56. package/dist/types/src/index.d.ts.map +1 -1
  57. package/dist/types/src/session/index.d.ts +1 -0
  58. package/dist/types/src/session/index.d.ts.map +1 -1
  59. package/dist/types/src/session/session.d.ts +4 -3
  60. package/dist/types/src/session/session.d.ts.map +1 -1
  61. package/dist/types/src/session/tools.d.ts +18 -0
  62. package/dist/types/src/session/tools.d.ts.map +1 -0
  63. package/dist/types/src/session/version-pin.d.ts +5 -0
  64. package/dist/types/src/session/version-pin.d.ts.map +1 -1
  65. package/dist/types/src/testing/index.d.ts +1 -0
  66. package/dist/types/src/testing/index.d.ts.map +1 -1
  67. package/dist/types/src/testing/logger.d.ts +1 -1
  68. package/dist/types/src/testing/logger.d.ts.map +1 -1
  69. package/dist/types/src/testing/ollama.d.ts.map +1 -1
  70. package/dist/types/src/testing/printer.d.ts +6 -0
  71. package/dist/types/src/testing/printer.d.ts.map +1 -0
  72. package/dist/types/src/testing/query-promts.d.ts +4 -4
  73. package/dist/types/src/testing/query-promts.d.ts.map +1 -1
  74. package/dist/types/src/testing/test-data.d.ts +5 -5
  75. package/dist/types/src/testing/test-data.d.ts.map +1 -1
  76. package/dist/types/src/testing/test-schema.d.ts +25 -23
  77. package/dist/types/src/testing/test-schema.d.ts.map +1 -1
  78. package/dist/types/src/util/trim.d.ts.map +1 -1
  79. package/dist/types/tsconfig.tsbuildinfo +1 -1
  80. package/package.json +19 -13
  81. package/src/ai-service/client.test.ts +5 -5
  82. package/src/ai-service/ollama-client.ts +8 -8
  83. package/src/ai-service/types.ts +14 -14
  84. package/src/bin/chat.ts +1 -1
  85. package/src/{conversation → experimental/conversation}/conversation.test.ts +5 -5
  86. package/src/{conversation → experimental/conversation}/conversation.ts +3 -112
  87. package/src/{conversation → experimental/conversation}/types.ts +10 -10
  88. package/src/{cypher → experimental/cypher}/echo-data-source.ts +7 -5
  89. package/src/{cypher → experimental/cypher}/query-executor.test.ts +1 -1
  90. package/src/{cypher → experimental/cypher}/schema.test.ts +1 -1
  91. package/src/{cypher → experimental/cypher}/schema.ts +1 -1
  92. package/src/experimental/index.ts +6 -0
  93. package/src/experimental/ner/ner.test.ts +163 -0
  94. package/src/experimental/research/exa.ts +38 -0
  95. package/src/experimental/research/instructions.tpl +64 -0
  96. package/src/experimental/research/research.test.ts +263 -0
  97. package/src/index.ts +3 -2
  98. package/src/session/index.ts +1 -0
  99. package/src/session/session.test.ts +28 -57
  100. package/src/session/session.ts +25 -15
  101. package/src/session/tools.ts +117 -0
  102. package/src/session/version-pin.ts +6 -0
  103. package/src/testing/artifacts.test.ts +22 -22
  104. package/src/testing/index.ts +1 -0
  105. package/src/testing/logger.ts +1 -1
  106. package/src/testing/printer.ts +41 -0
  107. package/src/testing/query-promts.ts +6 -6
  108. package/src/testing/query.test.ts +1 -2
  109. package/src/testing/test-data.ts +5 -5
  110. package/src/testing/test-schema.ts +27 -28
  111. package/src/typedefs.d.ts +8 -0
  112. package/dist/lib/browser/chunk-DEIGOD4U.mjs.map +0 -7
  113. package/dist/lib/node/chunk-7VH7NMIM.cjs.map +0 -7
  114. package/dist/lib/node-esm/chunk-7JI4MDGL.mjs.map +0 -7
  115. package/dist/types/src/conversation/conversation.d.ts.map +0 -1
  116. package/dist/types/src/conversation/conversation.test.d.ts.map +0 -1
  117. package/dist/types/src/conversation/index.d.ts.map +0 -1
  118. package/dist/types/src/conversation/types.d.ts.map +0 -1
  119. package/dist/types/src/cypher/ast.d.ts.map +0 -1
  120. package/dist/types/src/cypher/combinators.d.ts.map +0 -1
  121. package/dist/types/src/cypher/combinators.test.d.ts.map +0 -1
  122. package/dist/types/src/cypher/echo-data-source.d.ts.map +0 -1
  123. package/dist/types/src/cypher/execution-plan.d.ts.map +0 -1
  124. package/dist/types/src/cypher/execution-plan.test.d.ts.map +0 -1
  125. package/dist/types/src/cypher/index.d.ts.map +0 -1
  126. package/dist/types/src/cypher/parjs.d.ts.map +0 -1
  127. package/dist/types/src/cypher/parser.d.ts.map +0 -1
  128. package/dist/types/src/cypher/query-executor.d.ts.map +0 -1
  129. package/dist/types/src/cypher/query-executor.test.d.ts.map +0 -1
  130. package/dist/types/src/cypher/schema.d.ts.map +0 -1
  131. package/dist/types/src/cypher/schema.test.d.ts.map +0 -1
  132. /package/dist/types/src/{conversation → experimental/conversation}/conversation.test.d.ts +0 -0
  133. /package/dist/types/src/{conversation → experimental/conversation}/index.d.ts +0 -0
  134. /package/dist/types/src/{cypher → experimental/cypher}/ast.d.ts +0 -0
  135. /package/dist/types/src/{cypher → experimental/cypher}/combinators.d.ts +0 -0
  136. /package/dist/types/src/{cypher → experimental/cypher}/combinators.test.d.ts +0 -0
  137. /package/dist/types/src/{cypher → experimental/cypher}/echo-data-source.d.ts +0 -0
  138. /package/dist/types/src/{cypher → experimental/cypher}/execution-plan.d.ts +0 -0
  139. /package/dist/types/src/{cypher → experimental/cypher}/execution-plan.test.d.ts +0 -0
  140. /package/dist/types/src/{cypher → experimental/cypher}/index.d.ts +0 -0
  141. /package/dist/types/src/{cypher → experimental/cypher}/parjs.d.ts +0 -0
  142. /package/dist/types/src/{cypher → experimental/cypher}/parser.d.ts +0 -0
  143. /package/dist/types/src/{cypher → experimental/cypher}/query-executor.d.ts +0 -0
  144. /package/dist/types/src/{cypher → experimental/cypher}/query-executor.test.d.ts +0 -0
  145. /package/dist/types/src/{cypher → experimental/cypher}/schema.d.ts +0 -0
  146. /package/dist/types/src/{cypher → experimental/cypher}/schema.test.d.ts +0 -0
  147. /package/src/{conversation → experimental/conversation}/index.ts +0 -0
  148. /package/src/{cypher → experimental/cypher}/ast.ts +0 -0
  149. /package/src/{cypher → experimental/cypher}/combinators.test.ts +0 -0
  150. /package/src/{cypher → experimental/cypher}/combinators.ts +0 -0
  151. /package/src/{cypher → experimental/cypher}/execution-plan.test.ts +0 -0
  152. /package/src/{cypher → experimental/cypher}/execution-plan.ts +0 -0
  153. /package/src/{cypher → experimental/cypher}/index.ts +0 -0
  154. /package/src/{cypher → experimental/cypher}/parjs-shims.d.ts +0 -0
  155. /package/src/{cypher → experimental/cypher}/parjs.ts +0 -0
  156. /package/src/{cypher → experimental/cypher}/parser.ts +0 -0
  157. /package/src/{cypher → experimental/cypher}/query-executor.ts +0 -0
@@ -2,7 +2,7 @@
2
2
  // Copyright 2024 DXOS.org
3
3
  //
4
4
 
5
- import { Schema as S } from 'effect';
5
+ import { Schema } from 'effect';
6
6
 
7
7
  import { type Message, type MessageContentBlock } from '@dxos/artifact';
8
8
  import { toJsonSchema, JsonSchemaType, ObjectId } from '@dxos/echo-schema';
@@ -17,11 +17,11 @@ export const createUserMessage = (text: string): Message => ({
17
17
  /**
18
18
  * @deprecated Use {@link LLMTool} instead.
19
19
  */
20
- export const ToolDefinition = S.Struct({
21
- name: S.String,
22
- description: S.String,
20
+ export const ToolDefinition = Schema.Struct({
21
+ name: Schema.String,
22
+ description: Schema.String,
23
23
  parameters: JsonSchemaType,
24
- execute: S.Any,
24
+ execute: Schema.Any,
25
25
  });
26
26
 
27
27
  /**
@@ -83,14 +83,14 @@ export const ToolResult = Object.freeze({
83
83
  Break: (result: unknown): ToolResult => ({ kind: 'break', result }),
84
84
  });
85
85
 
86
- export type DefineToolParams<Params extends S.Schema.AnyNoContext> = {
86
+ export type DefineToolParams<Params extends Schema.Schema.AnyNoContext> = {
87
87
  name: string;
88
88
  description: string;
89
89
  schema: Params;
90
- execute: (params: S.Schema.Type<Params>, context: ToolExecutionContext) => Promise<ToolResult>;
90
+ execute: (params: Schema.Schema.Type<Params>, context: ToolExecutionContext) => Promise<ToolResult>;
91
91
  };
92
92
 
93
- export const defineTool = <Params extends S.Schema.AnyNoContext>({
93
+ export const defineTool = <Params extends Schema.Schema.AnyNoContext>({
94
94
  name,
95
95
  description,
96
96
  schema,
@@ -101,7 +101,7 @@ export const defineTool = <Params extends S.Schema.AnyNoContext>({
101
101
  description,
102
102
  parameters: toFunctionParameterSchema(schema),
103
103
  execute: (params, context) => {
104
- const sanitized = S.decodeSync(schema)(params);
104
+ const sanitized = Schema.decodeSync(schema)(params);
105
105
  return execute(sanitized, context);
106
106
  },
107
107
  };
@@ -110,7 +110,7 @@ export const defineTool = <Params extends S.Schema.AnyNoContext>({
110
110
  /**
111
111
  * Adapts schems to be able to pass to AI providers.
112
112
  */
113
- const toFunctionParameterSchema = (schema: S.Schema.All) => {
113
+ const toFunctionParameterSchema = (schema: Schema.Schema.All) => {
114
114
  const jsonSchema = toJsonSchema(schema);
115
115
  log('tool schema', { jsonSchema });
116
116
  delete jsonSchema.anyOf;
@@ -2,9 +2,11 @@
2
2
  // Copyright 2025 DXOS.org
3
3
  //
4
4
 
5
+ import { type Schema } from 'effect';
6
+
5
7
  import { raise } from '@dxos/debug';
6
- import { type EchoDatabase, Filter, type ReactiveEchoObject } from '@dxos/echo-db';
7
- import { getSchema, getSchemaTypename, type S, StoredSchema, toJsonSchema } from '@dxos/echo-schema';
8
+ import { type EchoDatabase, Filter, type AnyLiveObject } from '@dxos/echo-db';
9
+ import { getSchema, getSchemaTypename, StoredSchema, toJsonSchema } from '@dxos/echo-schema';
8
10
  import { log } from '@dxos/log';
9
11
 
10
12
  import type { DataSource, Node, Relationship } from './query-executor';
@@ -62,7 +64,7 @@ export class EchoDataSource implements DataSource {
62
64
  ).flat();
63
65
  }
64
66
 
65
- private async _getAllSchema(): Promise<S.Schema.AnyNoContext[]> {
67
+ private async _getAllSchema(): Promise<Schema.Schema.AnyNoContext[]> {
66
68
  return [
67
69
  ...(await this._db.schemaRegistry.query().run()),
68
70
  // TODO(dmaretskyi): Remove once we can serialize recursive schema.
@@ -70,7 +72,7 @@ export class EchoDataSource implements DataSource {
70
72
  ].filter((schema) => getSchemaTypename(schema) !== StoredSchema.typename);
71
73
  }
72
74
 
73
- private _objectToNode(object: ReactiveEchoObject<any>): Node {
75
+ private _objectToNode(object: AnyLiveObject<any>): Node {
74
76
  const { id, ...properties } = object;
75
77
  return {
76
78
  id,
@@ -80,7 +82,7 @@ export class EchoDataSource implements DataSource {
80
82
  };
81
83
  }
82
84
 
83
- private async _projectRefRelationship(object: ReactiveEchoObject<any>, prop: string): Promise<Relationship[]> {
85
+ private async _projectRefRelationship(object: AnyLiveObject<any>, prop: string): Promise<Relationship[]> {
84
86
  if (!object[prop]) {
85
87
  return [];
86
88
  }
@@ -7,7 +7,7 @@ import { test } from 'vitest';
7
7
  import { log } from '@dxos/log';
8
8
 
9
9
  import { executeQuery } from './query-executor';
10
- import { createTestData } from '../testing';
10
+ import { createTestData } from '../../testing';
11
11
 
12
12
  test.skip('run', async ({ expect }) => {
13
13
  const dataSource = createTestData();
@@ -7,7 +7,7 @@ import { test } from 'vitest';
7
7
  import { toJsonSchema } from '@dxos/echo-schema';
8
8
 
9
9
  import { formatJsonSchemaForLLM } from './schema';
10
- import { Contact, Organization, Project, Task } from '../testing';
10
+ import { Contact, Organization, Project, Task } from '../../testing';
11
11
 
12
12
  test('Organization-Project-Task-Contact schema', async ({ expect }) => {
13
13
  const jsonSchema = [Organization, Project, Task, Contact].map((schema) => toJsonSchema(schema));
@@ -5,7 +5,7 @@
5
5
  import { raise } from '@dxos/debug';
6
6
  import { JSON_SCHEMA_ECHO_REF_ID, type JsonSchemaType } from '@dxos/echo-schema';
7
7
 
8
- import { trim } from '../util';
8
+ import { trim } from '../../util';
9
9
 
10
10
  /**
11
11
  * Formats ECHO schema to be consumed by LLM.
@@ -0,0 +1,6 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ export * from './conversation';
6
+ export * from './cypher';
@@ -0,0 +1,163 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import { pipeline } from '@xenova/transformers';
6
+ import { beforeAll, describe, expect, test } from 'vitest';
7
+
8
+ import { log } from '@dxos/log';
9
+ import { createTestData } from '@dxos/schema/testing';
10
+
11
+ type NerToken = {
12
+ entity: string;
13
+ score: number;
14
+ index: number;
15
+ word: string;
16
+ start: number | null;
17
+ end: number | null;
18
+ };
19
+
20
+ const createTokenGroups = (tokens: NerToken[]): NerToken[][] => {
21
+ const tokenGroups: NerToken[][] = [];
22
+
23
+ const canBeCombined = (prevToken: NerToken, currentToken: NerToken) => {
24
+ const [currentState, currentEntity] = currentToken.entity.split('-'); // B, I, O
25
+ const [prevState, prevEntity] = prevToken.entity.split('-'); // B, I, O
26
+
27
+ if (prevEntity !== currentEntity) {
28
+ return false;
29
+ }
30
+
31
+ if (prevState === 'O') {
32
+ return false;
33
+ }
34
+
35
+ if (currentState === 'I') {
36
+ return true;
37
+ }
38
+
39
+ if ((prevState === 'B' || prevState === 'I') && currentState === 'B') {
40
+ return currentToken.word.startsWith('#');
41
+ }
42
+
43
+ return false;
44
+ };
45
+
46
+ for (const token of tokens) {
47
+ if (tokenGroups.length === 0) {
48
+ tokenGroups.push([token]);
49
+ continue;
50
+ }
51
+
52
+ const lastTokenGroup = tokenGroups.at(-1)!;
53
+ if (canBeCombined(lastTokenGroup.at(-1)!, token)) {
54
+ lastTokenGroup.push(token);
55
+ continue;
56
+ }
57
+
58
+ tokenGroups.push([token]);
59
+ }
60
+
61
+ return tokenGroups;
62
+ };
63
+
64
+ const combineNerTokens = (group: NerToken[]): NerToken => {
65
+ const combinedToken: NerToken = {
66
+ entity: group.at(0)!.entity.split('-')[1],
67
+ score: group.reduce((acc, token) => acc + token.score, 0) / group.length,
68
+ index: group.at(0)!.index,
69
+ word: group.at(0)!.word,
70
+ start: group.at(0)!.start,
71
+ end: group.at(-1)!.end,
72
+ };
73
+
74
+ for (const token of group.slice(1)) {
75
+ if (token.word.startsWith('#')) {
76
+ combinedToken.word += token.word.replace(/^#+/, '');
77
+ } else {
78
+ combinedToken.word += ' ' + token.word;
79
+ }
80
+ }
81
+
82
+ return combinedToken;
83
+ };
84
+
85
+ describe.skip('Named Entity Recognition', () => {
86
+ let ner: any;
87
+
88
+ beforeAll(async () => {
89
+ // Initialize the NER pipeline
90
+ ner = await pipeline('ner', 'Xenova/bert-base-NER');
91
+ });
92
+
93
+ test.skip('should identify named entities in text', async () => {
94
+ const text = 'Elon Musk is the CEO of SpaceX and Tesla.';
95
+ const result = await ner(text);
96
+
97
+ // Verify the structure of the result
98
+ expect(Array.isArray(result)).toBe(true);
99
+ expect(result.length).toBeGreaterThan(0);
100
+
101
+ log.info('ner', { result });
102
+
103
+ // Check for specific entities
104
+ const entities = result.map((item: any) => ({
105
+ text: item.word,
106
+ entity: item.entity,
107
+ score: item.score,
108
+ }));
109
+
110
+ // Verify Elon Musk is recognized as a person
111
+ const elonMusk = entities.find((e: any) => e.text === 'Elon' || e.text === 'Musk');
112
+ expect(elonMusk).toBeDefined();
113
+ expect(elonMusk?.entity).toMatch(/PER/);
114
+
115
+ // Verify SpaceX and Tesla are recognized as organizations
116
+ const companies = entities.filter((e: any) => e.text === 'SpaceX' || e.text === 'Tesla');
117
+ expect(companies.length).toBe(2);
118
+ companies.forEach((company: any) => {
119
+ expect(company.entity).toMatch(/ORG/);
120
+ });
121
+ });
122
+
123
+ test('own data', async () => {
124
+ const { transcriptWoflram, transcriptJosiah } = await createTestData();
125
+
126
+ const blocks = [...transcriptWoflram, ...transcriptJosiah].flatMap((message) =>
127
+ message.blocks.flatMap((block) => (block.type === 'transcription' ? [block.text] : [])),
128
+ );
129
+
130
+ for (const block of blocks) {
131
+ const result = await ner(block);
132
+ const combinedTokens = createTokenGroups(result).map(combineNerTokens);
133
+ log.info('ner', { text: block, result: combinedTokens });
134
+ }
135
+ });
136
+
137
+ test('more own data', async () => {
138
+ const { transcriptMessages } = await createTestData();
139
+
140
+ const blocks = transcriptMessages.flatMap((message) =>
141
+ message.blocks.flatMap((block) => (block.type === 'transcription' ? [block.text] : [])),
142
+ );
143
+
144
+ for (const block of blocks) {
145
+ const result = await ner(block);
146
+ const combinedTokens = createTokenGroups(result).map(combineNerTokens);
147
+ log.info('ner', { text: block, result: combinedTokens });
148
+ }
149
+ });
150
+
151
+ test('should handle empty text', async () => {
152
+ const result = await ner('');
153
+ expect(Array.isArray(result)).toBe(true);
154
+ expect(result.length).toBe(0);
155
+ });
156
+
157
+ test('should handle text with no named entities', async () => {
158
+ const text = 'The weather is nice today.';
159
+ const result = await ner(text);
160
+ expect(Array.isArray(result)).toBe(true);
161
+ expect(result.length).toBe(0);
162
+ });
163
+ });
@@ -0,0 +1,38 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import { Schema } from 'effect';
6
+ import Exa from 'exa-js';
7
+
8
+ import { defineTool, ToolResult } from '@dxos/artifact';
9
+ import { log } from '@dxos/log';
10
+
11
+ type CreateExaToolOptions = {
12
+ apiKey: string;
13
+ };
14
+
15
+ export const createExaTool = ({ apiKey }: CreateExaToolOptions) => {
16
+ const exa = new Exa(apiKey);
17
+
18
+ return defineTool('search', {
19
+ name: 'web_search',
20
+ description: 'Search the web for information',
21
+ schema: Schema.Struct({
22
+ query: Schema.String.annotations({ description: 'The query to search for' }),
23
+ }),
24
+ execute: async ({ query }) => {
25
+ const context = await exa.searchAndContents(query, {
26
+ type: 'auto',
27
+ text: {
28
+ maxCharacters: 3_000,
29
+ },
30
+ livecrawl: 'always',
31
+ });
32
+
33
+ log.info('exa search', { query, costDollars: context.costDollars });
34
+
35
+ return ToolResult.Success(context);
36
+ },
37
+ });
38
+ };
@@ -0,0 +1,64 @@
1
+ You are an expert research agent. Your job is to assist a user by conducting in-depth research using real-time web search.
2
+ You output the results in a structured format matching the schema provided.
3
+
4
+ You are equipped with the ability to:
5
+
6
+ - Generate precise and effective search queries.
7
+ - Request web pages by query (through a `web_search` tool).
8
+ - Read the full content of retrieved pages.
9
+ - Synthesize accurate, clear, and structured answers using reliable information from the retrieved content.
10
+
11
+ Always follow these principles:
12
+
13
+ - Relevance First: Only return facts that are supported by content in the retrieved web pages. Never fabricate or guess information.
14
+ - Summarize, Don't Copy: Synthesize and rephrase content in your own words. Quote only when necessary.
15
+ - Multiple Sources: Cross-reference at least 2 sources before drawing conclusions, unless the information is directly stated and non-controversial.
16
+ - Transparency: Mention which sources were used and explain how you arrived at your conclusions.
17
+ - Accuracy Over Brevity: Prefer detailed, technically accurate explanations over shallow summaries.
18
+ - If uncertain, say so. It's better to admit uncertainty than to mislead.
19
+ - Pick the most concrete schema types for the extracted information.
20
+ - Fill the schema fields as completely as possible with the information you are confident about, do not fill the fields that you are not confident about.
21
+ - When outputting results, you can add extra data that isn't directly related to the user's question but fits the schema.
22
+
23
+ The user may ask for:
24
+
25
+ - Technical explanations
26
+ - Literature reviews
27
+ - Comparisons
28
+ - Emerging trends
29
+ - Implementation strategies
30
+
31
+ Begin by interpreting the user's request, then:
32
+
33
+ Break it into sub-questions (if applicable).
34
+
35
+ For each sub-question, generate a clear, concise web search query.
36
+
37
+ Use `web_search`(query) to retrieve information.
38
+
39
+ Extract and synthesize relevant answers.
40
+
41
+ Output should include:
42
+
43
+ - A clear, structured answer to the user’s question.
44
+ - A citation list or link list of the sources used.
45
+
46
+ Optionally, follow-up suggestions or questions for deeper inquiry.
47
+
48
+ Here's your operational instructions:
49
+
50
+ 1. Analyze user's request and identify key topics to search for (3 or more). Print them out.
51
+ 2. Perform a web search for each topic.
52
+ 3. Read and analyze the results, cross reference information from multiple sources, in case of conflict, represent the information as a range of possible values.
53
+ 4. Create a list of follow-up topics to research. Print them out.
54
+ 5. Perform a web search for each follow-up topic.
55
+ 6. Read and analyze the results, cross reference information from multiple sources, in case of conflict, represent the information as a range of possible values.
56
+ 9. Create a clear, structured answer to the user's question.
57
+ 10. Create a citation list or link list of the sources used.
58
+ 11. Select the most concrete schema types for the extracted information. You can use multiple different schema types. Print your decision and reasoning.
59
+ 12. Submit the results using the specific schema.
60
+
61
+
62
+
63
+
64
+
@@ -0,0 +1,263 @@
1
+ //
2
+ // Copyright 2025 DXOS.org
3
+ //
4
+
5
+ import { Option, Schema, SchemaAST } from 'effect';
6
+ import { describe, test } from 'vitest';
7
+
8
+ import { structuredOutputParser } from '@dxos/artifact';
9
+ import { isEncodedReference } from '@dxos/echo-protocol';
10
+ import { create, getSchemaDXN, ObjectId, ReferenceAnnotationId } from '@dxos/echo-schema';
11
+ import { mapAst } from '@dxos/effect';
12
+ import { log } from '@dxos/log';
13
+ import { DataType } from '@dxos/schema';
14
+ import { deepMapValues } from '@dxos/util';
15
+
16
+ import { createExaTool } from './exa';
17
+ import INSTRUCTIONS from './instructions.tpl?raw';
18
+ import { AIServiceEdgeClient, OllamaClient } from '../../ai-service';
19
+ import { AISession } from '../../session';
20
+ import { AI_SERVICE_ENDPOINT, ConsolePrinter } from '../../testing';
21
+
22
+ const EXA_API_KEY = '9c7e17ff-0c85-4cd5-827a-8b489f139e03';
23
+ const REMOTE_AI = true;
24
+
25
+ const aiService = REMOTE_AI
26
+ ? new AIServiceEdgeClient({
27
+ endpoint: AI_SERVICE_ENDPOINT.REMOTE,
28
+ })
29
+ : new OllamaClient({
30
+ overrides: {
31
+ model: 'llama3.1:8b',
32
+ },
33
+ });
34
+
35
+ const TYPES = [DataType.Event, DataType.Organization, DataType.Person, DataType.Project, DataType.Task, DataType.Text];
36
+
37
+ describe.skip('Research', () => {
38
+ test('should generate a research report', { timeout: 1000000 }, async () => {
39
+ const searchTool = createExaTool({ apiKey: EXA_API_KEY });
40
+
41
+ const session = new AISession({ operationModel: 'configured' });
42
+
43
+ const printer = new ConsolePrinter();
44
+ session.message.on((message) => printer.printMessage(message));
45
+ session.userMessage.on((message) => printer.printMessage(message));
46
+ session.block.on((block) => printer.printContentBlock(block));
47
+
48
+ // TODO(dmaretskyi): Consider adding this pattern as the "Graph" output mode for the session.
49
+ const outputSchema = createExtractionSchema(TYPES);
50
+ const result = await session.runStructured(outputSchema, {
51
+ client: aiService,
52
+ systemPrompt: INSTRUCTIONS,
53
+ artifacts: [],
54
+ tools: [searchTool],
55
+ generationOptions: {
56
+ model: '@anthropic/claude-3-5-sonnet-20241022',
57
+ },
58
+ history: [],
59
+ prompt: 'Find projects that are in the space of AI and personal knowledge management',
60
+ });
61
+ const data = sanitizeObjects(TYPES, result as any);
62
+
63
+ log.info('result', { data });
64
+ });
65
+ });
66
+
67
+ describe.skip('misc', () => {
68
+ test('createExtractionSchema', () => {
69
+ const schema = createExtractionSchema(TYPES);
70
+ log.info('schema', { schema });
71
+ });
72
+
73
+ test('extract schema json schema', () => {
74
+ const schema = createExtractionSchema(TYPES);
75
+ const parser = structuredOutputParser(schema);
76
+ log.info('schema', { json: parser.tool.parameters });
77
+ });
78
+
79
+ test('getSanitizedSchemaName', () => {
80
+ const names = TYPES.map(getSanitizedSchemaName);
81
+ log.info('names', { names });
82
+ });
83
+
84
+ test('getTypeAnnotation', () => {
85
+ for (const schema of TYPES) {
86
+ const dxn = getSchemaDXN(schema);
87
+ log.info('dxn', { schema, dxn });
88
+ }
89
+ });
90
+
91
+ test('sanitizeObjects', () => {
92
+ const TEST_DATA = {
93
+ objects_dxos_org_type_Project: [
94
+ {
95
+ name: 'Reor',
96
+ description:
97
+ 'A private & local AI personal knowledge management app focused on high entropy thinkers. Features include Q&A chat with full context of notes, automatic connection of ideas, semantic search, and local-first architecture with LLMs and vector databases.',
98
+ image: 'https://reorhomepage-2-cwy0zagzg-reor-team.vercel.app/opengraph-image.jpg',
99
+ id: 'reor-project-01',
100
+ },
101
+ {
102
+ name: 'Personal AI',
103
+ description:
104
+ 'A platform for creating personal AI models with unlimited memory capabilities. Features include memory stacking, data uploads, and personalized language models that can be trained on individual knowledge bases.',
105
+ image: 'https://cdn.prod.website-files.com/5ff65c460ce39f5ec5681c6a/663d12aab1b425e1ad40d3a6_Memory-min.jpg',
106
+ id: 'personal-ai-project-01',
107
+ },
108
+ {
109
+ name: 'IKI AI',
110
+ description:
111
+ 'An AI-native workspace for research, strategy, and creative work. Offers features like AI summarization, content analysis, and team knowledge sharing capabilities.',
112
+ image: 'https://framerusercontent.com/assets/cI6Uo7x4q0W3uxzOt2preXjv6aE.jpg',
113
+ id: 'iki-ai-project-01',
114
+ },
115
+ {
116
+ name: 'Forethink',
117
+ description:
118
+ 'A privacy-first, on-device AI system that proactively links current activities to relevant knowledge. Features real-time learning across teams and local data processing.',
119
+ image: 'https://framerusercontent.com/assets/XDhN6tICnlElB134JWcWXOuXc.jpeg',
120
+ id: 'forethink-project-01',
121
+ },
122
+ {
123
+ name: 'Amurex',
124
+ description:
125
+ 'An invisible AI companion that handles tasks, remembers important information, and supports workflow. Includes features for meeting automation, email categorization, and cross-platform search.',
126
+ image: 'https://amurex.ai/ogimages/og_amurex.jpg',
127
+ id: 'amurex-project-01',
128
+ },
129
+ ],
130
+ objects_dxos_org_type_Organization: [
131
+ {
132
+ name: 'Reor',
133
+ description:
134
+ 'A technology company focused on developing local-first AI solutions for personal knowledge management.',
135
+ status: 'active',
136
+ website: 'https://www.reorproject.org',
137
+ id: 'reor-org-01',
138
+ },
139
+ {
140
+ name: 'Personal.ai',
141
+ description: 'A company specializing in personal AI development and memory management solutions.',
142
+ status: 'active',
143
+ website: 'https://www.personal.ai',
144
+ id: 'personal-ai-org-01',
145
+ },
146
+ {
147
+ name: 'IKI AI',
148
+ description: 'A startup backed by 500 Global, developing AI-native workspaces for knowledge workers.',
149
+ status: 'active',
150
+ website: 'https://iki.ai',
151
+ id: 'iki-ai-org-01',
152
+ },
153
+ {
154
+ name: 'Forethink.ai',
155
+ description:
156
+ 'A company focused on privacy-first AI solutions for knowledge management and team collaboration.',
157
+ status: 'active',
158
+ website: 'https://www.forethink.ai',
159
+ id: 'forethink-org-01',
160
+ },
161
+ ],
162
+ objects_dxos_org_type_Text: [
163
+ {
164
+ content:
165
+ 'Current trends in AI-powered Personal Knowledge Management (PKM) systems include: 1) Shift from document-based to graph-based systems for better knowledge connection, 2) Integration of large language models for enhanced content understanding and retrieval, 3) Focus on privacy-first and local-first architectures, 4) Emphasis on automatic knowledge connection and discovery, 5) Implementation of semantic search capabilities.',
166
+ id: 'pkm-trends-text-01',
167
+ },
168
+ {
169
+ content:
170
+ 'Key features emerging across modern PKM tools include: automated content categorization, semantic analysis and linking, personalized AI models that learn from user interaction, integration with existing workflows, and robust privacy protection. These tools are increasingly focusing on proactive knowledge surfacing rather than passive storage.',
171
+ id: 'pkm-features-text-01',
172
+ },
173
+ ],
174
+ };
175
+
176
+ const data = sanitizeObjects(TYPES, TEST_DATA);
177
+ log.info('data', { data });
178
+ });
179
+ });
180
+
181
+ const createExtractionSchema = (types: Schema.Schema.AnyNoContext[]) => {
182
+ return Schema.Struct({
183
+ ...Object.fromEntries(
184
+ types.map(preprocessSchema).map((schema, index) => [
185
+ `objects_${getSanitizedSchemaName(types[index])}`,
186
+ Schema.optional(Schema.Array(schema)).annotations({
187
+ description: `The objects to answer the query of type: ${getSchemaDXN(types[index])?.asTypeDXN()!.type}`,
188
+ }),
189
+ ]),
190
+ ),
191
+ });
192
+ };
193
+
194
+ const getSanitizedSchemaName = (schema: Schema.Schema.AnyNoContext) => {
195
+ return getSchemaDXN(schema)!
196
+ .asTypeDXN()!
197
+ .type.replaceAll(/[^a-zA-Z0-9]+/g, '_');
198
+ };
199
+
200
+ const sanitizeObjects = (types: Schema.Schema.AnyNoContext[], data: Record<string, readonly unknown[]>) => {
201
+ const entries = types
202
+ .map(
203
+ (type) =>
204
+ data[`objects_${getSanitizedSchemaName(type)}`]?.map((object: any) => ({
205
+ data: object,
206
+ schema: type,
207
+ })) ?? [],
208
+ )
209
+ .flat();
210
+
211
+ const idMap = new Map<string, string>();
212
+
213
+ return entries
214
+ .map((entry) => {
215
+ idMap.set(entry.data.id, ObjectId.random());
216
+ entry.data.id = idMap.get(entry.data.id);
217
+ return entry;
218
+ })
219
+ .map((entry) => {
220
+ const data = deepMapValues(entry.data, (value, recurse) => {
221
+ if (isEncodedReference(value)) {
222
+ const ref = value['/'];
223
+ if (idMap.has(ref)) {
224
+ // TODO(dmaretskyi): Whats the best way to represent a local url.
225
+ return { '/': `dxn:echo:@:${idMap.get(ref)}` };
226
+ } else {
227
+ // Search URIs?
228
+ return { '/': `search:?q=${encodeURIComponent(ref)}` };
229
+ }
230
+ }
231
+
232
+ return recurse(value);
233
+ });
234
+
235
+ return create(entry.schema, data);
236
+ });
237
+ };
238
+
239
+ const SoftRef = Schema.Struct({
240
+ '/': Schema.String,
241
+ }).annotations({
242
+ description: 'Reference to another object.',
243
+ });
244
+
245
+ const preprocessSchema = (schema: Schema.Schema.AnyNoContext) => {
246
+ const go = (ast: SchemaAST.AST): SchemaAST.AST => {
247
+ if (SchemaAST.getAnnotation(ast, ReferenceAnnotationId).pipe(Option.isSome)) {
248
+ return SoftRef.ast;
249
+ }
250
+
251
+ return mapAst(ast, go);
252
+ };
253
+
254
+ const processed = Schema.make<any, any, never>(mapAst(schema.ast, go));
255
+ return Schema.extend(
256
+ processed.pipe(Schema.omit('id')),
257
+ Schema.Struct({
258
+ id: Schema.String.annotations({
259
+ description: 'The id of this object. Come up with a unique id based on your judgement.',
260
+ }),
261
+ }),
262
+ );
263
+ };
package/src/index.ts CHANGED
@@ -3,6 +3,7 @@
3
3
  //
4
4
 
5
5
  export * from './ai-service';
6
- export * from './cypher';
7
- export * from './conversation';
8
6
  export * from './session';
7
+
8
+ // TODO(dmaretskyi): Separate entrypoint for experimental features.
9
+ export * from './experimental';
@@ -4,3 +4,4 @@
4
4
 
5
5
  export * from './session';
6
6
  export * from './version-pin';
7
+ export * from './tools';