Skip to main content
Version: 2.13.X

Model Artifacts

Models in Cogynt Authoring consist of "artifacts." An artifact is an entity that contains a certain kind of data or logic.

This section identifies the various artifacts within Cogynt Authoring models and describes their functions.

Projects​

A project contains all artifacts pertaining to a specific model.

Projects are independent of each other; thus, their artifacts cannot be shared.

For more information about working with projects, see Creating and Opening Projects.

Event Patterns​

An event pattern contains pattern detection logic. Users decide what kind of data it should receive, process, and produce for output.

Event patterns may also contain elements, outcomes, and constraints.

For more information about working with event patterns and their child artifacts, see Event Pattern Authoring.

Elements​

An element represents an event pattern's input event type. Other characteristics can also be specified for elements, such as time-to-live.

Outcomes​

An outcome represents an event pattern's output event type. An outcome may also contain outcome computations, risk distribution, and windowing specifications.

Constraints​

A constraint links two elements in an event pattern using their compatible fields (or their constraint computations outputs) coupled with a comparison condition.

User Data Schemas​

A user data schema defines the basic data structure of a data object. The structure contains an ordered list of fields, each given a name and a data type. The supported data types include:

  • Boolean
  • Datetime
  • Float
  • Geo-coordinate
  • Geo-polygon
  • Integer
  • IP
  • String
  • URL
  • Unique ID
  • Untyped or generic array
  • Boolean array
  • Datetime array
  • Float array
  • Geo-coordinate array
  • Geo-polygon array
  • Integer array
  • IP array
  • String array
  • URL array
  • Unique ID array

For more information about working with user data schemas, see Data Authoring.

Event Types​

An event type represents the data processed by an event pattern. It uses a user data schema for its field list. An event type also contains other specifications for the data stream (for example, stream type, stream source, stream filter, and so on).

For more information about working with event types, see Data Authoring.

Lexicons​

A lexicon represents a tree of terms and their synonyms that can be used to filter a data stream.

For more information about working with lexicons, see Lexicon Authoring.

Deployment Targets​

Deployment targets define the data sources, Flink configuration, and logging configuration for the deployment.

For more information about working with deployment targets, see Deploying Models.

Deployments​

A deployment translates the model into code for the system to process. In addition to its deployment target specification, a deployment identifies what event patterns to deploy. Deployments also allow overriding any Flink configuration specified in its linked deployment target. Deployments run indefinitely until they are cancelled.

For more information about working with deployments, see Deploying Models.

Tags​

A tag is a label for grouping or classifying artifacts. Tags can be given names and colors.

note

Currently, only the following artifacts can be tagged:

  • User data schemas
  • Event types
  • Event patterns
  • Lexicons

For information about working with tags, see Managing Tags.