apogee-ai-workflow¶

Long-running, durable agent workflows with HIL pause/resume.

Esta página está sendo ampliada

As tabelas abaixo são geradas do código-fonte do pacote, portanto estão corretas. Guias narrativos e exemplos comentados estão sendo escritos módulo a módulo.

API pública¶

Tudo abaixo é exportado pela raiz do pacote, então from apogee_ai_workflow import X funciona para cada nome.

Camada	Símbolos
Application · DTOs	CancelRunDTO, GateDecisionDTO, ResumeRunDTO, StartRunDTO
Application · Use cases	ApproveGateUseCase, CancelRunUseCase, GetRunUseCase, ListGatesUseCase, ListRunsUseCase, RegisterWorkflowUseCase, RejectGateUseCase, ResumeRunUseCase, StartRunUseCase
Domain	Checkpoint, CompensationFailed, EngineConfig, EngineUnavailable, GateDecision, GateNotFound, GateRejected, HumanGate, RetryPolicy, RunContext, RunStatus, SagaCompensation, Step, StepHandler, StepIO, StepRun, StepStatus, Workflow, WorkflowAlreadyRegistered, WorkflowDefinition, WorkflowRun
Domain · Enums	RetryPolicyKind, StepKind
Domain · Exceptions	RunNotFoundException, StepFailedException, WorkflowError, WorkflowNotFoundException
Domain · Protocols (ports)	ICheckpointer, IHumanGateGateway, IRunRepository, ISagaCompensator, IWorkflowEngine, IWorkflowRepository
Infrastructure	DBOSAdapter, DefaultSagaCompensator, InMemoryCheckpointer, InMemoryHumanGateGateway, InMemoryRunRepository, InMemoryWorkflowRepository, JsonCheckpointer, JsonHumanGateGateway, JsonRunRepository, NativeWorkflowEngine, RestateAdapter, SqlCheckpointer, TemporalAdapter, WorkflowEngineRegistry

Instalação¶

Bash

pip install apogee-ai-workflow

A instalação base não tem dependência externa obrigatória. Cada extra habilita um adapter.

Extra	Traz
`sql`	sqlalchemy>=2.0, asyncpg>=0.29, aiosqlite>=0.20
`redis`	redis>=5.0
`temporal`	temporalio>=1.7
`restate`	restate-sdk>=0.5
`dbos`	dbos>=0.20
`all`	sqlalchemy>=2.0, asyncpg>=0.29, aiosqlite>=0.20, redis>=5.0, temporalio>=1.7, restate-sdk>=0.5, dbos>=0.20

CLI¶

Instalado como console script e registrado como plugin do apogee, então os mesmos subcomandos funcionam sob o binário global.

Bash

apogee-workflow --help

Leia a seguir¶

Instalação
Referência — todo símbolo público, gerado do código-fonte
Apogee Framework — como os pacotes se encaixam