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

Describe provider-specific behavior consumed by the server application.

## Module Contents

### Classes

| Name                                                                                                  | Description                                                             |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| [`ProviderIntegration`](#nemoguardrails-server-experimental-provider-integration-ProviderIntegration) | Declare one mounted provider instance and its reviewed endpoint policy. |
| [`UpstreamSettings`](#nemoguardrails-server-experimental-provider-integration-UpstreamSettings)       | Configure one provider upstream and its local mount.                    |

### Data

[`ProviderOpenApiDocument`](#nemoguardrails-server-experimental-provider-integration-ProviderOpenApiDocument)

### API

```python
class nemoguardrails.server.experimental.provider.integration.ProviderIntegration(
    provider_type: str,
    instance_id: str,
    upstream: nemoguardrails.server.experimental.provider.integration.UpstreamSettings,
    display_name: str,
    endpoints: tuple[nemoguardrails.server.experimental.provider.endpoint.GuardedJsonEndpoint, ...],
    errors: nemoguardrails.server.experimental.provider.errors.ProviderErrorMapping,
    control_headers: frozenset[str] = frozenset(),
    openapi_document: nemoguardrails.server.experimental.provider.integration.ProviderOpenApiDocument | None = None
)
```

Dataclass

Declare one mounted provider instance and its reviewed endpoint policy.

`provider_type` identifies the protocol family, not a globally registered
definition. Instances of the same family may select different endpoints or
dialects, error mappings, and control headers. `instance_id` and mount
paths are unique within the application; policy is never selected from
untrusted request data or inferred from the upstream URL.

**`control_headers`** `frozenset[str] = frozenset()`

---

**`display_name`** `str`

---

**`endpoints`** `tuple[GuardedJsonEndpoint, ...]`

---

**`errors`** `ProviderErrorMapping`

---

**`instance_id`** `str`

---

**`openapi_document`** `ProviderOpenApiDocument | None = None`

---

**`provider_type`** `str`

---

**`upstream`** `UpstreamSettings`

---

```python
nemoguardrails.server.experimental.provider.integration.ProviderIntegration.__post_init__() -> None
```

```python
class nemoguardrails.server.experimental.provider.integration.UpstreamSettings(
    base_url: str,
    mount_path: str = ''
)
```

Dataclass

Configure one provider upstream and its local mount.

**`base_url`** `str`

---

**`mount_path`** `str = ''`

---

```python
nemoguardrails.server.experimental.provider.integration.ProviderOpenApiDocument: TypeAlias = Callable[[], Mapping[str, Any]]
```