merge main into feat/refactor

Author: robcaulk

CHANGELOG.md

@@ -1,3 +1,15 @@
+## 0.6.10 (2024-06-02)
+
+### Fix
+
+- default to fastest return_type 'string'
+
+## 0.6.9 (2024-05-31)
+
+### Fix
+
+- update the graph relationships
+
 ## 0.6.8 (2024-05-23)
 
 ### Fix

asknews_sdk/api/news.py

@@ -13,10 +13,7 @@ class NewsAPI(BaseAPI):
     """
 
     def get_article(
-        self,
-        article_id: Union[str, UUID],
-        *,
-        http_headers: Optional[Dict] = None
+        self, article_id: Union[str, UUID], *, http_headers: Optional[Dict] = None
     ) -> ArticleResponse:
         """
         Get a news article by its UUID.
@@ -45,7 +42,7 @@ def search_news(
         n_articles: int = 10,
         start_timestamp: Optional[int] = None,
         end_timestamp: Optional[int] = None,
-        return_type: Literal["string", "dicts", "both"] = "dicts",
+        return_type: Literal["string", "dicts", "both"] = "string",
         historical: bool = False,
         method: Literal["nl", "kw", "both"] = "nl",
         similarity_score_threshold: float = 0.5,
@@ -222,10 +219,7 @@ class AsyncNewsAPI(BaseAPI):
     """
 
     async def get_article(
-        self,
-        article_id: Union[str, UUID],
-        *,
-        http_headers: Optional[Dict] = None
+        self, article_id: Union[str, UUID], *, http_headers: Optional[Dict] = None
     ):
         """
         Get a news article by its UUID.
@@ -254,7 +248,7 @@ async def search_news(
         n_articles: int = 10,
         start_timestamp: Optional[int] = None,
         end_timestamp: Optional[int] = None,
-        return_type: Literal["string", "dicts", "both"] = "dicts",
+        return_type: Literal["string", "dicts", "both"] = "string",
         historical: bool = False,
         method: Literal["nl", "kw", "both"] = "nl",
         similarity_score_threshold: float = 0.5,

asknews_sdk/dto/stories.py

@@ -56,7 +56,7 @@ class IntraClusterStatistics(BaseModel):
 
 
 class GraphRelationships(BaseModel):
-    nodes: list[dict[Literal["id", "type"], str]]
+    nodes: list[dict[Literal["id", "type", "detailed_type"], str]]
     edges: list[dict[Literal["from", "to", "label"], str]]
 
 
@@ -125,7 +125,7 @@ class StoryResponse(BaseSchema):
     n_articles: Annotated[List[int], Field(title="N Articles")]
     n_updates: Annotated[int, Field(title="N Updates")]
     people: Annotated[List[str], Field(title="People")]
-    reddit_sentiment: Annotated[List[int], Field(title="Reddit Sentiment")]
+    reddit_sentiment: Annotated[List[int | float], Field(title="Reddit Sentiment")]
     reddit_sentiment_timestamps: Annotated[List[int], Field(title="Reddit Sentiment Timestamps")]
     rolling_sentiment: Annotated[List[float], Field(title="Rolling Sentiment")]
     sentiment: Annotated[List[int], Field(title="Sentiment")]

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "asknews"
-version = "0.6.8"
+version = "0.6.10"
 description = "Python SDK for AskNews"
 authors = ["Emergent Methods <[email protected]>"]
 packages = [{ include = "asknews_sdk" }]