fix: Add DeepNews endpoint

Author: robcaulk

asknews_sdk/api/chat.py

@@ -14,6 +14,11 @@
     WebSearchResponse,
 )
 from asknews_sdk.dto.common import PaginatedResponse
+from asknews_sdk.dto.deepnews import (
+    CreateDeepNewsRequest,
+    CreateDeepNewsResponse,
+    CreateDeepNewsResponseStream,
+)
 from asknews_sdk.response import EventSource
 
 
@@ -444,6 +449,73 @@ def list_alert_logs(
         )
         return PaginatedResponse[AlertLog].model_validate(response.content)
 
+    def get_deep_news(
+        self,
+        messages: List[Dict[str, str]],
+        model: Literal[
+            "claude-3-7-sonnet-latest",
+            "deepseek",
+            "o3-mini",
+        ] = "deepseek",
+        stream: bool = False,
+        inline_citations: Literal["markdown_link", "numbered", "none"] = "markdown_link",
+        append_references: bool = True,
+        asknews_watermark: bool = True,
+        journalist_mode: bool = True,
+        conversational_awareness: bool = False,
+        filter_params: Optional[Dict] = None,
+        sources: List[str] = None,
+        search_depth: int = 3,
+        max_depth: int = 5,
+        *,
+        http_headers: Optional[Dict] = None,
+    ) -> Union[CreateDeepNewsResponse, Iterator[CreateDeepNewsResponseStream]]:
+        """
+        Get deep news research!
+
+        https://docs.asknews.app/en/reference#post-/v1/openai/chat/deepnews
+        """
+        response = self.client.request(
+            method="POST",
+            endpoint="/v1/chat/deepnews",
+            body=CreateDeepNewsRequest(
+                messages=messages,
+                model=model,
+                stream=stream,
+                inline_citations=inline_citations,
+                append_references=append_references,
+                asknews_watermark=asknews_watermark,
+                journalist_mode=journalist_mode,
+                conversational_awareness=conversational_awareness,
+                filter_params=filter_params,
+                sources=sources if sources else ["asknews"],
+                search_depth=search_depth,
+                max_depth=max_depth,
+            ).model_dump(mode="json"),
+            headers={
+                **(http_headers or {}),
+                "Content-Type": CreateDeepNewsRequest.__content_type__,
+            },
+            accept=[
+                (CreateDeepNewsResponse.__content_type__, 1.0),
+                (CreateDeepNewsResponseStream.__content_type__, 1.0),
+            ],
+            stream=stream,
+            stream_type="lines",
+        )
+
+        if stream:
+
+            def _stream():
+                for event in EventSource.from_api_response(response):
+                    if event.content == "[DONE]":
+                        break
+                    yield CreateDeepNewsResponseStream.model_validate_json(event.content)
+
+            return _stream()
+        else:
+            return CreateDeepNewsResponse.model_validate(response.content)
+
 
 class AsyncChatAPI(BaseAPI):
     """

asknews_sdk/dto/chat.py

@@ -135,6 +135,7 @@ class WebSearchResult(BaseModel):
     published: str
     key_points: List[str]
     raw_text: str = ""
+    as_string_key: Optional[str] = None
 
 
 class WebSearchResponse(BaseModel):

asknews_sdk/dto/deepnews.py

@@ -0,0 +1,107 @@
+from __future__ import annotations
+
+from typing import Any, Dict, List, Literal, Optional, Union
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing_extensions import Annotated
+
+from asknews_sdk.dto.base import BaseSchema
+from asknews_sdk.dto.chat import WebSearchResult
+from asknews_sdk.dto.news import SearchResponseDictItem
+
+
+class DeepNewsSources(BaseModel):
+    news: Annotated[List[SearchResponseDictItem], Field(title="News")]
+    web: Annotated[List[WebSearchResult], Field(title="Web")]
+
+
+class CreateDeepNewsRequestMessage(BaseModel):
+    role: Annotated[str, Field(title="Role")]
+    content: Annotated[str, Field(title="Content")]
+    name: Annotated[Optional[str], Field(None, title="Name")]
+    function_call: Annotated[Optional[Dict[str, Any]], Field(None, title="Function Call")]
+
+
+class CreateDeepNewsResponseChoice(BaseModel):
+    index: Annotated[int, Field(title="Index")]
+    message: CreateDeepNewsRequestMessage
+    finish_reason: Annotated[Optional[str], Field(None, title="Finish Reason")]
+
+
+class CreateDeepNewsResponseStreamChoice(BaseModel):
+    index: Annotated[int, Field(title="Index")]
+    delta: CreateDeepNewsRequestMessage
+    finish_reason: Annotated[Optional[str], Field(None, title="Finish Reason")]
+
+
+class CreateDeepNewsResponseUsage(BaseModel):
+    prompt_tokens: Annotated[int, Field(title="Prompt Tokens")]
+    completion_tokens: Annotated[int, Field(title="Completion Tokens")]
+    total_tokens: Annotated[int, Field(title="Total Tokens")]
+
+
+class CreateDeepNewsRequest(BaseSchema):
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    model: Annotated[Optional[str], Field("deepseek", title="Model")]
+    messages: Annotated[List[CreateDeepNewsRequestMessage], Field(title="Messages")]
+    temperature: Annotated[Optional[float], Field(0.9, title="Temperature")]
+    top_p: Annotated[Optional[float], Field(1.0, title="Top P")]
+    n: Annotated[Optional[int], Field(1, title="N")]
+    stream: Annotated[Optional[bool], Field(False, title="Stream")]
+    stop: Annotated[Optional[Union[str, List[str]]], Field(None, title="Stop")]
+    max_tokens: Annotated[Optional[int], Field(9999, title="Max Tokens")]
+    presence_penalty: Annotated[Optional[int], Field(0, title="Presence Penalty")]
+    frequency_penalty: Annotated[Optional[int], Field(0, title="Frequency Penalty")]
+    user: Annotated[Optional[str], Field(None, title="User")]
+    inline_citations: Annotated[
+        Optional[Literal["markdown_link", "numbered", "none"]],
+        Field("markdown_link", title="Type of inline citation formatting."),
+    ]
+    journalist_mode: Annotated[
+        Optional[bool],
+        Field(
+            True,
+            title=(
+                "Activate journalist mode, with improved alignment for making claims"
+                "with supporting evidence. Improved journalistic style."
+            ),
+        ),
+    ]
+    asknews_watermark: Annotated[
+        Optional[bool], Field(True, title='Append "Generated by AskNews AI" watermark')
+    ]
+    append_references: Annotated[Optional[bool], Field(True, title="Append References or not")]
+    conversational_awareness: Annotated[
+        Optional[bool], Field(False, title="Conversational Awareness")
+    ]
+    filter_params: Annotated[
+        Optional[Dict[str, Any]],
+        Field(None, title="Any filter param available on the /news endpoint."),
+    ]
+    sources: Annotated[Optional[List[str]], Field(["asknews"], title="Sources")]
+    search_depth: Annotated[Optional[int], Field(2, title="Search Depth")]
+    max_depth: Annotated[Optional[int], Field(4, title="Max Depth")]
+
+
+class CreateDeepNewsResponse(BaseSchema):
+    id: Annotated[str, Field(title="Id")]
+    created: Annotated[int, Field(title="Created")]
+    object: Annotated[Optional[str], Field("chat.completion", title="Object")]
+    model: Annotated[Optional[str], Field("deepseek", title="Model")]
+    usage: CreateDeepNewsResponseUsage
+    choices: Annotated[List[CreateDeepNewsResponseChoice], Field(title="Choices")]
+    sources: Annotated[DeepNewsSources, Field(title="Sources")]
+
+
+class CreateDeepNewsResponseStream(BaseSchema):
+    __content_type__ = "text/event-stream"
+
+    id: Annotated[str, Field(title="Id")]
+    created: Annotated[int, Field(title="Created")]
+    object: Annotated[Optional[str], Field("chat.completion.chunk", title="Object")]
+    model: Annotated[Optional[str], Field("deepseek", title="Model")]
+    usage: CreateDeepNewsResponseUsage
+    choices: Annotated[List[CreateDeepNewsResponseStreamChoice], Field(title="Choices")]
+    sources: Annotated[DeepNewsSources, Field(title="Sources")]