@dxos/assistant 0.8.2-main.fbd8ed0 → 0.8.2-staging.4d6ad0f

package/src/experimental/research/research.test.ts

@@ -1,263 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import { Option, Schema, SchemaAST } from 'effect';
-import { describe, test } from 'vitest';
-
-import { structuredOutputParser } from '@dxos/artifact';
-import { isEncodedReference } from '@dxos/echo-protocol';
-import { create, getSchemaDXN, ObjectId, ReferenceAnnotationId } from '@dxos/echo-schema';
-import { mapAst } from '@dxos/effect';
-import { log } from '@dxos/log';
-import { DataType } from '@dxos/schema';
-import { deepMapValues } from '@dxos/util';
-
-import { createExaTool } from './exa';
-import INSTRUCTIONS from './instructions.tpl?raw';
-import { AIServiceEdgeClient, OllamaClient } from '../../ai-service';
-import { AISession } from '../../session';
-import { AI_SERVICE_ENDPOINT, ConsolePrinter } from '../../testing';
-
-const EXA_API_KEY = '9c7e17ff-0c85-4cd5-827a-8b489f139e03';
-const REMOTE_AI = true;
-
-const aiService = REMOTE_AI
-  ? new AIServiceEdgeClient({
-      endpoint: AI_SERVICE_ENDPOINT.REMOTE,
-    })
-  : new OllamaClient({
-      overrides: {
-        model: 'llama3.1:8b',
-      },
-    });
-
-const TYPES = [DataType.Event, DataType.Organization, DataType.Person, DataType.Project, DataType.Task, DataType.Text];
-
-describe.skip('Research', () => {
-  test('should generate a research report', { timeout: 1000000 }, async () => {
-    const searchTool = createExaTool({ apiKey: EXA_API_KEY });
-
-    const session = new AISession({ operationModel: 'configured' });
-
-    const printer = new ConsolePrinter();
-    session.message.on((message) => printer.printMessage(message));
-    session.userMessage.on((message) => printer.printMessage(message));
-    session.block.on((block) => printer.printContentBlock(block));
-
-    // TODO(dmaretskyi): Consider adding this pattern as the "Graph" output mode for the session.
-    const outputSchema = createExtractionSchema(TYPES);
-    const result = await session.runStructured(outputSchema, {
-      client: aiService,
-      systemPrompt: INSTRUCTIONS,
-      artifacts: [],
-      tools: [searchTool],
-      generationOptions: {
-        model: '@anthropic/claude-3-5-sonnet-20241022',
-      },
-      history: [],
-      prompt: 'Find projects that are in the space of AI and personal knowledge management',
-    });
-    const data = sanitizeObjects(TYPES, result as any);
-
-    log.info('result', { data });
-  });
-});
-
-describe.skip('misc', () => {
-  test('createExtractionSchema', () => {
-    const schema = createExtractionSchema(TYPES);
-    log.info('schema', { schema });
-  });
-
-  test('extract schema json schema', () => {
-    const schema = createExtractionSchema(TYPES);
-    const parser = structuredOutputParser(schema);
-    log.info('schema', { json: parser.tool.parameters });
-  });
-
-  test('getSanitizedSchemaName', () => {
-    const names = TYPES.map(getSanitizedSchemaName);
-    log.info('names', { names });
-  });
-
-  test('getTypeAnnotation', () => {
-    for (const schema of TYPES) {
-      const dxn = getSchemaDXN(schema);
-      log.info('dxn', { schema, dxn });
-    }
-  });
-
-  test('sanitizeObjects', () => {
-    const TEST_DATA = {
-      objects_dxos_org_type_Project: [
-        {
-          name: 'Reor',
-          description:
-            '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.',
-          image: 'https://reorhomepage-2-cwy0zagzg-reor-team.vercel.app/opengraph-image.jpg',
-          id: 'reor-project-01',
-        },
-        {
-          name: 'Personal AI',
-          description:
-            '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.',
-          image: 'https://cdn.prod.website-files.com/5ff65c460ce39f5ec5681c6a/663d12aab1b425e1ad40d3a6_Memory-min.jpg',
-          id: 'personal-ai-project-01',
-        },
-        {
-          name: 'IKI AI',
-          description:
-            'An AI-native workspace for research, strategy, and creative work. Offers features like AI summarization, content analysis, and team knowledge sharing capabilities.',
-          image: 'https://framerusercontent.com/assets/cI6Uo7x4q0W3uxzOt2preXjv6aE.jpg',
-          id: 'iki-ai-project-01',
-        },
-        {
-          name: 'Forethink',
-          description:
-            '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.',
-          image: 'https://framerusercontent.com/assets/XDhN6tICnlElB134JWcWXOuXc.jpeg',
-          id: 'forethink-project-01',
-        },
-        {
-          name: 'Amurex',
-          description:
-            'An invisible AI companion that handles tasks, remembers important information, and supports workflow. Includes features for meeting automation, email categorization, and cross-platform search.',
-          image: 'https://amurex.ai/ogimages/og_amurex.jpg',
-          id: 'amurex-project-01',
-        },
-      ],
-      objects_dxos_org_type_Organization: [
-        {
-          name: 'Reor',
-          description:
-            'A technology company focused on developing local-first AI solutions for personal knowledge management.',
-          status: 'active',
-          website: 'https://www.reorproject.org',
-          id: 'reor-org-01',
-        },
-        {
-          name: 'Personal.ai',
-          description: 'A company specializing in personal AI development and memory management solutions.',
-          status: 'active',
-          website: 'https://www.personal.ai',
-          id: 'personal-ai-org-01',
-        },
-        {
-          name: 'IKI AI',
-          description: 'A startup backed by 500 Global, developing AI-native workspaces for knowledge workers.',
-          status: 'active',
-          website: 'https://iki.ai',
-          id: 'iki-ai-org-01',
-        },
-        {
-          name: 'Forethink.ai',
-          description:
-            'A company focused on privacy-first AI solutions for knowledge management and team collaboration.',
-          status: 'active',
-          website: 'https://www.forethink.ai',
-          id: 'forethink-org-01',
-        },
-      ],
-      objects_dxos_org_type_Text: [
-        {
-          content:
-            '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.',
-          id: 'pkm-trends-text-01',
-        },
-        {
-          content:
-            '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.',
-          id: 'pkm-features-text-01',
-        },
-      ],
-    };
-
-    const data = sanitizeObjects(TYPES, TEST_DATA);
-    log.info('data', { data });
-  });
-});
-
-const createExtractionSchema = (types: Schema.Schema.AnyNoContext[]) => {
-  return Schema.Struct({
-    ...Object.fromEntries(
-      types.map(preprocessSchema).map((schema, index) => [
-        `objects_${getSanitizedSchemaName(types[index])}`,
-        Schema.optional(Schema.Array(schema)).annotations({
-          description: `The objects to answer the query of type: ${getSchemaDXN(types[index])?.asTypeDXN()!.type}`,
-        }),
-      ]),
-    ),
-  });
-};
-
-const getSanitizedSchemaName = (schema: Schema.Schema.AnyNoContext) => {
-  return getSchemaDXN(schema)!
-    .asTypeDXN()!
-    .type.replaceAll(/[^a-zA-Z0-9]+/g, '_');
-};
-
-const sanitizeObjects = (types: Schema.Schema.AnyNoContext[], data: Record<string, readonly unknown[]>) => {
-  const entries = types
-    .map(
-      (type) =>
-        data[`objects_${getSanitizedSchemaName(type)}`]?.map((object: any) => ({
-          data: object,
-          schema: type,
-        })) ?? [],
-    )
-    .flat();
-
-  const idMap = new Map<string, string>();
-
-  return entries
-    .map((entry) => {
-      idMap.set(entry.data.id, ObjectId.random());
-      entry.data.id = idMap.get(entry.data.id);
-      return entry;
-    })
-    .map((entry) => {
-      const data = deepMapValues(entry.data, (value, recurse) => {
-        if (isEncodedReference(value)) {
-          const ref = value['/'];
-          if (idMap.has(ref)) {
-            // TODO(dmaretskyi): Whats the best way to represent a local url.
-            return { '/': `dxn:echo:@:${idMap.get(ref)}` };
-          } else {
-            // Search URIs?
-            return { '/': `search:?q=${encodeURIComponent(ref)}` };
-          }
-        }
-
-        return recurse(value);
-      });
-
-      return create(entry.schema, data);
-    });
-};
-
-const SoftRef = Schema.Struct({
-  '/': Schema.String,
-}).annotations({
-  description: 'Reference to another object.',
-});
-
-const preprocessSchema = (schema: Schema.Schema.AnyNoContext) => {
-  const go = (ast: SchemaAST.AST): SchemaAST.AST => {
-    if (SchemaAST.getAnnotation(ast, ReferenceAnnotationId).pipe(Option.isSome)) {
-      return SoftRef.ast;
-    }
-
-    return mapAst(ast, go);
-  };
-
-  const processed = Schema.make<any, any, never>(mapAst(schema.ast, go));
-  return Schema.extend(
-    processed.pipe(Schema.omit('id')),
-    Schema.Struct({
-      id: Schema.String.annotations({
-        description: 'The id of this object. Come up with a unique id based on your judgement.',
-      }),
-    }),
-  );
-};

package/src/session/tools.ts

@@ -1,117 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-import { Message, type Tool, ToolResult } from '@dxos/artifact';
-import { create } from '@dxos/echo-schema';
-import { invariant } from '@dxos/invariant';
-import { log } from '@dxos/log';
-
-export const isToolUse = (message: Message, { onlyToolNames }: { onlyToolNames?: string[] } = {}) => {
-  const block = message.content.at(-1);
-  invariant(block);
-  return block.type === 'tool_use' && (!onlyToolNames || onlyToolNames.includes(block.name));
-};
-
-export type RunToolsOptions = {
-  message: Message;
-  tools: Tool[];
-  extensions?: ToolContextExtensions;
-};
-
-export type RunToolsResult =
-  | {
-      type: 'continue';
-      message: Message;
-    }
-  | {
-      type: 'break';
-      result: unknown;
-    };
-
-export const runTools = async ({ message, tools, extensions }: RunToolsOptions): Promise<RunToolsResult> => {
-  const toolCalls = message.content.filter((block) => block.type === 'tool_use');
-  invariant(toolCalls.length === 1);
-  const toolCall = toolCalls[0];
-  const tool = tools.find((tool) => tool.name === toolCall.name);
-  if (!tool) {
-    const resultMessage = create(Message, {
-      role: 'user',
-      content: [
-        {
-          type: 'tool_result',
-          toolUseId: toolCall.id,
-          content: `Tool not found: ${toolCall.name}`,
-          isError: true,
-        },
-      ],
-    });
-
-    // TODO(burdon): Retry count?
-    return {
-      type: 'continue',
-      message: resultMessage,
-    };
-  }
-
-  let toolResult: ToolResult;
-  try {
-    invariant(tool.execute);
-    toolResult = await tool.execute(toolCall.input, { extensions });
-  } catch (error: any) {
-    log('tool error', { error });
-    toolResult = ToolResult.Error(error.message);
-  }
-
-  switch (toolResult.kind) {
-    case 'error': {
-      log('tool error', { message: toolResult.message });
-      const resultMessage = create(Message, {
-        role: 'user',
-        content: [
-          {
-            type: 'tool_result',
-            toolUseId: toolCall.id,
-            content: toolResult.message,
-            isError: true,
-          },
-        ],
-      });
-
-      // TODO(burdon): Retry count?
-      return {
-        type: 'continue',
-        message: resultMessage,
-      };
-    }
-
-    case 'success': {
-      log('tool success', { result: toolResult.result });
-      const resultMessage = create(Message, {
-        role: 'user',
-        content: [
-          {
-            type: 'tool_result',
-            toolUseId: toolCall.id,
-            content:
-              typeof toolResult.result === 'string' ? toolResult.result : JSON.stringify(toolResult.result) ?? '',
-          },
-          ...(toolResult.extractContentBlocks ?? []),
-        ],
-      });
-
-      return {
-        type: 'continue',
-        message: resultMessage,
-      };
-    }
-
-    case 'break': {
-      log('tool break', { result: toolResult.result });
-      return {
-        type: 'break',
-        result: toolResult.result,
-      };
-    }
-  }
-};

package/src/testing/artifacts.test.ts

@@ -1,182 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-/*
-import { Schema } from '@effect/schema';
-import { describe, test } from 'vitest';
-
-import { ObjectId, toJsonSchema } from '@dxos/echo-schema';
-import { invariant } from '@dxos/invariant';
-import { SpaceId } from '@dxos/keys';
-import { log } from '@dxos/log';
-
-import { AIServiceEdgeClient, Tool } from '../ai-service';
-import { defineTool, ToolResult } from '../conversation';
-
-// TODO(dmaretskyi): Effect schema.
-const ArtifactDef = Schema.Struct({
-  typename: Schema.String,
-  description: Schema.String,
-  schema: Schema.Any,
-  actions: Schema.Array(Tool),
-}).pipe(Schema.mutable);
-
-type ArtifactDef = Schema.Schema.Type<typeof ArtifactDef>;
-
-const ListItem = Schema.Struct({
-  name: Schema.String,
-});
-
-const ListSchema = Schema.Struct({
-  id: ObjectId,
-  title: Schema.String,
-  items: Schema.Array(ListItem).pipe(Schema.mutable),
-}).pipe(Schema.mutable);
-
-type ListSchema = Schema.Schema.Type<typeof ListSchema>;
-
-const list: ArtifactDef = {
-  typename: 'example.com/type/List',
-  description: 'Ordered set of text items.',
-  schema: ListSchema,
-  actions: [
-    defineTool('list', {
-      name: 'query',
-      description: 'Query all lists',
-      schema: Schema.Struct({}),
-      execute: async ({}, context) => {
-        return ToolResult.Success(LISTS[id]);
-      },
-    }),
-    defineTool('list', {
-      name: 'inspect',
-      description: 'Get contents of the list',
-      schema: Schema.Struct({
-        id: ObjectId.annotations({ description: 'The list to inspect' }),
-      }),
-      execute: async ({ id }, context) => {
-        return ToolResult.Success(LISTS[id]);
-      },
-    }),
-    defineTool('list', {
-      name: 'create',
-      description: 'Add one or more items to an existing list',
-      schema: Schema.Struct({
-        id: ObjectId.annotations({ description: 'The list to add items to' }),
-        items: Schema.Array(ListItem).annotations({ description: 'The items to add to the list' }),
-      }),
-      execute: async ({ id, items }, context) => {
-        LISTS[id].items.push(...items);
-        return ToolResult.Success(LISTS[id]);
-      },
-    }),
-  ],
-};
-
-const LISTS: Record<ObjectId, ListSchema> = {};
-
-const artifacts = [list];
-
-const getArtifactDefinitions = defineTool('system', {
-  name: 'getArtifactDefinitions',
-  description: 'Queries the definitions and metadata of artifacts defined in the system',
-  schema: Schema.Any,
-  execute: async (_, context) => {
-    return ToolResult.Success(
-      artifacts.map((artifact) => ({
-        typename: artifact.typename,
-        description: artifact.description,
-        schema: toJsonSchema(artifact.schema),
-        actions: artifact.actions.map((action) => ({
-          name: action.name,
-          description: action.description,
-        })),
-      })),
-    );
-  },
-});
-
-const ARTIFACT_INSTRUCTIONS = `
-You have ability to interact with artifacts.
-Artifacts are persistent structured objects that have actions associated with them.
-
-Before replying to the user you should first query the artifact definitions and metadata.
-If there's
-
-`;
-
-describe('Artifacts', () => {
-  test('shopping list', async () => {
-    const client = new AIServiceEdgeClient({
-      endpoint: ENDPOINT,
-    });
-
-    const custodian: Tool = {
-      name: 'custodian',
-      description: 'Custodian can tell you the password if you say the magic word',
-      parameters: toJsonSchema(
-        Schema.Struct({
-          magicWord: Schema.String.annotations({ description: 'The magic word. Should be exactly "pretty please"' }),
-        }),
-      ),
-    };
-
-    const spaceId = SpaceId.random();
-    const threadId = ObjectId.random();
-
-    await client.appendMessages([
-      {
-        id: ObjectId.random(),
-        spaceId,
-        threadId,
-        role: 'user',
-        content: [{ type: 'text', text: 'What is the password? Ask the custodian' }],
-      },
-    ]);
-
-    const stream = await client.generate({
-      model: DEFAULT_EDGE_MODEL,
-      spaceId,
-      threadId,
-      systemPrompt: 'You are a helpful assistant.',
-      tools: [custodian],
-    });
-    for await (const event of stream) {
-      log('event', event);
-    }
-    const [message] = await stream.complete();
-    log('full message', {
-      message,
-    });
-    await client.appendMessages([message]);
-
-    const toolUse = message.content.find(({ type }) => type === 'tool_use')!;
-    invariant(toolUse.type === 'tool_use');
-    await client.appendMessages([
-      {
-        id: ObjectId.random(),
-        spaceId,
-        threadId,
-        role: 'user',
-        content: [{ type: 'tool_result', toolUseId: toolUse.id, content: 'password="The sky is gray"' }],
-      },
-    ]);
-
-    const stream2 = await client.generate({
-      model: DEFAULT_EDGE_MODEL,
-      spaceId,
-      threadId,
-      systemPrompt: 'You are a helpful assistant.',
-      tools: [custodian],
-    });
-    for await (const event of stream2) {
-      log('event', event);
-    }
-    const [message2] = await stream2.complete();
-    log('full message', {
-      message: message2,
-    });
-  });
-});
-*/

package/src/testing/data.ts

@@ -1,13 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-export const DATA_MESSAGES = [
-  `
-  <cot>
-  ${Array.from({ length: 5 })
-    .map((_, i) => `${i + 1}. Step`)
-    .join('\n')}
-  </cot>
-  `,
-];

package/src/testing/defs.ts

@@ -1,9 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-// TODO(burdon): Remove/Reconcile with @dxos/assistant-testing.
-export const AI_SERVICE_ENDPOINT = {
-  LOCAL: 'http://localhost:8788',
-  REMOTE: 'https://ai-service.dxos.workers.dev',
-};