> 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.providers.openai.errors

Render and document proxy failures in the OpenAI-compatible format.

## Module Contents

### Classes

| Name                                                                                                               | Description                                                |
| ------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------- |
| [`OpenAIProxyErrorDetails`](#nemoguardrails-server-experimental-providers-openai-errors-OpenAIProxyErrorDetails)   | Describe OpenAI-compatible details generated by the proxy. |
| [`OpenAIProxyErrorResponse`](#nemoguardrails-server-experimental-providers-openai-errors-OpenAIProxyErrorResponse) | Describe an OpenAI-compatible proxy error response.        |

### Functions

| Name                                                                                                     | Description                                                         |
| -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |
| [`_error_response`](#nemoguardrails-server-experimental-providers-openai-errors-_error_response)         | Create a compact OpenAI-compatible JSON error response.             |
| [`render_openai_error`](#nemoguardrails-server-experimental-providers-openai-errors-render_openai_error) | Render one typed proxy outcome with the OpenAI-compatible envelope. |

### Data

[`OPENAI_ERROR_MAPPING`](#nemoguardrails-server-experimental-providers-openai-errors-OPENAI_ERROR_MAPPING)

### API

```python
class nemoguardrails.server.experimental.providers.openai.errors.OpenAIProxyErrorDetails()
```

**Bases:** `BaseModel`

Describe OpenAI-compatible details generated by the proxy.

**`code`** `str`

---

**`message`** `str`

---

**`param`** `str | None`

---

**`type`** `str`

---

```python
class nemoguardrails.server.experimental.providers.openai.errors.OpenAIProxyErrorResponse()
```

**Bases:** `BaseModel`

Describe an OpenAI-compatible proxy error response.

**`error`** `OpenAIProxyErrorDetails`

---

```python
nemoguardrails.server.experimental.providers.openai.errors._error_response(
    status_code: int,
    message: str,
    error_type: str,
    code: str,
    param: str | None = None
) -> nemoguardrails.server.experimental._http_kernel.BufferedHttpResponse
```

Create a compact OpenAI-compatible JSON error response.

```python
nemoguardrails.server.experimental.providers.openai.errors.render_openai_error(
    outcome: nemoguardrails.server.experimental._content_checker.ContentCheckerConfigurationUnsupported | nemoguardrails.server.experimental._content_checker.ContentCheckerResolutionFailed | nemoguardrails.server.experimental._buffered_kernel.OperationBlocked | nemoguardrails.server.experimental._buffered_kernel.OperationCheckFailed | nemoguardrails.server.experimental._buffered_kernel.OperationModificationUnsupported | nemoguardrails.server.experimental._buffered_kernel.OperationProjectionFailed | nemoguardrails.server.experimental._http_kernel.HttpOperationFailed | nemoguardrails.server.experimental._http_kernel.HttpRouteRejected | nemoguardrails.server.experimental._guarded_stream.StreamInspectionUnsupported | nemoguardrails.server.experimental._guarded_stream.StreamProcessingFailed | nemoguardrails.server.experimental._guarded_stream.StreamUpstreamFailed
) -> nemoguardrails.server.experimental._http_kernel.BufferedHttpResponse
```

Render one typed proxy outcome with the OpenAI-compatible envelope.

```python
nemoguardrails.server.experimental.providers.openai.errors.OPENAI_ERROR_MAPPING = ProviderErrorMapping(renderer=render_openai_error, responses=(ProviderErrorRespo...
```