Skip to Content
DocsOntologyConcept Index

Concept Index

Alphabetical index of every class and property in the platform ontology suite. Module pages: Entities catalog, Workbench catalog, Server catalog, Runtime catalog.

ModuleKindLocal namePref labelDefinition
runtimeClassAcceptedOfferAccepted OfferElement of offers_accepted; typically mirrors slim OfferResult fields.
entitiesClassAgentConfigAgent ConfigEcogentic agent configuration (collection: agent_configs).
entitiesDatatype propertyagentNameagent name
runtimeDatatype propertyalphaalpha
workbenchClassAnalyticsDashboardAnalytics DashboardWorkbench analytics studio dashboard with charts and filters over Mongo collections.
serverClassAppGenerationJobApp Generation JobAsync job that generates application code from diagrams and ontology context.
runtimeDatatype propertyarmRewardarm reward
workbenchClassAsyncJobAsync JobBackground job for training, synthetic data, enrichment, or generation workflows.
entitiesDatatype propertybehavioralTypebehavioral typerandomisation.sub_approach. Required only for behaviorAlgos: lossAversion, riskAversion, prospectTheory, sentimentalEquilibrium, coverageAwareThompson, longTailBoostMF, generative.
entitiesObject propertybelongsToCatalogbelongs to catalog
runtimeDatatype propertybetabeta
runtimeDatatype propertycachecache
entitiesClassCalendarCalendarCalendar entity used by dynamic and budget scheduling (collection: calendar).
entitiesClassCampaignCampaignWorkbench campaign that binds patron sources, offer matrices, and recommender deployments (collection: campaigns).
runtimeDatatype propertycampaigncampaign
runtimeClassCampaignContextCampaign ContextIsolated runtime unit keyed by campaign/predictor name: models, corpora, plugins, logging collections, feature lookup, and optional linked offer matrix.
entitiesDatatype propertycampaignIdcampaign id
runtimeDatatype propertycampaignIdcampaign idRuntime case name (predictor.name / api_params.campaign).
entitiesDatatype propertycatalogIdcatalog id
entitiesDatatype propertycategorycategory
runtimeDatatype propertycategorycategory
runtimeDatatype propertychannelchannel
entitiesClassChannelProfileChannel ProfileDelivery channel configuration for ecogentic / engagement.
entitiesClassContactCatalogContacts CatalogCatalog definition for contact records and sources (collection: contacts_catalog).
entitiesDatatype propertycontactIdcontact id
runtimeClassContactLogContact LogMongo logging document for an invocation (logging.ecosystemruntime): uuid, predictor, api_params, params lookup, final_result, stats, scoring_data, date indexes.
entitiesClassContactRecordContact RecordIndividual contact / patron document with core, behavioral, and offers history.
entitiesDatatype propertycostcost
runtimeDatatype propertycostcost
runtimeDatatype propertycustomercustomer
runtimeClassCustomerFeatureDocumentCustomer Feature DocumentOpen polymorphic document returned by predictor.param.lookup or built from API params input/value. Any field shape is allowed. A spend or money personality lookup is valid when the document has the fields the post-score plugin copies. This is not an H2O feature-store frame and not a closed schema.
entitiesClassDashboardDashboardAnalytics dashboard definition.
entitiesClassDataConnectionData ConnectionExternal data connection such as Trino/Presto (collection: data_connections).
runtimeDatatype propertydateLogdate log
runtimeDatatype propertydebugEnableddebugOptional opt-in flag (true, 1). When set, the response includes a debug sibling object with pipeline errors and config snapshots. Not for production traffic.
entitiesDatatype propertydeploymentNamedeployment name
entitiesClassDeploymentStepDeployment StepEmbedded project deployment configuration pushed to ecosystem-runtime (paths, plugins, offer matrix, feature store).
serverClassDiagramDiagramSaved UML diagram (class, sequence, etc.) belonging to a modeling project.
serverDatatype propertydiagramNamediagram name
serverDatatype propertydiagramTypediagram type
serverClassDomainCatalogEntryDomain Catalog EntryHosted business-domain seed from the domain catalog (ontology.ttl + shapes.ttl) loaded by DomainCatalogService. Industry domains live under https://ecosystemcode.com/ontology/{id} .
serverDatatype propertydomainIddomain id
entitiesClassDynamicEngagementDynamic EngagementOnline learning / bandit engagement configuration (collection: dynamic_engagement) with algorithm, contextual variables, and store bindings.
runtimeClassDynamicEngagementConfigDynamic Engagement ConfigRuntime corpora entry for a dynamic engagement. The approach is epsilonGreedy, binaryThompson, naiveBayes, QLearning, behaviorAlgos, or Network. A behavioral type is required only for behaviorAlgos. Spend Personality and Money Personality are not approaches.
runtimeObject propertyembedsContactLogembeds contact logresponse_log field.
entitiesDatatype propertyengagementKindengagement kinddynamic, static, or hybrid. Derived from links and scoringMode. projectType is not the classifier.
entitiesDatatype propertyengagementNamename
entitiesClassEnrichmentPipelineEnrichment PipelineSaved data enrichment pipeline configuration.
runtimeDatatype propertyexploreexplore
entitiesClassFactInjectionConfigFact Injection ConfigFact injection / chat configuration (collection: chat_config).
runtimeClassFeatureLookupConfigFeature Lookup ConfigConfiguration for customer/feature DB lookup (database, collection, key, typically customer).
runtimeObject propertyfeaturesObjfeatures object
entitiesClassFeatureStoreRefFeature Store ReferencePointer to a feature-store database and collection used for customer or context lookup.
runtimeClassFinalResultEntryFinal Result EntryOne ranked row in final_result with rank, slim result, and result_full.
runtimeDatatype propertyfinalScorefinal score
entitiesClassFrameFrameTraining or reference data frame used by static model predictors (collection: frames).
entitiesDatatype propertyframeIdframe id
serverClassGenerationStrategyGeneration StrategySelectable strategy or plugin binding for app/UML generation.
runtimeClassGlobalSettingsGlobal SettingsDeployment properties for a campaign (plugins, logging, offer matrix path, param lookup, corpora).
runtimeObject propertyhasAcceptedOfferhas accepted offer
entitiesObject propertyhasAgenthas agentproject_agents asset link.
entitiesObject propertyhasCalendarhas calendar
entitiesObject propertyhasCampaignhas campaignproject_campaigns asset link.
entitiesObject propertyhasDataConnectionhas data connection
runtimeObject propertyhasDebughas debug
runtimeObject propertyhasDebugConfighas debug config
runtimeObject propertyhasDebugDatabasehas debug database
runtimeObject propertyhasDebugErrorhas debug error
runtimeObject propertyhasDebugExplanationhas debug explanation
runtimeObject propertyhasDebugParamshas debug params
entitiesObject propertyhasDeploymentStephas deployment stepdeployment_step array on the project document.
serverObject propertyhasDiagramhas diagram
entitiesObject propertyhasDynamicEngagementhas dynamic engagementproject_dynamic_interactions asset link.
runtimeObject propertyhasDynamicEngagementhas dynamic engagement
runtimeObject propertyhasEntryhas entry
entitiesObject propertyhasFactInjectionConfighas fact injection config
runtimeObject propertyhasFeatureLookuphas feature lookupOpen-schema binding; target documents are CustomerFeatureDocument instances of any shape.
entitiesObject propertyhasFeatureStorehas feature store
entitiesObject propertyhasFeatureStoreFramehas feature store framefeature_stores array. Static H2O frames. Leave empty for dynamic projects.
runtimeObject propertyhasFinalResulthas final result
entitiesObject propertyhasFramehas frameproject_models asset link.
entitiesObject propertyhasOfferEntryhas offer entry
entitiesObject propertyhasOfferMatrixhas offer matrixproject_offer_matrices asset link.
runtimeObject propertyhasOfferMatrixlinks offer matrixCampaign links one offer matrix with fixed row schema.
serverObject propertyhasOntologyContexthas ontology context
entitiesObject propertyhasOptionsStorehas options store
entitiesObject propertyhasPredictorhas predictorproject_predictors asset link.
entitiesObject propertyhasPrompthas prompt
entitiesObject propertyhasResponderConfighas responder config
runtimeObject propertyhasResponsePayloadhas response payload
runtimeObject propertyhasServerInfohas server info
runtimeObject propertyhasSettingshas settings
entitiesObject propertyhasSimulationhas simulation
runtimeObject propertyhasSlimResulthas slim result
runtimeObject propertyhasStatshas stats
workbenchClassIndicativeOntologyInferenceIndicative Ontology InferenceOperation that samples a Mongo collection and emits an indicative Turtle ontology draft from observed fields.
runtimeClassInvocationDebugInvocation DebugOptional debug payload on InvocationResponse when debug was requested: explanations, errors, config, database, params snapshots.
runtimeClassInvocationDebugConfigInvocation Debug ConfigIn-memory campaign snapshot: plugin_prescore, plugin_postscore, models_loaded, offers_loaded, mongo_client.
runtimeClassInvocationDebugDatabaseInvocation Debug DatabaseMongo ping snapshot from RuntimeConfig.getDatabaseStatus when client is present.
runtimeClassInvocationDebugErrorInvocation Debug ErrorOne recorded pipeline error in debug.errors: stage, code, exception, at, message.
runtimeClassInvocationDebugExplanationInvocation Debug ExplanationOperator-facing explanation in debug.explanations: code, severity, title, message, optional hint.
runtimeClassInvocationDebugParamsInvocation Debug ParamsSanitized request, lookup, and feature-name snapshot (no offer matrix or secrets).
runtimeClassInvocationRequestInvocation RequestPOST /invocations body: campaign, subcampaign, customer, channel, numberoffers, userid, params (JSON string).
runtimeClassInvocationResponseInvocation ResponseAPI return with uuid, final_result ranked offers, explore/cache flags, in_params echo.
runtimeClassInvocationStatsInvocation StatsTiming and model metadata on a contact log (duration, epsilon, predictor, error).
workbenchDatatype propertyjobIdjob id
workbenchDatatype propertyjobLifecycleStatelifecycle stateQueued, Running, Succeeded, Failed, or Cancelled.
runtimeObject propertyjoinsOfferjoins offeroptionKey equals matrix offer_id.
entitiesDatatype propertylearningAlgorithmlearning algorithmrandomisation.approach: epsilonGreedy, binaryThompson, naiveBayes, QLearning, behaviorAlgos, Network.
entitiesObject propertylinkedToProjectlinked to projectproject_ids on contacts catalog / records.
runtimeDatatype propertylookupKeylookup key
entitiesDatatype propertymatrixStatusstatusdraft, active, or archived.
entitiesDatatype propertymatrixVersionversion
entitiesDatatype propertymodelIdmodel id
serverClassModelingProjectModeling ProjectUML / modeling project persisted in ecosystem-server (projects collection) with description, diagrams, and optional ontologyContext. engagementKind belongs to the Workbench Project, not to this class.
serverDatatype propertymodelingProjectIdproject id
runtimeDatatype propertymodifiedOfferScoremodified offer score
workbenchClassMoneyPersonalityCaseMoney Personality CaseLookup-only money personality scoring. Any lookup store is valid when documents carry the PostScoreMoneyPersonality fields. The runtime result is PersonalityOfferResult.
entitiesClassMoneyPersonalityLookupMoney Personality LookupLookup-only money personality score copied by PostScoreMoneyPersonality. Any database and collection is valid when the document has the score fields.
entitiesDatatype propertymoneyPersonalitymoney personalitymoney_personality, or personality when that is the stored label.
entitiesDatatype propertymoneyPersonalityScoremoney personality scoremoney_personality_score, or personality_score.
entitiesDatatype propertymoneyTraitmoney trait
workbenchObject propertymonitorsCampaignmonitors campaign deployment
workbenchClassNetworkGraphNetwork GraphKnowledge or network analysis graph managed in the Networks submodule.
workbenchClassNetworkOntologyDefinitionNetwork Ontology DefinitionJSON ontology definition used by Networks for entity types, relation types, and inference rules (distinct from Turtle platform ontologies).
runtimeDatatype propertynumberOffersnumber offers
entitiesDatatype propertyofferIdoffer idJoin key for options store and matrix lookup.
runtimeDatatype propertyofferIdoffer id
entitiesClassOfferMatrixOffer MatrixFirst-class offer catalog entity (collection: offer_matrix) with spec, version, status, and rows or linked rows collection.
runtimeClassOfferMatrixOffer MatrixRuntime-linked offer catalog loaded via predictor.offer.matrix. Rows follow a fixed field format.
entitiesClassOfferMatrixEntryOffer Matrix EntryA single offer row in a matrix. Canonical runtime scoring fields: offer_id, offer_name, cost, price, category, static_offers.
runtimeClassOfferMatrixEntryOffer Matrix EntryCanonical offer row: offer_id, offer_name, cost, price, category, static_offers.
entitiesDatatype propertyofferMatrixIdoffer matrix id
entitiesDatatype propertyofferNameoffer nameDisplay name; primary /response match key.
runtimeDatatype propertyofferNameoffer name
runtimeClassOfferResultOffer ResultSlim scored offer: uuid, offer, offer_name, score, final_score, cost, price, offer_value, arm_reward, modified_offer_score.
serverClassOntologyContextOntology ContextStructured ontologyContext on a modeling project: domain ids, structuredModel, promptContext, roles, and related generation metadata.
serverClassOntologySynthesisRunOntology Synthesis RunEnhance/export run that merges diagrams, DB import, and roles into ontologyContext and Turtle export.
workbenchDatatype propertyontologyTtlontology turtleOptional open Turtle ontology text guiding synthetic generation.
runtimeClassOptionOptionDynamic engagement options row: optionKey joins OfferMatrixEntry.offer_id; alpha, beta, arm_reward, propensity.
runtimeDatatype propertyoptionKeyoption key
entitiesClassOptionsStoreRefOptions Store ReferencePointer to the dynamic engagement options store (arms / options with alpha, beta, rewards).
runtimeDatatype propertyparamsJsonparamsMust be a JSON string on the wire, not a nested object.
entitiesDatatype propertypersonalitypersonalitySpend personality label copied to offer, offer_id, and offer_name.
entitiesDatatype propertypersonalityScorepersonality scorepersonality_score on the looked-up document.
runtimeClassPersonalityOfferResultPersonality Offer ResultLookup-only result_full from PostScoreSpendingPersonality, including generated copies, or PostScoreMoneyPersonality. Those plugins copy precomputed fields. They do not score an H2O model and do not update the options store.
serverClassPlantUmlArtifactPlantUML ArtifactPlantUML text or SVG produced from diagram JSON via server-side conversion.
runtimeClassPostPredictPluginPost-Predict Pluginplugin.postscore class that builds final_result. PlatformDynamicEngagement is dynamic engagement. PostScoreBasic is static model scoring. PostScoreSpendingPersonality, including generated copies, and PostScoreMoneyPersonality are lookup-only. PostScoreNetwork is a network step.
entitiesDatatype propertypredictIdpredict idPrediction case identifier (predict_id / prediction_case_id).
entitiesClassPredictorPredictorStatic or AutoML prediction case configuration (collection: predictions). Links to a training frame and model parameters.
runtimeDatatype propertypredictorpredictor
runtimeClassPrePredictPluginPre-Predict Pluginplugin.prescore class that mutates params before scoring.
entitiesDatatype propertypriceprice
runtimeDatatype propertypriceprice
serverObject propertyproducesArtifactproduces artifact
runtimeClassProductOfferResultProduct Offer ResultRecommender result_full with nested product catalog fields and bandit stats (alpha, beta, propensity).
entitiesClassProjectProjectHub configuration that groups predictors, frames, dynamic engagements, offer matrices, campaigns, agents, and deployment steps for a solution.
entitiesDatatype propertyprojectDescriptionproject description
entitiesDatatype propertyprojectIdproject idPrimary business identifier for the project (project_id).
entitiesDatatype propertyprojectOwnerproject owner
entitiesDatatype propertyprojectTypeproject typeFree label. Not the classifier. Review may set dynamic_recommender.
entitiesClassPromptPromptGenerative prompt library entry (collection: prompt_library).
workbenchClassPublicApiCatalogEntryPublic API Catalog EntryDocumented public API entity label and collection mapping exposed by the Workbench public API catalog.
entitiesDatatype propertypurposepurpose
runtimeDatatype propertyrankrank
entitiesClassResponderConfigResponder API ConfigResponder / API configuration for serving predictions (collection: responder_config).
runtimeObject propertyrespondsToresponds toMatched by shared uuid.
runtimeClassResponseFeedbackResponse FeedbackPOST /response body: uuid required; offers_accepted with offer_name (preferred match key).
runtimeClassResponseLogResponse LogMongo logging document for feedback (logging.ecosystemruntime_response): uuid, response_uuid, embedded response_log (ContactLog), response payload, stats.
runtimeDatatype propertyresponseUuidresponse uuid
runtimeClassRewardPluginReward Pluginplugin.reward class that updates learning state after /response.
workbenchClassRuntimeConsoleRuntime ConsoleUI surface for inspecting and operating deployed ecosystem-runtime campaigns.
runtimeDatatype propertyscorescore
entitiesDatatype propertyscoringModescoring modedynamic, static, or lookup.
runtimeObject propertyscoringDatascoring dataOpen feature bag logged when logging.detail is true; may also echo options-store state.
runtimeClassScoringParamsScoring ParamsInternal pipeline object combining API fields, featuresObj, offerMatrix, corpora, and MAB flags passed to plugins.
runtimeClassServerInfoServer InfoRuntime host metadata: hostname, address, port, version.
entitiesClassSimulationSimulationSimulation configuration for offline evaluation of deployments.
workbenchClassSolutionCaseSolution CaseProductized Workbench solution configuration such as Spend Personality or Two-Tower recommender.
workbenchClassSpendPersonalityCaseSpend Personality CaseLookup-only spend personality scoring. Any lookup store is valid when documents carry the PostScoreSpendingPersonality fields. The runtime result is PersonalityOfferResult.
entitiesClassSpendPersonalityLookupSpend Personality LookupLookup-only spend personality score copied by PostScoreSpendingPersonality, including generated copies. Any database and collection is valid when the document has the score fields.
entitiesDatatype propertystaticOffersstatic offersStatic priority slate when greater than 0.
runtimeDatatype propertystaticOffersstatic offers
entitiesDatatype propertystepTypestep typedeployment_step.step_type. Does not override scoringMode.
runtimeDatatype propertysubcampaignsubcampaign
serverClassSyntheticDataPackageJobSynthetic Data Package JobModeling synthetic-data job that produces ZIP packages (JSON/CSV/SQL/DDL) from class diagrams — distinct from Workbench2 Mongo synthetic.
workbenchClassSyntheticDataRequestSynthetic Data RequestRequest to generate Mongo documents from a free-text prompt, optionally grounded by an open ontology TTL.
workbenchDatatype propertytargetCollectiontarget collection
workbenchDatatype propertytargetDatabasetarget database
entitiesDatatype propertytraittrait
entitiesDatatype propertytraitScoretrait scoretrait_score when present.
serverObject propertytriggeredByProjecttriggered by project
workbenchClassTwoTowerCaseTwo-Tower CaseTwo-tower recommender training and deployment case.
serverClassUmlGenerationJobUML Generation JobAsync job that generates or analyzes UML diagrams for a modeling project.
serverObject propertyusesDomainCataloguses domain catalog
entitiesObject propertyusesFrameuses frameTraining frame referenced by model_parms.training_frame.
entitiesObject propertyusesOfferMatrixuses offer matrix
runtimeObject propertyusesPostPluginuses post plugin
runtimeObject propertyusesPrePluginuses pre plugin
runtimeObject propertyusesRewardPluginuses reward plugin
workbenchObject propertyusesSolutionCaseuses solution case
runtimeDatatype propertyuuiduuidInvocation / contact correlation id shared across logs and /response.
Last updated on