feat(api): api update (#30)

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-05fcf73e2de271c4168a5c2a3c68046fbf65d9ea1c3c5a81de77c4a0b56471b2.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hyperspell%2Fhyperspell-7ff5aa8df478efbb456eaf85bd0509e79c857e5e2d9328d465316870c13b4ffe.yml

src/hyperspell/types/document.py

@@ -6,7 +6,7 @@
 
 from .._models import BaseModel
 
-__all__ = ["Document", "Section", "SectionElement", "SectionElementMetadata"]
+__all__ = ["Document", "Section", "SectionElement", "SectionElementMetadata", "SectionScores"]
 
 
 class SectionElementMetadata(BaseModel):
@@ -32,7 +32,7 @@ class SectionElementMetadata(BaseModel):
 class SectionElement(BaseModel):
     text: str
 
-    type: Literal["text", "markdown", "image", "table", "title"]
+    type: Literal["text", "markdown", "image", "table", "title", "query"]
 
     id: Optional[str] = None
 
@@ -41,6 +41,17 @@ class SectionElement(BaseModel):
     summary: Optional[str] = None
 
 
+class SectionScores(BaseModel):
+    full_text_search: Optional[float] = None
+    """How relevant the section is based on full text search"""
+
+    semantic_search: Optional[float] = None
+    """How relevant the section is based on vector search"""
+
+    weighted: Optional[float] = None
+    """The final weighted score of the section"""
+
+
 class Section(BaseModel):
     document_id: int
 
@@ -50,10 +61,12 @@ class Section(BaseModel):
 
     embedding_e5_large: Optional[List[float]] = None
 
-    fts: Optional[List[float]] = None
+    embedding_ts: Optional[str] = None
 
     metadata: Optional[object] = None
 
+    scores: Optional[SectionScores] = None
+
     text: Optional[str] = None
 
 

src/hyperspell/types/query_retrieve_response.py

@@ -12,6 +12,7 @@
     "DocumentSection",
     "DocumentSectionElement",
     "DocumentSectionElementMetadata",
+    "DocumentSectionScores",
 ]
 
 
@@ -38,7 +39,7 @@ class DocumentSectionElementMetadata(BaseModel):
 class DocumentSectionElement(BaseModel):
     text: str
 
-    type: Literal["text", "markdown", "image", "table", "title"]
+    type: Literal["text", "markdown", "image", "table", "title", "query"]
 
     id: Optional[str] = None
 
@@ -47,6 +48,17 @@ class DocumentSectionElement(BaseModel):
     summary: Optional[str] = None
 
 
+class DocumentSectionScores(BaseModel):
+    full_text_search: Optional[float] = None
+    """How relevant the section is based on full text search"""
+
+    semantic_search: Optional[float] = None
+    """How relevant the section is based on vector search"""
+
+    weighted: Optional[float] = None
+    """The final weighted score of the section"""
+
+
 class DocumentSection(BaseModel):
     document_id: int
 
@@ -56,10 +68,12 @@ class DocumentSection(BaseModel):
 
     embedding_e5_large: Optional[List[float]] = None
 
-    fts: Optional[List[float]] = None
+    embedding_ts: Optional[str] = None
 
     metadata: Optional[object] = None
 
+    scores: Optional[DocumentSectionScores] = None
+
     text: Optional[str] = None