Package (#2)

* prepare package for publishing

* add jscods

* bump node version

Author: augustas1

README.md

@@ -0,0 +1,9 @@
+# Weaviate Agents JS/TS client <img alt='Weaviate logo' src='https://weaviate.io/img/site/weaviate-logo-light.png' width='148' align='right' />
+
+JS/TS client for Weaviate Agents.
+
+<br>
+
+> ⚠️ **Alpha Release**: Weaviate Agents is currently in alpha and is subject to change. Features may be modified or removed without notice. Please check that you are using the latest version of the package.
+
+[Documentation](https://weaviate.io/developers/agents)

package.json

@@ -4,16 +4,27 @@
   "description": "JS/TS client for Weaviate Agents",
   "exports": "./dist/index.js",
   "type": "module",
+  "engines": {
+    "node": ">=20.0.0"
+  },
   "scripts": {
-    "build": "tsc"
+    "build": "tsc",
+    "prepack": "pnpm build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/weaviate/agents-typescript-client.git"
   },
   "keywords": [
     "weaviate"
   ],
   "author": "Weaviate",
   "license": "SEE LICENSE IN LICENSE",
+  "files": [
+    "dist"
+  ],
   "peerDependencies": {
-    "weaviate-client": "^3.5.2"
+    "weaviate-client": "^3.5.4"
   },
   "devDependencies": {
     "typescript": "^5.8.3"

src/query/agent.ts

@@ -2,10 +2,26 @@ import { WeaviateClient } from "weaviate-client";
 import { QueryAgentResponse } from "./response/response.js";
 import { mapResponse } from "./response/response-mapping.js";
 
+/**
+ * An agent for executing agentic queries against Weaviate.
+ *
+ * Warning:
+ * Weaviate Agents - Query Agent is an early stage alpha product.
+ * The API is subject to breaking changes. Please ensure you are using the latest version of the client.
+ *
+ * For more information, see the [Weaviate Query Agent Docs](https://weaviate.io/developers/agents/query)
+ */
 export class QueryAgent {
   private systemPrompt?: string;
   private agentsHost: string;
 
+  /**
+   * Creates a new QueryAgent instance.
+   *
+   * @param client - The Weaviate client instance.
+   * @param collections - The collections to query.
+   * @param options - Additional options for the QueryAgent.
+   */
   constructor(
     private client: WeaviateClient,
     private collections: string[],
@@ -18,6 +34,13 @@ export class QueryAgent {
     this.agentsHost = agentsHost;
   }
 
+  /**
+   * Run the query agent.
+   *
+   * @param query - The natural language query string for the agent.
+   * @param options - Additional options for the run.
+   * @returns The response from the query agent.
+   */
   async run(
     query: string,
     { viewProperties }: QueryAgentRunOptions = {}
@@ -51,11 +74,16 @@ export class QueryAgent {
   }
 }
 
+/** Options for the QueryAgent. */
 export type QueryAgentOptions = {
+  /** System prompt to guide the agent's behavior. */
   systemPrompt?: string;
+  /** Host of the agents service. */
   agentsHost?: string;
 };
 
+/** Options for the QueryAgent run. */
 export type QueryAgentRunOptions = {
+  /** List of of property names the agent has the ability to view across all collections. */
   viewProperties?: string[];
 };

src/query/response/response.ts

@@ -32,14 +32,17 @@ type PropertyFilterBase = {
   operator: ComparisonOperator;
 };
 
+/** Filter numeric properties using comparison operators */
 export type IntegerPropertyFilter = PropertyFilterBase & {
   value: number;
 };
 
+/** Filter text properties using equality or LIKE operators */
 export type TextPropertyFilter = PropertyFilterBase & {
   value: string;
 };
 
+/** Filter boolean properties using equality operators */
 export type BooleanPropertyFilter = PropertyFilterBase & {
   value: boolean;
 };
@@ -54,6 +57,12 @@ export enum ComparisonOperator {
   Like = "LIKE",
 }
 
+/**
+ * The aggregations performed on a collection in a vector database.
+ *
+ * They should be based on the original user query and can include multiple
+ * aggregations across different properties and metrics.
+ */
 export type AggregationResult = {
   collection: string;
   searchQuery?: string;
@@ -71,15 +80,18 @@ type PropertyAggregationBase = {
   propertyName: string;
 };
 
+/** Aggregate numeric properties using statistical functions */
 export type IntegerPropertyAggregation = PropertyAggregationBase & {
   metrics: NumericMetrics;
 };
 
+/** Aggregate text properties using frequency analysis */
 export type TextPropertyAggregation = PropertyAggregationBase & {
   metrics: TextMetrics;
   topOccurrencesLimit?: number;
 };
 
+/** Aggregate boolean properties using statistical functions */
 export type BooleanPropertyAggregation = PropertyAggregationBase & {
   metrics: BooleanMetrics;
 };