API reference¶
Generated from the docstrings of the public API. The classes you use day to day
are importable from the top-level langgraph_xai package; each entry below
shows the module where the class is defined.
| Page | Contents |
|---|---|
| Runtime | XAIRuntime, Run, XAIInstrumentationError, Registry, InstrumentedGraph, RUN_ID_METADATA_KEY |
| Configuration | XAIConfig |
| Canonical models | Execution records, decision records, explanation records, events, and enumerations |
| Capabilities | The ProvenanceStore base class and the provider protocols |
| Storage | InMemoryProvenanceStore, StoreFilter |
| Observability | LangSmith, Langfuse, OpenTelemetry, and no-op adapters, the adapter base class, helpers, and errors |
| Explanation engines | StructuredExplanationEngine, LLMExplanationEngine, ExplanationDraft |
| Attribution engines | HybridAttribution, RuleBasedAttribution, EvidenceAttribution |
| Policies | DefaultCapturePolicy, DefaultPolicyProvider, and the redaction helpers |
| Plugins | XAIPlugin, PluginManager |
Stability¶
- The public API is everything listed in this reference. Names that start with an underscore are private and may change at any time.
- Serialized records are versioned contracts, identified by their
schema_version. See Canonical model. - Breaking changes happen only in major releases, and each one is listed in the changelog.