@relevanceai/sdk 3.0.0-alpha.4 → 3.0.0-alpha.6

package/script/message/task.d.ts

@@ -2,7 +2,10 @@ import type { AgentMessage } from "./agent.js";
 import type { AgentErrorMessage } from "./agent-error.js";
 import type { ToolMessage } from "./tool.js";
 import type { UserMessage } from "./user.js";
-export type AnyTaskMessage = AgentMessage | AgentErrorMessage | ToolMessage | UserMessage;
+import type { WorkforceAgentMessage } from "./workforce-agent.js";
+import type { WorkforceAgentHandoverMessage } from "./workforce-agent-handover.js";
+export type AnyTaskMessage = AgentMessage | AgentErrorMessage | ToolMessage | UserMessage | WorkforceAgentMessage | WorkforceAgentHandoverMessage;
+export type TaskMessageType = AnyTaskMessage["type"];
 interface MessageContent {
     type: AnyTaskMessage["type"];
 }
@@ -11,13 +14,13 @@ export interface TaskMessageData<C extends MessageContent = MessageContent> {
     insert_date_: string;
     content: C;
 }
-export declare abstract class TaskMessage<C extends MessageContent = MessageContent> {
+export declare abstract class GenericMessage<C extends MessageContent = MessageContent> {
     protected readonly message: TaskMessageData<C>;
     constructor(message: TaskMessageData<C>);
     /**
      * The task's message type.
      *
-     * @property {"agent-error" | "agent-message" | "tool-run" | "user-message"}
+     * @property {TaskMessageType}
      */
     get type(): C["type"];
     /**
@@ -37,6 +40,24 @@ export declare abstract class TaskMessage<C extends MessageContent = MessageCont
      *
      * @returns {boolean}
      */
-    isAgent(): boolean;
+    isAgent(): this is AgentMessage;
+    /**
+     * Returns if the message is from a tool.
+     *
+     * @returns {boolean}
+     */
+    isTool(): this is ToolMessage;
+    /**
+     * Returns if the message was sent from a user.
+     *
+     * @returns {boolean}
+     */
+    isUser(): this is UserMessage;
+    /**
+     * Returns if the message was an error sent by the agent.
+     *
+     * @returns {boolean}
+     */
+    isAgentError(): this is AgentErrorMessage;
 }
 export {};

package/script/message/task.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TaskMessage = void 0;
-class TaskMessage {
+exports.GenericMessage = void 0;
+class GenericMessage {
     message;
     constructor(message) {
         this.message = message;
@@ -9,7 +9,7 @@ class TaskMessage {
     /**
      * The task's message type.
      *
-     * @property {"agent-error" | "agent-message" | "tool-run" | "user-message"}
+     * @property {TaskMessageType}
      */
     get type() {
         return this.message.content.type;
@@ -38,5 +38,29 @@ class TaskMessage {
     isAgent() {
         return this.type === "agent-message";
     }
+    /**
+     * Returns if the message is from a tool.
+     *
+     * @returns {boolean}
+     */
+    isTool() {
+        return this.type === "tool-run";
+    }
+    /**
+     * Returns if the message was sent from a user.
+     *
+     * @returns {boolean}
+     */
+    isUser() {
+        return this.type === "user-message";
+    }
+    /**
+     * Returns if the message was an error sent by the agent.
+     *
+     * @returns {boolean}
+     */
+    isAgentError() {
+        return this.type === "agent-error";
+    }
 }
-exports.TaskMessage = TaskMessage;
+exports.GenericMessage = GenericMessage;

package/script/message/tool.d.ts

@@ -1,8 +1,12 @@
+import type { JSONSchema4 } from "json-schema";
 import type { Region } from "../region.js";
-import { TaskMessage } from "./task.js";
+import { GenericMessage, type TaskMessageData } from "./task.js";
+import { Tool } from "../tool.js";
+type ToolState = "cancelled" | "error" | "finished" | "pending" | "running";
+export type ToolStatus = "cancelled" | "error" | "completed" | "pending" | "running";
 export interface ToolMessageContent {
     type: "tool-run";
-    tool_run_state: "cancelled" | "error" | "finished" | "pending" | "running";
+    tool_run_state: ToolState;
     output: Record<string, unknown> & {
         _agent_conversation_details?: {
             agent_id: string;
@@ -19,19 +23,25 @@ export interface ToolMessageContent {
         step_name: string;
     }[];
     tool_config: {
-        id: string;
-        type: "tool" | "agent";
+        type: "agent" | "tool";
+        title: string;
+        description: string;
         region: Region;
         project: string;
+        id: string;
+        emoji?: string;
+        params_schema: JSONSchema4;
     };
 }
-export declare class ToolMessage extends TaskMessage<ToolMessageContent> {
+export declare class ToolMessage extends GenericMessage<ToolMessageContent> {
+    readonly tool?: Tool;
+    constructor(message: TaskMessageData<ToolMessageContent>);
     /**
      * The tool status for _this_ message.
      *
-     * @property {"cancelled" | "error" | "finished" | "pending" | "running"}
+     * @property {ToolStatus}
      */
-    get status(): "cancelled" | "error" | "finished" | "pending" | "running";
+    get status(): ToolStatus;
     /**
      * Parameters used to call the tool.
      *
@@ -55,16 +65,16 @@ export declare class ToolMessage extends TaskMessage<ToolMessageContent> {
         message: string;
     }[];
     /**
-     * The tool's ID.
+     * The tool or agent ID.
      *
      * @property {string}
      */
-    get toolId(): string;
+    get toolOrAgentId(): string;
     /**
      * The agent's ID, if a sub-agent.
      *
      * @property {string}
-     * @see {@link ToolMessage.isSubAgent}
+     * @see {@link ToolMessage#isSubAgent}
      */
     get agentId(): string | null;
     /**
@@ -80,8 +90,8 @@ export declare class ToolMessage extends TaskMessage<ToolMessageContent> {
      */
     get region(): Region;
     /**
-     * The task ID the sub-agent ran. Will be `null` if the tool message is not
-     * a sub-agent.
+     * The task ID the subagent ran. Will be `null` if the tool message is not
+     * a subagent.
      *
      * @property {string}
      * @see {@link ToolMessage.isSubAgent}
@@ -105,4 +115,12 @@ export declare class ToolMessage extends TaskMessage<ToolMessageContent> {
      * @returns {boolean}
      */
     hasErrors(): boolean;
+    /**
+     * Checks if the tool message is currently running. Note that pending tools
+     * are also classified as running as they are just scheduled for running.
+     *
+     * @returns {boolean}
+     */
+    isRunning(): boolean;
 }
+export {};

package/script/message/tool.js

@@ -2,14 +2,35 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ToolMessage = void 0;
 const task_js_1 = require("./task.js");
-class ToolMessage extends task_js_1.TaskMessage {
+const tool_js_1 = require("../tool.js");
+class ToolMessage extends task_js_1.GenericMessage {
+    tool;
+    constructor(message) {
+        super(message);
+        if (message.content.tool_config.type === "tool") {
+            const { id, ...config } = message.content.tool_config;
+            this.tool = new tool_js_1.Tool({ studio_id: id, ...config });
+        }
+        // @todo: subagent
+    }
     /**
      * The tool status for _this_ message.
      *
-     * @property {"cancelled" | "error" | "finished" | "pending" | "running"}
+     * @property {ToolStatus}
      */
+    // deno-lint-ignore getter-return
     get status() {
-        return this.message.content.tool_run_state;
+        const status = this.message.content.tool_run_state;
+        switch (status) {
+            case "cancelled":
+            case "pending":
+            case "running":
+            case "error":
+                return status;
+            // agents and tools have different end statuses, align them
+            case "finished":
+                return "completed";
+        }
     }
     /**
      * Parameters used to call the tool.
@@ -25,7 +46,7 @@ class ToolMessage extends task_js_1.TaskMessage {
      * @property {object|null}
      */
     get output() {
-        return this.status === "finished" ? this.message.content.output : null;
+        return this.status === "completed" ? this.message.content.output : null;
     }
     /**
      * Tool errors.
@@ -40,18 +61,18 @@ class ToolMessage extends task_js_1.TaskMessage {
         }));
     }
     /**
-     * The tool's ID.
+     * The tool or agent ID.
      *
      * @property {string}
      */
-    get toolId() {
+    get toolOrAgentId() {
         return this.message.content.tool_config.id;
     }
     /**
      * The agent's ID, if a sub-agent.
      *
      * @property {string}
-     * @see {@link ToolMessage.isSubAgent}
+     * @see {@link ToolMessage#isSubAgent}
      */
     get agentId() {
         return this.isSubAgent()
@@ -75,8 +96,8 @@ class ToolMessage extends task_js_1.TaskMessage {
         return this.message.content.tool_config.region;
     }
     /**
-     * The task ID the sub-agent ran. Will be `null` if the tool message is not
-     * a sub-agent.
+     * The task ID the subagent ran. Will be `null` if the tool message is not
+     * a subagent.
      *
      * @property {string}
      * @see {@link ToolMessage.isSubAgent}
@@ -109,5 +130,20 @@ class ToolMessage extends task_js_1.TaskMessage {
     hasErrors() {
         return this.message.content.errors.length > 0;
     }
+    /**
+     * Checks if the tool message is currently running. Note that pending tools
+     * are also classified as running as they are just scheduled for running.
+     *
+     * @returns {boolean}
+     */
+    isRunning() {
+        switch (this.status) {
+            case "pending":
+            case "running":
+                return true;
+            default:
+                return false;
+        }
+    }
 }
 exports.ToolMessage = ToolMessage;

package/script/message/user.d.ts

@@ -1,10 +1,15 @@
-import { TaskMessage } from "./task.js";
+import type { Attachment } from "../client.js";
+import { GenericMessage } from "./task.js";
 export interface UserMessageContent {
+    attachments?: {
+        file_url: string;
+        file_name: string;
+    }[];
     type: "user-message";
     text: string;
     is_trigger_message: boolean;
 }
-export declare class UserMessage extends TaskMessage<UserMessageContent> {
+export declare class UserMessage extends GenericMessage<UserMessageContent> {
     /**
      * The message as text sent.
      *
@@ -17,4 +22,16 @@ export declare class UserMessage extends TaskMessage<UserMessageContent> {
      * @returns {boolean}
      */
     isTrigger(): boolean;
+    /**
+     * The attachments sent with the message.
+     *
+     * @property {Attachment[]}
+     */
+    get attachments(): Attachment[];
+    /**
+     * Returns if the message has attachments.
+     *
+     * @returns {boolean}
+     */
+    hasAttachments(): boolean;
 }

package/script/message/user.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UserMessage = void 0;
 const task_js_1 = require("./task.js");
-class UserMessage extends task_js_1.TaskMessage {
+class UserMessage extends task_js_1.GenericMessage {
     /**
      * The message as text sent.
      *
@@ -19,5 +19,24 @@ class UserMessage extends task_js_1.TaskMessage {
     isTrigger() {
         return this.message.content.is_trigger_message;
     }
+    /**
+     * The attachments sent with the message.
+     *
+     * @property {Attachment[]}
+     */
+    get attachments() {
+        return (this.message.content.attachments?.map(({ file_name, file_url }) => ({
+            fileName: file_name,
+            fileUrl: file_url,
+        })) ?? []);
+    }
+    /**
+     * Returns if the message has attachments.
+     *
+     * @returns {boolean}
+     */
+    hasAttachments() {
+        return this.attachments.length > 0;
+    }
 }
 exports.UserMessage = UserMessage;

package/script/message/workforce-agent-handover.d.ts

@@ -0,0 +1,23 @@
+import { GenericMessage } from "./task.js";
+export interface WorkforceAgentHandoverMessageContent {
+    type: "workforce-agent-handover";
+    task_details?: {
+        project: string;
+        region: string;
+        conversation_id: string;
+    };
+    agent_details: {
+        agent_id: string;
+        project: string;
+        region: string;
+        name?: string;
+        emoji?: string;
+        description?: string;
+        deleted_reason?: "entity_deleted";
+    };
+    trigger: {
+        message: string;
+    };
+}
+export declare class WorkforceAgentHandoverMessage extends GenericMessage<WorkforceAgentHandoverMessageContent> {
+}

package/script/message/workforce-agent-handover.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkforceAgentHandoverMessage = void 0;
+const task_js_1 = require("./task.js");
+class WorkforceAgentHandoverMessage extends task_js_1.GenericMessage {
+}
+exports.WorkforceAgentHandoverMessage = WorkforceAgentHandoverMessage;

package/script/message/workforce-agent.d.ts

@@ -0,0 +1,23 @@
+import type { AgentTaskState } from "../agent.js";
+import { GenericMessage } from "./task.js";
+export interface WorkforceAgentMessageContent {
+    type: "workforce-agent-run";
+    task_details: {
+        project: string;
+        region: string;
+        conversation_id: string;
+        finished_state?: AgentTaskState;
+        current_state?: AgentTaskState;
+    };
+    agent_details?: {
+        agent_id: string;
+        project: string;
+        region: string;
+        name?: string;
+        emoji?: string;
+        description?: string;
+        deleted_reason?: "entity_deleted";
+    };
+}
+export declare class WorkforceAgentMessage extends GenericMessage<WorkforceAgentMessageContent> {
+}

package/script/message/workforce-agent.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkforceAgentMessage = void 0;
+const task_js_1 = require("./task.js");
+class WorkforceAgentMessage extends task_js_1.GenericMessage {
+}
+exports.WorkforceAgentMessage = WorkforceAgentMessage;

package/script/mod.d.ts

@@ -1,10 +1,6 @@
 export { Agent } from "./agent.js";
-export { Client, createClient } from "./client.js";
+export { type Attachment, Client, createClient } from "./client.js";
 export { Key } from "./key.js";
 export { type Region, REGION_AU, REGION_EU, REGION_US } from "./region.js";
-export { Task, type TaskStatus } from "./task.js";
-export type { AgentErrorMessage } from "./message/agent-error.js";
-export type { AgentMessage } from "./message/agent.js";
-export type { ToolMessage } from "./message/tool.js";
-export type { UserMessage } from "./message/user.js";
-export type { AnyTaskMessage } from "./message/task.js";
+export { Workforce } from "./workforce.js";
+export type { Task } from "./task/task.js";

package/script/mod.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Task = exports.REGION_US = exports.REGION_EU = exports.REGION_AU = exports.Key = exports.createClient = exports.Client = exports.Agent = void 0;
+exports.Workforce = exports.REGION_US = exports.REGION_EU = exports.REGION_AU = exports.Key = exports.createClient = exports.Client = exports.Agent = void 0;
 var agent_js_1 = require("./agent.js");
 Object.defineProperty(exports, "Agent", { enumerable: true, get: function () { return agent_js_1.Agent; } });
 var client_js_1 = require("./client.js");
@@ -12,5 +12,5 @@ var region_js_1 = require("./region.js");
 Object.defineProperty(exports, "REGION_AU", { enumerable: true, get: function () { return region_js_1.REGION_AU; } });
 Object.defineProperty(exports, "REGION_EU", { enumerable: true, get: function () { return region_js_1.REGION_EU; } });
 Object.defineProperty(exports, "REGION_US", { enumerable: true, get: function () { return region_js_1.REGION_US; } });
-var task_js_1 = require("./task.js");
-Object.defineProperty(exports, "Task", { enumerable: true, get: function () { return task_js_1.Task; } });
+var workforce_js_1 = require("./workforce.js");
+Object.defineProperty(exports, "Workforce", { enumerable: true, get: function () { return workforce_js_1.Workforce; } });

package/script/task/agent-strategy.d.ts

@@ -0,0 +1,26 @@
+import { type Agent, type AgentTaskState } from "../agent.js";
+import { Client } from "../client.js";
+import type { AnyTaskMessage } from "../message/task.js";
+import { Task, type TaskMetadata, type TaskStrategy } from "./task.js";
+export type AgentTaskMetadata = {
+    knowledge_set: string;
+    insert_date: string;
+    update_date: string;
+    conversation: {
+        created_by_user_id: string;
+        state: AgentTaskState;
+        title: string;
+    };
+};
+export declare class AgentStrategy implements TaskStrategy<Agent> {
+    static get(id: string, agent: Agent, client?: Client): Promise<Task<Agent>>;
+    private readonly id;
+    private readonly agent;
+    private readonly client;
+    constructor(id: string, agent: Agent, client: Client);
+    get subject(): Agent;
+    getMetadata(): Promise<TaskMetadata>;
+    getMessages({ after }?: {
+        after?: Date;
+    }): Promise<AnyTaskMessage[]>;
+}

package/script/task/agent-strategy.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AgentStrategy = void 0;
+const agent_js_1 = require("../agent.js");
+const client_js_1 = require("../client.js");
+const agent_error_js_1 = require("../message/agent-error.js");
+const agent_js_2 = require("../message/agent.js");
+const tool_js_1 = require("../message/tool.js");
+const user_js_1 = require("../message/user.js");
+const task_js_1 = require("./task.js");
+class AgentStrategy {
+    static async get(id, agent, client = client_js_1.Client.default()) {
+        const subject = new this(id, agent, client);
+        return new task_js_1.Task(await subject.getMetadata(), subject);
+    }
+    id;
+    agent;
+    client;
+    constructor(id, agent, client) {
+        this.id = id;
+        this.agent = agent;
+        this.client = client;
+    }
+    get subject() {
+        return this.agent;
+    }
+    async getMetadata() {
+        const { metadata } = await this.client.fetch(`/agents/${this.agent.id}/tasks/${this.id}/metadata`);
+        return {
+            id: this.id,
+            region: this.client.region,
+            project: this.client.project,
+            name: metadata.conversation.title,
+            status: (0, agent_js_1.stateToStatus)(metadata.conversation.state),
+            createdAt: new Date(metadata.insert_date),
+            updatedAt: new Date(metadata.update_date),
+        };
+    }
+    async getMessages({ after = new Date(0) } = {}) {
+        const url = `/agents/${this.agent.id}/tasks/${this.id}/view`;
+        const res = await this.client.fetch(url, {
+            method: "POST",
+            body: JSON.stringify({
+                page_size: 1_000, // @todo: pagination
+                cursor: {
+                    after: after.toISOString(),
+                },
+            }),
+        });
+        // message should be in ascending order
+        return res.results.reverse().map((data) => {
+            switch (data.content.type) {
+                case "agent-error":
+                    return new agent_error_js_1.AgentErrorMessage(data);
+                case "agent-message":
+                    return new agent_js_2.AgentMessage(data);
+                case "tool-run":
+                    return new tool_js_1.ToolMessage(data);
+                case "user-message":
+                    return new user_js_1.UserMessage(data);
+                default:
+                    throw new Error("unknown message response");
+            }
+        });
+    }
+}
+exports.AgentStrategy = AgentStrategy;

package/script/task/task.d.ts

@@ -0,0 +1,59 @@
+import { Emitter } from "../emitter.js";
+import type { AnyTaskMessage } from "../message/task.js";
+import type { Region } from "../region.js";
+import type { Workforce } from "../workforce.js";
+import type { Agent } from "../agent.js";
+import type { AgentErrorMessage } from "../message/agent-error.js";
+export type TaskStatus = "not-started" | "idle" | "paused" | "queued" | "running" | "action" | "completed" | "cancelled" | "error";
+export interface TaskMetadata {
+    id: string;
+    region: Region;
+    project: string;
+    status: TaskStatus;
+    name: string;
+    createdAt: Date;
+    updatedAt: Date;
+}
+type TaskEventMap = {
+    updated: undefined;
+    message: {
+        message: AnyTaskMessage;
+    };
+    error: {
+        message: AgentErrorMessage;
+    };
+};
+export interface TaskStrategy<S> {
+    subject: S;
+    getMessages(options?: {
+        after?: Date;
+    }): Promise<AnyTaskMessage[]>;
+    getMetadata(): Promise<TaskMetadata>;
+}
+export declare const resetBackoffDuration: unique symbol;
+export declare class Task<S extends Agent | Workforce, E extends TaskEventMap = TaskEventMap> extends Emitter<E> {
+    #private;
+    private subscribed;
+    private backoff;
+    private backoffDuration;
+    private readonly strategy;
+    constructor(metadata: TaskMetadata, strategy: TaskStrategy<S>);
+    get subject(): S;
+    get id(): string;
+    get region(): Region;
+    get project(): string;
+    get name(): string;
+    get status(): TaskStatus;
+    get createdAt(): Date;
+    get updatedAt(): Date;
+    getMessages(options?: {
+        after?: Date;
+    }): Promise<AnyTaskMessage[]>;
+    isRunning(): boolean;
+    unsubscribe(): void;
+    [resetBackoffDuration](): void;
+    addEventListener<K extends keyof E>(type: Extract<K, string>, listener: ((event: CustomEvent<E[K]>) => void) | {
+        handleEvent: (event: CustomEvent<E[K]>) => void;
+    } | null, options?: boolean | AddEventListenerOptions): void;
+}
+export {};