fix: improve input validation to allow quotes for strategy parameter (#457)

# Improve input validation to allow quotes for strategy parameter
Updated the strategy parameter to allow `"` or `'` as input wrapped
around valid input to reduce 4xx errors.

# Testing

Invoked CURL and REST requests passing values such as `'fast'`,
`"fast"`, and `fast` for parameter values for the strategy.
```
curl -X POST "PATH_TO_API" \
  -H 'accept: application/json' \
  -H 'Content-Type: multipart/form-data' \
  -H 'unstructured-api-key: KEY' \
  -F "files=@/path_to_file.pdf" \
  -F "strategy='fast'" \
  -F "split-pdf-page=True" \
  -F "split-pdf-allow-failed=True" \
  -F "split-pdf-concurrency-level=15"
  ```
  
  Added unit tests (passing).

Author: jordan-homan

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.0.81.dev
+
+* Update `strategy` parameter to allow `'` and `"` as input surrounding the value.
+
 ## 0.0.80
 
 * Bump to `unstructured` 0.15.10

prepline_general/api/app.py

@@ -13,7 +13,7 @@
 app = FastAPI(
     title="Unstructured Pipeline API",
     summary="Partition documents with the Unstructured library",
-    version="0.0.80",
+    version="0.0.81",
     docs_url="/general/docs",
     openapi_url="/general/openapi.json",
     servers=[

prepline_general/api/general.py

@@ -653,7 +653,7 @@ def return_content_type(filename: str):
 
 
 @router.get("/general/v0/general", include_in_schema=False)
-@router.get("/general/v0.0.80/general", include_in_schema=False)
+@router.get("/general/v0.0.81/general", include_in_schema=False)
 async def handle_invalid_get_request():
     raise HTTPException(
         status_code=status.HTTP_405_METHOD_NOT_ALLOWED, detail="Only POST requests are supported."
@@ -668,7 +668,7 @@ async def handle_invalid_get_request():
     description="Description",
     operation_id="partition_parameters",
 )
-@router.post("/general/v0.0.80/general", include_in_schema=False)
+@router.post("/general/v0.0.81/general", include_in_schema=False)
 def general_partition(
     request: Request,
     # cannot use annotated type here because of a bug described here:

prepline_general/api/models/form_params.py

@@ -156,7 +156,7 @@ def as_form(
                 description="The strategy to use for partitioning PDF/image. Options are fast, hi_res, auto. Default: auto",
                 examples=["auto", "hi_res"],
             ),
-            BeforeValidator(SmartValueParser[str]().value_or_first_element),
+            BeforeValidator(SmartValueParser[str]().literal_value_stripped_or_first_element),
         ] = "auto",
         extract_image_block_types: Annotated[
             List[str],

prepline_general/api/utils.py

@@ -94,6 +94,17 @@ def value_or_first_element(self, value: Union[T, list[T]]) -> list[T] | T | None
             return [_cast_to_type(elem, container_elems_class) for elem in value]
         return _cast_to_type(value, origin_class)  # noqa
 
+    def literal_value_stripped_or_first_element(self, value: str) -> str | None:
+        """Returns the value itself for literal strings and strips quotation characters.
+
+        Args:
+            value (Union[T, List[str]]): value to cast to a type T or return as is
+        """
+        origin_class, container_elems_class = self._get_origin_container_classes()
+        value = value.replace("'", "")
+        value = value.replace('"', "")
+        return _cast_to_type(value, origin_class)
+
     def _get_origin_container_classes(self) -> tuple[type, type | None]:
         """Extracts class (and container class if it's a list) from a type hint
 

preprocessing-pipeline-family.yaml

@@ -1,2 +1,2 @@
 name: general
-version: 0.0.80
+version: 0.0.81

test_general/__init__.py

@@ -30,3 +30,23 @@
 def test_smart_value_parser(desired_type: type, value_to_parse: Any, expected_result: Any):
     parsed_value = SmartValueParser[desired_type]().value_or_first_element(value_to_parse)
     assert expected_result == parsed_value
+
+
+@pytest.mark.parametrize(
+    "desired_type, value_to_parse, expected_result",
+    [
+        (str, "fast", "fast"),
+        (str, "'fast'", "fast"),
+        (str, '"fast"', "fast"),
+        (str, "!fast", "!fast"),
+        (str, "fa'st", "fast"),
+        (str, "fast''''''", "fast"),
+    ],
+)
+def test_literal_value_stripped_or_first_element(
+    desired_type: type, value_to_parse: Any, expected_result: Any
+):
+    parsed_value = SmartValueParser[desired_type]().literal_value_stripped_or_first_element(
+        value_to_parse
+    )
+    assert expected_result == parsed_value