包简介

AskNews API [![status](https://status.asknews.app/api/badge/2/status?style=for-the-badge)](https://status.asknews.app/status/prod)

README 文档

README

AskNews API

Installation & Usage

Requirements

PHP 8.0 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/emergentmethods/asknews-php-sdk.git"
    }
  ],
  "require": {
    "emergentmethods/asknews-php-sdk": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/asknews-php-sdk/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');





$apiInstance = new AskNews\Api\AlertsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$create_alert_request = new \AskNews\Model\CreateAlertRequest(); // \AskNews\Model\CreateAlertRequest

try {
    $result = $apiInstance->createAlert($create_alert_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertsApi->createAlert: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.asknews.app

Class	Method	HTTP request	Description
AlertsApi	createAlert	POST /v1/chat/alerts	Create an alert
AlertsApi	deleteAlert	DELETE /v1/chat/alerts/{alert_id}	Delete an alert
AlertsApi	getAlert	GET /v1/chat/alerts/{alert_id}	Get an alert
AlertsApi	getAlertLogs	GET /v1/chat/alerts/{alert_id}/logs	Get alert logs
AlertsApi	getAlerts	GET /v1/chat/alerts	Get all created alerts
AlertsApi	getAllAlertLogs	GET /v1/chat/alerts/logs	Get all alert logs
AlertsApi	putAlert	PUT /v1/chat/alerts/{alert_id}	Update an alert
AlertsApi	runAlert	GET /v1/chat/alerts/{alert_id}/run	Run an existing alert
AnalyticsApi	getAssetSentiment	GET /v1/analytics/finance/sentiment	Get a timeseries of finance news sentiment for assets
AutofilterApi	autofilter	GET /v1/chat/autofilter	Generate filter params for AskNews endpoints
ByokApi	deleteByokKey	DELETE /v1/chat/byok/{provider}	Delete a stored BYOK API key for a provider
ByokApi	getByokKey	GET /v1/chat/byok/{provider}	Get a stored BYOK API key hint for a provider
ByokApi	upsertByokKey	PUT /v1/chat/byok/{provider}	Store a BYOK API key for a provider
ChartsApi	createChartsEndpoint	POST /v1/chat/charts	Create a chart
ChatApi	deepNews	POST /v1/chat/deepnews	Deep research into real-time news, archive news, and Google.
ChatApi	getChatCompletions	POST /v1/openai/chat/completions	Get chat completions from a news-infused AI assistant
ChatApi	listDeepnewsModels	GET /v1/chat/deepnews-models	List available DeepNews models
DistributionApi	domainHitShare	GET /v1/distribution/stats/hit_share	Get the hit share for a list of domains in a time period
DistributionApi	findDomains	GET /v1/distribution/domains	Find domains
DistributionApi	getArticleHits	GET /v1/distribution/stats/count	Get article hits
DistributionApi	getDomain	GET /v1/distribution/domains/{name}	Get a domain by name
DistributionApi	getDomainHitsSurface	GET /v1/distribution/articles/domain_hits_surface	Get total hits and surfaced articles for domains
DistributionApi	getDomainHitsSurfaceTimewindow	GET /v1/distribution/articles/domain_hits_surface_timewindow	Get hits and surfaced articles per day for domains
DistributionApi	getDomainQueries	GET /v1/distribution/articles/domain_queries	Get queries that surfaced domain articles
DistributionApi	topNArticlesByHits	GET /v1/distribution/articles/top_n	Get the top N articles by hits
DistributionApi	topNArticlesForDomainTimeseries	GET /v1/distribution/articles/top_n_for_domain_timeseries	Get the top N articles by hits for domain with daily breakdown
DistributionApi	topNArticlesForDomains	GET /v1/distribution/articles/top_n_for_domains	Get the top N articles by hits for domains
DistributionApi	topNDomainsByHits	GET /v1/distribution/domains/top_n	Get the top N domains by hits
DistributionApi	updateDomain	PUT /v1/distribution/domains/{name}	Update an existing domain
ForecastApi	getForecast	GET /v1/chat/forecast	Make an expert forecast for a news event.
GraphApi	buildGraph	POST /v1/news/graph	Build a custom mega-news-knowledge graph
IndexUrlsApi	indexUrls	POST /v1/news/index_urls	Index a list of URLs into AskNews
NewsApi	getArticle	GET /v1/news/{article_id}	Get an article by its UUID
NewsApi	getArticles	GET /v1/news	Get multiple articles by UUID
NewsApi	getIndexCounts	GET /v1/index_counts	Get the index counts underlying AskNews
NewsApi	getSourcesReport	GET /v1/sources	Get the sources underlying AskNews
NewsApi	searchNews	GET /v1/news/search	Search for enriched real-time news context
NewslettersApi	deleteNewsletter	DELETE /v1/chat/newsletters/{newsletter_id}	Delete a newsletter
NewslettersApi	deleteNewsletterContact	DELETE /v1/chat/newsletters/{newsletter_id}/contacts/{contact_id}	Delete a newsletter contact
NewslettersApi	getNewsletter	GET /v1/chat/newsletters/{newsletter_id}	Get a newsletter
NewslettersApi	getNewsletterContact	GET /v1/chat/newsletters/{newsletter_id}/contacts/{contact_id}	Get a newsletter contact
NewslettersApi	getNewsletterContacts	GET /v1/chat/newsletters/{newsletter_id}/contacts	Get newsletter contacts
NewslettersApi	getNewsletters	GET /v1/chat/newsletters	Get all created newsletters
NewslettersApi	getPublicNewsletters	GET /v1/chat/newsletters/public	Get all public newsletters
NewslettersApi	patchNewsletterContact	PATCH /v1/chat/newsletters/{newsletter_id}/contacts/{contact_id}	Update a newsletter contact
NewslettersApi	postNewsletter	POST /v1/chat/newsletters	Create a newsletter
NewslettersApi	postNewsletterContacts	POST /v1/chat/newsletters/{newsletter_id}/contacts	Create a newsletter contact
NewslettersApi	putNewsletter	PUT /v1/chat/newsletters/{newsletter_id}	Update a newsletter
NewslettersApi	unsubscribeNewsletter	POST /v1/chat/newsletters/{newsletter_id}/unsubscribe	Unsubscribe from a newsletter
PingApi	ping	GET /	Ping
ProfileApi	getRateLimitStatus	GET /v1/profiles/me/limits	Get the current user's rate limit status
ProfileApi	getUserProfile	GET /v1/profiles/me	Get the current user's profile
RedditApi	searchReddit	GET /v1/reddit/search	Search Reddit, summarize threads, and return analysis.
StoriesApi	getStories	GET /v1/stories	Filter and search for top news narratives
StoriesApi	getStory	GET /v1/stories/{story_id}	Get a story containing updates
WebsearchApi	liveWebSearch	GET /v1/chat/websearch	Run a live websearch.
WikiApi	searchWiki	GET /v1/wiki/search	Search for Wikipedia context with natural language

Models

Authorization

Find full details at the AskNews API documentation.

Support

Join our Discord to see what other people are building, and to get support with your projects.

emergentmethods/asknews-php-sdk 适用场景与选型建议

emergentmethods/asknews-php-sdk 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 18.94k 次下载、GitHub Stars 达 1，最近一次更新时间为 2024 年 08 月 16 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「news」「newsapi」「llm」「rag」「syntheticdata」「asknews」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 emergentmethods/asknews-php-sdk 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 emergentmethods/asknews-php-sdk 我们能提供哪些服务？

定制开发 / 二次开发

基于 emergentmethods/asknews-php-sdk 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 emergentmethods/asknews-php-sdk 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

jcobhams/newsapi 43

A PHP client for NewsApi

jweiland/jwnewsevent 0

Extend news to use them also as event

buepro/typo3-pizpalue-distribution 4

This TYPO3 distribution provides a sample website using bootstrap and the extensions pizpalue and container_elements. The distribution tailors Swiss market featuring German as default language and additional translations to French, English and Finnish.

adrifkat/cryptopanic 9

PHP unofficial client to cryptopanic.com API

ceddyg/clara-news 0

News feature for Clara.

georgringer/news-subheadline 1

Extend news by a sub headline

emergentmethods/asknews-php-sdk

包简介

关键字：