feat: add AskNews toolkit

[ZackYule]

Description

add AskNews toolkit

Motivation and Context

close #860

• I have raised an issue to propose this change (required for new features and bug fixes)

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds core functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Documentation (update in the documentation)
• Example (update in the folder of example)

Implemented Tasks

• Subtask 1
• Subtask 2
• Subtask 3

Checklist

Go over all the following points, and put an x in all the boxes that apply.
If you are unsure about any of these, don't hesitate to ask. We are here to help!

• I have read the CONTRIBUTION guide. (required)
• My change requires a change to the documentation.
• I have updated the tests accordingly. (required for a bug fix or a new feature)
• I have updated the documentation accordingly.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[Wendong-Fan]

Thanks @ZackYule , we also need to add the dependency to toml file, but I found there's some conflict with MistralAI package, maybe we can raise one issue to see whether asknews can update their dependency version. It's would be better if can add some test code for the integration

asknews also support async running via AsyncAskNewsSDK, could we also add support for this?

[Wendong-Fan]

can we also support ask.stories.search_stories?

    response = ask.stories.search_stories(
        categories=["Technology", "Science"],
        continent="North America",
        sort_by="coverage",  # sort by coverage
        sort_type="desc",  # highest to lowest coverage
        reddit=3,  # include 3 reddit threads
        expand_updates=True,  # get all the details for updates
        max_updates=2,  # get the 2 most recent updates for each story
        max_articles=10  # include 10 news articles associated with each update
    )
    print([story.updates[0].headline for story in response.stories])

[robcaulk]

Thanks @ZackYule , we also need to add the dependency to toml file, but I found there's some conflict with MistralAI package, maybe we can raise one issue to see whether asknews can update their dependency version. It's would be better if can add some test code for the integration

asknews also support async running via AsyncAskNewsSDK, could we also add support for this?

Hey Wendong, we just bumped httpx so that AskNews can be installed with mistralai. The new version is 0.7.39.

[Wendong-Fan]

Thanks @ZackYule , we also need to add the dependency to toml file, but I found there's some conflict with MistralAI package, maybe we can raise one issue to see whether asknews can update their dependency version. It's would be better if can add some test code for the integration
asknews also support async running via AsyncAskNewsSDK, could we also add support for this?

Hey Wendong, we just bumped httpx so that AskNews can be installed with mistralai. The new version is 0.7.39.

Hey @robcaulk , that's awesome! Thanks so much for doing this

[ZackYule]

can we also support ask.stories.search_stories?我们还可以支持ask.stories.search_stories吗？

    response = ask.stories.search_stories(
        categories=["Technology", "Science"],
        continent="North America",
        sort_by="coverage",  # sort by coverage
        sort_type="desc",  # highest to lowest coverage
        reddit=3,  # include 3 reddit threads
        expand_updates=True,  # get all the details for updates
        max_updates=2,  # get the 2 most recent updates for each story
        max_articles=10  # include 10 news articles associated with each update
    )
    print([story.updates[0].headline for story in response.stories])

Updated

[Wendong-Fan]

Thanks @ZackYule and sorry for the late review, the docstring format need to be aligned with other code, It would be great if we could also add some simple example code under example folder

[Wendong-Fan]

Hey @ZackYule , I did some update for this PR and would merge this one, feel free to check changes @ZackYule