Skip to content

fix: resolve FastAPI deprecation warning for example fields #507

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
awalker4 merged 1 commit into from
Jun 2, 2025
Merged

fix: resolve FastAPI deprecation warning for example fields #507

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions prepline_general/api/models/form_params.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ def as_form(
Form(
title="OCR Languages",
description="The languages present in the document, for use in partitioning and/or OCR",
example="[eng]",
examples=["[eng]"],
),
BeforeValidator(SmartValueParser[List[str]]().value_or_first_element),
] = [], # noqa
Expand All @@ -63,7 +63,7 @@ def as_form(
Form(
title="OCR Languages",
description="The languages present in the document, for use in partitioning and/or OCR",
example="[eng]",
examples=["[eng]"],
),
BeforeValidator(SmartValueParser[List[str]]().value_or_first_element),
] = [],
Expand All @@ -74,7 +74,7 @@ def as_form(
description=(
"The document types that you want to skip table extraction with. Default: []"
),
example="['pdf', 'jpg', 'png']",
examples=["['pdf', 'jpg', 'png']"],
),
BeforeValidator(SmartValueParser[List[str]]().value_or_first_element),
] = [], # noqa
Expand All @@ -83,15 +83,15 @@ def as_form(
Form(
title="Uncompressed Content Type",
description="If file is gzipped, use this content type after unzipping",
example="application/pdf",
examples=["application/pdf"],
),
] = None,
output_format: Annotated[
Literal["application/json", "text/csv"],
Form(
title="Output Format",
description="The format of the response. Supported formats are application/json and text/csv. Default: application/json.",
example="application/json",
examples=["application/json"],
),
] = "application/json",
coordinates: Annotated[
Expand All @@ -107,7 +107,7 @@ def as_form(
Form(
title="Content type",
description="A hint about the content type to use (such as text/markdown), when there are problems processing a specific file. This value is a MIME type in the format type/subtype.",
example="text/markdown",
examples=["text/markdown"],
),
BeforeValidator(SmartValueParser[str]().value_or_first_element),
] = None,
Expand All @@ -116,7 +116,7 @@ def as_form(
Form(
title="Encoding",
description="The encoding method used to decode the text input. Default: utf-8",
example="utf-8",
examples=["utf-8"],
),
BeforeValidator(SmartValueParser[str]().value_or_first_element),
] = "utf-8",
Expand All @@ -125,7 +125,7 @@ def as_form(
Form(
title="Hi Res Model Name",
description="The name of the inference model used when strategy is hi_res",
example="yolox",
examples=["yolox"],
),
BeforeValidator(SmartValueParser[str]().value_or_first_element),
] = None,
Expand Down Expand Up @@ -163,7 +163,7 @@ def as_form(
Form(
title="Image block types to extract",
description="The types of elements to extract, for use in extracting image blocks as base64 encoded data stored in metadata fields",
example="""["image", "table"]""",
examples=["""["image", "table"]"""],
),
BeforeValidator(SmartValueParser[List[str]]().value_or_first_element),
] = [], # noqa
Expand All @@ -173,7 +173,7 @@ def as_form(
title="unique_element_ids",
description="""When `True`, assign UUIDs to element IDs, which guarantees their uniqueness
(useful when using them as primary keys in database). Otherwise a SHA-256 of element text is used. Default: False""",
example=True,
examples=[True],
),
] = False,
# -- chunking options --
Expand All @@ -190,15 +190,15 @@ def as_form(
Form(
title="Combine Under N Chars",
description="If chunking strategy is set, combine elements until a section reaches a length of n chars. Default: 500",
example=500,
examples=[500],
),
] = None,
max_characters: Annotated[
int,
Form(
title="Max Characters",
description="If chunking strategy is set, cut off new sections after reaching a length of n chars (hard max). Default: 1500",
example=1500,
examples=[1500],
),
] = 500,
multipage_sections: Annotated[
Expand All @@ -213,7 +213,7 @@ def as_form(
Form(
title="New after n chars",
description="If chunking strategy is set, cut off new sections after reaching a length of n chars (soft max). Default: 1500",
example=1500,
examples=[1500],
),
] = None,
overlap: Annotated[
Expand All @@ -223,7 +223,7 @@ def as_form(
description="""Specifies the length of a string ("tail") to be drawn from each chunk and prefixed to the
next chunk as a context-preserving mechanism. By default, this only applies to split-chunks
where an oversized element is divided into multiple chunks by text-splitting. Default: 0""",
example=20,
examples=[20],
),
] = 0,
overlap_all: Annotated[
Expand All @@ -233,7 +233,7 @@ def as_form(
description="""When `True`, apply overlap between "normal" chunks formed from whole
elements and not subject to text-splitting. Use this with caution as it entails a certain
level of "pollution" of otherwise clean semantic chunk boundaries. Default: False""",
example=True,
examples=[True],
),
] = False,
starting_page_number: Annotated[
Expand All @@ -244,7 +244,7 @@ def as_form(
"When PDF is split into pages before sending it into the API, providing "
"this information will allow the page number to be assigned correctly."
),
example=3,
examples=[3],
),
] = None,
include_slide_notes: Annotated[
Expand All @@ -255,7 +255,7 @@ def as_form(
"When `True`, slide notes from .ppt and .pptx files"
" will be included in the response. Default: `True`"
),
example=False,
examples=[False],
),
] = True,
) -> "GeneralFormParams":
Expand Down