feat(api): manual updates

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 14
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/zeroentropy%2Fzeroentropy-b5badb1383675a2606a4e65b515426cf70010d0e834372de7bcf39fda4939692.yml
-openapi_spec_hash: b3b0c03c89fe5ea66cc91fea2fa9726b
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/zeroentropy%2Fzeroentropy-cd86445a8ef095a12e7bf74baddc7d5a8225531f8edb88ba613e12a52e219a42.yml
+openapi_spec_hash: 6da635b19c554a476ea9c967b619ae5b
 config_hash: f5fb1effd4b0e263e1e93de3f573f46f

src/zeroentropy/resources/queries.py

@@ -130,6 +130,7 @@ def top_pages(
         query: str,
         filter: Optional[Dict[str, object]] | Omit = omit,
         include_content: bool | Omit = omit,
+        include_metadata: bool | Omit = omit,
         latency_mode: Literal["low", "high"] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -155,6 +156,9 @@ def top_pages(
 
           include_content: If set to true, then the content of all pages will be returned.
 
+          include_metadata: Whether or not to include the document metadata in the response. If not
+              provided, then the default will be `False`.
+
           latency_mode: This option selects between our two latency modes. The higher latency mode takes
               longer, but can allow for more accurate responses. If desired, test both to
               customize your search experience for your particular use-case, or use the
@@ -178,6 +182,7 @@ def top_pages(
                     "query": query,
                     "filter": filter,
                     "include_content": include_content,
+                    "include_metadata": include_metadata,
                     "latency_mode": latency_mode,
                 },
                 query_top_pages_params.QueryTopPagesParams,
@@ -371,6 +376,7 @@ async def top_pages(
         query: str,
         filter: Optional[Dict[str, object]] | Omit = omit,
         include_content: bool | Omit = omit,
+        include_metadata: bool | Omit = omit,
         latency_mode: Literal["low", "high"] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -396,6 +402,9 @@ async def top_pages(
 
           include_content: If set to true, then the content of all pages will be returned.
 
+          include_metadata: Whether or not to include the document metadata in the response. If not
+              provided, then the default will be `False`.
+
           latency_mode: This option selects between our two latency modes. The higher latency mode takes
               longer, but can allow for more accurate responses. If desired, test both to
               customize your search experience for your particular use-case, or use the
@@ -419,6 +428,7 @@ async def top_pages(
                     "query": query,
                     "filter": filter,
                     "include_content": include_content,
+                    "include_metadata": include_metadata,
                     "latency_mode": latency_mode,
                 },
                 query_top_pages_params.QueryTopPagesParams,

src/zeroentropy/types/query_top_pages_params.py

@@ -32,6 +32,12 @@ class QueryTopPagesParams(TypedDict, total=False):
     include_content: bool
     """If set to true, then the content of all pages will be returned."""
 
+    include_metadata: bool
+    """Whether or not to include the document metadata in the response.
+
+    If not provided, then the default will be `False`.
+    """
+
     latency_mode: Literal["low", "high"]
     """This option selects between our two latency modes.
 

src/zeroentropy/types/query_top_pages_response.py

@@ -1,10 +1,33 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import List, Optional
+from typing import Dict, List, Union, Optional
 
 from .._models import BaseModel
 
-__all__ = ["QueryTopPagesResponse", "Result"]
+__all__ = ["QueryTopPagesResponse", "DocumentResult", "Result"]
+
+
+class DocumentResult(BaseModel):
+    file_url: str
+    """
+    A URL to the document data, which can be used to download the raw document
+    content or to display the document in frontend applications.
+
+    NOTE: If a `/documents/update-document` call returned a new document id, then
+    this url will be invalidated and must be retrieved again.
+    """
+
+    metadata: Optional[Dict[str, Union[str, List[str]]]] = None
+    """The metadata for that document.
+
+    Will be `None` if `include_metadata` is `False`.
+    """
+
+    path: str
+    """The path of the document."""
+
+    score: float
+    """The relevancy score assigned to this document."""
 
 
 class Result(BaseModel):
@@ -43,4 +66,12 @@ class Result(BaseModel):
 
 
 class QueryTopPagesResponse(BaseModel):
+    document_results: List[DocumentResult]
+    """The array of associated document information.
+
+    Note how each result page has an associated document path. After deduplicating
+    the document paths, this array will contain document info for each document path
+    that is referenced by at least one page result.
+    """
+
     results: List[Result]

tests/api_resources/test_queries.py

@@ -88,6 +88,7 @@ def test_method_top_pages_with_all_params(self, client: ZeroEntropy) -> None:
             query="query",
             filter={"foo": "bar"},
             include_content=True,
+            include_metadata=True,
             latency_mode="low",
         )
         assert_matches_type(QueryTopPagesResponse, query, path=["response"])
@@ -243,6 +244,7 @@ async def test_method_top_pages_with_all_params(self, async_client: AsyncZeroEnt
             query="query",
             filter={"foo": "bar"},
             include_content=True,
+            include_metadata=True,
             latency_mode="low",
         )
         assert_matches_type(QueryTopPagesResponse, query, path=["response"])