> This page is for version v0.25.0.
> For other versions, use one of these documentation indexes:
> - Latest (default): https://docs.nvidia.com/nemo/guardrails/latest/llms.txt
> - v0.25.0: https://docs.nvidia.com/nemo/guardrails/v0.25.0/llms.txt
> - v0.24.1: https://docs.nvidia.com/nemo/guardrails/v0.24.1/llms.txt
> - v0.24.0: https://docs.nvidia.com/nemo/guardrails/v0.24.0/llms.txt
> - v0.23.0: https://docs.nvidia.com/nemo/guardrails/v0.23.0/llms.txt
> - v0.22.0: https://docs.nvidia.com/nemo/guardrails/v0.22.0/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/nemo/guardrails/llms.txt.

# nemoguardrails.server.experimental.provider.stream_classifier

Validate declared event shapes without changing the inspected wire text.

## Module Contents

### Classes

| Name                                                                                                                      | Description                                                         |
| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |
| [`StreamArraySelection`](#nemoguardrails-server-experimental-provider-stream_classifier-StreamArraySelection)             | Select stream content by provider discriminator fields.             |
| [`StreamClassifier`](#nemoguardrails-server-experimental-provider-stream_classifier-StreamClassifier)                     | Classify provider events using validated stream rules.              |
| [`StreamClassifierDefinition`](#nemoguardrails-server-experimental-provider-stream_classifier-StreamClassifierDefinition) | Describe the event-shape semantics of one guarded provider stream.  |
| [`StreamEventRule`](#nemoguardrails-server-experimental-provider-stream_classifier-StreamEventRule)                       | Declare validation and classification for one provider event shape. |

### Functions

| Name                                                                                                                | Description                                                        |
| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
| [`_resolve_text`](#nemoguardrails-server-experimental-provider-stream_classifier-_resolve_text)                     | -                                                                  |
| [`build_stream_classifier`](#nemoguardrails-server-experimental-provider-stream_classifier-build_stream_classifier) | Validate declared event rules and return their runtime classifier. |

### Data

[`StreamMatchValue`](#nemoguardrails-server-experimental-provider-stream_classifier-StreamMatchValue)

[`StreamTextPath`](#nemoguardrails-server-experimental-provider-stream_classifier-StreamTextPath)

### API

```python
class nemoguardrails.server.experimental.provider.stream_classifier.StreamArraySelection(
    match: tuple[tuple[str, nemoguardrails.server.experimental.provider.stream_classifier.StreamMatchValue], ...],
    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], ...]`

---

```python
nemoguardrails.server.experimental.provider.stream_classifier.StreamArraySelection.select(
    items: collections.abc.Sequence[object]
) -> object | None
```

```python
class nemoguardrails.server.experimental.provider.stream_classifier.StreamClassifier(
    subject: str,
    contract: nemoguardrails.server.experimental.provider.stream.StreamProjectionContract,
    rules: tuple[nemoguardrails.server.experimental.provider.stream_classifier.StreamEventRule, ...],
    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`

---

```python
nemoguardrails.server.experimental.provider.stream_classifier.StreamClassifier.classify_event(
    event: nemoguardrails.server.experimental.provider.sse.ServerSentEvent
) -> nemoguardrails.server.experimental.provider.stream.GuardedStreamEvent
```

Validate and classify one native provider event.

```python
class nemoguardrails.server.experimental.provider.stream_classifier.StreamClassifierDefinition(
    subject: str,
    contract: nemoguardrails.server.experimental.provider.stream.StreamProjectionContract,
    rules: tuple[nemoguardrails.server.experimental.provider.stream_classifier.StreamEventRule, ...],
    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`

---

```python
class nemoguardrails.server.experimental.provider.stream_classifier.StreamEventRule(
    shape: str,
    model: type[pydantic.BaseModel],
    role: nemoguardrails.server.experimental.provider.stream.StreamEventRole,
    match: tuple[tuple[str, nemoguardrails.server.experimental.provider.stream_classifier.StreamMatchValue], ...] = (),
    required_fields: frozenset[str] = frozenset(),
    text_path: nemoguardrails.server.experimental.provider.stream_classifier.StreamTextPath | None = None,
    missing_text_role: nemoguardrails.server.experimental.provider.stream.StreamEventRole | None = None,
    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`

---

```python
nemoguardrails.server.experimental.provider.stream_classifier.StreamEventRule.matches(
    payload: dict[str, typing.Any]
) -> bool
```

Return whether a provider payload selects this event rule.

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

```python
nemoguardrails.server.experimental.provider.stream_classifier.build_stream_classifier(
    definition: nemoguardrails.server.experimental.provider.stream_classifier.StreamClassifierDefinition
) -> nemoguardrails.server.experimental.provider.stream_classifier.StreamClassifier
```

Validate declared event rules and return their runtime classifier.

```python
nemoguardrails.server.experimental.provider.stream_classifier.StreamMatchValue = str | int | float | bool | None
```

```python
nemoguardrails.server.experimental.provider.stream_classifier.StreamTextPath = tuple[str | int | StreamArraySelection, ...]
```