feat(api): api update (#28)

Author: stainless-app[bot]

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 2
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hyperspell%2Fhyperspell-363c228e40d56a22d2ffff0751e999364709fb95ff4bae587ce8659008d67323.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hyperspell%2Fhyperspell-589d4cc41f6a3e0ad2bdb5cba036cb053954fa9f848a013e32c614318c3dead8.yml

src/hyperspell/types/document.py

@@ -6,32 +6,58 @@
 
 from .._models import BaseModel
 
-__all__ = ["Document", "Section"]
+__all__ = ["Document", "Section", "SectionElement", "SectionElementMetadata"]
 
 
-class Section(BaseModel):
-    content: str
+class SectionElementMetadata(BaseModel):
+    author: Optional[str] = None
+
+    continued_from: Optional[str] = None
+    """
+    The id of the element that this element is continued from if it had to be split
+    during chunking
+    """
+
+    filename: Optional[str] = None
+
+    languages: Optional[List[str]] = None
+
+    links: Optional[List[str]] = None
+
+    page_number: Optional[int] = None
+
+    title_level: Optional[int] = None
+
+
+class SectionElement(BaseModel):
+    text: str
+
+    type: Literal["text", "markdown", "image", "table", "title"]
+
+    id: Optional[str] = None
 
+    metadata: Optional[SectionElementMetadata] = None
+
+    summary: Optional[str] = None
+
+
+class Section(BaseModel):
     document_id: int
 
     id: Optional[int] = None
 
+    elements: Optional[List[SectionElement]] = None
+
     embedding_e5_large: Optional[List[float]] = None
 
     fts: Optional[List[float]] = None
 
     metadata: Optional[object] = None
 
-    type: Optional[Literal["text", "markdown", "table", "image", "messages", "message"]] = None
-    """Type of the section"""
-
 
 class Document(BaseModel):
     collection_id: int
 
-    resource_id: str
-    """Along with service, uniquely identifies the source document"""
-
     id: Optional[int] = None
 
     created_at: Optional[datetime] = None
@@ -40,18 +66,25 @@ class Document(BaseModel):
 
     metadata: Optional[object] = None
 
+    resource_id: Optional[str] = None
+    """Along with service, uniquely identifies the source document"""
+
     sections: Optional[List[Section]] = None
 
     sections_count: Optional[int] = None
 
     source: Optional[
         Literal[
             "generic",
-            "generic_chat",
-            "generic_email",
-            "generic_transcript",
-            "generic_legal",
+            "markdown",
+            "chat",
+            "email",
+            "transcript",
+            "legal",
             "website",
+            "image",
+            "pdf",
+            "audio",
             "slack",
             "s3",
             "gmail",

src/hyperspell/types/query_retrieve_params.py

@@ -29,20 +29,21 @@ class QueryRetrieveParams(TypedDict, total=False):
 
 
 class Filter(TypedDict, total=False):
-    chunk_type: List[Literal["text", "markdown", "table", "image", "messages", "message"]]
-    """Only query chunks of these types."""
-
     end_date: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
     """Only query documents before this date."""
 
     source: List[
         Literal[
             "generic",
-            "generic_chat",
-            "generic_email",
-            "generic_transcript",
-            "generic_legal",
+            "markdown",
+            "chat",
+            "email",
+            "transcript",
+            "legal",
             "website",
+            "image",
+            "pdf",
+            "audio",
             "slack",
             "s3",
             "gmail",

tests/api_resources/test_query.py

@@ -30,7 +30,6 @@ def test_method_retrieve_with_all_params(self, client: Hyperspell) -> None:
             query="query",
             collections=["string"],
             filter={
-                "chunk_type": ["text"],
                 "end_date": parse_datetime("2019-12-27T18:11:19.117Z"),
                 "source": ["generic"],
                 "start_date": parse_datetime("2019-12-27T18:11:19.117Z"),
@@ -81,7 +80,6 @@ async def test_method_retrieve_with_all_params(self, async_client: AsyncHyperspe
             query="query",
             collections=["string"],
             filter={
-                "chunk_type": ["text"],
                 "end_date": parse_datetime("2019-12-27T18:11:19.117Z"),
                 "source": ["generic"],
                 "start_date": parse_datetime("2019-12-27T18:11:19.117Z"),