Skip to main content
Version: 0.3.1

Primitives

Attribution

@dataclass(frozen=True)
class Attribution

A word-level relevance value recovered from raw per-head attributions.

Source: src/invera_sdk/completions.py:47

ChatMessage

@dataclass(frozen=True)
class ChatMessage

One chat message rendered through a profile-specific tokenizer template.

Source: src/invera_sdk/completions.py:35

ChatMessageRole

ChatMessageRole = Literal['assistant', 'system', 'tool-description', 'tool', 'user']

Roles supported by the release-pinned chat templates.

Source: src/invera_sdk/completions.py:31

ChatTool

ChatTool = dict[str, Any]

An OpenAI-compatible function tool definition accepted by the chat template.

Source: src/invera_sdk/completions.py:43

ClaimEvidence

@dataclass(frozen=True)
class ClaimEvidence

Evidence and source grounding for one stable assistant claim.

Source: src/invera_sdk/evidence.py:80

ClaimVerificationInput

@dataclass(frozen=True)
class ClaimVerificationInput

Input passed to a host-provided semantic claim verifier.

Source: src/invera_sdk/evidence.py:67

ClaimVerifier

ClaimVerifier = Callable[[ClaimVerificationInput], SemanticVerification]

A host extension that can turn attribution grounding into semantic support.

Source: src/invera_sdk/evidence.py:76

CompletionRequest

@dataclass(frozen=True)
class CompletionRequest

Options for one greedy attributed completion.

Source: src/invera_sdk/completions.py:72

CompletionStreamChunk

@dataclass(frozen=True)
class CompletionStreamChunk

A compatibility chunk matching the former PrismX chat-completions stream.

Source: src/invera_sdk/completions.py:58

EngineCompatibilityError

class EngineCompatibilityError(ValueError)

Raised when an Engine cannot safely serve this SDK.

Source: src/invera_sdk/__init__.py:57

EvidenceOptions

@dataclass(frozen=True)
class EvidenceOptions

Options controlling claim boundaries, verification, and local tool policy.

Source: src/invera_sdk/evidence.py:156

EvidenceSource

@dataclass(frozen=True)
class EvidenceSource

A context source selected from word attribution for an evidence object.

Source: src/invera_sdk/evidence.py:45

EvidenceStreamEvent

@dataclass(frozen=True)
class EvidenceStreamEvent

One event from the semantic completion stream with evidence.

An output_kind event is emitted once, as soon as the kind of the FIRST output is observed (definitive is true because the kind was directly observed, not heuristically guessed). A response may still continue with the other kind afterwards; the final ResponseEvidence.output_kind then reports "mixed".

Source: src/invera_sdk/evidence.py:177

EvidenceVerdict

EvidenceVerdict = Literal['supported', 'contradicted', 'grounded', 'partially_grounded', 'ungrounded', 'unknown']

How strongly the available context grounds or verifies one claim.

Source: src/invera_sdk/evidence.py:26

InveraClient

class InveraClient

Lazy high-level PrismX client compatible with the old attributed chat stream.

Source: src/invera_sdk/completions.py:186

InveraClientOptions

@dataclass(frozen=True)
class InveraClientOptions

Construction options for the high-level attributed-completion client.

Source: src/invera_sdk/completions.py:93

InveraHttpError

class InveraHttpError(RuntimeError)

Raised when an Engine HTTP request fails.

Source: src/invera_sdk/__init__.py:61

ModelInfo

@dataclass(frozen=True)
class ModelInfo

Stable model details intended for application display and diagnostics.

Source: src/invera_sdk/completions.py:83

OutputKind

OutputKind = Literal['text', 'tool_call', 'mixed']

The semantic kind observed in an assistant response.

Source: src/invera_sdk/evidence.py:23

ParameterEvidence

@dataclass(frozen=True)
class ParameterEvidence

Evidence connecting one generated tool argument to conversation context.

Source: src/invera_sdk/evidence.py:109

ResponseEvidence

@dataclass(frozen=True)
class ResponseEvidence

Final evidence report emitted after every claim and tool call is assessed.

Source: src/invera_sdk/evidence.py:166

SchemaIssue

@dataclass(frozen=True)
class SchemaIssue

A machine-readable JSON-schema problem found in a generated tool call.

Source: src/invera_sdk/evidence.py:119

SemanticVerification

@dataclass(frozen=True)
class SemanticVerification

Optional semantic judgement supplied by a host verifier.

Source: src/invera_sdk/evidence.py:58

TextSpan

@dataclass(frozen=True)
class TextSpan

Character offsets into the visible assistant text.

Source: src/invera_sdk/evidence.py:37

ToolCallEvidence

@dataclass(frozen=True)
class ToolCallEvidence

A completed tool call assessed before an agent harness executes it.

Source: src/invera_sdk/evidence.py:135

ToolPolicy

@dataclass(frozen=True)
class ToolPolicy

Local action-risk metadata that is never rendered into the model prompt.

Source: src/invera_sdk/evidence.py:99