@memberjunction/ai-cohere 0.0.1 → 3.3.0

package/dist/index.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @memberjunction/ai-cohere
+ *
+ * Cohere AI provider for MemberJunction.
+ * Currently provides reranking capabilities using Cohere's Rerank API.
+ *
+ * Supported models:
+ * - rerank-v3.5: Latest English reranker with best accuracy
+ * - rerank-multilingual-v3.0: Supports 100+ languages
+ *
+ * API Key:
+ * Set via environment variable: AI_VENDOR_API_KEY__COHERELLM
+ *
+ * Usage:
+ * ```typescript
+ * import { LoadCohereReranker } from '@memberjunction/ai-cohere';
+ *
+ * // Ensure class registration
+ * LoadCohereReranker();
+ *
+ * // Create instance via ClassFactory
+ * const reranker = ClassFactory.CreateInstance<BaseReranker>(
+ *     BaseReranker,
+ *     'CohereLLM',
+ *     apiKey,
+ *     'rerank-v3.5'
+ * );
+ *
+ * const response = await reranker.Rerank({
+ *     query: 'What is the capital of France?',
+ *     documents: [
+ *         { id: '1', text: 'Paris is the capital of France.' },
+ *         { id: '2', text: 'London is in England.' }
+ *     ],
+ *     topK: 5
+ * });
+ * ```
+ */
+export { CohereReranker, createCohereReranker, LoadCohereReranker } from './models/CohereReranker';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAEH,OAAO,EACH,cAAc,EACd,oBAAoB,EACpB,kBAAkB,EACrB,MAAM,yBAAyB,CAAC"}

package/dist/index.js

@@ -0,0 +1,46 @@
+"use strict";
+/**
+ * @memberjunction/ai-cohere
+ *
+ * Cohere AI provider for MemberJunction.
+ * Currently provides reranking capabilities using Cohere's Rerank API.
+ *
+ * Supported models:
+ * - rerank-v3.5: Latest English reranker with best accuracy
+ * - rerank-multilingual-v3.0: Supports 100+ languages
+ *
+ * API Key:
+ * Set via environment variable: AI_VENDOR_API_KEY__COHERELLM
+ *
+ * Usage:
+ * ```typescript
+ * import { LoadCohereReranker } from '@memberjunction/ai-cohere';
+ *
+ * // Ensure class registration
+ * LoadCohereReranker();
+ *
+ * // Create instance via ClassFactory
+ * const reranker = ClassFactory.CreateInstance<BaseReranker>(
+ *     BaseReranker,
+ *     'CohereLLM',
+ *     apiKey,
+ *     'rerank-v3.5'
+ * );
+ *
+ * const response = await reranker.Rerank({
+ *     query: 'What is the capital of France?',
+ *     documents: [
+ *         { id: '1', text: 'Paris is the capital of France.' },
+ *         { id: '2', text: 'London is in England.' }
+ *     ],
+ *     topK: 5
+ * });
+ * ```
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LoadCohereReranker = exports.createCohereReranker = exports.CohereReranker = void 0;
+var CohereReranker_1 = require("./models/CohereReranker");
+Object.defineProperty(exports, "CohereReranker", { enumerable: true, get: function () { return CohereReranker_1.CohereReranker; } });
+Object.defineProperty(exports, "createCohereReranker", { enumerable: true, get: function () { return CohereReranker_1.createCohereReranker; } });
+Object.defineProperty(exports, "LoadCohereReranker", { enumerable: true, get: function () { return CohereReranker_1.LoadCohereReranker; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;;;AAEH,0DAIiC;AAH7B,gHAAA,cAAc,OAAA;AACd,sHAAA,oBAAoB,OAAA;AACpB,oHAAA,kBAAkB,OAAA"}

package/dist/models/CohereReranker.d.ts

@@ -0,0 +1,58 @@
+import { BaseReranker, RerankParams, RerankResult } from '@memberjunction/ai';
+/**
+ * Cohere implementation of the BaseReranker class.
+ * Uses Cohere's Rerank API for semantic document reranking.
+ *
+ * Supported models:
+ * - rerank-v3.5: Latest English reranker with best accuracy
+ * - rerank-multilingual-v3.0: Supports 100+ languages
+ *
+ * API Key:
+ * Set via environment variable: AI_VENDOR_API_KEY__COHERELLM
+ *
+ * Usage:
+ * ```typescript
+ * const reranker = ClassFactory.CreateInstance<BaseReranker>(
+ *     BaseReranker,
+ *     'CohereReranker',
+ *     apiKey,
+ *     'rerank-v3.5'
+ * );
+ *
+ * const response = await reranker.Rerank({
+ *     query: 'What is the capital of France?',
+ *     documents: [
+ *         { id: '1', text: 'Paris is the capital of France.' },
+ *         { id: '2', text: 'London is in England.' }
+ *     ],
+ *     topK: 5
+ * });
+ * ```
+ */
+export declare class CohereReranker extends BaseReranker {
+    private _client;
+    /**
+     * Create a new CohereReranker instance.
+     * @param apiKey - Cohere API key
+     * @param modelName - Model to use (default: 'rerank-v3.5')
+     */
+    constructor(apiKey: string, modelName?: string);
+    /**
+     * Rerank documents using Cohere's Rerank API.
+     *
+     * The Cohere API returns results sorted by relevance with scores from 0-1.
+     * We map the response to our RerankResult format, preserving document metadata.
+     */
+    protected doRerank(params: RerankParams): Promise<RerankResult[]>;
+}
+/**
+ * Factory function to create a CohereReranker with default model.
+ * Convenience function for simple usage.
+ */
+export declare function createCohereReranker(apiKey: string, modelName?: string): CohereReranker;
+/**
+ * Ensure the CohereReranker class is loaded for tree-shaking prevention.
+ * Import this function in your module's entry point.
+ */
+export declare function LoadCohereReranker(): void;
+//# sourceMappingURL=CohereReranker.d.ts.map

package/dist/models/CohereReranker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CohereReranker.d.ts","sourceRoot":"","sources":["../../src/models/CohereReranker.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAG9E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBACa,cAAe,SAAQ,YAAY;IAC5C,OAAO,CAAC,OAAO,CAAe;IAE9B;;;;OAIG;gBACS,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM;IAM9C;;;;;OAKG;cACa,QAAQ,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;CAwD1E;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,cAAc,CAEvF;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,IAAI,IAAI,CAGzC"}

package/dist/models/CohereReranker.js

@@ -0,0 +1,133 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LoadCohereReranker = exports.createCohereReranker = exports.CohereReranker = void 0;
+const global_1 = require("@memberjunction/global");
+const ai_1 = require("@memberjunction/ai");
+const cohere_ai_1 = require("cohere-ai");
+/**
+ * Cohere implementation of the BaseReranker class.
+ * Uses Cohere's Rerank API for semantic document reranking.
+ *
+ * Supported models:
+ * - rerank-v3.5: Latest English reranker with best accuracy
+ * - rerank-multilingual-v3.0: Supports 100+ languages
+ *
+ * API Key:
+ * Set via environment variable: AI_VENDOR_API_KEY__COHERELLM
+ *
+ * Usage:
+ * ```typescript
+ * const reranker = ClassFactory.CreateInstance<BaseReranker>(
+ *     BaseReranker,
+ *     'CohereReranker',
+ *     apiKey,
+ *     'rerank-v3.5'
+ * );
+ *
+ * const response = await reranker.Rerank({
+ *     query: 'What is the capital of France?',
+ *     documents: [
+ *         { id: '1', text: 'Paris is the capital of France.' },
+ *         { id: '2', text: 'London is in England.' }
+ *     ],
+ *     topK: 5
+ * });
+ * ```
+ */
+let CohereReranker = class CohereReranker extends ai_1.BaseReranker {
+    /**
+     * Create a new CohereReranker instance.
+     * @param apiKey - Cohere API key
+     * @param modelName - Model to use (default: 'rerank-v3.5')
+     */
+    constructor(apiKey, modelName) {
+        super(apiKey, modelName || 'rerank-v3.5');
+        // Use inherited protected apiKey getter from BaseModel
+        this._client = new cohere_ai_1.CohereClient({ token: this.apiKey });
+    }
+    /**
+     * Rerank documents using Cohere's Rerank API.
+     *
+     * The Cohere API returns results sorted by relevance with scores from 0-1.
+     * We map the response to our RerankResult format, preserving document metadata.
+     */
+    async doRerank(params) {
+        // Build enhanced query with context about what makes memory notes relevant
+        const enhancedQuery = `You are evaluating agent memory notes for relevance to a user message.
+
+Key principles for scoring relevance:
+- User identity notes (name, preferences) are almost ALWAYS relevant, especially for greetings
+- Memory notes provide context that COULD be useful, not just direct matches
+- Preferences should be applied whenever the topic might come up
+- Context notes help maintain continuity across conversations
+
+The user's current message is: "${params.query}"
+
+Find memory notes that would help respond appropriately to this message.`;
+        // DEBUG: Log request with ALL documents
+        console.log('CohereReranker REQUEST:', JSON.stringify({
+            model: this._modelName,
+            originalQuery: params.query,
+            enhancedQuery: enhancedQuery.substring(0, 200) + '...',
+            documentCount: params.documents.length,
+            topK: params.topK,
+            allDocs: params.documents.map((d, i) => `[${i}] ${d.text.substring(0, 80)}...`)
+        }, null, 2));
+        // Call Cohere's rerank endpoint with enhanced query
+        const response = await this._client.rerank({
+            model: this._modelName,
+            query: enhancedQuery,
+            documents: params.documents.map(d => d.text),
+            topN: params.topK || params.documents.length,
+            returnDocuments: false // We track documents ourselves to preserve metadata
+        });
+        // DEBUG: Log response
+        console.log('CohereReranker RESPONSE:', JSON.stringify({
+            resultCount: response.results.length,
+            results: response.results.slice(0, 5).map(r => ({
+                index: r.index,
+                relevanceScore: r.relevanceScore
+            }))
+        }, null, 2));
+        // Map Cohere results to our format
+        // Cohere returns results already sorted by relevance
+        const results = response.results.map((result, idx) => {
+            const originalDoc = params.documents[result.index];
+            return {
+                id: originalDoc.id,
+                relevanceScore: result.relevanceScore,
+                document: originalDoc,
+                rank: idx
+            };
+        });
+        return results;
+    }
+};
+exports.CohereReranker = CohereReranker;
+exports.CohereReranker = CohereReranker = __decorate([
+    (0, global_1.RegisterClass)(ai_1.BaseReranker, 'CohereLLM')
+], CohereReranker);
+/**
+ * Factory function to create a CohereReranker with default model.
+ * Convenience function for simple usage.
+ */
+function createCohereReranker(apiKey, modelName) {
+    return new CohereReranker(apiKey, modelName);
+}
+exports.createCohereReranker = createCohereReranker;
+/**
+ * Ensure the CohereReranker class is loaded for tree-shaking prevention.
+ * Import this function in your module's entry point.
+ */
+function LoadCohereReranker() {
+    // This function exists to ensure the class registration occurs
+    // when the module is imported, preventing tree-shaking from removing it
+}
+exports.LoadCohereReranker = LoadCohereReranker;
+//# sourceMappingURL=CohereReranker.js.map

package/dist/models/CohereReranker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CohereReranker.js","sourceRoot":"","sources":["../../src/models/CohereReranker.ts"],"names":[],"mappings":";;;;;;;;;AAAA,mDAAuD;AACvD,2CAA8E;AAC9E,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEI,IAAM,cAAc,GAApB,MAAM,cAAe,SAAQ,iBAAY;IAG5C;;;;OAIG;IACH,YAAY,MAAc,EAAE,SAAkB;QAC1C,KAAK,CAAC,MAAM,EAAE,SAAS,IAAI,aAAa,CAAC,CAAC;QAC1C,uDAAuD;QACvD,IAAI,CAAC,OAAO,GAAG,IAAI,wBAAY,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,QAAQ,CAAC,MAAoB;QACzC,2EAA2E;QAC3E,MAAM,aAAa,GAAG;;;;;;;;kCAQI,MAAM,CAAC,KAAK;;yEAE2B,CAAC;QAElE,wCAAwC;QACxC,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,IAAI,CAAC,SAAS,CAAC;YAClD,KAAK,EAAE,IAAI,CAAC,UAAU;YACtB,aAAa,EAAE,MAAM,CAAC,KAAK;YAC3B,aAAa,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,KAAK;YACtD,aAAa,EAAE,MAAM,CAAC,SAAS,CAAC,MAAM;YACtC,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,OAAO,EAAE,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC;SAClF,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAEb,oDAAoD;QACpD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;YACvC,KAAK,EAAE,IAAI,CAAC,UAAU;YACtB,KAAK,EAAE,aAAa;YACpB,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;YAC5C,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM;YAC5C,eAAe,EAAE,KAAK,CAAC,oDAAoD;SAC9E,CAAC,CAAC;QAEH,sBAAsB;QACtB,OAAO,CAAC,GAAG,CAAC,0BAA0B,EAAE,IAAI,CAAC,SAAS,CAAC;YACnD,WAAW,EAAE,QAAQ,CAAC,OAAO,CAAC,MAAM;YACpC,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;gBAC5C,KAAK,EAAE,CAAC,CAAC,KAAK;gBACd,cAAc,EAAE,CAAC,CAAC,cAAc;aACnC,CAAC,CAAC;SACN,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAEb,mCAAmC;QACnC,qDAAqD;QACrD,MAAM,OAAO,GAAmB,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;YACjE,MAAM,WAAW,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACnD,OAAO;gBACH,EAAE,EAAE,WAAW,CAAC,EAAE;gBAClB,cAAc,EAAE,MAAM,CAAC,cAAc;gBACrC,QAAQ,EAAE,WAAW;gBACrB,IAAI,EAAE,GAAG;aACZ,CAAC;QACN,CAAC,CAAC,CAAC;QAEH,OAAO,OAAO,CAAC;IACnB,CAAC;CACJ,CAAA;AA5EY,wCAAc;yBAAd,cAAc;IAD1B,IAAA,sBAAa,EAAC,iBAAY,EAAE,WAAW,CAAC;GAC5B,cAAc,CA4E1B;AAED;;;GAGG;AACH,SAAgB,oBAAoB,CAAC,MAAc,EAAE,SAAkB;IACnE,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AACjD,CAAC;AAFD,oDAEC;AAED;;;GAGG;AACH,SAAgB,kBAAkB;IAC9B,+DAA+D;IAC/D,wEAAwE;AAC5E,CAAC;AAHD,gDAGC"}

package/package.json

@@ -1,10 +1,31 @@
 {
   "name": "@memberjunction/ai-cohere",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for @memberjunction/ai-cohere",
-  "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
+  "version": "3.3.0",
+  "description": "MemberJunction: Cohere AI Provider - Semantic reranking using Cohere's Rerank API",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "scripts": {
+    "start": "ts-node-dev src/index.ts",
+    "build": "tsc",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "MemberJunction.com",
+  "license": "ISC",
+  "dependencies": {
+    "@memberjunction/ai": "3.3.0",
+    "@memberjunction/global": "3.3.0",
+    "cohere-ai": "^7.14.0"
+  },
+  "devDependencies": {
+    "@types/node": "20.14.2",
+    "ts-node-dev": "^2.0.0",
+    "typescript": "^5.4.5"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MemberJunction/MJ"
+  }
 }

package/README.md

@@ -1,45 +0,0 @@
-# @memberjunction/ai-cohere
-
-## ⚠️ IMPORTANT NOTICE ⚠️
-
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
-
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
-
-## Purpose
-
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@memberjunction/ai-cohere`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
-
-## What is OIDC Trusted Publishing?
-
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
-
-## Setup Instructions
-
-To properly configure OIDC trusted publishing for this package:
-
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
-
-## DO NOT USE THIS PACKAGE
-
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
-
-## More Information
-
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
-
----
-
-**Maintained for OIDC setup purposes only**