Class SkipSDK

Private config

Private Static __lastRefreshTime

Private Static __skipEntitiesCache$

Private buildAPIKeys

• buildAPIKeys(): SkipAPIRequestAPIKey[]

• Build API keys for AI services

  Returns SkipAPIRequestAPIKey[]

Private buildAgentNotes

• buildAgentNotes(contextUser): Promise<{
      noteTypes: SkipAPIAgentNoteType[];
      notes: SkipAPIAgentNote[];
  }>

• Build agent notes for Skip

  Parameters

  • contextUser: UserInfo

  Returns Promise<{
      noteTypes: SkipAPIAgentNoteType[];
      notes: SkipAPIAgentNote[];
  }>

Private buildArtifacts

• buildArtifacts(contextUser, dataSource, conversationId): Promise<SkipAPIArtifact[]>

• Build artifacts for a conversation using optimized query Uses GetConversationArtifactsForAgent query which joins through ConversationDetailArtifact to get artifacts that were outputs from Skip agent's conversation details

  Parameters

  • contextUser: UserInfo
  • dataSource: ConnectionPool
  • conversationId: string

  Returns Promise<SkipAPIArtifact[]>

Private buildBaseRequest

• buildBaseRequest(contextUser, dataSource, includeEntities, includeQueries, includeNotes, includeRequests, forceEntityRefresh, includeCallbackAuth, additionalTokenInfo?): Promise<Partial<SkipAPIRequest>>

• Build base request with metadata, API keys, and callback auth

  Parameters

  • contextUser: UserInfo
  • dataSource: ConnectionPool
  • includeEntities: boolean
  • includeQueries: boolean
  • includeNotes: boolean
  • includeRequests: boolean
  • forceEntityRefresh: boolean
  • includeCallbackAuth: boolean
  • additionalTokenInfo: any = {}

  Returns Promise<Partial<SkipAPIRequest>>

Private buildEntities

• buildEntities(dataSource, forceRefresh, refreshIntervalMinutes?): Promise<SkipEntityInfo[]>

• Build entity metadata for Skip Copied from AskSkipResolver.BuildSkipEntities - uses cached metadata with refresh logic

  Parameters

  • dataSource: ConnectionPool
  • forceRefresh: boolean
  • refreshIntervalMinutes: number = 15

  Returns Promise<SkipEntityInfo[]>

Private buildHeaders

• buildHeaders(): Record<string, string>

• Build HTTP headers for Skip API requests

  Returns Record<string, string>

Private buildQueries

• buildQueries(status?): SkipQueryInfo[]

• Build saved queries for Skip

  Parameters

  • status: "Pending" | "In-Review" | "Approved" | "Rejected" | "Obsolete" = 'Approved'

  Returns SkipQueryInfo[]

Private buildQueryCategoryPath

• buildQueryCategoryPath(md, categoryID): string

• Recursively build category path for a query

  Parameters

  • md: Metadata
  • categoryID: string

  Returns string

Private buildSkipRequest

• buildSkipRequest(options): Promise<SkipAPIRequest>

• Build the Skip API request object

  Parameters

  • options: SkipCallOptions

  Returns Promise<SkipAPIRequest>

Private getFieldDistinctValues

• getFieldDistinctValues(f, dataSource): Promise<SkipEntityFieldValueInfo[]>

• Gets distinct values for a field from the database Used to provide Skip with information about the possible values Copied from AskSkipResolver.GetFieldDistinctValues

  Parameters

  • f: EntityFieldInfo
  • dataSource: ConnectionPool

  Returns Promise<SkipEntityFieldValueInfo[]>

Private isDelegationMessage

• isDelegationMessage(content): boolean

• Check if a message is a delegation message that should be filtered out Uses flexible pattern matching to detect variations of delegation messages

  Parameters

  • content: string

  Returns boolean

Private packFieldPossibleValues

• packFieldPossibleValues(f, dataSource): Promise<SkipEntityFieldValueInfo[]>

• Packs possible values for an entity field These values help Skip understand the domain and valid values for fields Copied from AskSkipResolver.PackFieldPossibleValues

  Parameters

  • f: EntityFieldInfo
  • dataSource: ConnectionPool

  Returns Promise<SkipEntityFieldValueInfo[]>

Private packSingleSkipEntityField

• packSingleSkipEntityField(f, dataSource): Promise<SkipEntityFieldInfo>

• Packs information about a single entity field Includes metadata and possible values Copied from AskSkipResolver.PackSingleSkipEntityField

  Parameters

  • f: EntityFieldInfo
  • dataSource: ConnectionPool

  Returns Promise<SkipEntityFieldInfo>

Private packSingleSkipEntityInfo

• packSingleSkipEntityInfo(e, dataSource): Promise<SkipEntityInfo>

• Packs information about a single entity for Skip Includes fields, relationships, and sample data Copied from AskSkipResolver.PackSingleSkipEntityInfo

  Parameters

  • e: EntityInfo
  • dataSource: ConnectionPool

  Returns Promise<SkipEntityInfo>

Private packSingleSkipEntityRelationship

• packSingleSkipEntityRelationship(r): SkipEntityRelationshipInfo

• Packs information about a single entity relationship These relationships help Skip understand the data model Copied from AskSkipResolver.PackSingleSkipEntityRelationship

  Parameters

  • r: EntityRelationshipInfo

  Returns SkipEntityRelationshipInfo

Private processMessages

• processMessages(messages): SkipMessage[]

• Process messages: filter delegation messages and add metadata fields Messages coming in should already have conversationDetailID if they exist in the database

  Parameters

  • messages: SkipMessage[]

  Returns SkipMessage[]

Private refreshSkipEntities

• refreshSkipEntities(dataSource): Promise<SkipEntityInfo[]>

• Refreshes the Skip entities cache Rebuilds the entity information that is provided to Skip Copied from AskSkipResolver.refreshSkipEntities

  Parameters

  • dataSource: ConnectionPool

  Returns Promise<SkipEntityInfo[]>