Merge pull request #74 from weaviate/add-hybrid-fusion-support

Add hybrid fusion type support

Author: antas-marcin

src/graphql/getter.test.ts

@@ -1,4 +1,4 @@
-import Getter from './getter';
+import Getter, { FusionType } from './getter';
 import { WhereFilter } from '../openapi/types';
 import { NearObjectArgs } from './nearObject';
 import { AskArgs } from './ask';
@@ -1242,6 +1242,19 @@ describe('hybrid valid searchers', () => {
 
     expect(mockClient.query).toHaveBeenCalledWith(expectedQuery);
   });
+
+  test('query and alpha 0 and fusionType', () => {
+    const subQuery = `(hybrid:{query:"accountant",alpha:0,fusionType:rankedFusion})`;
+    const expectedQuery = `{Get{Person` + subQuery + `{name}}}`;
+
+    new Getter(mockClient)
+      .withClassName('Person')
+      .withFields('name')
+      .withHybrid({ query: 'accountant', alpha: 0, fusionType: FusionType.rankedFusion })
+      .do();
+
+    expect(mockClient.query).toHaveBeenCalledWith(expectedQuery);
+  });
 });
 
 describe('generative search', () => {

src/graphql/getter.ts

@@ -15,6 +15,7 @@ import { GenerateArgs, GraphQLGenerate } from './generate';
 import { ConsistencyLevel } from '../data';
 import GroupBy, { GroupByArgs } from './groupBy';
 
+export { FusionType } from './hybrid';
 export default class GraphQLGetter extends CommandBase {
   private after?: string;
   private askString?: string;

src/graphql/hybrid.ts

@@ -3,19 +3,27 @@ export interface HybridArgs {
   query: string;
   vector?: number[];
   properties?: string[];
+  fusionType?: FusionType;
+}
+
+export enum FusionType {
+  rankedFusion = 'rankedFusion',
+  relativeScoreFusion = 'relativeScoreFusion',
 }
 
 export default class GraphQLHybrid {
   private alpha?: number;
   private query: string;
   private vector?: number[];
   private properties?: string[];
+  private fusionType?: FusionType;
 
   constructor(args: HybridArgs) {
     this.alpha = args.alpha;
     this.query = args.query;
     this.vector = args.vector;
     this.properties = args.properties;
+    this.fusionType = args.fusionType;
   }
 
   toString() {
@@ -34,6 +42,10 @@ export default class GraphQLHybrid {
       args = [...args, `properties:["${props}"]`];
     }
 
+    if (this.fusionType !== undefined) {
+      args = [...args, `fusionType:${this.fusionType}`];
+    }
+
     return `{${args.join(',')}}`;
   }
 }

src/graphql/index.ts

@@ -25,3 +25,4 @@ export { default as Aggregator } from './aggregator';
 export { default as GraphQLGetter } from './getter';
 export { default as Explorer } from './explorer';
 export { default as Raw } from './raw';
+export { FusionType } from './getter';

src/graphql/journey.test.ts

@@ -9,6 +9,7 @@ import weaviate, {
   Tenant,
   ReferenceCreator,
 } from '..';
+import { FusionType } from './hybrid';
 
 describe('the graphql journey', () => {
   let client: WeaviateClient;
@@ -372,6 +373,41 @@ describe('the graphql journey', () => {
       });
   });
 
+  test('graphql get hybrid with query, alpha, properties and fushionType: rankedFusion', () => {
+    return client.graphql
+      .get()
+      .withClassName('Article')
+      .withHybrid({ query: 'Apple', properties: ['title'], alpha: 0, fusionType: FusionType.rankedFusion })
+      .withFields('_additional { id }')
+      .do()
+      .then((res: any) => {
+        expect(res.data.Get.Article.length).toBe(1);
+      })
+      .catch((e: any) => {
+        throw new Error('it should not have errord' + e);
+      });
+  });
+
+  test('graphql get hybrid with query, alpha, properties and fushionType: relativeScoreFusion', () => {
+    return client.graphql
+      .get()
+      .withClassName('Article')
+      .withHybrid({
+        query: 'Apple',
+        properties: ['title'],
+        alpha: 0,
+        fusionType: FusionType.relativeScoreFusion,
+      })
+      .withFields('_additional { id }')
+      .do()
+      .then((res: any) => {
+        expect(res.data.Get.Article.length).toBe(1);
+      })
+      .catch((e: any) => {
+        throw new Error('it should not have errord' + e);
+      });
+  });
+
   test('graphql get with nearText (with certainty)', () => {
     return client.graphql
       .get()