watson_developer_cloud.alchemy_data_news_v1 module

The AlchemyData News service (https://www.ibm.com/watson/developercloud/alchemy-data-news.html)

class AlchemyDataNewsV1(url='https://gateway-a.watsonplatform.net/calls', **kwargs)[source]

Bases: watson_developer_cloud.watson_service.WatsonService

default_url = 'https://gateway-a.watsonplatform.net/calls'
get_news_documents(start, end, max_results=10, query_fields=None, return_fields=None, time_slice=None, next_page=None, dedup=None, dedup_threshold=None, rank=None)[source]
Parameters:start – The time (in UTC seconds) of the beginning date and time

of the query. Valid values are UTC times and relative times: now (current time), now-{time value}, s (seconds), m (minutes), h (hours), d (days), M (months), and y (years)

Parameters:end – The time (in UTC seconds) of the end date and time of the

query. Valid values are UTC times and relative times: now (current time), now-{time value}, s (seconds), m (minutes), h (hours), d (days), M (months), and y (years)

Parameters:max_results – The maximum number of results that are returned

from your query. If None, all matching results are returned

Parameters:query_fields – There are nearly 400 variations of entity,

taxonomy, sentiment analysis, concepts, and keywords. The full list of parameters is available in the Developer Cloud API documentation. Common fields include q.enriched.url.enrichedTitle.relations.relation, q.enriched.url.enrichedTitle.entities.entity, q.enriched.url.enrichedTitle.taxonomy.taxonomy, q.enriched.url.enrichedTitle.docSentiment.type, q.enriched.url.concepts.concept.text, q.enriched.url.enrichedTitle.keywords.keyword.text

Parameters:fields (return) – A comma-separated list of document fields to

return for each matching document. Any available document fields can be retrieved. To return multiple fields, use a comma separated list. Common fields to return are enriched.url.url (URL), enriched.url.title (title), enriched.url.text(full article text), and enriched.url.author (author name). If you do not specify fields to be returned or a timeSlice, the AlchemyData News API only returns the total number of matching results within the start and end date range

Parameters:time_slice – The interval to divide the returned data. The

default is that the query engine returns the total count over the time duration specified with start and end. If you specify a value, it returns a time series representing the count (max 1000) in each slice of time: now (current time), s (seconds), m (minutes), h (hours), d (days), M (months), and y (years)

Parameters:next_page – If a query is too broad or spans a long time period,

the number of results can be very large and more results may be available than those which were returned. If there are more matching results available, a next parameter is returned in the response. To get the next page of results, execute the query again and append the next parameter to your query

Parameters:dedup – Many news articles are published by a single source,

such as Associated Press, and then syndicated widely across the web. dedup removes duplicate results based on a comparison of their cleaned titles: False (Default) turns off dudup, True turns on dedup

Parameters:dedup_threshold – Defines how strictly the algorithm defines a

duplicate. Valid values are between 0 and 1. The default value is 0.4. A value of 0.0 allows only titles that exactly match those of other articles to be tagged as duplicate. 0.4 allows articles that are very similar but not necessarily identical to be tagged as duplicates. A value of 1.0 allows articles to be aggressively labeled as duplicates, sometimes even when the titles are very dissimilar

Parameters:rank – The News API monitors and ranks 60,000 top-level domains,

each with a varying range of page views. rank allows you to specify to only return articles from well-known, high-traffic publishers. If the rank parameter is not specified, articles of all ranks are returned: high, medium, low, or unknown

Returns:result elements depend on the parameters that you passed to

the query. If return fields are requested, the result element contains a docs element that contains the matching documents, a next element that contains an identifier for the next matching result in the AlchemyData News data set, and a status element that provides status information about retrieving the requested number of results. If no return fields are requested in your query, the result element contains a count of matching news items and the status of querying the AlchemyData News data set.