Pipeline API

Reference for the optixlog.pipeline module — ingest workflow nodes into a project graph.

The optixlog.pipeline module provides the write path for the OptixLog SDK. You use it to ingest typed workflow nodes into a project's graph, creating or updating nodes and wiring their edges.

from optixlog.pipeline import Pipeline, PipelineProject, IngestResult, IngestibleNode

Module contents

Symbol	Kind	Description
`Pipeline`	class	Entry point — wraps an `SDKClient`, resolves project handles.
`PipelineProject`	class	Project-scoped ingest surface — call `.ingest()` here.
`IngestResult`	frozen dataclass	Returned by every `.ingest()` call.
`IngestibleNode`	Protocol	Structural contract that node classes (generated or custom) must satisfy.

Typical usage

ingest.py

from optixlog import SDKClient
from optixlog.pipeline import Pipeline
from optixlog_gen import SimulationNode  # generated node class

client = SDKClient(base_url="https://optixlog.leidos.com", api_key="sk-opt-...")
pipeline = Pipeline(client)
project = pipeline.project("proj_grating_7f3a")

result = project.ingest(
    data=SimulationNode(config={}, solver="fdtd"),
    prompt="Ran an FDTD simulation of the grating coupler.",
)
print(result.node_id, result.created)

Pipeline

Pipeline.__init__, Pipeline.project, Pipeline.project_from.

PipelineProject

PipelineProject.ingest — both overloads documented in full.

IngestResult

IngestResult frozen dataclass — all fields.