BiB2dZddlmZmZddlmZddlmZmZmZm Z m Z ddl m Z m Z mZmZmZmZmZmZmZmZeee dfZeee dd fZeee dd fZeee d d d fZeee dddfZeee ddfZeee ddfZeee ddfZeee dfZGddeeZ GddeeZ!Gdde Z"Gdde Z#Gdd e Z$Gd!d"e Z%Gd#d$e Z&Gd%d&e Z'y')(a4 Revised Pydantic v2 models for Napkin AI API. Changelog: - Adopted Pydantic v2 features: strict types, field/model validators, Annotated constraints, and BaseModel config. - Added strong validation for IDs, URLs, emails, language tags, and list bounds with patterns. - Normalized response envelopes and enhanced error modeling with codes and details. - Improved serialization settings (from_attributes, ser_json_timedelta/bytes) and schema examples. - Added docstrings, field descriptions, and test-friendly snippets; redaction for sensitive fields. - Ensured OpenAPI/JSON Schema compatibility and consistent naming conventions. Model overview: - VisualRequest: client request for visual generation, with constraints and PNG-specific rules. - GeneratedFile: metadata for produced outputs. - VisualResponse: detailed status with files, timestamps, and error message when present. - StatusResponse: lightweight progress/status view. - ErrorResponse: normalized error envelope with code/details and timestamp. - RateLimitInfo: rate limits from headers with helper properties. )datetime timedelta)Enum) AnnotatedListOptionalDictAny) BaseModelFieldHttpUrl StrictBool StrictFloat StrictInt StrictStr SecretStrfield_validatormodel_validator) min_lengthi)r max_lengthi'#z#^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$rrpattern@z^[A-Za-z0-9_\-]+$)geledirc$eZdZdZdZdZdZdZdZy) RequestStatusz!Visual generation request status.pending processing completedfailedexpiredN) __name__ __module__ __qualname____doc__PENDING PROCESSING COMPLETEDFAILEDEXPIRED-/var/www/html/Napkin-AI-API/src/api/models.pyr$r$7s+GJI FGr4r$ceZdZdZdZdZy) OutputFormatzSupported output formats.svgpngN)r*r+r,r-SVGPNGr3r4r5r7r7As# C Cr4r7c eZdZUdZedddgZeed<eejddg Z eed <ed d Z e e ed<ed d Ze e ed<ed d Ze eed<edd Zeed<edd Zeed<edd Zeed<edd Zeed<ed d Ze eed<ed d Ze eed!<ed d" Ze eed#<ed d$dd%&Ze eeed'<ed d( Ze e ed)<ed d*dd%&Ze ee ed+<ed d,d-.Z e e!ed/<e"d01d2Z#e$d'e%d3Z&e$d+e%d4Z'd-d-d5d6d7ddd8dd9d:d;dd-dd?gid@Z(y )A VisualRequestzRequest model for creating a visual. Notes: - PNG dimensions (width/height) are only allowed when format=png. - Lists, when provided, must not be empty and must contain non-empty identifiers. .z;The text content to generate visuals from (1..10000 chars).zMachine Learning Pipeline descriptionexamplescontentzDesired output format.r8defaultr?r@formatNz;Optional context preceding the main content (<=5000 chars).rCr?context_beforez;Optional context following the main content (<=5000 chars). context_afterzAVisual style ID (built-in or custom, 8..64 chars, [A-Za-z0-9_-]).style_idzen-USz8Language code in BCP 47 format (e.g., en, en-US, fr-FR).languageFz-Enable transparent background for PNG output.transparent_backgroundz&Invert colors in the generated visual.inverted_colorrz/Number of visual variations to generate (1..4).number_of_visualsz6PNG width in pixels (100..4096, only with format=png).widthz7PNG height in pixels (100..4096, only with format=png).heightz)Reference a single existing visual by ID. visual_idz;Reference multiple existing visuals by ID (non-empty list).rCr?rr visual_idsz$Query for selecting a single visual. visual_queryz8Queries for selecting multiple visuals (non-empty list).visual_queriesz7Optional bearer token; excluded from serialized output.T)rCr?exclude api_tokenaftermodec|jtjk7r#|j |j t d|S)z0Ensure width/height only set when format is PNG.0width and height can only be set when format=png)rDr7r;rMrN ValueErrorselfs r5_validate_png_dimensionsz&VisualRequest._validate_png_dimensionss: ;;,** *zz%)@ !STT r4c<|t|dk(r td|S)Nrz(visual_ids must not be empty if providedlenr\clsvs r5_validate_visual_idsz"VisualRequest._validate_visual_idss$ =SVq[GH Hr4c<|t|dk(r td|S)Nrz,visual_queries must not be empty if providedrarcs r5_validate_visual_queriesz&VisualRequest._validate_visual_queriess$ =SVq[KL Lr4floatbase64r@CDQPRVVJCSTPRBBCD5Q6AWRr)rArDrHrIrLzData flow diagramr9)rArDrMrNrJrK)populate_by_namefrom_attributesser_json_timedeltaser_json_bytesjson_schema_extra))r*r+r,r-r rALongText__annotations__r7r:rDrFr ShortTextrGrHIdStrrILangCoderJrrKrLPositiveSmallIntrMPngDimrNrOrRrrSrTrVrrr_r classmethodrfrh model_configr3r4r5r=r=Hs Q-.GX !  ,FL+0Q+NHY'*/Q*M8I& !&W!HhuoNHh*/C*J"'<"NJ +0E+' $LE8F  %M FHV  "'?"Ix).Q )Je% ).:)L(9%16N 1NHT)_-&+M&Ix " '"#\"# %&' !%" :# 9 ')*  3#!!.2&+  Lr4r=c reZdZUdZeddZeed<eddZe e ed <edd Z e ed <edd d dZ e eed<eddZe eed<eddZe eed<eddZe eed<eddZe eed<edddddZe eed<dd d!d"d#d$d%d&d'gid(Zy)) GeneratedFilez%Metadata for a generated visual file..zUnique file identifier.r?idNz;URL to download the file (requires Authorization; expires).rEurlz File format.rDzHSuggested filename (optional; may be overridden by Content-Disposition).rirQfilenamezWidth in pixels (PNG only).rMzHeight in pixels (PNG only).rNzFile size in bytes (>=0). size_byteszFile creation timestamp (UTC). created_atz%Optional checksum (e.g., SHA256 hex). z^[A-Fa-f0-9]+$)rCr?rrrchecksumTr@z426614174000-wdjvjhwv8z`https://api.napkin.ai/v1/visual/123e4567-e89b-12d3-a456-426614174000/file/426614174000-wdjvjhwv8r8z visual.svgi2025-01-01T12:00:00Z)rrrDrrrrorr)r*r+r,r-r rrvrtrrr rDr7rrrMryrNr BytesCountrrrr{r3r4r5r}r}sF/ -B #QC' ! "FL %*^ %Hhy! $1E8F  %2 FHV (-/(J$&+4&J"%*;! %Hhy! 2}# ,"("8    Lr4r}ceZdZUdZeddZeed<eddZe ed<eddZ e ed <ed d Z e e ed <ed d Ze e ed<eeddZeeed<ed dddZe eed<edefdZedefdZedefdZedefdZddd d!d"d#gd$d d%d"d&d'd(d)d*d+d,d-gd$gid.Zy )/VisualResponsez3Response model for visual creation request outcome..zUnique request identifier.r~ request_idzCurrent request status.statusz!Request creation timestamp (UTC).rNzLast update timestamp (UTC).rE updated_atz#Request expiration timestamp (UTC). expires_atz0List of generated files (empty until available). )default_factoryr?rfilesz$Error message if the request failed.rrQerrorreturnc<|jtjk(S)z(True if request reached COMPLETED state.)rr$r0r]s r5 is_completedzVisualResponse.is_completed9s{{m5555r4c<|jtjk(S)z%True if request reached FAILED state.)rr$r1r]s r5 is_failedzVisualResponse.is_failed>s{{m2222r4c<|jtjk(S)z&True if request reached EXPIRED state.)rr$r2r]s r5 is_expiredzVisualResponse.is_expiredCs{{m3333r4cx|jtjtjtjhvS)zBTrue if request is in a terminal state (completed/failed/expired).)rr$r0r1r2r]s r5 is_terminalzVisualResponse.is_terminalHs5{{  # #   ! !   r4Tr@ REQ_abcd1234r&rz2025-01-01T12:00:10Z)rrrrrr'2025-01-01T12:00:30Z FILE_abc123z-https://cdn.example.com/files/FILE_abc123.pngr9rlrmiNF)rrrDrMrNrr)r*r+r,r-r rrvrtrr$rrrrrlistrrr}rrpropertyboolrrrrr{r3r4r5rrs= 0J" -FM! 7J&+2&J"&+9&J""'F"E4  "': "E8I 6d6634334D44 T   "0*"8"8 #1)"8"8#0#R&+%)&)*0    Lr4rc eZdZUdZeddZeed<eddZe ed<edd Z e e ed <edd Z e eed <edd Zeed<edd Zeed<edd Ze eed<eddddZe eed<edd Ze eeeefed<eddZdd d!d"d#d$d%dd&d'gid(Zy))StatusResponsez?Lightweight response for status polling and progress reporting..zRequest identifier.r~rzCurrent status.rNzProgress percentage (0..100).rEprogresszStatus message (<=5000 chars).messagerzNumber of files ready (>=0). files_readyz%Total number of files expected (>=0). files_totalz#Estimated time remaining, if known.etazError message if failed.rrrQrzQRaw files from API (generated_files/files). Client normalizes for download logic.rrWrXc|jdks|jdkr td|j|jkDr|jdk7r td|S)Nrz(files_total and files_ready must be >= 0z%files_ready cannot exceed files_total)rrr\r]s r5_validate_file_countsz$StatusResponse._validate_file_countss[   a 4#3#3a#7GH H   d.. .43C3Cq3HDE E r4Tiso8601r@rr&g@E@zRendering variants...)rrrrrr)rorprr)r*r+r,r-r rrvrtrr$rr PercentFloatrrurrrrrrrrrr strr rrr{r3r4r5rrqs\I )J" %FM(-3(Hh|$$)4$GXi $2K$;K %9 C) "'. "E8I -2g-E8Dc3h( ) '"# ' "0* $6#$#$    Lr4rceZdZUdZedddgZeed<eddd g Ze e e ed d d fed<eddZ e e ed<eddZe eed<eej"dZeed<dddd ddidddgiiZy) ErrorResponsez'Normalized API error response envelope..zHuman-readable error message.zInvalid width for PNG formatr>rNz5Machine-readable error code (e.g., VALIDATION_ERROR).VALIDATION_ERRORrBrrz ^[A-Z0-9_]+$rcodez/Additional error details (field errors, hints).rEdetailsz(Request ID if available for correlation.rzError timestamp (UTC).)rr? timestamprrr@r[fieldrMrr)rrrrr)r*r+r,r-r r NonEmptyStrrtrrrrrdictrrvrutcnowrr{r3r4r5rrs1 301E; K$%   ( ub/R R  $EGXd^#(>#J  ,Ix  O. '1"0!7    Lr4rceZdZUdZeddZeed<eddZeed<eddZ e ed <ed d Z e e eed fed<edefdZdddd dddgidZy ) RateLimitInfoz5Rate limit information derived from response headers..zRequest limit per window (>=0).r~limitz+Remaining requests in current window (>=0). remainingz(When the rate limit window resets (UTC).resetNz&Seconds to wait before retrying (>=0).rErr" retry_afterrc |jdkS)z.True when no remaining requests are available.r)rr]s r5 is_exceededzRateLimitInfo.is_exceededs~~""r4Tr@<z2025-01-01T12:01:00Z)rrrrr)r*r+r,r-r rrrtrrrrrrrrrrr{r3r4r5rrs? 5E:" AIz >E8@E<@K)Iu{$:;< #T##  !"3#%    Lr4rN)(r-rrenumrtypingrrrr r pydanticr r r rrrrrrrrrursrwrvrxryrrrr$r7r=r}rrrrr3r4r5rsn()77    5A#667 i!!EE F Yu EE F   Q2/UVX   ub:NOO Yq(99: 9est44 5eqS&99: y%1+- . C3KIK\=I=@XYXvBYBJ*I*Z%I%r4