@stack-spot/portal-network 0.182.0 → 0.184.0-beta.1

package/src/client/types.ts

@@ -245,19 +245,20 @@ export interface ChatAgentTool {
   image?: string,
   input?: string,
   output?: string,
+  goal: string,
 }
 
 export interface ChatStepAttempt {
   /**
    * The tools used by this step.
    */
-  tools?: ChatAgentTool[],
+  tools?: Partial<ChatAgentTool>[],
 }
 
 export interface BaseChatStep {
   id: string,
-  type: 'planning' | 'step' | 'answer',
-  status: 'pending' | 'running' | 'success' | 'error',
+  type: 'planning' | 'step' | 'answer' | 'tool',
+  status: 'pending' | 'running' | 'success' | 'error' | 'awaiting_approval',
   /**
    * Duration in seconds.
    */
@@ -266,9 +267,24 @@ export interface BaseChatStep {
 
 export interface PlanningChatStep extends BaseChatStep {
   type: 'planning',
-  status: 'success',
+  status: 'success' | 'awaiting_approval',
   steps: string[],
   goal: string,
+  user_question?: string,
+}
+
+export interface ToolChatStep extends BaseChatStep {
+  type: 'tool',
+  status: 'running' | 'success' | 'error' | 'awaiting_approval',
+  /**
+   * Each step might attempt to run for multiple times, with different inputs and outputs. If first attempt succeeds, this array will have
+   * only one element.
+   * 
+   * This array never has less than one element, despite the step's status.
+   */
+  attempts: ChatStepAttempt[],
+  input?: Record<string, any>,
+  user_question?: string,
 }
 
 export interface StepChatStep extends BaseChatStep {
@@ -288,17 +304,19 @@ export interface AnswerChatStep extends BaseChatStep {
   type: 'answer',
 }
 
-export type ChatStep = PlanningChatStep | StepChatStep | AnswerChatStep
+export type ChatStep = PlanningChatStep | StepChatStep | AnswerChatStep | ToolChatStep
 
 export interface BaseAgentInfo {
   type: 'chat' | 'planning' | 'step' | 'tool' | 'final_answer',
-  action: 'start' | 'end',
+  action: 'start' | 'end' | 'awaiting_approval',
   duration?: number,
+  id: string,
 }
 
 export interface AgentTool {
   tool_id: string,
   tool_execution_id: string,
+  goal: string,
 }
 
 export interface PlanningAgentInfo extends BaseAgentInfo {
@@ -311,6 +329,7 @@ export interface PlanningAgentInfo extends BaseAgentInfo {
       goal: string,
       tools?: AgentTool[],
     }[],
+    user_question?: string,
   },
 }
 
@@ -326,6 +345,8 @@ export interface ToolAgentInfo extends BaseAgentInfo {
     input?: any,
     attempt: number,
     output?: string,
+    user_question?: string,
+    tool_id: string,
   },
 }
 

package/src/client/workspace-ai.ts

@@ -13,7 +13,6 @@ import {
   deleteFavoriteV1WorkspacesWorkspaceIdFavoriteDelete,
   deleteWorkspaceV1WorkspacesWorkspaceIdDelete,
   getWorkspaceByIdV1WorkspacesIdGet,
-  HttpValidationError,
   listAllByContentTypeV1WorkspacesWorkspaceIdContentTypeGet,
   listAllContentsV1WorkspacesContentsContentTypeGet,
   listGroupsAndMembersPermissionInWorkspaceV1WorkspacesWorkspaceIdPermissionsGet,
@@ -28,8 +27,10 @@ import {
 import { StackspotAPIError } from '../error/StackspotAPIError'
 import { ReactQueryNetworkClient } from '../network/ReactQueryNetworkClient'
 import { removeAuthorizationParam } from '../utils/remove-authorization-param'
-import { FixedAddResourceToWorkspaceAi, FixedWorkspaceAiPermissions, ReplaceResult } from './types'
 import { getApiAddresses } from '../api-addresses'
+import { DefaultAPIError } from '../error/DefaultAPIError'
+import { wksAiDictionary } from '../error/dictionary/workspace-ai'
+import { FixedAddResourceToWorkspaceAi, FixedWorkspaceAiPermissions, ReplaceResult } from './types'
 
 class WorkspaceAiClient extends ReactQueryNetworkClient {
   constructor() {
@@ -37,12 +38,7 @@ class WorkspaceAiClient extends ReactQueryNetworkClient {
   }
 
   protected buildStackSpotError(error: HttpError): StackspotAPIError {
-    return new StackspotAPIError({
-      status: error.status,
-      headers: error.headers,
-      stack: error.stack,
-      message: (error.data as HttpValidationError | undefined)?.detail?.map(d => d.msg)?.join('\n'),
-    })
+    return new DefaultAPIError(error.data, error.status, wksAiDictionary, error.headers)
   }
 
   createWorkspaceAi = this.mutation(removeAuthorizationParam(createWorkspaceV1WorkspacesPost))
@@ -50,7 +46,7 @@ class WorkspaceAiClient extends ReactQueryNetworkClient {
   workspaceAi = this.query(removeAuthorizationParam(getWorkspaceByIdV1WorkspacesIdGet))
   updateWorkspaceAi = this.mutation(removeAuthorizationParam(updateWorkspaceV1WorkspacesWorkspaceIdPatch))
   deleteWorkspaceAi = this.mutation(removeAuthorizationParam(deleteWorkspaceV1WorkspacesWorkspaceIdDelete))
-  
+
   /**
    * Adds a resource to the Spot.
    */
@@ -73,7 +69,7 @@ class WorkspaceAiClient extends ReactQueryNetworkClient {
     request: (
       signal,
       variables: Omit<Parameters<typeof listAllByContentTypeV1WorkspacesWorkspaceIdContentTypeGet>[0],
-      'authorization' | 'contentType'>,
+        'authorization' | 'contentType'>,
     ) =>
       listAllByContentTypeV1WorkspacesWorkspaceIdContentTypeGet({ ...variables, contentType: 'knowledge_source', authorization: '' },
         { signal }) as unknown as Promise<KnowledgeSourceItemResponse[]>,
@@ -88,7 +84,7 @@ class WorkspaceAiClient extends ReactQueryNetworkClient {
     request: (
       signal,
       variables: Omit<Parameters<typeof listAllByContentTypeV1WorkspacesWorkspaceIdContentTypeGet>[0],
-      'authorization' | 'contentType'>,
+        'authorization' | 'contentType'>,
     ) =>
       listAllByContentTypeV1WorkspacesWorkspaceIdContentTypeGet({ ...variables, contentType: 'stack', authorization: '' },
         { signal }) as unknown as Promise<GetAiStackResponse[]>,
@@ -103,7 +99,7 @@ class WorkspaceAiClient extends ReactQueryNetworkClient {
     request: (
       signal,
       variables: Omit<Parameters<typeof listAllByContentTypeV1WorkspacesWorkspaceIdContentTypeGet>[0],
-      'authorization' | 'contentType'>,
+        'authorization' | 'contentType'>,
     ) =>
       listAllByContentTypeV1WorkspacesWorkspaceIdContentTypeGet({ ...variables, contentType: 'quick_command', authorization: '' },
         { signal }) as unknown as Promise<QuickCommandResponse[]>,
@@ -118,7 +114,7 @@ class WorkspaceAiClient extends ReactQueryNetworkClient {
     request: (
       signal,
       variables: Omit<Parameters<typeof listAllByContentTypeV1WorkspacesWorkspaceIdContentTypeGet>[0],
-      'authorization' | 'contentType'>,
+        'authorization' | 'contentType'>,
     ) =>
       listAllByContentTypeV1WorkspacesWorkspaceIdContentTypeGet({ ...variables, contentType: 'agent', authorization: '' },
         { signal }) as unknown as Promise<AgentResponse[]>,
@@ -133,7 +129,7 @@ class WorkspaceAiClient extends ReactQueryNetworkClient {
     request: (
       signal,
       variables: Omit<Parameters<typeof listAllByContentTypeV1WorkspacesWorkspaceIdContentTypeGet>[0],
-      'authorization' | 'contentType'>,
+        'authorization' | 'contentType'>,
     ) =>
       listAllByContentTypeV1WorkspacesWorkspaceIdContentTypeGet({ ...variables, contentType: 'toolkit', authorization: '' },
         { signal }) as unknown as Promise<CustomToolkitResponse[]>,
@@ -144,7 +140,7 @@ class WorkspaceAiClient extends ReactQueryNetworkClient {
     removeContentV1WorkspacesWorkspaceIdContentTypeContentIdDelete))
   addPermissionToWorkspaceAi = this.mutation(removeAuthorizationParam(addPermissionV1WorkspacesWorkspaceIdPermissionsPatch))
   removePermissionToWorkspaceAi = this.mutation(removeAuthorizationParam(removePermissionV1WorkspacesWorkspaceIdPermissionsDelete))
-  
+
   /**
    * Get group of permission on workspace AI
    * @param search can be used to search by name
@@ -158,24 +154,24 @@ class WorkspaceAiClient extends ReactQueryNetworkClient {
    * Adds the resource of type Workspace AI to the list of favorites.
    */
   addFavoriteWorkspaceAi = this.mutation(removeAuthorizationParam(addFavoriteV1WorkspacesWorkspaceIdFavoritePost))
-  
+
   /**
    * Removes the resource of type Workspace AI from the list of favorites.
    */
-  removeFavoriteWorkspaceAi = this.mutation(removeAuthorizationParam(deleteFavoriteV1WorkspacesWorkspaceIdFavoriteDelete)) 
+  removeFavoriteWorkspaceAi = this.mutation(removeAuthorizationParam(deleteFavoriteV1WorkspacesWorkspaceIdFavoriteDelete))
 
   /**
    * Gets all content from all workspaces to which the user has permissions.
    */
-  workspacesContentsByType  = this.query(removeAuthorizationParam(listAllContentsV1WorkspacesContentsContentTypeGet))
+  workspacesContentsByType = this.query(removeAuthorizationParam(listAllContentsV1WorkspacesContentsContentTypeGet))
   /**
    * Get a generated link to share a spot
    */
-  generateShareSpotLink  = this.mutation(removeAuthorizationParam(createShareableLinkV1WorkspacesWorkspaceIdSharePost))
+  generateShareSpotLink = this.mutation(removeAuthorizationParam(createShareableLinkV1WorkspacesWorkspaceIdSharePost))
   /**
    * Get a shareable link from a spot
    */
-  shareableLink  = this.mutation(removeAuthorizationParam(useShareableLinkV1ShareShareIdPatch))
+  shareableLink = this.mutation(removeAuthorizationParam(useShareableLinkV1ShareShareIdPatch))
   /**
    * Add permission to resource
    */
@@ -183,13 +179,13 @@ class WorkspaceAiClient extends ReactQueryNetworkClient {
   /**
    * Remove permission to resource
    */
-  removePermissionResource = 
+  removePermissionResource =
     this.mutation(removeAuthorizationParam(removePermissionV1ResourceTypeResourceTypeResourcesResourceIdentifierDelete))
   /**
    * List members with permission to resource
    */
-  listMembersResource = 
+  listMembersResource =
     this.infiniteQuery(removeAuthorizationParam(listMembersV1ResourceTypeResourceTypeResourcesResourceIdentifierMembersGet))
-}  
+}
 
 export const workspaceAiClient = new WorkspaceAiClient()

package/src/error/dictionary/workspace-ai.ts

@@ -0,0 +1,10 @@
+import { Dictionary } from '@stack-spot/portal-translate'
+
+export const wksAiDictionary = {
+  en: {
+    AGENT_1105_TOOLKIT_WITH_PERSONAL_SECRET: 'It is not possible to share the agent, as it has a tool with a personal secret. Remove the tool or replace it with an organization secret.',
+  },
+  pt: {
+    AGENT_1105_TOOLKIT_WITH_PERSONAL_SECRET: 'Não é possível compartilhar o agente, pois ele possui uma ferramenta com segredo pessoal. Remova a ferramenta ou substitua por um segredo da organização.',
+  },
+} satisfies Dictionary