@stack-spot/portal-network 0.101.0 → 0.102.0

package/src/api/agent.ts

@@ -37,16 +37,32 @@ export type NewAgentRequest = {
     "type": AgentType;
     llm_config?: (LlmConfigRequestPart) | null;
     knowledge_sources_config?: (KnowledgeSourcesConfigRequestPart) | null;
+    builtin_tools_ids?: string[];
+    detail_mode?: boolean;
 };
 export type ViolationResponse = {
     field?: string;
     message?: string;
 };
+export type WorkspaceListRequest = {
+    agentIds?: string[];
+    name?: string;
+};
+export type Uuid = string;
 export type WorkspaceForkRequest = {
     agentIds?: string[];
+    memberId?: Uuid;
 };
 export type WorkspaceForkResponse = {
-    ids?: string[];
+    agentIds?: string[];
+    agentIdsAccount?: string[];
+    ksIds?: string[];
+    ksIdsAccount?: string[];
+    errorIds?: string[];
+};
+export type WorkspaceDeleteRequest = {
+    agentIds?: string[];
+    isRollback?: boolean;
 };
 export type LlmConfigResponse = {
     model_slug: string;
@@ -74,6 +90,21 @@ export type KnowledgeSourceResponse = {
     knowledge_sources_details?: KnowledgeSourceDetailResponse[];
 };
 export type ZonedDateTime = string;
+export type BuiltinToolResponse = {
+    id?: string;
+    name?: string;
+    description?: string;
+};
+export type BuiltinToolkitResponse = {
+    id?: string;
+    name?: string;
+    description?: string;
+    image_url?: string;
+    tools?: BuiltinToolResponse[];
+};
+export type ToolkitsInAgentResponse = {
+    builtins?: BuiltinToolkitResponse[];
+};
 export type ModifiedAgentRequest = {
     name?: string | null;
     slug?: string | null;
@@ -85,6 +116,8 @@ export type ModifiedAgentRequest = {
     llm_config?: (LlmConfigRequestPart) | null;
     knowledge_sources_config?: (KnowledgeSourcesConfigRequestPart) | null;
     use_only?: boolean | null;
+    builtin_tools_ids?: string[];
+    detail_mode?: boolean | null;
 };
 export type ForkAgentRequest = {
     slug?: string;
@@ -113,6 +146,8 @@ export type AgentResponse = {
     created_at: ZonedDateTime;
     updated_by?: string;
     updated_at?: ZonedDateTime;
+    toolkits?: ToolkitsInAgentResponse;
+    detail_mode?: boolean;
 };
 /**
  * Creates a new AI Agent.
@@ -156,6 +191,75 @@ export function postV1Agent({ newAgentRequest }: {
         body: newAgentRequest
     })));
 }
+/**
+ * List Workspace Fork AI agents.
+ */
+export function postV1AgentDependencies({ workspaceListRequest }: {
+    workspaceListRequest?: WorkspaceListRequest;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 201;
+        data: Blob;
+    } | {
+        status: 500;
+        data: {
+            code?: string;
+            details?: string;
+            additionalInformation?: {
+                [key: string]: any;
+            } | null;
+        };
+    }>("/v1/agent/dependencies", oazapfts.json({
+        ...opts,
+        method: "POST",
+        body: workspaceListRequest
+    })));
+}
+/**
+ * List agents with specific KS
+ */
+export function getV1AgentKnowledgeSourceById({ id }: {
+    id: string;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: Blob;
+    } | {
+        status: 500;
+        data: {
+            code?: string;
+            details?: string;
+            additionalInformation?: {
+                [key: string]: any;
+            } | null;
+        };
+    }>(`/v1/agent/knowledge-source/${encodeURIComponent(id)}`, {
+        ...opts
+    }));
+}
+/**
+ * Disassociate KS from Agent
+ */
+export function deleteV1AgentKnowledgeSourceById({ id }: {
+    id: string;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 204;
+        data: Blob;
+    } | {
+        status: 500;
+        data: {
+            code?: string;
+            details?: string;
+            additionalInformation?: {
+                [key: string]: any;
+            } | null;
+        };
+    }>(`/v1/agent/knowledge-source/${encodeURIComponent(id)}`, {
+        ...opts,
+        method: "DELETE"
+    }));
+}
 /**
  * Workspace Fork AI agents.
  */
@@ -174,7 +278,7 @@ export function postV1AgentWorkspaceFork({ workspaceForkRequest }: {
                 [key: string]: any;
             } | null;
         };
-    }>("/v1/agent/workspace-fork", oazapfts.json({
+    }>("/v1/agent/workspace/fork", oazapfts.json({
         ...opts,
         method: "POST",
         body: workspaceForkRequest
@@ -183,8 +287,8 @@ export function postV1AgentWorkspaceFork({ workspaceForkRequest }: {
 /**
  * Delete Workspace Fork AI agents.
  */
-export function deleteV1AgentWorkspaceFork({ workspaceForkRequest }: {
-    workspaceForkRequest?: WorkspaceForkRequest;
+export function deleteV1AgentWorkspaceFork({ workspaceDeleteRequest }: {
+    workspaceDeleteRequest?: WorkspaceDeleteRequest;
 }, opts?: Oazapfts.RequestOpts) {
     return oazapfts.ok(oazapfts.fetchJson<{
         status: 201;
@@ -198,10 +302,34 @@ export function deleteV1AgentWorkspaceFork({ workspaceForkRequest }: {
                 [key: string]: any;
             } | null;
         };
-    }>("/v1/agent/workspace-fork", oazapfts.json({
+    }>("/v1/agent/workspace/fork", oazapfts.json({
         ...opts,
         method: "DELETE",
-        body: workspaceForkRequest
+        body: workspaceDeleteRequest
+    })));
+}
+/**
+ * List Workspace Fork AI agents.
+ */
+export function postV1AgentWorkspaceList({ workspaceListRequest }: {
+    workspaceListRequest?: WorkspaceListRequest;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 201;
+        data: Blob;
+    } | {
+        status: 500;
+        data: {
+            code?: string;
+            details?: string;
+            additionalInformation?: {
+                [key: string]: any;
+            } | null;
+        };
+    }>("/v1/agent/workspace/list", oazapfts.json({
+        ...opts,
+        method: "POST",
+        body: workspaceListRequest
     })));
 }
 /**
@@ -230,6 +358,8 @@ export function getV1AgentByAgentId({ agentId }: {
             created_at: ZonedDateTime;
             updated_by?: string;
             updated_at?: ZonedDateTime;
+            toolkits?: ToolkitsInAgentResponse;
+            detail_mode?: boolean;
         };
     } | {
         status: 404;
@@ -342,57 +472,6 @@ export function deleteV1AgentByAgentId({ agentId }: {
         method: "DELETE"
     }));
 }
-/**
- * AI Agent validade publish.
- */
-export function getV1AgentByAgentIdDependencies({ agentId }: {
-    agentId: string;
-}, opts?: Oazapfts.RequestOpts) {
-    return oazapfts.ok(oazapfts.fetchJson<{
-        status: 200;
-        data: {
-            ks_names?: string[];
-            error_ks_names?: string[];
-            missing_ks_list?: string[];
-        };
-    } | {
-        status: 400;
-        data: {
-            code?: string;
-            details?: string;
-            violations?: ViolationResponse[];
-        };
-    } | {
-        status: 404;
-        data: {
-            code?: string;
-            details?: string;
-            additionalInformation?: {
-                [key: string]: any;
-            } | null;
-        };
-    } | {
-        status: 422;
-        data: {
-            code?: string;
-            details?: string;
-            additionalInformation?: {
-                [key: string]: any;
-            } | null;
-        };
-    } | {
-        status: 500;
-        data: {
-            code?: string;
-            details?: string;
-            additionalInformation?: {
-                [key: string]: any;
-            } | null;
-        };
-    }>(`/v1/agent/${encodeURIComponent(agentId)}/dependencies`, {
-        ...opts
-    }));
-}
 /**
  * Fork an AI agent.
  */
@@ -518,6 +597,8 @@ export function getV1AgentByAgentSlugExists({ agentSlug }: {
             created_at: ZonedDateTime;
             updated_by?: string;
             updated_at?: ZonedDateTime;
+            toolkits?: ToolkitsInAgentResponse;
+            detail_mode?: boolean;
         };
     } | {
         status: 404;
@@ -633,6 +714,8 @@ export function getV1PublicAgentByAgentId({ agentId }: {
             created_at: ZonedDateTime;
             updated_by?: string;
             updated_at?: ZonedDateTime;
+            toolkits?: ToolkitsInAgentResponse;
+            detail_mode?: boolean;
         };
     } | {
         status: 404;
@@ -745,57 +828,6 @@ export function deleteV1PublicAgentByAgentId({ agentId }: {
         method: "DELETE"
     }));
 }
-/**
- * AI Agent validade publish.
- */
-export function getV1PublicAgentByAgentIdDependencies({ agentId }: {
-    agentId: string;
-}, opts?: Oazapfts.RequestOpts) {
-    return oazapfts.ok(oazapfts.fetchJson<{
-        status: 200;
-        data: {
-            ks_names?: string[];
-            error_ks_names?: string[];
-            missing_ks_list?: string[];
-        };
-    } | {
-        status: 400;
-        data: {
-            code?: string;
-            details?: string;
-            violations?: ViolationResponse[];
-        };
-    } | {
-        status: 404;
-        data: {
-            code?: string;
-            details?: string;
-            additionalInformation?: {
-                [key: string]: any;
-            } | null;
-        };
-    } | {
-        status: 422;
-        data: {
-            code?: string;
-            details?: string;
-            additionalInformation?: {
-                [key: string]: any;
-            } | null;
-        };
-    } | {
-        status: 500;
-        data: {
-            code?: string;
-            details?: string;
-            additionalInformation?: {
-                [key: string]: any;
-            } | null;
-        };
-    }>(`/v1/public/agent/${encodeURIComponent(agentId)}/dependencies`, {
-        ...opts
-    }));
-}
 /**
  * AI Agent update visibility.
  */
@@ -871,6 +903,8 @@ export function getV1PublicAgentByAgentSlugExists({ agentSlug }: {
             created_at: ZonedDateTime;
             updated_by?: string;
             updated_at?: ZonedDateTime;
+            toolkits?: ToolkitsInAgentResponse;
+            detail_mode?: boolean;
         };
     } | {
         status: 404;

package/src/client/ai.ts

@@ -1,7 +1,7 @@
 import { HttpError } from '@oazapfts/runtime'
+import { last } from 'lodash'
 import {
   addFavoriteV1FavoritesPost,
-  ChatResponse3,
   conversationHistoryV1ConversationsConversationIdGet,
   defaults,
   deleteConversationV1ConversationsConversationIdDelete,
@@ -30,7 +30,16 @@ import { StackspotAPIError } from '../error/StackspotAPIError'
 import { ReactQueryNetworkClient } from '../network/ReactQueryNetworkClient'
 import { removeAuthorizationParam } from '../utils/remove-authorization-param'
 import { StreamedJson } from '../utils/StreamedJson'
-import { FixedChatRequest, FixedConversationResponse, FixedDependencyResponse, ReplaceResult } from './types'
+import { agentClient } from './agent'
+import {
+  ChatAgentTool,
+  ChatResponseWithSteps,
+  FixedChatRequest,
+  FixedChatResponse,
+  FixedConversationResponse,
+  FixedDependencyResponse,
+  ReplaceResult,
+} from './types'
 
 class AIClient extends ReactQueryNetworkClient {
   constructor() {
@@ -46,42 +55,107 @@ class AIClient extends ReactQueryNetworkClient {
     })
   }
 
+  /**
+   * Chat: runs a quick action.
+   */
   runQuickAction = this.mutation(removeAuthorizationParam(quickActionsV1QuickActionsPost))
+  /**
+   * Lists the AI Stacks according to their visibilities.
+   */
   aiStacks = this.query(removeAuthorizationParam(listAiStacksV1AiStacksGet))
+  /**
+   * Gets a workspace by its id.
+   */
   workspace = this.query(removeAuthorizationParam(listAssociationV1WorkspaceWorkspaceIdGet))
+  /**
+   * Lists the quick commands according to filters passed as parameter.
+   */
   quickCommands = this.query(removeAuthorizationParam(listAllV1QuickCommandsAllGet))
+  /**
+   * Gets a quick command by its slug.
+   */
   quickCommand = this.query(removeAuthorizationParam(getQuickCommandV1QuickCommandsSlugGet))
+  /**
+   * Lists the knowledge sources according to filters passed as parameter.
+   */
   knowledgeSources = this.query(removeAuthorizationParam(listKnowledgeSourcesV1KnowledgeSourcesGet))
+  /**
+   * Gets a knowledge source by its slug.
+   */
   knowledgeSource = this.query(removeAuthorizationParam(findKnowledgeSourceV1KnowledgeSourcesSlugGet))
+  /**
+   * Gets a knowledge source document by the slug of the parent knowledge source and the document id.
+   */
   knowledgeSourceDocument = this.query(removeAuthorizationParam(findKnowledgeObjectByCustomIdV1KnowledgeSourcesSlugObjectsCustomIdGet))
+  /**
+   * Gets the chat history. This is a paginated resource.
+   */
   chats = this.infiniteQuery(removeAuthorizationParam(listConversationsV1ConversationsGet))
+  /**
+   * Gets a specific chat from the history according to its id.
+   */
   chat = this.query(removeAuthorizationParam(
     conversationHistoryV1ConversationsConversationIdGet as ReplaceResult<
       typeof conversationHistoryV1ConversationsConversationIdGet,
       FixedConversationResponse
     >,
   ))
+  /**
+   * Deletes a chat from the chat history.
+   */
   deleteChat = this.mutation(removeAuthorizationParam(deleteConversationV1ConversationsConversationIdDelete))
+  /**
+   * Gets a plain text version of the chat with id passed as parameter.
+   */
   downloadChat = this.mutation(removeAuthorizationParam(downloadConversationV1ConversationsConversationIdDownloadGet))
+  /**
+   * Renames a chat.
+   */
   renameChat = this.mutation(removeAuthorizationParam(updateTitleV1ConversationsConversationIdPatch))
+  /**
+   * Creates an event so it can be used as metric by the product designers (analytics).
+   */
   createEvent = this.mutation(removeAuthorizationParam(postEventV1EventsPost))
+  /**
+   * Runs a step of type "fetch" of a quick command.
+   */
   fetchStepOfQuickCommand = this.mutation(removeAuthorizationParam(formatFetchStepV1QuickCommandsSlugStepsStepSlugFetchFormatPost))
+  /**
+   * Runs a step of type "llm" of a quick command.
+   */
   llmStepOfQuickCommand = this.mutation(removeAuthorizationParam(quickCommandsRunV2V2QuickCommandsSlugStepsStepSlugRunPost))
+  /**
+   * Formats the result of a quick command into a human-readable text (markdown).
+   */
   formatResultOfQuickCommand = this.mutation(removeAuthorizationParam(formatResultV1QuickCommandsSlugResultFormatPost))
   /**
-     * List of favorites by type
-     */
+   * Lists the resources of type "$type" marked as favorites.
+   */
   listFavoritesByType = this.query(removeAuthorizationParam(getFavoritesByTypeV1FavoritesGet)) 
   /**
-     * Remove favorite from list
-     */
+   * Removes the resource of type "favoriteRequest.type" from the list of favorites.
+   */
   removeFavorite = this.mutation(removeAuthorizationParam(deleteFavoriteV1FavoritesDelete)) 
   /**
-     * Add favorite to list
-     */
+   * Adds the resource of type "favoriteRequest.type" to the list of favorites.
+   */
   addFavorite = this.mutation(removeAuthorizationParam(addFavoriteV1FavoritesPost)) 
 
-  sendChatMessage(request: FixedChatRequest, minChangeIntervalMS?: number): StreamedJson<ChatResponse3> {
+  private static async toolsOfAgent(agentId?: string) {
+    try {
+      const agent = agentId ? await agentClient.agent.query({ agentId }) : undefined
+      if (!agent) return []
+      const tools: (Omit<ChatAgentTool, 'duration' | 'prompt' | 'output'>)[] = []
+      agent.toolkits?.builtins?.forEach(kit => kit.tools?.forEach(({ id, name, description }) => {
+        if (id) tools.push({ image: kit.image_url, id, name: name || id, description })
+      }))
+      return tools
+    } catch {
+      return []
+    }
+  }
+
+  sendChatMessage(request: FixedChatRequest, minChangeIntervalMS?: number): StreamedJson<ChatResponseWithSteps> {
     const abortController = new AbortController()
     const headers = {
       'Content-Type': 'application/json',
@@ -91,7 +165,92 @@ class AIClient extends ReactQueryNetworkClient {
       this.resolveURL('v3/chat'),
       { method: 'post', body: JSON.stringify(request), headers, signal: abortController.signal },
     )
-    return new StreamedJson(events, abortController, minChangeIntervalMS)
+
+    /**
+     * This function treats events in the streaming that deals with the execution of tools. Since these events are not concatenated like
+     * normal streamings of data, we need this separate function to deal with them. It transforms the internal data model of the
+     * StreamedJson object whenever an event is triggered.
+     */
+    async function transform(event: Partial<FixedChatResponse>, data: Partial<ChatResponseWithSteps>) {
+      const info = event.agent_info
+      if (!info) return
+      data.steps = data.steps ? [...data.steps] : []
+      
+      if (info.type === 'planning' && info.action === 'end') {
+        const tools = await AIClient.toolsOfAgent(request.context?.agent_id)
+        data.steps.push(
+          { id: 'planning', type: 'planning', duration: info.duration, input: info.data?.plan_goal ?? '', status: 'success' },
+        )
+        info.data?.steps.forEach(s => data.steps?.push({
+          id: s.id,
+          type: 'step',
+          input: s.goal,
+          status: 'pending',
+          tools: s.tools?.map(t => ({
+            ...(tools.find(({ id }) => id === t.tool_id) ?? { id: t.tool_id, name: t.tool_id }),
+            executionId: t.tool_execution_id,
+          })),
+        }))
+        data.steps.push({ id: 'answer', type: 'answer', status: 'pending' })
+      }
+
+      if (info.type === 'step' && info.action === 'start') {
+        const step = data.steps.find(s => s.id === info.id)
+        if (step) step.status = 'running'
+      }
+
+      if (info.type === 'step' && info.action === 'end') {
+        const step = data.steps.find(s => s.id === info.id)
+        if (step) {
+          step.status = 'success'
+          step.duration = info.duration
+          step.output = last(step.tools)?.output
+        }
+      }
+
+      if (info.type === 'tool' && info.action === 'start') {
+        const currentStep = data.steps.find(s => s.status === 'running')
+        const tool = currentStep?.tools?.find(t => t.executionId === info.id)
+        if (tool) {
+          tool.input = info.data ? JSON.stringify(info.data.input, null, 2) : undefined
+        }
+      }
+
+      if (info.type === 'tool' && info.action === 'end') {
+        const currentStep = data.steps.find(s => s.status === 'running')
+        const tool = currentStep?.tools?.find(t => t.executionId === info.id)
+        if (tool) {
+          tool.output = info.data?.output
+          tool.duration ??= 0
+          tool.duration += info.duration ?? 0
+        }
+      }
+
+      if (info.type === 'final_answer' && info.action === 'start') {
+        // if we get a "final_answer" event while there's a previous step still running, it means that step has failed.
+        data.steps?.forEach((s) => {
+          if (s.type === 'step' && s.status === 'running') s.status = 'error'
+        })
+        const answerStep = last(data.steps)
+        if (answerStep) answerStep.status = 'running'
+      }
+
+      if (info.type === 'final_answer' && info.action === 'end') {
+        const answerStep = last(data.steps)
+        if (answerStep) {
+          answerStep.status = 'success'
+          answerStep.duration = info.duration
+        }
+      }
+    }
+
+    return new StreamedJson({
+      eventsPromise: events,
+      abortController,
+      minChangeIntervalMS,
+      ignoreKeys: ['agent_info'],
+      transform,
+    })
   }
   
   contentDependencies = this.query(removeAuthorizationParam(

package/src/client/types.ts

@@ -227,6 +227,78 @@ export interface FixedAddResourceToWorkspaceAi {
   error_id: string[],
 }
 
+export interface ChatAgentTool {
+  id: string,
+  executionId?: string,
+  duration?: number,
+  name: string,
+  description?: string,
+  image?: string,
+  input?: string,
+  output?: string,
+}
+
+export interface ChatStep {
+  id: string,
+  type: 'planning' | 'step' | 'answer',
+  duration?: number,
+  input?: string,
+  output?: string,
+  status: 'pending' | 'running' | 'success' | 'error',
+  tools?: ChatAgentTool[],
+}
+
+export interface BaseAgentInfo {
+  type: 'chat' | 'planning' | 'step' | 'tool' | 'final_answer',
+  action: 'start' | 'end',
+  duration?: number,
+}
+
+export interface PlanningAgentInfo extends BaseAgentInfo {
+  type: 'planning',
+  data?: {
+    plan_goal: string,
+    total_steps: number,
+    steps: {
+      id: string,
+      goal: string,
+      tools?: {
+        tool_id: string,
+        tool_execution_id: string,
+      }[],
+    }[],
+  },
+}
+
+export interface StepAgentInfo extends BaseAgentInfo {
+  type: 'step',
+  id: string,
+}
+
+export interface ToolAgentInfo extends BaseAgentInfo {
+  type: 'tool',
+  id: string,
+  data?: {
+    input?: any,
+    attempt: number,
+    output?: string,
+  },
+}
+
+export interface GenericAgentInfo extends BaseAgentInfo {
+  type: 'chat' | 'final_answer',
+}
+
+export type AgentInfo = GenericAgentInfo | PlanningAgentInfo | StepAgentInfo | ToolAgentInfo
+
+export interface FixedChatResponse extends ChatResponse3 {
+  agent_info: AgentInfo,
+}
+
+export interface ChatResponseWithSteps extends FixedChatResponse {
+  steps: ChatStep[],
+}
+
 export type OazapftsFunction<Variables = any, Result = any> = (variables: Variables, opts?: RequestOpts) => Promise<Result>
 
 type Unpromisify<T> = T extends Promise<infer R> ? Unpromisify<R> : T