feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,3 +1,3 @@
 configured_endpoints: 43
-openapi_spec_hash: 6d2d01f4951c677a47cffe973084413e
+openapi_spec_hash: 3873591605b529e6ae298fc7f04d4ba1
 config_hash: 5e459b33c53ffa6e554087a779bdb790

src/codex/resources/projects/entries.py

@@ -319,6 +319,7 @@ def query(
         question: str,
         use_llm_matching: bool | NotGiven = NOT_GIVEN,
         client_metadata: Optional[object] | NotGiven = NOT_GIVEN,
+        query_metadata: Optional[entry_query_params.QueryMetadata] | NotGiven = NOT_GIVEN,
         x_client_library_version: str | NotGiven = NOT_GIVEN,
         x_integration_type: str | NotGiven = NOT_GIVEN,
         x_source: str | NotGiven = NOT_GIVEN,
@@ -334,6 +335,10 @@ def query(
         Query Entries Route
 
         Args:
+          client_metadata: Deprecated: Use query_metadata instead
+
+          query_metadata: Optional logging data that can be provided by the client.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -361,6 +366,7 @@ def query(
                 {
                     "question": question,
                     "client_metadata": client_metadata,
+                    "query_metadata": query_metadata,
                 },
                 entry_query_params.EntryQueryParams,
             ),
@@ -708,6 +714,7 @@ async def query(
         question: str,
         use_llm_matching: bool | NotGiven = NOT_GIVEN,
         client_metadata: Optional[object] | NotGiven = NOT_GIVEN,
+        query_metadata: Optional[entry_query_params.QueryMetadata] | NotGiven = NOT_GIVEN,
         x_client_library_version: str | NotGiven = NOT_GIVEN,
         x_integration_type: str | NotGiven = NOT_GIVEN,
         x_source: str | NotGiven = NOT_GIVEN,
@@ -723,6 +730,10 @@ async def query(
         Query Entries Route
 
         Args:
+          client_metadata: Deprecated: Use query_metadata instead
+
+          query_metadata: Optional logging data that can be provided by the client.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -750,6 +761,7 @@ async def query(
                 {
                     "question": question,
                     "client_metadata": client_metadata,
+                    "query_metadata": query_metadata,
                 },
                 entry_query_params.EntryQueryParams,
             ),

src/codex/types/projects/entry_query_params.py

@@ -2,12 +2,12 @@
 
 from __future__ import annotations
 
-from typing import Optional
+from typing import Dict, List, Union, Iterable, Optional
 from typing_extensions import Required, Annotated, TypedDict
 
 from ..._utils import PropertyInfo
 
-__all__ = ["EntryQueryParams"]
+__all__ = ["EntryQueryParams", "QueryMetadata", "QueryMetadataContextUnionMember3"]
 
 
 class EntryQueryParams(TypedDict, total=False):
@@ -16,6 +16,10 @@ class EntryQueryParams(TypedDict, total=False):
     use_llm_matching: bool
 
     client_metadata: Optional[object]
+    """Deprecated: Use query_metadata instead"""
+
+    query_metadata: Optional[QueryMetadata]
+    """Optional logging data that can be provided by the client."""
 
     x_client_library_version: Annotated[str, PropertyInfo(alias="x-client-library-version")]
 
@@ -24,3 +28,34 @@ class EntryQueryParams(TypedDict, total=False):
     x_source: Annotated[str, PropertyInfo(alias="x-source")]
 
     x_stainless_package_version: Annotated[str, PropertyInfo(alias="x-stainless-package-version")]
+
+
+class QueryMetadataContextUnionMember3(TypedDict, total=False):
+    content: Required[str]
+    """The actual content/text of the document."""
+
+    id: Optional[str]
+    """Unique identifier for the document. Useful for tracking documents"""
+
+    source: Optional[str]
+    """Source or origin of the document. Useful for citations."""
+
+    tags: Optional[List[str]]
+    """Tags or categories for the document. Useful for filtering"""
+
+    title: Optional[str]
+    """Title or heading of the document. Useful for display and context."""
+
+
+class QueryMetadata(TypedDict, total=False):
+    context: Union[str, List[str], Iterable[object], Iterable[QueryMetadataContextUnionMember3], None]
+    """RAG context used for the query"""
+
+    custom_metadata: Optional[object]
+    """Arbitrary metadata supplied by the user/system"""
+
+    eval_scores: Optional[Dict[str, float]]
+    """Evaluation scores for the original response"""
+
+    evaluated_response: Optional[str]
+    """The response being evaluated from the RAG system(before any remediation)"""

tests/api_resources/projects/test_entries.py

@@ -396,6 +396,12 @@ def test_method_query_with_all_params(self, client: Codex) -> None:
             question="question",
             use_llm_matching=True,
             client_metadata={},
+            query_metadata={
+                "context": "string",
+                "custom_metadata": {},
+                "eval_scores": {"foo": 0},
+                "evaluated_response": "evaluated_response",
+            },
             x_client_library_version="x-client-library-version",
             x_integration_type="x-integration-type",
             x_source="x-source",
@@ -871,6 +877,12 @@ async def test_method_query_with_all_params(self, async_client: AsyncCodex) -> N
             question="question",
             use_llm_matching=True,
             client_metadata={},
+            query_metadata={
+                "context": "string",
+                "custom_metadata": {},
+                "eval_scores": {"foo": 0},
+                "evaluated_response": "evaluated_response",
+            },
             x_client_library_version="x-client-library-version",
             x_integration_type="x-integration-type",
             x_source="x-source",