C3 AI Documentation Home

Nexus Base Package Documentation

The nexusBase package supplies the common building blocks the Nexus packages reuse instead of re-implementing: the base application and CloudService types they extend, the GenaiCore.Llm provider and embedding types for talking to Azure, OpenAI, Bedrock, and Vertex AI, and shared helpers for app-start hooks, scheduled jobs, privileged server-side helpers, and errors. You don't use it directly; you get it as a dependency of the package you install (such as nexus or llmService). Depend on it when building a new Nexus package that needs the same primitives.

Key types in this package

TypeWhat you use it for
NexusBase.AppExtend it to build a new Nexus application.
NexusBase.AppStartHookRun setup and reconciliation logic when the app starts.
NexusBase.CloudServiceExtend it to add a Helm-deployed service to a Nexus package.
NexusBase.CloudServiceConfigConfigure a Nexus CloudService.
NexusBase.CronManagerRegister and manage the package's scheduled jobs.
GenaiCore.Llm.ClientCall an LLM provider (Azure, OpenAI, Bedrock, Vertex) from package code.

Key files in this package

The package is structured in the following manner:

Text
.
└── nexusBase/
    ├── config
    ├── metadata
    ├── test
    └── src/
        ├── app
        └── llm
Folder nameContent
configPackage configuration files.
metadataSeed roles and package metadata.
testTests per runtime for the shared utilities.
src/appBase application type and the update manager.
src/llmGenaiCore.Llm provider, model, auth, and embedding types.
Was this page helpful?