SABundle

Sentient Agent Bundle consists of the definition of the services, data streams, and configurations to transform data at the edge and publish the results to upstream SABRs

Logical Diagram

Attributes

  • name:string - Name of the Sentient Agent Bundle
  • version:string - Version of the SABundle

Associations

Name Cardinality Class Composition Owner Description
inputs n DataStream false false Input Data Streams for the SABR
outputs n DataStream false false Output Data Streams for the SABR
learningStream 1 DataStream     Learning Corpus Stream receives updates and sends out updates to the aimodel
adminStream 1 DataStream     Administration Stream to handle registration of SABRS to Capabilities
transforms n DataTransform     Data Transformations run on input data send to output data.
applications n Application      
stacks n Stack false false  
aimodels n AIModel false false  
instances n SABundleInstance false true  
secureVault 1 SecureVault true true  
policies n ChannelCreationPolicy     Policies to apply to the SABR when the instance is launched. This should build the channels for the data streams.
builds n SABundleBuild     Builds for the SABundle. A SABundleBuild encrypts the bundle and gets it ready for deployment.
images n Image     Images attached to the bundle

Users of the Model

Name Cardinality Class Composition Owner Description
bundles n Capability false false SABR Bundles that make up the Capabilities.
consumers n DataStream     This is a consumer of the data stream.
producers n DataStream     This is a producer of the data stream.
consumers n AdminDataStream     This is a consumer of the data stream.
producers n AdminDataStream     This is a producer of the data stream.
parent 1 SABundleInstance     Parent of the SAB Instance

State Net

The SABundle has a state net corresponding to instances of the class. Each state transistion will emit an event that can be caught with a websocket client. The name of the event is the name of the state in all lower case. The following diagram is the state net for this class.

State Net Diagram

Name Description Events
Init Initial State create->Created,
Created The SAB has been created and ready and can be built. build->Building,
Building The SAB is being built. built->Built, failed->Failed,
Built The SABR has been built and ready to be deployed. deploy->Deploying, deploying->Deploying,
Deploying The SABR is connecting to all of the streams including admin and learning streams. deployed->Enabled,
Enabled The SABR is running all transformation and streams are receiving and transmitting disable->Disabled,
Disabled The SABR is disabled and is not receiving or transmitting data. enable->Enabled,
Failed The SABR failed to be built or created.  

Methods

Method Details

Action sabundle build

  • REST - sabundle/build?buildID=string
  • bin - sabundle build –buildID string
  • js - sabundle.build({ buildID:string })

Description

Build the Sentient Agent Bundle

Parameters

Name Type Required Description
buildID string true ID for the build of the bundle

Action sabundle create

  • REST - sabundle/create?name=string&file=file
  • bin - sabundle create –name string –file file
  • js - sabundle.create({ name:string,file:file })

Description

Create a Sentient Agent Bundle

Parameters

Name Type Required Description
name string true name of the Sentient Agent Bundle
file file false file with the definition

Action sabundle deploy

  • REST - sabundle/deploy?policies=ref&parameters=json
  • bin - sabundle deploy –policies ref –parameters json
  • js - sabundle.deploy({ policies:ref,parameters:json })

Description

Deploy a SABundle

Parameters

Name Type Required Description
policies ref true Policies to use for deploying the Bundle.
parameters json false Parameters for the Instance

Action sabundle toJScript

  • REST - sabundle/toJScript?
  • bin - sabundle toJScript
  • js - sabundle.toJScript({ })

Description

Convert the Bundle to a string to be passed over a connection.

Parameters

No parameters