fix pylint and mypy errors and rename filter to advanced_filter in search_by_pdf()

Author: MoSchmidt

backend/app/repositories/search_repository.py

@@ -1,7 +1,7 @@
 from datetime import date
 from typing import List, Optional, Tuple, Union
 
-from sqlalchemy import and_, or_, select
+from sqlalchemy import and_, or_, select, ClauseElement
 from sqlalchemy.ext.asyncio import AsyncSession
 
 from app.models.paper import Paper as PaperModel
@@ -23,10 +23,10 @@ class SearchRepository:
 
     @staticmethod
     async def search_papers_by_embeddings(
-        db: AsyncSession,
-        embeddings: List[List[float]],
-        limit: int = 5,
-        search_filter: Optional[AdvancedSearchFilter] = None,
+            db: AsyncSession,
+            embeddings: List[List[float]],
+            limit: int = 5,
+            search_filter: Optional[AdvancedSearchFilter] = None,
     ) -> List[Tuple[PaperModel, float]]:
         """
         Perform a vector search for papers based on a list of embeddings.
@@ -72,7 +72,7 @@ def _build_filter_clauses(search_filter: AdvancedSearchFilter) -> list:
         return clauses
 
     @staticmethod
-    def _build_group_clause(group: ConditionGroup):
+    def _build_group_clause(group: ConditionGroup) -> Optional[ClauseElement]:
         """Recursively build an AND/OR clause from a ConditionGroup."""
         if not group.children:
             return None
@@ -91,7 +91,7 @@ def _build_group_clause(group: ConditionGroup):
         return or_(*child_clauses)
 
     @staticmethod
-    def _build_node_clause(node: Union[TextCondition, ConditionGroup]):
+    def _build_node_clause(node: Union[TextCondition, ConditionGroup]) -> Optional[ClauseElement]:
         """Build a clause for a single node (condition or nested group)."""
         if node.type == "group":
             return SearchRepository._build_group_clause(node)

backend/app/routes/search_routes.py

@@ -42,7 +42,7 @@ async def search_by_pdf(
         default=None,
         description="Optional: query specifying what you want to find in relation to the paper",
     ),
-    filter: str | None = Form(
+    advanced_filter: str | None = Form(
         default=None,
         description="Optional: JSON-encoded advanced search filter",
     ),
@@ -60,9 +60,9 @@ async def search_by_pdf(
         )
 
     search_filter = None
-    if filter:
+    if advanced_filter:
         try:
-            search_filter = AdvancedSearchFilter.model_validate(json.loads(filter))
+            search_filter = AdvancedSearchFilter.model_validate(json.loads(advanced_filter))
         except (json.JSONDecodeError, ValueError) as exc:
             raise HTTPException(
                 status_code=400,

backend/app/schemas/search_dto.py

@@ -8,13 +8,17 @@
 
 
 class TextCondition(BaseModel):
+    """Single text-based filter condition on a paper field."""
+
     type: Literal["condition"]
     field: Literal["title", "abstract"]
     operator: Literal["contains", "not_contains"]
     value: str
 
 
 class ConditionGroup(BaseModel):
+    """Logical group combining multiple conditions with AND / OR."""
+
     type: Literal["group"]
     operator: Literal["AND", "OR"]
     children: List[
@@ -23,6 +27,8 @@ class ConditionGroup(BaseModel):
 
 
 class AdvancedSearchFilter(BaseModel):
+    """Structured filter with optional year range and boolean condition tree."""
+
     year_from: Optional[int] = None
     year_to: Optional[int] = None
     root: ConditionGroup

frontend/src/api/apis/search-api.ts

@@ -37,11 +37,11 @@ export const SearchApiAxiosParamCreator = function (configuration?: Configuratio
          * @summary Search for papers using a PDF
          * @param {File} pdf Research paper PDF
          * @param {string | null} [query] 
-         * @param {string | null} [filter] 
+         * @param {string | null} [advancedFilter] 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        searchByPdfSearchPdfPost: async (pdf: File, query?: string | null, filter?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        searchByPdfSearchPdfPost: async (pdf: File, query?: string | null, advancedFilter?: string | null, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'pdf' is not null or undefined
             assertParamExists('searchByPdfSearchPdfPost', 'pdf', pdf)
             const localVarPath = `/search/pdf`;
@@ -66,8 +66,8 @@ export const SearchApiAxiosParamCreator = function (configuration?: Configuratio
                 localVarFormParams.append('query', query as any);
             }
 
-            if (filter !== undefined) { 
-                localVarFormParams.append('filter', filter as any);
+            if (advancedFilter !== undefined) { 
+                localVarFormParams.append('advanced_filter', advancedFilter as any);
             }
             localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
             localVarHeaderParameter['Accept'] = 'application/json';
@@ -131,12 +131,12 @@ export const SearchApiFp = function(configuration?: Configuration) {
          * @summary Search for papers using a PDF
          * @param {File} pdf Research paper PDF
          * @param {string | null} [query] 
-         * @param {string | null} [filter] 
+         * @param {string | null} [advancedFilter] 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async searchByPdfSearchPdfPost(pdf: File, query?: string | null, filter?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchResponse>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.searchByPdfSearchPdfPost(pdf, query, filter, options);
+        async searchByPdfSearchPdfPost(pdf: File, query?: string | null, advancedFilter?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.searchByPdfSearchPdfPost(pdf, query, advancedFilter, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['SearchApi.searchByPdfSearchPdfPost']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -168,12 +168,12 @@ export const SearchApiFactory = function (configuration?: Configuration, basePat
          * @summary Search for papers using a PDF
          * @param {File} pdf Research paper PDF
          * @param {string | null} [query] 
-         * @param {string | null} [filter] 
+         * @param {string | null} [advancedFilter] 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        searchByPdfSearchPdfPost(pdf: File, query?: string | null, filter?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<SearchResponse> {
-            return localVarFp.searchByPdfSearchPdfPost(pdf, query, filter, options).then((request) => request(axios, basePath));
+        searchByPdfSearchPdfPost(pdf: File, query?: string | null, advancedFilter?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<SearchResponse> {
+            return localVarFp.searchByPdfSearchPdfPost(pdf, query, advancedFilter, options).then((request) => request(axios, basePath));
         },
         /**
          * Returns a list of papers that match the search query. Optionally accepts an advanced filter with year range and text conditions.
@@ -197,12 +197,12 @@ export class SearchApi extends BaseAPI {
      * @summary Search for papers using a PDF
      * @param {File} pdf Research paper PDF
      * @param {string | null} [query] 
-     * @param {string | null} [filter] 
+     * @param {string | null} [advancedFilter] 
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    public searchByPdfSearchPdfPost(pdf: File, query?: string | null, filter?: string | null, options?: RawAxiosRequestConfig) {
-        return SearchApiFp(this.configuration).searchByPdfSearchPdfPost(pdf, query, filter, options).then((request) => request(this.axios, this.basePath));
+    public searchByPdfSearchPdfPost(pdf: File, query?: string | null, advancedFilter?: string | null, options?: RawAxiosRequestConfig) {
+        return SearchApiFp(this.configuration).searchByPdfSearchPdfPost(pdf, query, advancedFilter, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**

frontend/src/api/models/advanced-search-filter.ts

@@ -17,6 +17,9 @@
 // @ts-ignore
 import type { ConditionGroup } from './condition-group';
 
+/**
+ * Structured filter with optional year range and boolean condition tree.
+ */
 export interface AdvancedSearchFilter {
     'year_from'?: number | null;
     'year_to'?: number | null;

frontend/src/api/models/condition-group.ts

@@ -17,6 +17,9 @@
 // @ts-ignore
 import type { ConditionGroupChildrenInner } from './condition-group-children-inner';
 
+/**
+ * Logical group combining multiple conditions with AND / OR.
+ */
 export interface ConditionGroup {
     'type': ConditionGroupTypeEnum;
     'operator': ConditionGroupOperatorEnum;

frontend/src/api/models/text-condition.ts

@@ -14,6 +14,9 @@
 
 
 
+/**
+ * Single text-based filter condition on a paper field.
+ */
 export interface TextCondition {
     'type': TextConditionTypeEnum;
     'field': TextConditionFieldEnum;

openapi/openapi.json

@@ -753,7 +753,8 @@
         "required": [
           "root"
         ],
-        "title": "AdvancedSearchFilter"
+        "title": "AdvancedSearchFilter",
+        "description": "Structured filter with optional year range and boolean condition tree."
       },
       "Body_search_by_pdf_search_pdf_post": {
         "properties": {
@@ -775,7 +776,7 @@
             "title": "Query",
             "description": "Optional: query specifying what you want to find in relation to the paper"
           },
-          "filter": {
+          "advanced_filter": {
             "anyOf": [
               {
                 "type": "string"
@@ -784,7 +785,7 @@
                 "type": "null"
               }
             ],
-            "title": "Filter",
+            "title": "Advanced Filter",
             "description": "Optional: JSON-encoded advanced search filter"
           }
         },
@@ -856,7 +857,8 @@
           "operator",
           "children"
         ],
-        "title": "ConditionGroup"
+        "title": "ConditionGroup",
+        "description": "Logical group combining multiple conditions with AND / OR."
       },
       "HTTPValidationError": {
         "properties": {
@@ -1281,7 +1283,8 @@
           "operator",
           "value"
         ],
-        "title": "TextCondition"
+        "title": "TextCondition",
+        "description": "Single text-based filter condition on a paper field."
       },
       "UserCreate": {
         "properties": {