V2 api (#33)

* swith ask mode to v2 API

* swith ask stream to v2 API

* swith search mode to v2 API

* upgrade client version to v1

Author: augustas1

package.json

@@ -1,6 +1,6 @@
 {
   "name": "weaviate-agents",
-  "version": "0.1.4",
+  "version": "1.0.0",
   "description": "JS/TS client for Weaviate Agents",
   "exports": "./dist/index.js",
   "type": "module",

src/query/agent.test.ts

@@ -108,30 +108,22 @@ it("search-only mode success: caches searches and sends on subsequent request",
   const capturedBodies: ApiSearchModeResponse[] = [];
 
   const apiSuccess: ApiSearchModeResponse = {
-    original_query: "Test this search only mode!",
     searches: [
       {
-        queries: ["search query"],
-        filters: [
-          [
-            {
-              filter_type: "integer",
-              property_name: "test_property",
-              operator: ComparisonOperator.GreaterThan,
-              value: 0,
-            },
-          ],
-        ],
-        filter_operators: "AND",
+        query: "search query",
+        filters: {
+          filter_type: "integer",
+          property_name: "test_property",
+          operator: ComparisonOperator.GreaterThan,
+          value: 0,
+        },
         collection: "test_collection",
       },
     ],
     usage: {
-      requests: 0,
-      request_tokens: undefined,
-      response_tokens: undefined,
-      total_tokens: undefined,
-      details: undefined,
+      model_units: 1,
+      usage_in_plan: true,
+      remaining_plan_requests: 2,
     },
     total_time: 1.5,
     search_results: {
@@ -200,30 +192,22 @@ it("search-only mode success: caches searches and sends on subsequent request",
     collections: ["test_collection"],
   });
   expect(first).toMatchObject({
-    originalQuery: apiSuccess.original_query,
     searches: [
       {
         collection: "test_collection",
-        queries: ["search query"],
-        filters: [
-          [
-            {
-              filterType: "integer",
-              propertyName: "test_property",
-              operator: ComparisonOperator.GreaterThan,
-              value: 0,
-            },
-          ],
-        ],
-        filterOperators: "AND",
+        query: "search query",
+        filters: {
+          filterType: "integer",
+          propertyName: "test_property",
+          operator: ComparisonOperator.GreaterThan,
+          value: 0,
+        },
       },
     ],
     usage: {
-      requests: 0,
-      requestTokens: undefined,
-      responseTokens: undefined,
-      totalTokens: undefined,
-      details: undefined,
+      modelUnits: 1,
+      usageInPlan: true,
+      remainingPlanRequests: 2,
     },
     totalTime: 1.5,
     searchResults: {
@@ -266,7 +250,6 @@ it("search-only mode success: caches searches and sends on subsequent request",
   expect(capturedBodies[1].searches).toEqual(apiSuccess.searches);
   // Response mapping should be the same (because response is mocked)
   expect(second).toMatchObject({
-    originalQuery: apiSuccess.original_query,
     searches: first.searches,
     usage: first.usage,
     totalTime: first.totalTime,

src/query/agent.ts

@@ -3,12 +3,13 @@ import {
   QueryAgentResponse,
   ProgressMessage,
   StreamedTokens,
+  AskModeResponse,
 } from "./response/response.js";
 import {
   mapResponse,
   mapProgressMessageFromSSE,
   mapStreamedTokensFromSSE,
-  mapResponseFromSSE,
+  mapAskModeResponse,
 } from "./response/response-mapping.js";
 import { mapApiResponse } from "./response/api-response-mapping.js";
 import { fetchServerSentEvents } from "./response/server-sent-events.js";
@@ -109,11 +110,11 @@ export class QueryAgent {
   async ask(
     query: QueryAgentQuery,
     { collections }: QueryAgentAskOptions = {},
-  ): Promise<QueryAgentResponse> {
+  ): Promise<AskModeResponse> {
     const targetCollections = this.validateCollections(collections);
     const { requestHeaders, connectionHeaders } = await getHeaders(this.client);
 
-    const response = await fetch(`${this.agentsHost}/agent/query`, {
+    const response = await fetch(`${this.agentsHost}/query/ask`, {
       method: "POST",
       headers: requestHeaders,
       body: JSON.stringify({
@@ -128,7 +129,7 @@ export class QueryAgent {
       await handleError(await response.text());
     }
 
-    return mapResponse(await response.json());
+    return mapAskModeResponse(await response.json());
   }
 
   /**
@@ -221,7 +222,7 @@ export class QueryAgent {
       } else if (event.event === "streamed_tokens") {
         output = mapStreamedTokensFromSSE(event);
       } else if (event.event === "final_state") {
-        output = mapResponseFromSSE(event);
+        output = mapResponse(JSON.parse(event.data));
       } else {
         throw new Error(`Unexpected event type: ${event.event}: ${event.data}`);
       }
@@ -250,7 +251,7 @@ export class QueryAgent {
       includeProgress: false;
       includeFinalState?: true;
     },
-  ): AsyncGenerator<StreamedTokens | QueryAgentResponse>;
+  ): AsyncGenerator<StreamedTokens | AskModeResponse>;
   askStream(
     query: QueryAgentQuery,
     options: QueryAgentAskStreamOptions & {
@@ -264,15 +265,15 @@ export class QueryAgent {
       includeProgress?: true;
       includeFinalState?: true;
     },
-  ): AsyncGenerator<ProgressMessage | StreamedTokens | QueryAgentResponse>;
+  ): AsyncGenerator<ProgressMessage | StreamedTokens | AskModeResponse>;
   async *askStream(
     query: QueryAgentQuery,
     {
       collections,
       includeProgress,
       includeFinalState,
     }: QueryAgentAskStreamOptions = {},
-  ): AsyncGenerator<ProgressMessage | StreamedTokens | QueryAgentResponse> {
+  ): AsyncGenerator<ProgressMessage | StreamedTokens | AskModeResponse> {
     const targetCollections = collections ?? this.collections;
 
     if (!targetCollections) {
@@ -283,7 +284,7 @@ export class QueryAgent {
       await this.client.getConnectionDetails();
 
     const sseStream = fetchServerSentEvents(
-      `${this.agentsHost}/agent/stream_query`,
+      `${this.agentsHost}/query/stream_ask`,
       {
         method: "POST",
         headers: {
@@ -308,13 +309,13 @@ export class QueryAgent {
         await handleError(event.data);
       }
 
-      let output: ProgressMessage | StreamedTokens | QueryAgentResponse;
+      let output: ProgressMessage | StreamedTokens | AskModeResponse;
       if (event.event === "progress_message") {
         output = mapProgressMessageFromSSE(event);
       } else if (event.event === "streamed_tokens") {
         output = mapStreamedTokensFromSSE(event);
       } else if (event.event === "final_state") {
-        output = mapResponseFromSSE(event);
+        output = mapAskModeResponse(JSON.parse(event.data));
       } else {
         throw new Error(`Unexpected event type: ${event.event}: ${event.data}`);
       }

src/query/response/api-response.ts

@@ -8,6 +8,41 @@ import {
   ComparisonOperator,
 } from "./response.js";
 
+export type ApiAskModeResponse = {
+  searches: ApiSearch[];
+  aggregations: ApiAggregation[];
+  usage: ApiModelUnitUsage;
+  total_time: number;
+  is_partial_answer?: boolean;
+  missing_information?: string[];
+  final_answer: string;
+  sources?: ApiSource[];
+};
+
+export type ApiSearch = {
+  query?: string;
+  filters?: ApiPropertyFilter | ApiFilterAndOr;
+  collection: string;
+};
+
+export type ApiAggregation = {
+  groupby_property?: string;
+  aggregation: ApiPropertyAggregation;
+  filters?: ApiPropertyFilter | ApiFilterAndOr;
+  collection: string;
+};
+
+export type ApiFilterAndOr = {
+  combine: "AND" | "OR";
+  filters: (ApiPropertyFilter | ApiFilterAndOr)[];
+};
+
+export type ApiModelUnitUsage = {
+  model_units: number;
+  usage_in_plan: boolean;
+  remaining_plan_requests: number;
+};
+
 export type ApiQueryAgentResponse = {
   original_query: string;
   collection_names: string[];
@@ -212,9 +247,8 @@ export type ApiWeaviateReturn = {
 };
 
 export type ApiSearchModeResponse = {
-  original_query: string;
-  searches?: ApiSearchResult[];
-  usage: ApiUsage;
+  searches?: ApiSearch[];
+  usage: ApiModelUnitUsage;
   total_time: number;
   search_results: ApiWeaviateReturn;
 };