@squidcloud/client 1.0.293 → 1.0.295

package/dist/internal-common/src/public-types/ai-matchmaking.types.d.ts

@@ -0,0 +1,38 @@
+import { AiContextMetadata } from './ai-chatbot.public-types';
+/**
+ * Represents a category in the matchmaker.
+ * The description is used by the AI to extract features from the content.
+ */
+export interface MmCategory {
+    id: string;
+    description: string;
+}
+/**
+ * Represents a matchmaker entity for a given category.
+ * The metadata is used to filter the entities when finding matches.
+ */
+export interface MmEntity {
+    id: string;
+    content: string;
+    categoryId: string;
+    metadata: AiContextMetadata;
+}
+/**
+ * Represents a matchmaker.
+ * The description is used to describe the matchmaker and by the AI to better understand the domain.
+ * The two categories represent the two types of entities that can be matched.
+ */
+export interface MmMatchMaker {
+    id: string;
+    description: string;
+    firstCategory: MmCategory;
+    secondCategory: MmCategory;
+}
+/**
+ * Represents a matchmaker entity match. A high score indicates a good match.
+ */
+export interface MmEntityMatch extends MmEntity {
+    /** The score of the match between 0 and 100 - 100 represents best match. */
+    score: number;
+    reasoning: string;
+}

package/dist/typescript-client/src/ai-matchmaking-client.d.ts

@@ -0,0 +1,37 @@
+import { RpcManager } from './rpc.manager';
+import { AiContextMetadataFilter } from '../../internal-common/src/public-types/ai-chatbot.public-types';
+import { MmEntity, MmEntityMatch, MmMatchMaker } from '../../internal-common/src/public-types/ai-matchmaking.types';
+/**
+ * Client for the AI Matchmaking service. This service allows you to create matchmakers and insert entities into them.
+ * The service will then find matches for the entities.
+ */
+export declare class AiMatchMakingClient {
+    private readonly rpcManager;
+    constructor(rpcManager: RpcManager);
+    /**
+     * Creates a new matchmaker with the given id, description, and categories.
+     * @param matchMaker The matchmaker to create.
+     */
+    createMatchMaker(matchMaker: MmMatchMaker): Promise<MatchMaker>;
+    /**
+     * Retrieves an existing matchmaker by its ID.
+     */
+    getMatchMaker(matchMakerId: string): MatchMaker;
+    listMatchMakers(): Promise<Array<MmMatchMaker>>;
+}
+/**
+ * Represents a matchmaker. You can insert entities into the matchmaker and find matches for them.
+ */
+export declare class MatchMaker {
+    id: string;
+    private readonly rpcManager;
+    /** Adds a new entity to the matchmaker. */
+    insertEntity(entity: MmEntity): Promise<void>;
+    delete(): Promise<void>;
+    deleteEntity(entityId: string): Promise<void>;
+    /** Finds matches for the given entity id. */
+    findMatches(entityId: string, metadataFilter?: AiContextMetadataFilter): Promise<Array<MmEntityMatch>>;
+    /** Finds matches for the given entity. */
+    findMatchesForEntity(entity: Omit<MmEntity, 'metadata' | 'id'>, metadataFilter?: AiContextMetadataFilter): Promise<Array<MmEntityMatch>>;
+    listEntities(categoryId: string, metadataFilter?: AiContextMetadataFilter): Promise<Array<MmEntity>>;
+}

package/dist/typescript-client/src/ai.types.d.ts

@@ -3,6 +3,7 @@ import { AiAssistantClient } from './ai-assistant-client';
 import { ApiOptions, IntegrationId } from './public-types';
 import { AiImageClient } from './ai-image-client';
 import { AiAudioClient } from './ai-audio-client';
+import { AiMatchMakingClient } from './ai-matchmaking-client';
 export interface ExecuteAiQueryRequest {
     integrationId: IntegrationId;
     prompt: string;
@@ -77,6 +78,10 @@ export declare class AiClient {
      * Retrieves an AI audio client.
      */
     audio(): AiAudioClient;
+    /**
+     * Retrieves an AI match-making client.
+     */
+    matchMaking(): AiMatchMakingClient;
     /**
      * Executes an AI query using a specific DB integration, sending a prompt to the AI and returning its response.
      * This function allows for direct interaction with the AI's capabilities by sending text prompts and receiving

package/dist/typescript-client/src/index.d.ts

@@ -46,3 +46,4 @@ export * from './storage-client';
 export * from './personal-storage-client';
 export * from './extraction-client';
 export * from './file-utils';
+export * from './ai-matchmaking-client';

package/dist/typescript-client/src/public-types.d.ts

@@ -23,3 +23,4 @@ export * from '../../internal-common/src/public-types/socket.public-types';
 export * from '../../internal-common/src/public-types/storage.types';
 export * from '../../internal-common/src/public-types/typescript.public-types';
 export * from '../../internal-common/src/public-types/extraction.public-types';
+export * from '../../internal-common/src/public-types/ai-matchmaking.types';

package/dist/typescript-client/src/version.d.ts

@@ -1 +1 @@
-export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.293";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.295";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.293",
+  "version": "1.0.295",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "types": "dist/typescript-client/src/index.d.ts",