> This page is for version Latest (default).
> 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.transport

Describe provider fields and API revisions bound outside JSON bodies.

## Module Contents

### Classes

| Name                                                                                                              | Description                                                       |
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| [`ApiRevisionConstraint`](#nemoguardrails-server-experimental-provider-transport-ApiRevisionConstraint)           | Define which client-selected API revisions a binding accepts.     |
| [`ExactApiRevision`](#nemoguardrails-server-experimental-provider-transport-ExactApiRevision)                     | Accept one exact provider API revision.                           |
| [`ProviderApiRevisionBinding`](#nemoguardrails-server-experimental-provider-transport-ProviderApiRevisionBinding) | Bind a client-selected provider API revision to HTTP metadata.    |
| [`ProviderBindingViolation`](#nemoguardrails-server-experimental-provider-transport-ProviderBindingViolation)     | Report request metadata outside a guarded endpoint binding.       |
| [`ProviderTransportRequest`](#nemoguardrails-server-experimental-provider-transport-ProviderTransportRequest)     | Expose the HTTP metadata used by provider transport bindings.     |
| [`TransportLocation`](#nemoguardrails-server-experimental-provider-transport-TransportLocation)                   | Identify where provider protocol data appears in an HTTP request. |

### API

```python
class nemoguardrails.server.experimental.provider.transport.ApiRevisionConstraint()
```

Abstract

Define which client-selected API revisions a binding accepts.

**`example`** `str`

Return one accepted revision for examples and tests.

---

```python
nemoguardrails.server.experimental.provider.transport.ApiRevisionConstraint.accepts(
    revision: str | None
) -> bool
```

abstract

Return whether a received revision is accepted.

```python
nemoguardrails.server.experimental.provider.transport.ApiRevisionConstraint.describe() -> str
```

abstract

Describe accepted revisions in validation errors.

```python
nemoguardrails.server.experimental.provider.transport.ApiRevisionConstraint.openapi_schema() -> dict[str, object]
```

abstract

Describe accepted revisions as an OpenAPI string schema.

```python
class nemoguardrails.server.experimental.provider.transport.ExactApiRevision(
    value: str
)
```

Dataclass

**Bases:** [ApiRevisionConstraint](#nemoguardrails-server-experimental-provider-transport-ApiRevisionConstraint)

Accept one exact provider API revision.

**`example`** `str`

Return the accepted revision.

---

**`value`** `str`

---

```python
nemoguardrails.server.experimental.provider.transport.ExactApiRevision.__post_init__() -> None
```

Require a non-empty revision.

```python
nemoguardrails.server.experimental.provider.transport.ExactApiRevision.accepts(
    revision: str | None
) -> bool
```

Return whether the received revision is the reviewed value.

```python
nemoguardrails.server.experimental.provider.transport.ExactApiRevision.describe() -> str
```

Describe the accepted revision in validation errors.

```python
nemoguardrails.server.experimental.provider.transport.ExactApiRevision.openapi_schema() -> dict[str, object]
```

Describe the exact revision as an OpenAPI string schema.

```python
class nemoguardrails.server.experimental.provider.transport.ProviderApiRevisionBinding(
    accepted: nemoguardrails.server.experimental.provider.transport.ApiRevisionConstraint,
    location: nemoguardrails.server.experimental.provider.transport.TransportLocation,
    transport_name: str,
    error_code: str = 'unsupported_provider_api_r...
)
```

Dataclass

Bind a client-selected provider API revision to HTTP metadata.

**`accepted`** `ApiRevisionConstraint`

---

**`error_code`** `str = 'unsupported_provider_api_revision'`

---

**`location`** `TransportLocation`

---

**`transport_name`** `str`

---

```python
nemoguardrails.server.experimental.provider.transport.ProviderApiRevisionBinding.__post_init__() -> None
```

Validate revision transport metadata.

```python
nemoguardrails.server.experimental.provider.transport.ProviderApiRevisionBinding.openapi_parameter() -> dict[str, object]
```

Return the required OpenAPI revision parameter.

```python
nemoguardrails.server.experimental.provider.transport.ProviderApiRevisionBinding.validate(
    request: nemoguardrails.server.experimental.provider.transport.ProviderTransportRequest
) -> None
```

Validate one revision selector, rejecting even identical duplicates.

```python
class nemoguardrails.server.experimental.provider.transport.ProviderBindingViolation(
    message: str,
    code: str
)
```

**Bases:** `ValueError`

Report request metadata outside a guarded endpoint binding.

```python
class nemoguardrails.server.experimental.provider.transport.ProviderTransportRequest()
```

Protocol

Expose the HTTP metadata used by provider transport bindings.

**`headers`** `Sequence[tuple[bytes, bytes]]`

Return the request headers as raw name/value pairs.

---

**`query`** `bytes`

Return the raw request query string.

---

```python
class nemoguardrails.server.experimental.provider.transport.TransportLocation
```

**Bases:** `enum.Enum`

Identify where provider protocol data appears in an HTTP request.

**`HEADER`** `= 'header'`

---

**`PATH`** `= 'path'`

---

**`QUERY`** `= 'query'`

---