Skip to navigation

nemoguardrails.server.experimental.providers.openai.chat_completions.request_projection

View as MarkdownOpen in Claude

Field policies for guarded OpenAI Chat Completions requests.

Module Contents

Classes

NameDescription
ChatCompletionsGuardedRequestProjectionDeclare the single-message request shape and explicit feature restrictions.
ChatCompletionsUserMessageProjectionAccept one user text message with reviewed optional provider metadata.

Functions

NameDescription
_require_intReject booleans, strings, and floats before Literal[1] can coerce them.

API

class nemoguardrails.server.experimental.providers.openai.chat_completions.request_projection.ChatCompletionsGuardedRequestProjection()

Bases: PolicyModel, GuardedRequestModel

Declare the single-message request shape and explicit feature restrictions.

The request binding attaches extraction, coverage, and response-mode metadata. Recognizing the stream flag does not imply that an endpoint supports streaming. The request is closed to OpenAI’s fields: compatible servers render some other fields, such as chat_template_kwargs or documents, into the prompt.

audio
Annotated[None, disabled(core_capability.audio_content)] = None
function_call
Annotated[None, disabled(core_capability.tool_content)] = None
functions
Annotated[None, disabled(core_capability.tool_content)] = None
logprobs
Annotated[StrictFalse | None, constrained(reason=(provider_integrity.token_logprobs))] = None
messages
Annotated[list[ChatCompletionsUserMessageProjection], guarded(min_length=1, max_length=1)]
modalities
Annotated[None, disabled(core_capability.multimodal_content)] = None
n
Annotated[Literal[1], BeforeValidator(_require_int), constrained(reason=(core_capability.single_text_target))] = 1
parallel_tool_calls
Annotated[None, disabled(core_capability.tool_content)] = None
policy
ObjectPolicy
prediction
Annotated[None, disabled(core_capability.predicted_content)] = None
reasoning_effort
Annotated[Literal['none', 'minimal', 'low', 'medium', 'high', 'xhigh', 'max'] | None, constrained()] = None
response_format
Annotated[None, disabled(projection_policy.plain_text_output)] = None
stream
Annotated[StrictBool | None, constrained()] = False
tool_choice
Annotated[None, disabled(core_capability.tool_content)] = None
tools
Annotated[None, disabled(core_capability.tool_content)] = None
top_logprobs
Annotated[None, disabled(provider_integrity.token_logprobs)] = None
web_search_options
Annotated[None, disabled(core_capability.tool_content)] = None
class nemoguardrails.server.experimental.providers.openai.chat_completions.request_projection.ChatCompletionsUserMessageProjection()

Bases: PolicyModel, GuardedContentModel

Accept one user text message with reviewed optional provider metadata.

content
Annotated[str, guarded(user, replaceable=True, min_length=1)]
name
Annotated[None, disabled(core_capability.participant_name)] = None
policy
ObjectPolicy
role
Annotated[Literal['user'], constrained()]
nemoguardrails.server.experimental.providers.openai.chat_completions.request_projection._require_int(
value: object
) -> object

Reject booleans, strings, and floats before Literal[1] can coerce them.