@cognizant-ai-lab/ui-common 1.3.3

package/dist/controller/agent/Agent.js

@@ -0,0 +1,162 @@
+/*
+Copyright 2025 Cognizant Technology Solutions Corp, www.cognizant.com.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+/**
+ * Controller module for interacting with the Agent LLM API.
+ */
+import { ApiPaths, 
+// eslint-disable-next-line camelcase
+ChatFilterChat_filter_type, ChatMessageType, } from "../../generated/neuro-san/NeuroSanClient.js";
+import { sendLlmRequest } from "../llm/LlmChat.js";
+/**
+ * Insert the target agent name into the path. The paths Api enum contains values like:
+ * <code>"/api/v1/{agent_name}/connectivity"</code> so unfortunately we need to do a replace() to insert the target
+ * agent.
+ * @param agent The agent to send the request to.
+ * @param path The API path to insert the target agent into.
+ * @returns The path with the target agent name inserted.
+ */
+const insertTargetAgent = (agent, path) => {
+    return path.replace("{agent_name}", agent);
+};
+/**
+ * Test connection for a neuro-san server.
+ * @param url The neuro-san server URL.
+ * @returns A boolean indicating whether the connection was successful.
+ */
+export async function testConnection(url) {
+    const controller = new AbortController();
+    const timeout = setTimeout(() => controller.abort(), 2500); // 2.5s timeout
+    try {
+        const response = await fetch(url, { signal: controller.signal });
+        if (!response.ok) {
+            return { success: false, status: response.statusText };
+        }
+        const jsonResponse = await response.json();
+        // eslint-disable-next-line no-shadow
+        const status = jsonResponse?.status;
+        // Different versions of the server return different status values, so we need to check for both.
+        const success = status === "healthy" || status === "ok";
+        // For now, just capture the Neuro-san version since that's all the server returns. More can be added later.
+        const version = jsonResponse?.versions?.["neuro-san"];
+        return { success, status, version };
+    }
+    catch (error) {
+        const errorMessage = error instanceof Error ? error.message : String(error);
+        return { success: false, status: errorMessage };
+    }
+    finally {
+        clearTimeout(timeout);
+    }
+}
+/**
+ * Get the list of available agent networks from the concierge service.
+ * @param url The neuro-san server URL
+ * @returns A promise that resolves to an array of agent network names.
+ */
+export async function getAgentNetworks(url) {
+    const path = `${url}${ApiPaths.ConciergeService_List}`;
+    const response = await fetch(path);
+    const conciergeResponse = (await response.json());
+    return conciergeResponse.agents.map((network) => network.agent_name);
+}
+// Function to split each chunk by newline and call the real callback. The server can send multiple JSON objects per
+// chunk delimited by newline.
+function handleJsonLines(chunk, callback) {
+    chunk.split("\n").forEach((line) => {
+        const trimmed = line.trim();
+        if (trimmed) {
+            callback(trimmed);
+        }
+    });
+}
+/**
+ * Send a chat query to the Agent LLM API. This opens a session with the agent network..
+ * @param url The neuro-san server URL
+ * @param signal The AbortSignal to use for the request. Used to cancel the request on user demand
+ * @param userInput The user input to send to the agent.
+ * In practice this "input" will actually be the output from one of the previous agents such as the data generator
+ * or scoping agent.
+ * @param targetAgent The target agent to send the request to. See CombinedAgentType for the list of available agents.
+ * @param callback The callback function to be called when a chunk of data is received from the server.
+ * @param chatContext "Opaque" conversation context for maintaining conversation state with the server. Neuro-san
+ * agents do not use ChatHistory directly, but rather, ChatContext, which is a collection of ChatHistory objects.
+ * @param slyData Data items that should not be send to the LLM. Generated by the server.
+ * @param userId Current user ID in the session.
+ * @returns The response from the agent network.
+ */
+export async function sendChatQuery(url, signal, userInput, targetAgent, callback, chatContext, slyData, userId) {
+    // Create request
+    const userMessage = {
+        type: ChatMessageType.HUMAN,
+        text: userInput,
+    };
+    const agentChatRequest = {
+        sly_data: slyData,
+        user_message: userMessage,
+        // eslint-disable-next-line camelcase
+        chat_filter: { chat_filter_type: ChatFilterChat_filter_type.MAXIMAL },
+        chat_context: chatContext,
+    };
+    const fetchUrl = `${url}${insertTargetAgent(targetAgent, ApiPaths.AgentService_StreamingChat)}`;
+    const requestRecord = Object.entries(agentChatRequest).reduce((acc, [key, value]) => (value ? { ...acc, [key]: value } : acc), {});
+    return sendLlmRequest((chunk) => handleJsonLines(chunk, callback), signal, fetchUrl, requestRecord, null, null, userId);
+}
+/**
+ * Gets information on the agent and tool connections within a network
+ * @param url The neuro-san server URL
+ * @param network The network to get connectivity information for
+ * @param userId Current user ID in the session.
+ * @returns The connectivity info as a <code>ConnectivityResponse</code> object
+ * @throws Various exceptions if anything goes wrong such as network issues or invalid agent type.
+ * Caller is responsible for try-catch.
+ */
+export async function getConnectivity(url, network, userId) {
+    const fetchUrl = `${url}${insertTargetAgent(network, ApiPaths.AgentService_Connectivity)}`;
+    const response = await fetch(fetchUrl, {
+        method: "GET",
+        headers: {
+            "Content-Type": "application/json",
+            user_id: userId,
+        },
+    });
+    if (!response.ok) {
+        console.debug(`response: ${JSON.stringify(response)}`);
+        throw new Error(`Failed to send connectivity request: ${response.statusText}`);
+    }
+    return response.json();
+}
+/**
+ * Get the function of a specified agent meaning its brief description
+ * @param url The neuro-san server URL
+ * @param agent The agent to get the function for
+ * @param userId Current user ID in the session.
+ * @returns The function info as a <code>FunctionResponse</code> object
+ * @throws Various exceptions if anything goes wrong such as network issues or invalid agent type.
+ */
+export async function getAgentFunction(url, agent, userId) {
+    const fetchUrl = `${url}${insertTargetAgent(agent, ApiPaths.AgentService_Function)}`;
+    const response = await fetch(fetchUrl, {
+        method: "GET",
+        headers: {
+            "Content-Type": "application/json",
+            user_id: userId,
+        },
+    });
+    if (!response.ok) {
+        throw new Error(`Failed to send agent function request: ${response.statusText}`);
+    }
+    return response.json();
+}

package/dist/controller/llm/LlmChat.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generic controller class for allowing the user to chat with LLMs.
+ * Allows streaming callback for a more interactive experience.
+ */
+import { BaseMessage } from "@langchain/core/messages";
+/**
+ * Send a request to an LLM and stream the response to a callback.
+ * @param callback The callback function to be called when a chunk of data is received from the server.
+ * @param signal The AbortSignal object to be used for aborting the request.
+ * @param fetchUrl The URL to send the request to.
+ * @param params Arbitrary parameters to send to the server.
+ * @param userQuery The user query to send to the server (sometimes part of chat history instead).
+ * @param chatHistory The chat history to be sent to the server. Contains user requests and server responses.
+ * @param userId Current user ID in the session.
+ * @returns Either the JSON result of the call, or, if a callback is provided, nothing, but tokens are streamed
+ * to the callback as they are received from the server.
+ */
+export declare function sendLlmRequest(callback: (token: string) => void, signal: AbortSignal, fetchUrl: string, params: Record<string, unknown>, userQuery?: string, chatHistory?: BaseMessage[], userId?: string): Promise<any>;

package/dist/controller/llm/LlmChat.js

@@ -0,0 +1,65 @@
+/*
+Copyright 2025 Cognizant Technology Solutions Corp, www.cognizant.com.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+/**
+ * Send a request to an LLM and stream the response to a callback.
+ * @param callback The callback function to be called when a chunk of data is received from the server.
+ * @param signal The AbortSignal object to be used for aborting the request.
+ * @param fetchUrl The URL to send the request to.
+ * @param params Arbitrary parameters to send to the server.
+ * @param userQuery The user query to send to the server (sometimes part of chat history instead).
+ * @param chatHistory The chat history to be sent to the server. Contains user requests and server responses.
+ * @param userId Current user ID in the session.
+ * @returns Either the JSON result of the call, or, if a callback is provided, nothing, but tokens are streamed
+ * to the callback as they are received from the server.
+ */
+export async function sendLlmRequest(callback, signal, fetchUrl, params, userQuery, chatHistory, userId) {
+    const res = await fetch(fetchUrl, {
+        method: "POST",
+        headers: {
+            Accept: "application/json",
+            "Content-Type": "application/json",
+            ...(userId && { user_id: userId }), // Only include user query if it exists (optional)
+        },
+        body: JSON.stringify({
+            ...(chatHistory && { chatHistory }), // Only include chat history if it exists (optional)
+            ...(userQuery && { userQuery }), // Only include user query if it exists (optional)
+            ...params,
+        }),
+        signal,
+    });
+    // Check if the request was successful
+    if (!res.ok) {
+        throw new Error(`Failed to fetch: ${res.statusText} error code ${res.status}`);
+    }
+    if (callback) {
+        const reader = res.body.getReader();
+        const utf8decoder = new TextDecoder("utf8");
+        while (true) {
+            const { done, value } = await reader.read();
+            if (done) {
+                break; // End of stream
+            }
+            // Decode chunk from server
+            const chunk = utf8decoder.decode(value);
+            // Send current chunk to callback
+            callback(chunk);
+        }
+        return null;
+    }
+    else {
+        return res.json();
+    }
+}

package/dist/controller/llm/endpoints.d.ts

@@ -0,0 +1 @@
+export declare const CHATBOT_ENDPOINT = "/api/gpt/chatBot";

package/dist/controller/llm/endpoints.js

@@ -0,0 +1,17 @@
+/*
+Copyright 2025 Cognizant Technology Solutions Corp, www.cognizant.com.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+// Temporarily not used pending migration from Pinecone to pgvector
+export const CHATBOT_ENDPOINT = "/api/gpt/chatBot";