fix(agents-api): Add metadata_filter to openapi spec

Signed-off-by: Diwank Singh Tomer <diwank.singh@gmail.com>

agents-api/agents_api/autogen/Docs.py

@@ -6,7 +6,7 @@
 from typing import Annotated, Any, Literal
 from uuid import UUID
 
-from pydantic import AwareDatetime, BaseModel, ConfigDict, Field, StrictBool
+from pydantic import AwareDatetime, BaseModel, ConfigDict, Field
 
 
 class BaseDocSearchRequest(BaseModel):
@@ -18,7 +18,7 @@ class BaseDocSearchRequest(BaseModel):
     """
     The language to be used for text-only search. Support for other languages coming soon.
     """
-    metadata_filter: dict[str, float | str | StrictBool | None] = {}
+    metadata_filter: dict[str, Any] = {}
     mmr_strength: Annotated[float, Field(ge=0.0, lt=1.0)] = 0
     """
     MMR Strength (mmr_strength = 1 - mmr_lambda)

agents-api/agents_api/autogen/Tools.py

@@ -12,6 +12,7 @@
     BaseModel,
     ConfigDict,
     Field,
+    RootModel,
     StrictBool,
 )
 

agents-api/agents_api/dependencies/query_filter.py

@@ -1,6 +1,7 @@
-from typing import Any, Callable
+from typing import Annotated, Any, Callable
 
-from fastapi import Request
+from fastapi import Query, Request
+from pydantic import BaseModel, ConfigDict
 
 
 def convert_value(value: str) -> Any:
@@ -15,9 +16,13 @@ def convert_value(value: str) -> Any:
     return value
 
 
+class MetadataFilter(BaseModel):
+    model_config = ConfigDict(extra="allow")
+
+
 def create_filter_extractor(
-    prefix: str = "filter",
-) -> Callable[[Request], dict[str, Any]]:
+    prefix: str = "metadata_filter",
+) -> Callable[[Request], MetadataFilter]:
     """
     Creates a dependency function to extract filter parameters with a given prefix.
 
@@ -31,7 +36,12 @@ def create_filter_extractor(
     # Add a dot to the prefix to allow for nested filters
     prefix += "."
 
-    def extract_filters(request: Request) -> dict[str, Any]:
+    def extract_filters(
+        request: Request,
+        metadata_filter: Annotated[
+            MetadataFilter, Query(default_factory=MetadataFilter)
+        ],
+    ) -> MetadataFilter:
         """
         Extracts query parameters that start with the specified prefix and returns them as a dictionary.
 
@@ -49,6 +59,6 @@ def extract_filters(request: Request) -> dict[str, Any]:
                 filter_key = key[len(prefix) :]
                 filters[filter_key] = convert_value(value)
 
-        return filters
+        return MetadataFilter(**filters)
 
     return extract_filters

agents-api/agents_api/routers/docs/list_docs.py

@@ -1,22 +1,33 @@
-from typing import Annotated, Literal
+import json
+from typing import Annotated, Literal, Optional
 from uuid import UUID
 
-from fastapi import Depends
+from pydantic import BaseModel, BeforeValidator, ConfigDict
+from fastapi import Depends, Query
 
 from ...autogen.openapi_model import Doc, ListResponse
 from ...dependencies.developer_id import get_developer_id
-from ...dependencies.query_filter import create_filter_extractor
+from ...dependencies.query_filter import create_filter_extractor, MetadataFilter
 from ...models.docs.list_docs import list_docs as list_docs_query
 from .router import router
 
 
+class ListDocsQuery(BaseModel):
+    limit: int = 100
+    offset: int = 0
+    sort_by: Literal["created_at", "updated_at"] = "created_at"
+    direction: Literal["asc", "desc"] = "desc"
+    metadata_filter: MetadataFilter = None
+
+
 @router.get("/users/{user_id}/docs", tags=["docs"])
 async def list_user_docs(
     x_developer_id: Annotated[UUID, Depends(get_developer_id)],
+    user_id: UUID,
     metadata_filter: Annotated[
-        dict, Depends(create_filter_extractor("metadata_filter"))
+        MetadataFilter,
+        Depends(create_filter_extractor("metadata_filter")),
     ],
-    user_id: UUID,
     limit: int = 100,
     offset: int = 0,
     sort_by: Literal["created_at", "updated_at"] = "created_at",
@@ -30,7 +41,7 @@ async def list_user_docs(
         offset=offset,
         sort_by=sort_by,
         direction=direction,
-        metadata_filter=metadata_filter or {},
+        metadata_filter=metadata_filter.model_dump(mode="json"),
     )
 
     return ListResponse[Doc](items=docs)
@@ -39,10 +50,10 @@ async def list_user_docs(
 @router.get("/agents/{agent_id}/docs", tags=["docs"])
 async def list_agent_docs(
     x_developer_id: Annotated[UUID, Depends(get_developer_id)],
+    agent_id: UUID,
     metadata_filter: Annotated[
-        dict, Depends(create_filter_extractor("metadata_filter"))
+        MetadataFilter, Depends(create_filter_extractor("metadata_filter"))
     ],
-    agent_id: UUID,
     limit: int = 100,
     offset: int = 0,
     sort_by: Literal["created_at", "updated_at"] = "created_at",
@@ -56,7 +67,7 @@ async def list_agent_docs(
         offset=offset,
         sort_by=sort_by,
         direction=direction,
-        metadata_filter=metadata_filter or {},
+        metadata_filter=metadata_filter.model_dump(mode="json"),
     )
 
     return ListResponse[Doc](items=docs)

integrations-service/integrations/autogen/Docs.py

@@ -6,7 +6,7 @@
 from typing import Annotated, Any, Literal
 from uuid import UUID
 
-from pydantic import AwareDatetime, BaseModel, ConfigDict, Field, StrictBool
+from pydantic import AwareDatetime, BaseModel, ConfigDict, Field
 
 
 class BaseDocSearchRequest(BaseModel):
@@ -18,7 +18,7 @@ class BaseDocSearchRequest(BaseModel):
     """
     The language to be used for text-only search. Support for other languages coming soon.
     """
-    metadata_filter: dict[str, float | str | StrictBool | None] = {}
+    metadata_filter: dict[str, Any] = {}
     mmr_strength: Annotated[float, Field(ge=0.0, lt=1.0)] = 0
     """
     MMR Strength (mmr_strength = 1 - mmr_lambda)

integrations-service/integrations/autogen/Tools.py

@@ -12,6 +12,7 @@
     BaseModel,
     ConfigDict,
     Field,
+    RootModel,
     StrictBool,
 )
 

typespec/common/types.tsp

@@ -13,7 +13,7 @@ namespace Common;
 //
 
 alias Metadata = Record<unknown>;
-alias MetadataFilter = Record<concreteType>;
+alias MetadataFilter = Record<unknown>;
 
 model ResourceCreatedResponse {
     @doc("ID of created resource")
@@ -52,7 +52,7 @@ model PaginationOptions {
     @query direction: sortDirection = "asc",
 
     /** Object to filter results by metadata */
-    @query metadata_filter: MetadataFilter,
+    @query metadata_filter: Record<unknown> = #{},
 }
 
 @events

typespec/tsp-output/@typespec/openapi3/openapi-1.0.0.yaml

@@ -1340,12 +1340,8 @@ components:
       description: Object to filter results by metadata
       schema:
         type: object
-        additionalProperties:
-          anyOf:
-            - type: number
-            - type: string
-            - type: boolean
-          nullable: true
+        additionalProperties: {}
+        default: {}
       explode: false
     Common.PaginationOptions.offset:
       name: offset
@@ -2451,12 +2447,7 @@ components:
           default: en-US
         metadata_filter:
           type: object
-          additionalProperties:
-            anyOf:
-              - type: number
-              - type: string
-              - type: boolean
-            nullable: true
+          additionalProperties: {}
           default: {}
         mmr_strength:
           type: number