Skip to navigation

OpenAI Chat Completions Guard Contract

View as MarkdownOpen in Claude

API reference · Field-policy meanings

Operation: createChatCompletion. Payload profile: single_text.v1. Contract format: 1.0.0-alpha.1.

Request · Response · Stream · Exact contract

These declarations describe the native binding’s guard boundary, not a complete provider schema. Rails configuration selects the checks that run. See supported content.

Response and stream inspection declarations apply when output inspection is enabled. Guarded request validation still applies when checks are disabled. See disabled checks and pass-through.

Required presence is local to each containing object and schema branch. Nested accordions preserve those scopes; branch labels identify schema alternatives, not payload members. Hover a field name for its exact schema pointer. Defaults are not inserted into forwarded traffic.

Request

FieldTypePresencePolicyRules
audionullOptionalDisabledOmit or null.
frequency_penaltyanyOptionalOpaqueProvider requirements apply.
function_callnullOptionalDisabledOmit or null.
functionsnullOptionalDisabledOmit or null.
logit_biasanyOptionalOpaqueProvider requirements apply.
logprobsboolean or nullOptionalConstrainedIf non-null, must be false.
max_completion_tokensanyOptionalOpaqueProvider requirements apply.
max_tokensanyOptionalOpaqueProvider requirements apply.
messagesarrayRequiredGuardedExactly 1 item. See nested fields.
metadataanyOptionalOpaqueProvider requirements apply.
modalitiesnullOptionalDisabledOmit or null.
modelanyOptionalOpaqueProvider requirements apply.
moderationanyOptionalOpaqueProvider requirements apply.
nintegerOptionalConstrainedMust be 1.
parallel_tool_callsnullOptionalDisabledOmit or null.
predictionnullOptionalDisabledOmit or null.
presence_penaltyanyOptionalOpaqueProvider requirements apply.
prompt_cache_keyanyOptionalOpaqueProvider requirements apply.
prompt_cache_optionsanyOptionalOpaqueProvider requirements apply.
prompt_cache_retentionanyOptionalOpaqueProvider requirements apply.
reasoning_effortstring or nullOptionalConstrainedIf non-null, allowed: "none", "minimal", "low", "medium", "high", "xhigh", "max".
response_formatnullOptionalDisabledOmit or null.
safety_identifieranyOptionalOpaqueProvider requirements apply.
seedanyOptionalOpaqueProvider requirements apply.
service_tieranyOptionalOpaqueProvider requirements apply.
stopanyOptionalOpaqueProvider requirements apply.
storeanyOptionalOpaqueProvider requirements apply.
streamboolean or nullOptionalConstrainedIf non-null, see exact contract.
stream_optionsanyOptionalOpaqueProvider requirements apply.
temperatureanyOptionalOpaqueProvider requirements apply.
tool_choicenullOptionalDisabledOmit or null.
toolsnullOptionalDisabledOmit or null.
top_logprobsnullOptionalDisabledOmit or null.
top_panyOptionalOpaqueProvider requirements apply.
useranyOptionalOpaqueProvider requirements apply.
verbosityanyOptionalOpaqueProvider requirements apply.
web_search_optionsnullOptionalDisabledOmit or null.
model: ChatCompletionsGuardedRequest
reject_case_aliases: true
stream_selector_field: stream
unknown_fields: forbid
FieldTypePresencePolicyRules
contentstringRequiredGuardedAt least 1 character.
namenullOptionalDisabledOmit or null.
rolestringRequiredConstrainedMust be "user".
reject_case_aliases: true
source: '#/components/schemas/ChatCompletionRequestUserMessage'
unknown_fields: configurable

Response

FieldTypePresencePolicyRules
choicesarrayRequiredGuardedExactly 1 item. See nested fields.
createdanyOptionalOpaqueProvider requirements apply.
idanyOptionalOpaqueProvider requirements apply.
metadataanyOptionalOpaqueProvider requirements apply.
modelanyOptionalOpaqueProvider requirements apply.
moderationanyOptionalOpaqueProvider requirements apply.
objectanyOptionalOpaqueProvider requirements apply.
service_tieranyOptionalOpaqueProvider requirements apply.
system_fingerprintanyOptionalOpaqueProvider requirements apply.
usageanyOptionalOpaqueProvider requirements apply.
model: ChatCompletionsGuardedResponse
reject_case_aliases: true
unknown_fields: forbid
FieldTypePresencePolicyRules
finish_reasonanyOptionalOpaqueProvider requirements apply.
indexanyOptionalOpaqueProvider requirements apply.
logprobsnullOptionalDisabledOmit or null.
messageobjectRequiredGuardedSee nested fields.
reject_case_aliases: true
unknown_fields: configurable
FieldTypePresencePolicyRules
annotationsarray or nullOptionalConstrainedIf non-null, at most 0 items. See nested fields.
audionullOptionalDisabledOmit or null.
contentstring or nullRequiredGuardedIf non-null, see exact contract.
function_callnullOptionalDisabledOmit or null.
reasoning_contentnullOptionalDisabledOmit or null.
refusalnullOptionalDisabledOmit or null.
rolestringRequiredConstrainedMust be "assistant".
tool_callsarray or nullOptionalConstrainedIf non-null, at most 0 items. See nested fields.
classification: guarded
reject_case_aliases: true
source: '#/components/schemas/ChatCompletionResponseMessage'
unknown_fields: configurable

Stream

Event roles and missing-text rules come from the bound classifier. See stream declaration meanings and runtime completion and errors.

ShapeRoleText subjectsMissing textSelection
chat.completion.chunk:contentguarded_delta$.choices[].delta.content{"missing_text": "opaque", "missing_text_shape": "chat.completion.chunk:metadata"}{"match": {"object": "chat.completion.chunk"}, "source_schema": "CreateChatCompletionStreamResponse"}
errorprovider_error——{"required_fields": ["error"], "source_schema": "ErrorResponse"}

Transport declarations

transport:
non_data_shape: keepalive
require_sse_event: false
sentinels:
'[DONE]': '[DONE]'

Exact contract

This is the unmodified export from the bound Python endpoint. Stateful stream hooks, enabled Rails checks, and arbitrary Python validation are not serialized.