Skip to navigation

nemoguardrails.server.experimental.provider.stream_classifier

View as MarkdownOpen in Claude

Validate declared event shapes without changing the inspected wire text.

Module Contents

Classes

NameDescription
StreamArraySelectionSelect stream content by provider discriminator fields.
StreamClassifierClassify provider events using validated stream rules.
StreamClassifierDefinitionDescribe the event-shape semantics of one guarded provider stream.
StreamEventRuleDeclare validation and classification for one provider event shape.

Functions

NameDescription
_resolve_text-
build_stream_classifierValidate declared event rules and return their runtime classifier.

Data

StreamMatchValue

StreamTextPath

API

class nemoguardrails.server.experimental.provider.stream_classifier.StreamArraySelection(
cardinality: typing.Literal['at_most_one', 'exactly_one']
)
Dataclass

Select stream content by provider discriminator fields.

cardinality
Literal['at_most_one', 'exactly_one']
match
tuple[tuple[str, StreamMatchValue], ...]
nemoguardrails.server.experimental.provider.stream_classifier.StreamArraySelection.select(
items: collections.abc.Sequence[object]
) -> object | None
class nemoguardrails.server.experimental.provider.stream_classifier.StreamClassifier(
subject: str,
sentinels: tuple[tuple[bytes, str], ...],
non_data_shape: str | None,
event_type_field: str | None,
require_event_type: bool
)
Dataclass

Classify provider events using validated stream rules.

contract
StreamProjectionContract
event_type_field
str | None
non_data_shape
str | None
require_event_type
bool
rules
tuple[StreamEventRule, ...]
sentinels
tuple[tuple[bytes, str], ...]
subject
str
nemoguardrails.server.experimental.provider.stream_classifier.StreamClassifier.classify_event(

Validate and classify one native provider event.

class nemoguardrails.server.experimental.provider.stream_classifier.StreamClassifierDefinition(
subject: str,
sentinels: tuple[tuple[bytes, str], ...] = (),
non_data_shape: str | None = None,
event_type_field: str | None = None,
require_event_type: bool = False
)
Dataclass

Describe the event-shape semantics of one guarded provider stream.

contract
StreamProjectionContract
event_type_field
str | None = None
non_data_shape
str | None = None
require_event_type
bool = False
rules
tuple[StreamEventRule, ...]
sentinels
tuple[tuple[bytes, str], ...] = ()
subject
str
class nemoguardrails.server.experimental.provider.stream_classifier.StreamEventRule(
shape: str,
model: type[pydantic.BaseModel],
required_fields: frozenset[str] = frozenset(),
missing_text_shape: str | None = None,
missing_text_value: str | None = None
)
Dataclass

Declare validation and classification for one provider event shape.

match
tuple[tuple[str, StreamMatchValue], ...] = ()
missing_text_role
StreamEventRole | None = None
missing_text_shape
str | None = None
missing_text_value
str | None = None
model
type[BaseModel]
required_fields
frozenset[str] = frozenset()
role
StreamEventRole
shape
str
text_path
StreamTextPath | None = None
nemoguardrails.server.experimental.provider.stream_classifier.StreamEventRule.matches(
payload: dict[str, typing.Any]
) -> bool

Return whether a provider payload selects this event rule.

nemoguardrails.server.experimental.provider.stream_classifier._resolve_text(
projection: pydantic.BaseModel | dict[str, typing.Any],
) -> str | None

Validate declared event rules and return their runtime classifier.

nemoguardrails.server.experimental.provider.stream_classifier.StreamMatchValue = str | int | float | bool | None
nemoguardrails.server.experimental.provider.stream_classifier.StreamTextPath = tuple[str | int | StreamArraySelection, ...]