Merge pull request #66 from alkem-io/develop

Release v0.11.0

.env.default

@@ -21,8 +21,8 @@ AUTH_ADMIN_PASSWORD=master-password
 VECTOR_DB_HOST=localhost
 VECTOR_DB_PORT=8765
 
-CHUNK_SIZE=1000
-CHUNK_OVERLAP=100
+CHUNK_SIZE=9000
+CHUNK_OVERLAP=500
 
 SUMMARY_LENGTH=10000
 

graphql/fragments/callout.graphql

@@ -0,0 +1,50 @@
+fragment CalloutFields on Callout {
+  id
+  nameID
+  type
+  visibility
+  comments {
+    messagesCount
+    messages {
+      sender {
+        ... on User {
+          profile {
+            url
+            displayName
+          }
+        }
+        ... on VirtualContributor {
+          profile {
+            url
+            displayName
+          }
+        }
+      }
+      message
+      timestamp
+    }
+  }
+  framing {
+    id
+    profile {
+      ...ProfileFields
+    }
+  }
+  contributions {
+    post {
+      id
+      nameID
+      profile {
+        ...ProfileFields
+      }
+    }
+    link {
+      id
+      uri
+      profile {
+        ...ProfileNoTagsetFields
+      }
+
+    }
+  }
+}

graphql/fragments/profile.graphql

@@ -5,6 +5,12 @@ fragment ProfileFields on Profile {
   tagline
   url
   type
+  location {
+    city
+    country
+    postalCode
+  }
+
   tagset {
     tags
   }

graphql/fragments/space-ingest.graphql

@@ -3,27 +3,7 @@ fragment SpaceIngest on Space {
   nameID
   type
   profile {
-    description
-    displayName
-    tagline
-    url
-    location {
-      city
-      country
-      postalCode
-    }
-    tagset {
-      tags
-    }
-    references {
-      description
-      name
-      uri
-    }
-    visuals {
-      uri
-      name
-    }
+    ...ProfileFields
   }
   context {
     vision
@@ -32,54 +12,9 @@ fragment SpaceIngest on Space {
   }
 
   collaboration {
-    callouts {
-      id
-      nameID
-      type
-      visibility
-      comments {
-        messagesCount
-        messages {
-          sender {
-            ... on User {
-              profile {
-                url
-                displayName
-              }
-            }
-            ... on VirtualContributor {
-              profile {
-                url
-                displayName
-              }
-            }
-          }
-          message
-          timestamp
-        }
-      }
-      framing {
-        id
-        profile {
-          ...ProfileFields
-        }
-      }
-      contributions {
-        post {
-          id
-          nameID
-          profile {
-            ...ProfileFields
-          }
-        }
-        link {
-          id
-          uri
-          profile {
-            ...ProfileNoTagsetFields
-          }
-
-        }
+    calloutsSet {
+      callouts {
+        ...CalloutFields
       }
     }
   }

graphql/queries/knowledge-base-ingest.graphql

@@ -0,0 +1,15 @@
+query knowledgeBaseIngest($knowledgeBaseID: UUID!){
+  lookup {
+    knowledgeBase(ID: $knowledgeBaseID) {
+      id
+      profile {
+        ...ProfileFields
+      }
+      calloutsSet {
+        callouts {
+          ...CalloutFields
+        }
+      }
+    }
+  }
+}

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "@alkemio/space-ingest",
-  "version": "0.10.0",
+  "name": "@alkemio/ingest-alkemio-data",
+  "version": "0.11.0",
   "description": "",
   "author": "Alkemio Foundation",
   "private": true,
@@ -59,6 +59,7 @@
     "graphql": "^16.6.0",
     "graphql-upload": "^16.0.1",
     "langchain": "^0.2.2",
+    "langsmith": "^0.1.66",
     "mammoth": "^1.7.2",
     "officeparser": "^4.1.1",
     "pdf-parse": "^1.1.1",

src/callout.handlers/base.ts

@@ -38,6 +38,7 @@ export const baseHandler = async (
 
   const result: Document[] = [
     new Document({
+      id: documentId,
       pageContent,
       metadata: {
         documentId,
@@ -63,6 +64,7 @@ export const baseHandler = async (
         generateDocument(docLike);
       result.push(
         new Document({
+          id: documentId,
           pageContent,
           metadata: {
             documentId,

src/callout.handlers/index.ts

@@ -3,7 +3,7 @@ import { Callout, CalloutType } from '../generated/graphql';
 import { Document } from 'langchain/document';
 import { baseHandler } from './base';
 import { linkCollectionHandler } from './link.collection';
-import { AlkemioCliClient } from 'src/graphql.client/AlkemioCliClient';
+import { AlkemioCliClient } from '../graphql.client/AlkemioCliClient';
 
 const handlersMap: Record<
   CalloutType,

src/data.readers/knowledge.base.ts

@@ -0,0 +1,41 @@
+import generateDocument from '../generate.document';
+import { Document } from 'langchain/document';
+import { IngestBodyOfKnowledge } from '../event.bus/events/ingest.body.of.knowledge';
+import { AlkemioCliClient } from '../graphql.client/AlkemioCliClient';
+import { processCallouts } from '../process.callouts';
+import { Callout } from '../generated/graphql';
+
+export const embedKnowledgeBase = async (
+  event: IngestBodyOfKnowledge,
+  alkemioClient: AlkemioCliClient
+) => {
+  const knowledgeBaseId = event.bodyOfKnowledgeId;
+  // make sure the service user has sufficient priviliges
+  const knowledgeBase = await alkemioClient.ingestKnowledgeBase(
+    knowledgeBaseId
+  );
+  const documents: Document[] = [];
+  const { documentId, source, pageContent, type, title } =
+    generateDocument(knowledgeBase);
+
+  documents.push(
+    new Document({
+      id: documentId,
+      pageContent,
+      metadata: {
+        documentId,
+        source,
+        type,
+        title,
+      },
+    })
+  );
+
+  const calloutDocs = await processCallouts(
+    (knowledgeBase.calloutsSet?.callouts || []) as Partial<Callout>[],
+    alkemioClient
+  );
+  documents.push(...calloutDocs);
+
+  return { bodyOfKnowledge: knowledgeBase, documents };
+};

src/space.embed/process.space.tree.ts → src/data.readers/process.space.tree.ts

@@ -1,11 +1,11 @@
 import { Document } from 'langchain/document';
 
-import { CalloutVisibility, Callout, Space } from '../generated/graphql';
+import { Space } from '../generated/graphql';
 
-import logger from '../logger';
 import generateDocument from '../generate.document';
-import { handleCallout } from '../callout.handlers';
 import { AlkemioCliClient } from '../graphql.client/AlkemioCliClient';
+import { processCallouts } from '../process.callouts';
+
 // recursive function
 // first invocation is with [rootSpace]
 // second invocation is with rootSpace.subspaces
@@ -21,6 +21,7 @@ export const processSpaceTree = async (
       generateDocument(subspace);
     documents.push(
       new Document({
+        id: documentId,
         pageContent,
         metadata: {
           documentId,
@@ -30,21 +31,11 @@ export const processSpaceTree = async (
         },
       })
     );
-
-    for (let j = 0; j < (subspace.collaboration?.callouts || []).length; j++) {
-      const callout = (subspace.collaboration?.callouts || [])[j];
-      if (callout && callout.visibility === CalloutVisibility.Published) {
-        const document = await handleCallout(
-          callout as Partial<Callout>,
-          logger,
-          alkemioClient
-        );
-        // empty doc - nothing to do here
-        if (document) {
-          documents.push(...document);
-        }
-      }
-    }
+    const calloutDocs = await processCallouts(
+      subspace.collaboration?.calloutsSet?.callouts || [],
+      alkemioClient
+    );
+    documents.push(...calloutDocs);
 
     // incoke recursively for the subspaces of the rootSpace
     const subspacesDocs = await processSpaceTree(

src/data.readers/space.ts

@@ -0,0 +1,23 @@
+import { Document } from 'langchain/document';
+
+import { Space } from '../generated/graphql';
+
+import { AlkemioCliClient } from '../graphql.client/AlkemioCliClient';
+import { processSpaceTree } from './process.space.tree';
+import { IngestBodyOfKnowledge } from 'src/event.bus/events/ingest.body.of.knowledge';
+import { ReadResult } from './types';
+
+export const embedSpace = async (
+  event: IngestBodyOfKnowledge,
+  alkemioClient: AlkemioCliClient
+): Promise<ReadResult> => {
+  const spaceId = event.bodyOfKnowledgeId;
+  // make sure the service user has sufficient priviliges
+  const space = await alkemioClient.ingestSpace(spaceId);
+  const documents: Document[] = await processSpaceTree(
+    [space as Partial<Space>],
+    alkemioClient
+  );
+
+  return { bodyOfKnowledge: space, documents };
+};

src/data.readers/types.d.ts

@@ -0,0 +1,9 @@
+export declare type BodyOfKnowledgeReadResult = {
+  id: string;
+  profile: { displayName: string; url: string };
+};
+
+export declare type ReadResult = {
+  documents?: Document[];
+  bodyOfKnowledge?: BodyOfKnowledgeReadResult;
+};