Skip to navigation

nemoguardrails.server.experimental.provider.integration

View as MarkdownOpen in Claude

Describe provider-specific behavior consumed by the server application.

Module Contents

Classes

NameDescription
ProviderIntegrationDeclare one mounted provider instance and its reviewed endpoint policy.
UpstreamSettingsConfigure one provider upstream and its local mount.

Data

ProviderOpenApiDocument

API

class nemoguardrails.server.experimental.provider.integration.ProviderIntegration(
provider_type: str,
instance_id: str,
display_name: str,
control_headers: frozenset[str] = frozenset(),
)
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
nemoguardrails.server.experimental.provider.integration.ProviderIntegration.__post_init__() -> None
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 = ''
nemoguardrails.server.experimental.provider.integration.ProviderOpenApiDocument: TypeAlias = Callable[[], Mapping[str, Any]]