> 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.sse

Parse Server-Sent Events without provider-specific knowledge.

The parser preserves complete upstream events byte-for-byte while exposing the
event type and joined data fields needed by provider adapters.

## Module Contents

### Classes

| Name                                                                                                    | Description                                                        |
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
| [`AmbiguousServerSentEvent`](#nemoguardrails-server-experimental-provider-sse-AmbiguousServerSentEvent) | Report SSE bytes that common clients interpret differently.        |
| [`ServerSentEvent`](#nemoguardrails-server-experimental-provider-sse-ServerSentEvent)                   | Represent one complete SSE event.                                  |
| [`ServerSentEventTooLarge`](#nemoguardrails-server-experimental-provider-sse-ServerSentEventTooLarge)   | Report an SSE event that exceeds the configured buffering limit.   |
| [`TruncatedServerSentEvent`](#nemoguardrails-server-experimental-provider-sse-TruncatedServerSentEvent) | Report an unfinished SSE block containing fields at end of stream. |
| [`_SSEFramer`](#nemoguardrails-server-experimental-provider-sse-_SSEFramer)                             | -                                                                  |

### Functions

| Name                                                                                  | Description                                                |
| ------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| [`iter_sse_events`](#nemoguardrails-server-experimental-provider-sse-iter_sse_events) | Yield complete SSE blocks from arbitrary HTTP byte chunks. |

### API

```python
class nemoguardrails.server.experimental.provider.sse.AmbiguousServerSentEvent()
```

**Bases:** `ValueError`

Report SSE bytes that common clients interpret differently.

```python
class nemoguardrails.server.experimental.provider.sse.ServerSentEvent(
    raw: bytes,
    lines: tuple[bytes, ...]
)
```

Dataclass

Represent one complete SSE event.

**`data`** `bytes | None`

Return joined SSE data fields, or `None` when none are present.

---

**`event_type`** `bytes | None`

Return the last SSE event field, or `None` when it is absent.

---

**`lines`** `tuple[bytes, ...]`

Event field and comment lines without line endings.

---

**`raw`** `bytes`

Original event bytes, including its terminating blank line when
supplied by the upstream server.

---

```python
nemoguardrails.server.experimental.provider.sse.ServerSentEvent.from_bytes(
    raw: bytes
) -> nemoguardrails.server.experimental.provider.sse.ServerSentEvent
```

classmethod

Create an event while retaining its original representation.

**Parameters:**

**`raw`** `bytes`

Exactly one complete SSE block, without stream-start BOM handling.

---

**Returns:** [`ServerSentEvent`](#nemoguardrails-server-experimental-provider-sse-ServerSentEvent)

The parsed event representation.

```python
class nemoguardrails.server.experimental.provider.sse.ServerSentEventTooLarge()
```

**Bases:** `ValueError`

Report an SSE event that exceeds the configured buffering limit.

```python
class nemoguardrails.server.experimental.provider.sse.TruncatedServerSentEvent()
```

**Bases:** `ValueError`

Report an unfinished SSE block containing fields at end of stream.

```python
class nemoguardrails.server.experimental.provider.sse._SSEFramer(
    max_event_bytes: int,
    stream_start: bool = True
)
```

**`line_start`** `= 0`

---

**`lines`** `list[bytes] = []`

---

**`raw`** `= bytearray()`

---

```python
nemoguardrails.server.experimental.provider.sse._SSEFramer._append(
    value: int
) -> None
```

```python
nemoguardrails.server.experimental.provider.sse._SSEFramer._end_line(
    ending_length: int
) -> nemoguardrails.server.experimental.provider.sse.ServerSentEvent | None
```

```python
nemoguardrails.server.experimental.provider.sse._SSEFramer._field_line(
    line: bytes
) -> bytes
```

```python
nemoguardrails.server.experimental.provider.sse._SSEFramer.feed(
    chunk: bytes
) -> collections.abc.Iterator[nemoguardrails.server.experimental.provider.sse.ServerSentEvent]
```

```python
nemoguardrails.server.experimental.provider.sse._SSEFramer.finish() -> collections.abc.Iterator[nemoguardrails.server.experimental.provider.sse.ServerSentEvent]
```

```python
nemoguardrails.server.experimental.provider.sse.iter_sse_events(
    source: collections.abc.AsyncIterator[bytes],
    max_event_bytes: int = 1024 * 1024
) -> collections.abc.AsyncIterator[nemoguardrails.server.experimental.provider.sse.ServerSentEvent]
```

async

Yield complete SSE blocks from arbitrary HTTP byte chunks.

Preserve raw bytes, including an initial BOM ignored only for field parsing.
Drop unfinished comment tails; reject all other unfinished field blocks.

**Parameters:**

**`source`** `AsyncIterator[bytes]`

Raw upstream response byte stream.

---

**`max_event_bytes`** `int` — default: 1024 \* 1024

Maximum bytes buffered for one event.

---

**Raises:**

* `ValueError`: If `max_event_bytes` is not positive.
* `ServerSentEventTooLarge`: If one event exceeds the limit.
* `TruncatedServerSentEvent`: If the stream ends in an unfinished field block.
* `AmbiguousServerSentEvent`: If a line after stream start begins with a BOM.