@stack-spot/portal-network 0.215.1-alpha.0 → 0.216.0

package/src/client/ai.ts

@@ -1,14 +1,16 @@
 import { HttpError } from '@oazapfts/runtime'
-import { isArray } from 'lodash'
+import { findLast, isArray, last } from 'lodash'
 import { getApiAddresses } from '../api-addresses'
 import {
   addFavoriteV1AiStacksStackIdFavoritePost,
   addFavoriteV1QuickCommandsSlugFavoritePost,
   calculateNextStepV1QuickCommandsSlugStepsStepSlugCalculateNextStepPost,
   callbackV1QuickCommandsCallbackExecutionIdGet,
+  checkQuickCommandExistsV1QuickCommandsSlugExistsGet,
   conversationHistoryV1ConversationsConversationIdGet,
   createAnswerForReviewV1ResourcesResourceTypeSlugResourceSlugReviewsReviewIdAnswersPost,
   createExecutionV1QuickCommandsCreateExecutionSlugPost,
+  createQuickCommandV1QuickCommandsPost,
   createResourceReviewV1ResourcesResourceTypeSlugResourceSlugReviewsPost,
   currentV1TokensUsageCurrentGet,
   defaults,
@@ -16,11 +18,15 @@ import {
   deleteFavoriteV1AiStacksStackIdFavoriteDelete,
   deleteFavoriteV1QuickCommandsSlugFavoriteDelete,
   deleteKnowledgeObjectByCustomIdV1KnowledgeSourcesSlugObjectsCustomIdDelete,
+  deleteKnowledgeSourceV1KnowledgeSourcesSlugDelete,
+  deleteQuickCommandV1QuickCommandsSlugDelete,
   deleteResourceReviewV1ResourcesResourceTypeSlugResourceSlugReviewsReviewIdDelete,
   deleteReviewCommentV1ResourcesResourceTypeSlugResourceSlugReviewsReviewIdAnswersAnswerIdDelete,
   downloadConversationV1ConversationsConversationIdDownloadGet,
   findKnowledgeObjectByCustomIdV1KnowledgeSourcesSlugObjectsCustomIdGet,
+  findKnowledgeSourceDependenciesV1KnowledgeSourcesSlugDependenciesGet,
   findKnowledgeSourceV1KnowledgeSourcesSlugGet,
+  forkV1QuickCommandsSlugForkPost,
   formatFetchStepV1QuickCommandsSlugStepsStepSlugFetchFormatPost,
   formatResultV1QuickCommandsSlugResultFormatPost,
   getContentDependenciesV1ContentContentTypeContentIdDependenciesGet,
@@ -38,6 +44,7 @@ import {
   listConversationsV1ConversationsGet,
   listKnowledgeSourcesV1KnowledgeSourcesGet,
   postEventV1EventsPost,
+  publishV1QuickCommandsSlugPublishPost,
   quickActionsV1QuickActionsPost,
   QuickCommandPromptResponse2,
   QuickCommandsExecutionRequest,
@@ -56,15 +63,22 @@ import {
   vectorizeCustomKnowledgeSourceV1KnowledgeSourcesSlugCustomPost,
 } from '../api/ai'
 
-
 import { StackspotAPIError } from '../error/StackspotAPIError'
 import { ReactQueryNetworkClient } from '../network/ReactQueryNetworkClient'
 import { removeAuthorizationParam } from '../utils/remove-authorization-param'
 import { StreamedJson } from '../utils/StreamedJson'
+import { formatJson } from '../utils/string'
+import { agentToolsClient } from './agent-tools'
 import {
+  AgentInfo,
+  ChatAgentTool,
+  ChatResponseWithSteps,
+  FixedChatRequest,
+  FixedChatResponse,
   FixedConversationResponse,
   FixedDependencyResponse,
   ReplaceResult,
+  StepChatStep,
 } from './types'
 
 const listQAV3WithoutAuthorization = removeAuthorizationParam(listAllV3QuickCommandsGet)
@@ -109,6 +123,10 @@ class AIClient extends ReactQueryNetworkClient {
    */
   vectorizeCustomKS = this.mutation(
     removeAuthorizationParam(vectorizeCustomKnowledgeSourceV1KnowledgeSourcesSlugCustomPost))
+  /**
+   * Deletes a KS
+   */
+  deleteKS = this.mutation(removeAuthorizationParam(deleteKnowledgeSourceV1KnowledgeSourcesSlugDelete))
   /**
    * Lists the AI Stacks according to their visibilities.
    */
@@ -150,6 +168,26 @@ class AIClient extends ReactQueryNetworkClient {
    * Gets the execution status and result of a quick command by its execution ID.
    */
   quickCommandCallbackExecutionId = this.query(removeAuthorizationParam(callbackV1QuickCommandsCallbackExecutionIdGet))
+  /**
+   * Creates a QC
+   */
+  createQuickCommand = this.mutation(removeAuthorizationParam(createQuickCommandV1QuickCommandsPost))
+  /**
+   * Deletes a QC
+   */
+  deleteQuickCommand = this.mutation(removeAuthorizationParam(deleteQuickCommandV1QuickCommandsSlugDelete))
+  /**
+   * Forks a QC
+   */
+  forkQuickCommand = this.mutation(removeAuthorizationParam(forkV1QuickCommandsSlugForkPost))
+  /**
+   * Publishes a QC
+   */
+  publishQuickCommand = this.mutation(removeAuthorizationParam(publishV1QuickCommandsSlugPublishPost))
+  /**
+   * Check Quick Command Available slug
+   */
+  checkAvailableQuickCommandSlug = this.query(removeAuthorizationParam(checkQuickCommandExistsV1QuickCommandsSlugExistsGet))
   /**
    * Lists the knowledge sources according to filters passed as parameter.
    */
@@ -166,6 +204,10 @@ class AIClient extends ReactQueryNetworkClient {
    * Lists knowledge sources matching the provided IDs.
    */
   searchKnowledgeSources = this.query(removeAuthorizationParam(searchKnowledgeSourcesV1KnowledgeSourcesSearchPost))
+  /**
+   * Finds Knowledge Source Dependencies
+   */
+  dependenciesKnowledgeSources = this.query(removeAuthorizationParam(findKnowledgeSourceDependenciesV1KnowledgeSourcesSlugDependenciesGet))
   /**
    * Gets the chat history. This is a paginated resource.
    */
@@ -332,6 +374,262 @@ class AIClient extends ReactQueryNetworkClient {
   deleteReviewComment = this.mutation(
     removeAuthorizationParam(deleteReviewCommentV1ResourcesResourceTypeSlugResourceSlugReviewsReviewIdAnswersAnswerIdDelete))
 
+  private static async toolsOfAgent(agentId?: string) {
+    try {
+      const agent = agentId ? await agentToolsClient.agent.query({ agentId }) : undefined
+      if (!agent) return []
+      const tools: (Omit<ChatAgentTool, 'duration' | 'prompt' | 'output'>)[] = []
+      agent.toolkits?.builtin_toolkits?.forEach(kit => kit.tools?.forEach(({ id, name, description }) => {
+        if (id) tools.push({ image: kit.image_url, id, name: name || id, description })
+      }))
+      agent.toolkits?.custom_toolkits?.forEach(kit => kit.tools?.forEach(({ id, name, description }) => {
+        if (id) tools.push({ image: kit.avatar ?? undefined, 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',
+      'Accept': 'text/event-stream',
+    }
+    const events = this.stream(
+      this.resolveURL('v3/chat'),
+      { method: 'post', body: JSON.stringify(request), headers, signal: abortController.signal },
+    )
+
+    const DYNAMIC_TOOL_ID = 'dynamic'
+    function isDynamicTool(info: AgentInfo) {
+      return info.type === 'tool' && info.id === DYNAMIC_TOOL_ID
+    }
+    /**
+     * 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
+      const tools = await AIClient.toolsOfAgent(request.context?.agent_id)
+      data.steps = data.steps ? [...data.steps] : []
+    
+      if (info.type === 'planning' && info.action === 'end') {
+        data.steps.push({
+          id: 'planning',
+          type: 'planning',
+          status: 'success',
+          duration: info.duration || 0,
+          steps: info.data?.steps?.map(s => s.goal) ?? [],
+          goal: info.data?.plan_goal ?? '',
+        })
+
+        info.data?.steps.forEach(s => data.steps?.push({
+          id: s.id,
+          type: 'step',
+          status: 'pending',
+          input: s.goal,
+          attempts: [{
+            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,
+              goal: t.goal,
+            })),
+          }],
+        }))
+        data.steps.push({ id: 'answer', type: 'answer', status: 'pending' })
+      }
+
+      if (info.type === 'planning' && info.action === 'awaiting_approval') {
+        data.steps.push({
+          id: 'planning',
+          type: 'planning',
+          status: 'awaiting_approval',
+          user_question: info.data?.user_question,
+          duration: info.duration || 0,
+          steps: info.data?.steps?.map(s => s.goal) ?? [],
+          goal: info.data?.plan_goal ?? '',
+        })
+        info.data?.steps.forEach(s => data.steps?.push({
+          id: s.id,
+          type: 'step',
+          status: 'pending',
+          input: s.goal,
+          attempts: [{
+            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,
+              goal: t.goal,
+            })),
+          }],
+        }))
+        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) as StepChatStep
+        if (step) {
+          step.status = 'success'
+          step.duration = info.duration
+          const lastToolId = last(step.attempts[0].tools)?.id
+          const lastAttemptOfLastTool = findLast(step.attempts.map(a => a.tools).flat(), t => t?.id === lastToolId)
+          step.output = lastAttemptOfLastTool?.output
+        }
+      }
+
+      if (info.type === 'tool_calls' && info.action === 'start') {
+        const hasPlanning = data.steps.find(s => s.type === 'planning')
+        // On the first tool_calls:start, create the synthetic planning ("dynamic") step.
+        if (!hasPlanning) {
+          const userPrompt = request.user_prompt  === 'string' ? request.user_prompt : JSON.stringify(request.user_prompt)
+          data.steps.push({
+            id: 'dynamic',
+            type: 'planning',
+            status: 'success',
+            steps: [],
+            goal: userPrompt,
+            user_question: userPrompt,
+          })
+        }
+        const toolsStepId = data.steps.filter(s => s.id === 'tools' || s.id.startsWith('tools-')).length + 1
+        data.steps.push({
+          id: `tools-${toolsStepId.toString()}`,
+          type: 'step',
+          status: 'running',
+          attempts: [{ tools: [] }],
+        } as StepChatStep)
+      }
+      
+      if (info.type === 'tool_calls' && info.action === 'end') {
+        const lastStep = findLast(data.steps, s => s.id === 'tools' || s.id.startsWith('tools-')) as StepChatStep
+        if (lastStep) {
+          lastStep.status = 'success'
+          lastStep.duration = info.duration
+          const lastAttemptOfLastTool = last(lastStep.attempts.map(a => a.tools).flat())
+          lastStep.output = lastAttemptOfLastTool?.output
+        }
+      }
+
+      if (info.type === 'tool' && info.action === 'awaiting_approval') {
+        const tool = tools.find(({ id }) => id === info.data?.tool_id)
+        data.steps.push({
+          id: info.id,
+          type: 'tool',
+          status: 'awaiting_approval',
+          duration: info.duration || 0,
+          input: info.data?.input,
+          user_question: info.data?.user_question,
+          attempts: [{
+            tools: [{
+              executionId: info.id,
+              id: info.data?.tool_id ?? '',
+              name: tool?.name ?? '',
+              goal: tool?.goal,
+              ...tool,
+            }],
+          }],
+        })
+        data.steps.push({ id: 'answer', type: 'answer', status: 'pending' })
+      }
+
+      if (info.type === 'tool' && info.action === 'start') {
+        if (!info.data) return
+        const input = formatJson(info.data.input)
+        const tool = findLast(tools, ({ id }) => id === info.data?.tool_id) ?? { id: info.data?.tool_id, name: info.data?.tool_id }
+        
+        const currentStep = findLast(data.steps, s => s.status === 'running') as StepChatStep
+
+        //There might be a tool with status awaiting_approval, so we want to inform tool has already started
+        if (!currentStep || !currentStep?.attempts?.[0]?.tools) {
+          data.steps.push({
+            id: info.id,
+            type: 'tool',
+            status: 'running',
+            duration: info.duration || 0,
+            input: info.data?.input,
+            user_question: info.data?.user_question,
+            attempts: [{
+              tools: [{ ...tool, executionId: info.id, input }],
+            }],
+          })
+        } else {
+          const toolInFirstAttempt = findLast(currentStep?.attempts?.[0]?.tools, t => t.executionId === info.id)
+          //One step might have multiple tools. When in an approval mode, we might not have all the tools in the array yet.
+          //For dynamic tools (id === 'dynamic'), we always push a new tool, since dynamic executions can trigger
+          //multiple tool runs in the same step and do not follow the planned tool structure.
+          //So we make sure to add any tools that are not in there, or always add for dynamic tools.
+          if (!toolInFirstAttempt || isDynamicTool(info)) {            
+            currentStep.attempts?.[0].tools?.push({
+              ...tool,
+              executionId: info.id,
+              input,
+              status: 'running',
+            })
+          } else {
+            const input = formatJson(info.data.input)
+            if (info.data.attempt === 1) {
+              toolInFirstAttempt.input = input
+            } else {
+              currentStep.attempts[info.data.attempt - 1] ??= { tools: [] }
+              currentStep.attempts[info.data.attempt - 1].tools?.push({
+                ...tool,
+                executionId: info.id,
+                input,
+              })
+            }
+          }
+        }
+      }
+
+      if (info.type === 'tool' && info.action === 'end') {
+        const currentStep = data.steps.find(s => s.status === 'running') as StepChatStep
+        if (!currentStep || !info.data) return
+        
+        // attempt index for tool execution starts at 0 for dynamically executed tools,while for planned tools it starts at 1
+        const attempt = isDynamicTool(info) ? info.data.attempt : info.data.attempt - 1
+        const tool = last(currentStep?.attempts?.[attempt]?.tools)
+        if (tool) {
+          tool.output = formatJson(info.data.output)
+          tool.duration = info.duration
+          tool.status = 'success'
+        }
+      }
+
+      if (info.type === 'final_answer' && info.action === 'start') {
+        const answerStep = last(data.steps)
+        if (answerStep) answerStep.status = 'running'
+      }
+
+
+      if (info.type === 'chat' && info.action === 'end') {
+        const lastStep = last(data.steps)
+        if (lastStep?.type === 'answer') {
+          lastStep.status = 'success'
+          lastStep.duration = info.duration
+        } else {
+          data.steps.push({ id: 'answer', type: 'answer', status: 'success' })
+        }
+      }
+    }
+
+    return new StreamedJson({
+      eventsPromise: events,
+      abortController,
+      minChangeIntervalMS,
+      ignoreKeys: ['agent_info'],
+      transform,
+      textFromErrorEvent: data => data.answer ?? 'Unknown error',
+    })
+  }
+
   contentDependencies = this.query(removeAuthorizationParam(
     getContentDependenciesV1ContentContentTypeContentIdDependenciesGet as ReplaceResult<
       typeof getContentDependenciesV1ContentContentTypeContentIdDependenciesGet,

package/src/client/discover.ts

@@ -2,16 +2,16 @@ import { HttpError } from '@oazapfts/runtime'
 import { findLast, last } from 'lodash'
 import { getApiAddresses } from '../api-addresses'
 import { ConversationResponse } from '../api/ai'
-import { AiChatRequest, create, create1, create2, defaults, deleteById, deleteById1, deleteById2, fetchInsights, getAll, getAll1, getAll2, getAllByHypothesis, getById, getById1, getById2, getInsightById, GetOpportunityResponse, refreshInsights } from '../api/discover'
+import { create, create1, create2, defaults, deleteById, deleteById1, deleteById2, fetchInsights, getAll, getAll1, getAll2, getAllByHypothesis, getById, getById1, getById2, getInsightById, GetOpportunityResponse, AiChatRequest, refreshInsights } from '../api/discover'
 import { DefaultAPIError } from '../error/DefaultAPIError'
-import { baseDictionary } from '../error/dictionary/base'
 import { StackspotAPIError } from '../error/StackspotAPIError'
-import { ReactQueryNetworkClient } from '../network/ReactQueryNetworkClient'
 import { StreamedJson } from '../utils/StreamedJson'
+import { baseDictionary } from '../error/dictionary/base'
 import { formatJson } from '../utils/string'
-import { agentToolsClient } from './agent-tools'
+import { ReactQueryNetworkClient } from '../network/ReactQueryNetworkClient'
 import { aiClient } from './ai'
-import { AgentInfo, ChatAgentTool, ChatResponseWithSteps, FixedChatResponse, StepChatStep } from './types'
+import { ChatAgentTool, ChatResponseWithSteps, FixedChatResponse, StepChatStep } from './types'
+import { agentToolsClient } from './agent-tools'
 
 export interface ChatConversionDetails extends ConversationResponse {
   opportunityName?: string,
@@ -137,8 +137,7 @@ class DiscoverClient extends ReactQueryNetworkClient {
        * StreamedJson object whenever an event is triggered.
        */
     async function transform(event: Partial<FixedChatResponse>, data: Partial<ChatResponseWithSteps>) {
-      // todo fix
-      const info = event.agent_info as unknown as AgentInfo
+      const info = event.agent_info
 
       if (!info) return