RetrievalInstructionFailureReason¶
Structure Class¶
RetrievalInstructionFailureReason
dataclass
¶
Bases: _SerdeShape
One reason the most recent create or update did not succeed. code drives programmatic branching (fix the text, fix the configuration, or retry); message carries the specific cause.
Attributes¶
code
instance-attribute
¶
code: str
Stable, machine-readable classification by fault attribution. Valid values:
-
CONTENT_REJECTED -- The review rejected the named field's content; revise the text and resubmit.
-
CLIENT_ERROR -- The review could not run for a customer-side reason, for example the customer managed AWS KMS key could not be used; fix the configuration and resubmit.
-
INTERNAL_ERROR -- The review could not complete due to a service fault; retry the create or update.
New values may be added over time; your client should tolerate values it does not recognize and treat them as a failure.
field_name
class-attribute
instance-attribute
¶
field_name: str | None = ...
The instruction field this entry is about. Present on review rejections of a specific field; absent when the failure applies to the whole review, because a client-side execution failure or a service fault has no single field.