aylien_news_api 4.3.0 → 4.6.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/aylien_news_api.gemspec +1 -1
- data/docs/DefaultApi.md +213 -177
- data/docs/DeprecatedEntities.md +19 -0
- data/docs/DeprecatedEntity.md +33 -0
- data/docs/DeprecatedEntitySurfaceForm.md +21 -0
- data/docs/DeprecatedRelatedStories.md +27 -0
- data/docs/DeprecatedStories.md +25 -0
- data/docs/DeprecatedStory.md +61 -0
- data/docs/Entity.md +12 -10
- data/docs/EntityInText.md +19 -0
- data/docs/EntityMention.md +19 -0
- data/docs/EntityMentionIndex.md +19 -0
- data/docs/EntitySurfaceForm.md +4 -2
- data/docs/Story.md +1 -1
- data/lib/aylien_news_api.rb +10 -5
- data/lib/aylien_news_api/api/default_api.rb +237 -183
- data/lib/aylien_news_api/api_client.rb +1 -1
- data/lib/aylien_news_api/api_error.rb +1 -1
- data/lib/aylien_news_api/configuration.rb +1 -1
- data/lib/aylien_news_api/models/aggregated_sentiment.rb +1 -1
- data/lib/aylien_news_api/models/author.rb +1 -1
- data/lib/aylien_news_api/models/autocomplete.rb +1 -1
- data/lib/aylien_news_api/models/autocompletes.rb +1 -1
- data/lib/aylien_news_api/models/category.rb +1 -1
- data/lib/aylien_news_api/models/category_links.rb +1 -1
- data/lib/aylien_news_api/models/category_taxonomy.rb +1 -1
- data/lib/aylien_news_api/models/cluster.rb +1 -1
- data/lib/aylien_news_api/models/clusters.rb +1 -1
- data/lib/aylien_news_api/models/deprecated_entities.rb +221 -0
- data/lib/aylien_news_api/models/deprecated_entity.rb +314 -0
- data/lib/aylien_news_api/models/deprecated_entity_surface_form.rb +244 -0
- data/lib/aylien_news_api/models/deprecated_related_stories.rb +260 -0
- data/lib/aylien_news_api/models/deprecated_stories.rb +252 -0
- data/lib/aylien_news_api/models/deprecated_story.rb +429 -0
- data/lib/aylien_news_api/models/entity.rb +91 -45
- data/lib/aylien_news_api/models/entity_in_text.rb +217 -0
- data/lib/aylien_news_api/models/entity_links.rb +1 -1
- data/lib/aylien_news_api/models/entity_mention.rb +215 -0
- data/lib/aylien_news_api/models/entity_mention_index.rb +265 -0
- data/lib/aylien_news_api/models/entity_sentiment.rb +1 -1
- data/lib/aylien_news_api/models/entity_surface_form.rb +35 -10
- data/lib/aylien_news_api/models/error.rb +1 -1
- data/lib/aylien_news_api/models/error_links.rb +1 -1
- data/lib/aylien_news_api/models/errors.rb +1 -1
- data/lib/aylien_news_api/models/histogram_interval.rb +1 -1
- data/lib/aylien_news_api/models/histograms.rb +1 -1
- data/lib/aylien_news_api/models/location.rb +1 -1
- data/lib/aylien_news_api/models/logicals.rb +1 -1
- data/lib/aylien_news_api/models/media.rb +1 -1
- data/lib/aylien_news_api/models/media_format.rb +1 -1
- data/lib/aylien_news_api/models/media_type.rb +1 -1
- data/lib/aylien_news_api/models/nested_entity.rb +1 -1
- data/lib/aylien_news_api/models/parameter.rb +1 -1
- data/lib/aylien_news_api/models/query.rb +1 -1
- data/lib/aylien_news_api/models/rank.rb +1 -1
- data/lib/aylien_news_api/models/rankings.rb +1 -1
- data/lib/aylien_news_api/models/related_stories.rb +2 -1
- data/lib/aylien_news_api/models/representative_story.rb +1 -1
- data/lib/aylien_news_api/models/scope.rb +1 -1
- data/lib/aylien_news_api/models/scope_level.rb +1 -1
- data/lib/aylien_news_api/models/sentiment.rb +1 -1
- data/lib/aylien_news_api/models/sentiment_polarity.rb +1 -1
- data/lib/aylien_news_api/models/sentiments.rb +1 -1
- data/lib/aylien_news_api/models/share_count.rb +1 -1
- data/lib/aylien_news_api/models/share_counts.rb +1 -1
- data/lib/aylien_news_api/models/source.rb +1 -1
- data/lib/aylien_news_api/models/stories.rb +2 -1
- data/lib/aylien_news_api/models/story.rb +6 -3
- data/lib/aylien_news_api/models/story_cluster.rb +1 -1
- data/lib/aylien_news_api/models/story_links.rb +1 -1
- data/lib/aylien_news_api/models/story_translation.rb +1 -1
- data/lib/aylien_news_api/models/story_translations.rb +1 -1
- data/lib/aylien_news_api/models/summary.rb +1 -1
- data/lib/aylien_news_api/models/time_series.rb +1 -1
- data/lib/aylien_news_api/models/time_series_list.rb +1 -1
- data/lib/aylien_news_api/models/trend.rb +1 -1
- data/lib/aylien_news_api/models/trends.rb +1 -1
- data/lib/aylien_news_api/models/warning.rb +1 -1
- data/lib/aylien_news_api/version.rb +2 -2
- data/spec/api/default_api_spec.rb +143 -5
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/aggregated_sentiment_spec.rb +1 -1
- data/spec/models/author_spec.rb +1 -1
- data/spec/models/autocomplete_spec.rb +1 -1
- data/spec/models/autocompletes_spec.rb +1 -1
- data/spec/models/category_links_spec.rb +1 -1
- data/spec/models/category_spec.rb +1 -1
- data/spec/models/category_taxonomy_spec.rb +1 -1
- data/spec/models/cluster_spec.rb +1 -1
- data/spec/models/clusters_spec.rb +1 -1
- data/spec/models/deprecated_entities_spec.rb +47 -0
- data/spec/models/deprecated_entity_spec.rb +89 -0
- data/spec/models/deprecated_entity_surface_form_spec.rb +53 -0
- data/spec/models/deprecated_related_stories_spec.rb +71 -0
- data/spec/models/deprecated_stories_spec.rb +65 -0
- data/spec/models/deprecated_story_spec.rb +173 -0
- data/spec/models/entity_in_text_spec.rb +47 -0
- data/spec/models/entity_links_spec.rb +7 -1
- data/spec/models/entity_mention_index_spec.rb +47 -0
- data/spec/models/entity_mention_spec.rb +47 -0
- data/spec/models/entity_sentiment_spec.rb +1 -1
- data/spec/models/entity_spec.rb +24 -6
- data/spec/models/entity_surface_form_spec.rb +8 -2
- data/spec/models/error_links_spec.rb +1 -1
- data/spec/models/error_spec.rb +1 -1
- data/spec/models/errors_spec.rb +1 -1
- data/spec/models/histogram_interval_spec.rb +1 -1
- data/spec/models/histograms_spec.rb +1 -1
- data/spec/models/location_spec.rb +1 -1
- data/spec/models/logicals_spec.rb +1 -1
- data/spec/models/media_format_spec.rb +1 -1
- data/spec/models/media_spec.rb +1 -1
- data/spec/models/media_type_spec.rb +1 -1
- data/spec/models/nested_entity_spec.rb +20 -2
- data/spec/models/parameter_spec.rb +1 -1
- data/spec/models/query_spec.rb +1 -1
- data/spec/models/rank_spec.rb +1 -1
- data/spec/models/rankings_spec.rb +1 -1
- data/spec/models/related_stories_spec.rb +1 -1
- data/spec/models/representative_story_spec.rb +1 -1
- data/spec/models/scope_level_spec.rb +1 -1
- data/spec/models/scope_spec.rb +1 -1
- data/spec/models/sentiment_polarity_spec.rb +1 -1
- data/spec/models/sentiment_spec.rb +1 -1
- data/spec/models/sentiments_spec.rb +1 -1
- data/spec/models/share_count_spec.rb +1 -1
- data/spec/models/share_counts_spec.rb +1 -1
- data/spec/models/source_spec.rb +1 -1
- data/spec/models/stories_spec.rb +1 -1
- data/spec/models/story_cluster_spec.rb +1 -1
- data/spec/models/story_links_spec.rb +1 -1
- data/spec/models/story_spec.rb +7 -1
- data/spec/models/story_translation_spec.rb +1 -1
- data/spec/models/story_translations_spec.rb +1 -1
- data/spec/models/summary_spec.rb +1 -1
- data/spec/models/time_series_list_spec.rb +1 -1
- data/spec/models/time_series_spec.rb +7 -1
- data/spec/models/trend_spec.rb +7 -1
- data/spec/models/trends_spec.rb +1 -1
- data/spec/models/warning_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +38 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e33c3dadd670aef2bc6bab34989c761ba2183b885c7724a08df2b2c0dffccf25
|
4
|
+
data.tar.gz: 1b4d938aa6f7f6e69a1a6bdd5492e90b7571312626bc7fe643f8956c3f3d9a5f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c4531362539b87697eb2b4eadb81b8c4ad0f3f7c869b522dcb317904e6229edca1124bcb0cb3720aaf5ddcdbf06a6bafa926e61e00ff386fc0c6960b7114ea51
|
7
|
+
data.tar.gz: aca60fef988b8018c3741d07955d98c0da4c1e7c72157a29a74bee8ee4062e0b71146fcb53031ff42e47447e1a440dbd68490490b4e8b8c4ebea2ab8c66a25b0
|
data/aylien_news_api.gemspec
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
|
6
6
|
#The AYLIEN News API is the most powerful way of sourcing, searching and syndicating analyzed and enriched news content. It is accessed by sending HTTP requests to our server, which returns information to your client.
|
7
7
|
|
8
|
-
The version of the OpenAPI document:
|
8
|
+
The version of the OpenAPI document: 4.6
|
9
9
|
Contact: support@aylien.com
|
10
10
|
Generated by: https://openapi-generator.tech
|
11
11
|
OpenAPI Generator version: 5.0.0-SNAPSHOT
|
data/docs/DefaultApi.md
CHANGED
@@ -18,7 +18,7 @@ Method | HTTP request | Description
|
|
18
18
|
|
19
19
|
## advanced_list_stories
|
20
20
|
|
21
|
-
>
|
21
|
+
> DeprecatedStories advanced_list_stories(unknown_base_type, opts)
|
22
22
|
|
23
23
|
List Stories
|
24
24
|
|
@@ -79,7 +79,7 @@ Name | Type | Description | Notes
|
|
79
79
|
|
80
80
|
### Return type
|
81
81
|
|
82
|
-
[**
|
82
|
+
[**DeprecatedStories**](DeprecatedStories.md)
|
83
83
|
|
84
84
|
### Authorization
|
85
85
|
|
@@ -302,37 +302,37 @@ opts = {
|
|
302
302
|
categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
303
303
|
not_categories_level: [56], # Array<Integer> | This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
304
304
|
entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
305
|
-
not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
306
|
-
entities_title_surface_forms_text:
|
307
|
-
not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
305
|
+
not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
306
|
+
entities_title_surface_forms_text: 'entities_title_surface_forms_text_example', # String | This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
307
|
+
not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
308
308
|
entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
309
309
|
not_entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
310
310
|
entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
311
311
|
not_entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
312
|
-
entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in
|
313
|
-
not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
312
|
+
entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
313
|
+
not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
314
314
|
entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
315
315
|
not_entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
316
|
-
entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities
|
317
|
-
not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
318
|
-
entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities
|
319
|
-
not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
316
|
+
entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
317
|
+
not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
318
|
+
entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
319
|
+
not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
320
320
|
entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
321
|
-
not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
321
|
+
not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
322
322
|
entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
323
|
-
not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
323
|
+
not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
324
324
|
entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
325
325
|
not_entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
326
326
|
entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
327
327
|
not_entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
328
328
|
entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
329
|
-
not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
329
|
+
not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
330
330
|
entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
331
331
|
not_entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
332
332
|
entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
333
|
-
not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
333
|
+
not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
334
334
|
entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
335
|
-
not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
335
|
+
not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
336
336
|
sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
|
337
337
|
not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
|
338
338
|
sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
|
@@ -387,6 +387,9 @@ opts = {
|
|
387
387
|
social_shares_count_reddit_min: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
|
388
388
|
social_shares_count_reddit_max: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
|
389
389
|
clusters: ['clusters_example'], # Array<String> | This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering).
|
390
|
+
aql: 'aql_example', # String | This parameter is used to supply a query in AYLIEN Query Language.
|
391
|
+
aql_default_field: 'text', # String | This parameter is used to supply an optional default field name used in the AQL query.
|
392
|
+
query: 'query_example', # String | This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string.
|
390
393
|
interval_start: 56, # Integer | This parameter is used for setting the start data point of histogram intervals.
|
391
394
|
interval_end: 56, # Integer | This parameter is used for setting the end data point of histogram intervals.
|
392
395
|
interval_width: 56, # Integer | This parameter is used for setting the width of histogram intervals.
|
@@ -430,37 +433,37 @@ Name | Type | Description | Notes
|
|
430
433
|
**categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
431
434
|
**not_categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
432
435
|
**entities_title_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
433
|
-
**not_entities_title_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
434
|
-
**entities_title_surface_forms_text** |
|
435
|
-
**not_entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
436
|
+
**not_entities_title_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
437
|
+
**entities_title_surface_forms_text** | **String**| This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
438
|
+
**not_entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
436
439
|
**entities_title_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
437
440
|
**not_entities_title_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
438
441
|
**entities_title_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
439
442
|
**not_entities_title_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
440
|
-
**entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in
|
441
|
-
**not_entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
443
|
+
**entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
444
|
+
**not_entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
442
445
|
**entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
443
446
|
**not_entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
444
|
-
**entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities
|
445
|
-
**not_entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
446
|
-
**entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities
|
447
|
-
**not_entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
447
|
+
**entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
448
|
+
**not_entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
449
|
+
**entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
450
|
+
**not_entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
448
451
|
**entities_body_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
449
|
-
**not_entities_body_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
452
|
+
**not_entities_body_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
450
453
|
**entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
451
|
-
**not_entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
454
|
+
**not_entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
452
455
|
**entities_body_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
453
456
|
**not_entities_body_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
454
457
|
**entities_body_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
455
458
|
**not_entities_body_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
456
459
|
**entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
457
|
-
**not_entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
460
|
+
**not_entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
458
461
|
**entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
459
462
|
**not_entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
460
463
|
**entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
461
|
-
**not_entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
464
|
+
**not_entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
462
465
|
**entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
463
|
-
**not_entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
466
|
+
**not_entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
464
467
|
**sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
|
465
468
|
**not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
|
466
469
|
**sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
|
@@ -515,6 +518,9 @@ Name | Type | Description | Notes
|
|
515
518
|
**social_shares_count_reddit_min** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. | [optional]
|
516
519
|
**social_shares_count_reddit_max** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. | [optional]
|
517
520
|
**clusters** | [**Array<String>**](String.md)| This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional]
|
521
|
+
**aql** | **String**| This parameter is used to supply a query in AYLIEN Query Language. | [optional]
|
522
|
+
**aql_default_field** | **String**| This parameter is used to supply an optional default field name used in the AQL query. | [optional] [default to 'text']
|
523
|
+
**query** | **String**| This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string. | [optional]
|
518
524
|
**interval_start** | **Integer**| This parameter is used for setting the start data point of histogram intervals. | [optional]
|
519
525
|
**interval_end** | **Integer**| This parameter is used for setting the end data point of histogram intervals. | [optional]
|
520
526
|
**interval_width** | **Integer**| This parameter is used for setting the width of histogram intervals. | [optional]
|
@@ -536,7 +542,7 @@ Name | Type | Description | Notes
|
|
536
542
|
|
537
543
|
## list_related_stories_get
|
538
544
|
|
539
|
-
>
|
545
|
+
> DeprecatedRelatedStories list_related_stories_get(opts)
|
540
546
|
|
541
547
|
|
542
548
|
|
@@ -583,37 +589,37 @@ opts = {
|
|
583
589
|
categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
584
590
|
not_categories_level: [56], # Array<Integer> | This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
585
591
|
entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
586
|
-
not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
587
|
-
entities_title_surface_forms_text:
|
588
|
-
not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
592
|
+
not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
593
|
+
entities_title_surface_forms_text: 'entities_title_surface_forms_text_example', # String | This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
594
|
+
not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
589
595
|
entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
590
596
|
not_entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
591
597
|
entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
592
598
|
not_entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
593
|
-
entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in
|
594
|
-
not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
599
|
+
entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
600
|
+
not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
595
601
|
entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
596
602
|
not_entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
597
|
-
entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities
|
598
|
-
not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
599
|
-
entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities
|
600
|
-
not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
603
|
+
entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
604
|
+
not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
605
|
+
entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
606
|
+
not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
601
607
|
entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
602
|
-
not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
608
|
+
not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
603
609
|
entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
604
|
-
not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
610
|
+
not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
605
611
|
entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
606
612
|
not_entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
607
613
|
entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
608
614
|
not_entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
609
615
|
entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
610
|
-
not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
616
|
+
not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
611
617
|
entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
612
618
|
not_entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
613
619
|
entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
614
|
-
not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
620
|
+
not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
615
621
|
entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
616
|
-
not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
622
|
+
not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
617
623
|
sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
|
618
624
|
not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
|
619
625
|
sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
|
@@ -673,6 +679,9 @@ opts = {
|
|
673
679
|
story_url: 'story_url_example', # String | An article or webpage
|
674
680
|
story_title: 'story_title_example', # String | Title of the article
|
675
681
|
story_body: 'story_body_example', # String | Body of the article
|
682
|
+
aql: 'aql_example', # String | This parameter is used to supply a query in AYLIEN Query Language.
|
683
|
+
aql_default_field: 'text', # String | This parameter is used to supply an optional default field name used in the AQL query.
|
684
|
+
query: 'query_example', # String | This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string.
|
676
685
|
boost_by: 'boost_by_example', # String | This parameter is used for boosting the result by the specified value.
|
677
686
|
story_language: 'auto', # String | This parameter is used for setting the language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
|
678
687
|
per_page: 3 # Integer | This parameter is used for specifying number of items in each page.
|
@@ -714,37 +723,37 @@ Name | Type | Description | Notes
|
|
714
723
|
**categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
715
724
|
**not_categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
716
725
|
**entities_title_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
717
|
-
**not_entities_title_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
718
|
-
**entities_title_surface_forms_text** |
|
719
|
-
**not_entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
726
|
+
**not_entities_title_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
727
|
+
**entities_title_surface_forms_text** | **String**| This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
728
|
+
**not_entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
720
729
|
**entities_title_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
721
730
|
**not_entities_title_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
722
731
|
**entities_title_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
723
732
|
**not_entities_title_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
724
|
-
**entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in
|
725
|
-
**not_entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
733
|
+
**entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
734
|
+
**not_entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
726
735
|
**entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
727
736
|
**not_entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
728
|
-
**entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities
|
729
|
-
**not_entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
730
|
-
**entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities
|
731
|
-
**not_entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
737
|
+
**entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
738
|
+
**not_entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
739
|
+
**entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
740
|
+
**not_entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
732
741
|
**entities_body_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
733
|
-
**not_entities_body_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
742
|
+
**not_entities_body_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
734
743
|
**entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
735
|
-
**not_entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
744
|
+
**not_entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
736
745
|
**entities_body_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
737
746
|
**not_entities_body_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
738
747
|
**entities_body_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
739
748
|
**not_entities_body_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
740
749
|
**entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
741
|
-
**not_entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
750
|
+
**not_entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
742
751
|
**entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
743
752
|
**not_entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
744
753
|
**entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
745
|
-
**not_entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
754
|
+
**not_entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
746
755
|
**entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
747
|
-
**not_entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
756
|
+
**not_entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
748
757
|
**sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
|
749
758
|
**not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
|
750
759
|
**sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
|
@@ -804,13 +813,16 @@ Name | Type | Description | Notes
|
|
804
813
|
**story_url** | **String**| An article or webpage | [optional]
|
805
814
|
**story_title** | **String**| Title of the article | [optional]
|
806
815
|
**story_body** | **String**| Body of the article | [optional]
|
816
|
+
**aql** | **String**| This parameter is used to supply a query in AYLIEN Query Language. | [optional]
|
817
|
+
**aql_default_field** | **String**| This parameter is used to supply an optional default field name used in the AQL query. | [optional] [default to 'text']
|
818
|
+
**query** | **String**| This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string. | [optional]
|
807
819
|
**boost_by** | **String**| This parameter is used for boosting the result by the specified value. | [optional]
|
808
820
|
**story_language** | **String**| This parameter is used for setting the language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [default to 'auto']
|
809
821
|
**per_page** | **Integer**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
|
810
822
|
|
811
823
|
### Return type
|
812
824
|
|
813
|
-
[**
|
825
|
+
[**DeprecatedRelatedStories**](DeprecatedRelatedStories.md)
|
814
826
|
|
815
827
|
### Authorization
|
816
828
|
|
@@ -824,7 +836,7 @@ Name | Type | Description | Notes
|
|
824
836
|
|
825
837
|
## list_related_stories_post
|
826
838
|
|
827
|
-
>
|
839
|
+
> DeprecatedRelatedStories list_related_stories_post(opts)
|
828
840
|
|
829
841
|
|
830
842
|
|
@@ -871,37 +883,37 @@ opts = {
|
|
871
883
|
categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
872
884
|
not_categories_level: [56], # Array<Integer> | This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
873
885
|
entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
874
|
-
not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
875
|
-
entities_title_surface_forms_text:
|
876
|
-
not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
886
|
+
not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
887
|
+
entities_title_surface_forms_text: 'entities_title_surface_forms_text_example', # String | This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
888
|
+
not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
877
889
|
entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
878
890
|
not_entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
879
891
|
entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
880
892
|
not_entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
881
|
-
entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in
|
882
|
-
not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
893
|
+
entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
894
|
+
not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
883
895
|
entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
884
896
|
not_entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
885
|
-
entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities
|
886
|
-
not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
887
|
-
entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities
|
888
|
-
not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
897
|
+
entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
898
|
+
not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
899
|
+
entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
900
|
+
not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
889
901
|
entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
890
|
-
not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
902
|
+
not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
891
903
|
entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
892
|
-
not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
904
|
+
not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
893
905
|
entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
894
906
|
not_entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
895
907
|
entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
896
908
|
not_entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
897
909
|
entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
898
|
-
not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
910
|
+
not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
899
911
|
entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
900
912
|
not_entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
901
913
|
entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
902
|
-
not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
914
|
+
not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
903
915
|
entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
904
|
-
not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
916
|
+
not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
905
917
|
sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
|
906
918
|
not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
|
907
919
|
sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
|
@@ -961,6 +973,9 @@ opts = {
|
|
961
973
|
story_url: 'story_url_example', # String | An article or webpage
|
962
974
|
story_title: 'story_title_example', # String | Title of the article
|
963
975
|
story_body: 'story_body_example', # String | Body of the article
|
976
|
+
aql: 'aql_example', # String | This parameter is used to supply a query in AYLIEN Query Language.
|
977
|
+
aql_default_field: 'text', # String | This parameter is used to supply an optional default field name used in the AQL query.
|
978
|
+
query: 'query_example', # String | This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string.
|
964
979
|
boost_by: 'boost_by_example', # String | This parameter is used for boosting the result by the specified value.
|
965
980
|
story_language: 'auto', # String | This parameter is used for setting the language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes.
|
966
981
|
per_page: 3 # Integer | This parameter is used for specifying number of items in each page.
|
@@ -1002,37 +1017,37 @@ Name | Type | Description | Notes
|
|
1002
1017
|
**categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
1003
1018
|
**not_categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
1004
1019
|
**entities_title_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1005
|
-
**not_entities_title_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1006
|
-
**entities_title_surface_forms_text** |
|
1007
|
-
**not_entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1020
|
+
**not_entities_title_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1021
|
+
**entities_title_surface_forms_text** | **String**| This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1022
|
+
**not_entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1008
1023
|
**entities_title_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1009
1024
|
**not_entities_title_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1010
1025
|
**entities_title_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1011
1026
|
**not_entities_title_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1012
|
-
**entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in
|
1013
|
-
**not_entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1027
|
+
**entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1028
|
+
**not_entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1014
1029
|
**entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1015
1030
|
**not_entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1016
|
-
**entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities
|
1017
|
-
**not_entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1018
|
-
**entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities
|
1019
|
-
**not_entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1031
|
+
**entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1032
|
+
**not_entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1033
|
+
**entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1034
|
+
**not_entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1020
1035
|
**entities_body_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1021
|
-
**not_entities_body_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1036
|
+
**not_entities_body_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1022
1037
|
**entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1023
|
-
**not_entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1038
|
+
**not_entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1024
1039
|
**entities_body_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1025
1040
|
**not_entities_body_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1026
1041
|
**entities_body_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1027
1042
|
**not_entities_body_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1028
1043
|
**entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1029
|
-
**not_entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1044
|
+
**not_entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1030
1045
|
**entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1031
1046
|
**not_entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1032
1047
|
**entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1033
|
-
**not_entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1048
|
+
**not_entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1034
1049
|
**entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1035
|
-
**not_entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1050
|
+
**not_entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1036
1051
|
**sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
|
1037
1052
|
**not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
|
1038
1053
|
**sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
|
@@ -1092,13 +1107,16 @@ Name | Type | Description | Notes
|
|
1092
1107
|
**story_url** | **String**| An article or webpage | [optional]
|
1093
1108
|
**story_title** | **String**| Title of the article | [optional]
|
1094
1109
|
**story_body** | **String**| Body of the article | [optional]
|
1110
|
+
**aql** | **String**| This parameter is used to supply a query in AYLIEN Query Language. | [optional]
|
1111
|
+
**aql_default_field** | **String**| This parameter is used to supply an optional default field name used in the AQL query. | [optional] [default to 'text']
|
1112
|
+
**query** | **String**| This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string. | [optional]
|
1095
1113
|
**boost_by** | **String**| This parameter is used for boosting the result by the specified value. | [optional]
|
1096
1114
|
**story_language** | **String**| This parameter is used for setting the language of the story. It supports [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language codes. | [optional] [default to 'auto']
|
1097
1115
|
**per_page** | **Integer**| This parameter is used for specifying number of items in each page. | [optional] [default to 3]
|
1098
1116
|
|
1099
1117
|
### Return type
|
1100
1118
|
|
1101
|
-
[**
|
1119
|
+
[**DeprecatedRelatedStories**](DeprecatedRelatedStories.md)
|
1102
1120
|
|
1103
1121
|
### Authorization
|
1104
1122
|
|
@@ -1112,7 +1130,7 @@ Name | Type | Description | Notes
|
|
1112
1130
|
|
1113
1131
|
## list_stories
|
1114
1132
|
|
1115
|
-
>
|
1133
|
+
> DeprecatedStories list_stories(opts)
|
1116
1134
|
|
1117
1135
|
List Stories
|
1118
1136
|
|
@@ -1161,37 +1179,37 @@ opts = {
|
|
1161
1179
|
categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
1162
1180
|
not_categories_level: [56], # Array<Integer> | This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
1163
1181
|
entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1164
|
-
not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1165
|
-
entities_title_surface_forms_text:
|
1166
|
-
not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1182
|
+
not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1183
|
+
entities_title_surface_forms_text: 'entities_title_surface_forms_text_example', # String | This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1184
|
+
not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1167
1185
|
entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1168
1186
|
not_entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1169
1187
|
entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1170
1188
|
not_entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1171
|
-
entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in
|
1172
|
-
not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1189
|
+
entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1190
|
+
not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1173
1191
|
entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1174
1192
|
not_entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1175
|
-
entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities
|
1176
|
-
not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1177
|
-
entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities
|
1178
|
-
not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1193
|
+
entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1194
|
+
not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1195
|
+
entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1196
|
+
not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1179
1197
|
entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1180
|
-
not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1198
|
+
not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1181
1199
|
entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1182
|
-
not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1200
|
+
not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1183
1201
|
entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1184
1202
|
not_entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1185
1203
|
entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1186
1204
|
not_entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1187
1205
|
entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1188
|
-
not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1206
|
+
not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1189
1207
|
entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1190
1208
|
not_entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1191
1209
|
entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1192
|
-
not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1210
|
+
not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1193
1211
|
entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1194
|
-
not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1212
|
+
not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1195
1213
|
sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
|
1196
1214
|
not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
|
1197
1215
|
sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
|
@@ -1247,6 +1265,9 @@ opts = {
|
|
1247
1265
|
social_shares_count_reddit_max: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
|
1248
1266
|
clusters: ['clusters_example'], # Array<String> | This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering).
|
1249
1267
|
_return: ['_return_example'], # Array<String> | This parameter is used for specifying return fields.
|
1268
|
+
aql: 'aql_example', # String | This parameter is used to supply a query in AYLIEN Query Language.
|
1269
|
+
aql_default_field: 'text', # String | This parameter is used to supply an optional default field name used in the AQL query.
|
1270
|
+
query: 'query_example', # String | This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string.
|
1250
1271
|
sort_by: 'published_at', # String | This parameter is used for changing the order column of the results. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results).
|
1251
1272
|
sort_direction: 'desc', # String | This parameter is used for changing the order direction of the result. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results).
|
1252
1273
|
cursor: '*', # String | This parameter is used for finding a specific page. You can read more about pagination of results [here](https://newsapi.aylien.com/docs/pagination-of-results).
|
@@ -1290,37 +1311,37 @@ Name | Type | Description | Notes
|
|
1290
1311
|
**categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
1291
1312
|
**not_categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
1292
1313
|
**entities_title_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1293
|
-
**not_entities_title_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1294
|
-
**entities_title_surface_forms_text** |
|
1295
|
-
**not_entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1314
|
+
**not_entities_title_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1315
|
+
**entities_title_surface_forms_text** | **String**| This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1316
|
+
**not_entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1296
1317
|
**entities_title_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1297
1318
|
**not_entities_title_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1298
1319
|
**entities_title_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1299
1320
|
**not_entities_title_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1300
|
-
**entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in
|
1301
|
-
**not_entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1321
|
+
**entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1322
|
+
**not_entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1302
1323
|
**entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1303
1324
|
**not_entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1304
|
-
**entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities
|
1305
|
-
**not_entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1306
|
-
**entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities
|
1307
|
-
**not_entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1325
|
+
**entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1326
|
+
**not_entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1327
|
+
**entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1328
|
+
**not_entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1308
1329
|
**entities_body_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1309
|
-
**not_entities_body_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1330
|
+
**not_entities_body_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1310
1331
|
**entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1311
|
-
**not_entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1332
|
+
**not_entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1312
1333
|
**entities_body_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1313
1334
|
**not_entities_body_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1314
1335
|
**entities_body_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1315
1336
|
**not_entities_body_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1316
1337
|
**entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1317
|
-
**not_entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1338
|
+
**not_entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1318
1339
|
**entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1319
1340
|
**not_entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1320
1341
|
**entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1321
|
-
**not_entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1342
|
+
**not_entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1322
1343
|
**entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1323
|
-
**not_entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1344
|
+
**not_entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1324
1345
|
**sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
|
1325
1346
|
**not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
|
1326
1347
|
**sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
|
@@ -1376,6 +1397,9 @@ Name | Type | Description | Notes
|
|
1376
1397
|
**social_shares_count_reddit_max** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. | [optional]
|
1377
1398
|
**clusters** | [**Array<String>**](String.md)| This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional]
|
1378
1399
|
**_return** | [**Array<String>**](String.md)| This parameter is used for specifying return fields. | [optional]
|
1400
|
+
**aql** | **String**| This parameter is used to supply a query in AYLIEN Query Language. | [optional]
|
1401
|
+
**aql_default_field** | **String**| This parameter is used to supply an optional default field name used in the AQL query. | [optional] [default to 'text']
|
1402
|
+
**query** | **String**| This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string. | [optional]
|
1379
1403
|
**sort_by** | **String**| This parameter is used for changing the order column of the results. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results). | [optional] [default to 'published_at']
|
1380
1404
|
**sort_direction** | **String**| This parameter is used for changing the order direction of the result. You can read about sorting results [here](https://newsapi.aylien.com/docs/sorting-results). | [optional] [default to 'desc']
|
1381
1405
|
**cursor** | **String**| This parameter is used for finding a specific page. You can read more about pagination of results [here](https://newsapi.aylien.com/docs/pagination-of-results). | [optional] [default to '*']
|
@@ -1383,7 +1407,7 @@ Name | Type | Description | Notes
|
|
1383
1407
|
|
1384
1408
|
### Return type
|
1385
1409
|
|
1386
|
-
[**
|
1410
|
+
[**DeprecatedStories**](DeprecatedStories.md)
|
1387
1411
|
|
1388
1412
|
### Authorization
|
1389
1413
|
|
@@ -1442,37 +1466,37 @@ opts = {
|
|
1442
1466
|
categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
1443
1467
|
not_categories_level: [56], # Array<Integer> | This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
1444
1468
|
entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1445
|
-
not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1446
|
-
entities_title_surface_forms_text:
|
1447
|
-
not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1469
|
+
not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1470
|
+
entities_title_surface_forms_text: 'entities_title_surface_forms_text_example', # String | This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1471
|
+
not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1448
1472
|
entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1449
1473
|
not_entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1450
1474
|
entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1451
1475
|
not_entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1452
|
-
entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in
|
1453
|
-
not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1476
|
+
entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1477
|
+
not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1454
1478
|
entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1455
1479
|
not_entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1456
|
-
entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities
|
1457
|
-
not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1458
|
-
entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities
|
1459
|
-
not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1480
|
+
entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1481
|
+
not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1482
|
+
entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1483
|
+
not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1460
1484
|
entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1461
|
-
not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1485
|
+
not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1462
1486
|
entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1463
|
-
not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1487
|
+
not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1464
1488
|
entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1465
1489
|
not_entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1466
1490
|
entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1467
1491
|
not_entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1468
1492
|
entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1469
|
-
not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1493
|
+
not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1470
1494
|
entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1471
1495
|
not_entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1472
1496
|
entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1473
|
-
not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1497
|
+
not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1474
1498
|
entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1475
|
-
not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1499
|
+
not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1476
1500
|
sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
|
1477
1501
|
not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
|
1478
1502
|
sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
|
@@ -1527,6 +1551,9 @@ opts = {
|
|
1527
1551
|
social_shares_count_reddit_min: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
|
1528
1552
|
social_shares_count_reddit_max: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
|
1529
1553
|
clusters: ['clusters_example'], # Array<String> | This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering).
|
1554
|
+
aql: 'aql_example', # String | This parameter is used to supply a query in AYLIEN Query Language.
|
1555
|
+
aql_default_field: 'text', # String | This parameter is used to supply an optional default field name used in the AQL query.
|
1556
|
+
query: 'query_example', # String | This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string.
|
1530
1557
|
published_at_start: 'NOW-7DAYS/DAY', # String | This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).
|
1531
1558
|
published_at_end: 'NOW/DAY', # String | This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates).
|
1532
1559
|
period: '+1DAY' # String | The size of each date range is expressed as an interval to be added to the lower bound. It supports Date Math Syntax. Valid options are `+` following an integer number greater than 0 and one of the Date Math keywords. e.g. `+1DAY`, `+2MINUTES` and `+1MONTH`. Here are [Supported keywords](https://newsapi.aylien.com/docs/working-with-dates#date-math).
|
@@ -1565,37 +1592,37 @@ Name | Type | Description | Notes
|
|
1565
1592
|
**categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
1566
1593
|
**not_categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
1567
1594
|
**entities_title_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1568
|
-
**not_entities_title_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1569
|
-
**entities_title_surface_forms_text** |
|
1570
|
-
**not_entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1595
|
+
**not_entities_title_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1596
|
+
**entities_title_surface_forms_text** | **String**| This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1597
|
+
**not_entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1571
1598
|
**entities_title_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1572
1599
|
**not_entities_title_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1573
1600
|
**entities_title_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1574
1601
|
**not_entities_title_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1575
|
-
**entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in
|
1576
|
-
**not_entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1602
|
+
**entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1603
|
+
**not_entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1577
1604
|
**entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1578
1605
|
**not_entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1579
|
-
**entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities
|
1580
|
-
**not_entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1581
|
-
**entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities
|
1582
|
-
**not_entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1606
|
+
**entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1607
|
+
**not_entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1608
|
+
**entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1609
|
+
**not_entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1583
1610
|
**entities_body_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1584
|
-
**not_entities_body_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1611
|
+
**not_entities_body_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1585
1612
|
**entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1586
|
-
**not_entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1613
|
+
**not_entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1587
1614
|
**entities_body_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1588
1615
|
**not_entities_body_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1589
1616
|
**entities_body_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1590
1617
|
**not_entities_body_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1591
1618
|
**entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1592
|
-
**not_entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1619
|
+
**not_entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1593
1620
|
**entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1594
1621
|
**not_entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1595
1622
|
**entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1596
|
-
**not_entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1623
|
+
**not_entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1597
1624
|
**entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1598
|
-
**not_entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1625
|
+
**not_entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1599
1626
|
**sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
|
1600
1627
|
**not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
|
1601
1628
|
**sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
|
@@ -1650,6 +1677,9 @@ Name | Type | Description | Notes
|
|
1650
1677
|
**social_shares_count_reddit_min** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. | [optional]
|
1651
1678
|
**social_shares_count_reddit_max** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. | [optional]
|
1652
1679
|
**clusters** | [**Array<String>**](String.md)| This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional]
|
1680
|
+
**aql** | **String**| This parameter is used to supply a query in AYLIEN Query Language. | [optional]
|
1681
|
+
**aql_default_field** | **String**| This parameter is used to supply an optional default field name used in the AQL query. | [optional] [default to 'text']
|
1682
|
+
**query** | **String**| This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string. | [optional]
|
1653
1683
|
**published_at_start** | **String**| This parameter is used for finding stories whose published at time is less than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). | [optional] [default to 'NOW-7DAYS/DAY']
|
1654
1684
|
**published_at_end** | **String**| This parameter is used for finding stories whose published at time is greater than the specified value. [Here](https://newsapi.aylien.com/docs/working-with-dates) you can find more information about how [to work with dates](https://newsapi.aylien.com/docs/working-with-dates). | [optional] [default to 'NOW/DAY']
|
1655
1685
|
**period** | **String**| The size of each date range is expressed as an interval to be added to the lower bound. It supports Date Math Syntax. Valid options are `+` following an integer number greater than 0 and one of the Date Math keywords. e.g. `+1DAY`, `+2MINUTES` and `+1MONTH`. Here are [Supported keywords](https://newsapi.aylien.com/docs/working-with-dates#date-math). | [optional] [default to '+1DAY']
|
@@ -1720,37 +1750,37 @@ opts = {
|
|
1720
1750
|
categories_level: [56], # Array<Integer> | This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
1721
1751
|
not_categories_level: [56], # Array<Integer> | This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories).
|
1722
1752
|
entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1723
|
-
not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1724
|
-
entities_title_surface_forms_text:
|
1725
|
-
not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1753
|
+
not_entities_title_id: ['entities_title_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1754
|
+
entities_title_surface_forms_text: 'entities_title_surface_forms_text_example', # String | This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1755
|
+
not_entities_title_surface_forms_text: ['entities_title_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1726
1756
|
entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1727
1757
|
not_entities_title_text: ['entities_title_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1728
1758
|
entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1729
1759
|
not_entities_title_type: ['entities_title_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1730
|
-
entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in
|
1731
|
-
not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1760
|
+
entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1761
|
+
not_entities_title_stock_ticker: ['entities_title_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1732
1762
|
entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1733
1763
|
not_entities_title_links_dbpedia: ['entities_title_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1734
|
-
entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities
|
1735
|
-
not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1736
|
-
entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities
|
1737
|
-
not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1764
|
+
entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1765
|
+
not_entities_title_links_wikipedia: ['entities_title_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1766
|
+
entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1767
|
+
not_entities_title_links_wikidata: ['entities_title_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1738
1768
|
entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1739
|
-
not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1769
|
+
not_entities_body_id: ['entities_body_id_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1740
1770
|
entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1741
|
-
not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1771
|
+
not_entities_body_surface_forms_text: ['entities_body_surface_forms_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1742
1772
|
entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1743
1773
|
not_entities_body_text: ['entities_body_text_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1744
1774
|
entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1745
1775
|
not_entities_body_type: ['entities_body_type_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1746
1776
|
entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1747
|
-
not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1777
|
+
not_entities_body_stock_ticker: ['entities_body_stock_ticker_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1748
1778
|
entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1749
1779
|
not_entities_body_links_dbpedia: ['entities_body_links_dbpedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1750
1780
|
entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1751
|
-
not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1781
|
+
not_entities_body_links_wikipedia: ['entities_body_links_wikipedia_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1752
1782
|
entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1753
|
-
not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified
|
1783
|
+
not_entities_body_links_wikidata: ['entities_body_links_wikidata_example'], # Array<String> | This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities).
|
1754
1784
|
sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for finding stories whose title sentiment is the specified value.
|
1755
1785
|
not_sentiment_title_polarity: 'sentiment_title_polarity_example', # String | This parameter is used for excluding stories whose title sentiment is the specified value.
|
1756
1786
|
sentiment_body_polarity: 'sentiment_body_polarity_example', # String | This parameter is used for finding stories whose body sentiment is the specified value.
|
@@ -1804,7 +1834,10 @@ opts = {
|
|
1804
1834
|
social_shares_count_linkedin_max: 56, # Integer | This parameter is used for finding stories whose LinkedIn social shares count is less than or equal to the specified value.
|
1805
1835
|
social_shares_count_reddit_min: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value.
|
1806
1836
|
social_shares_count_reddit_max: 56, # Integer | This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value.
|
1807
|
-
clusters: ['clusters_example'] # Array<String> | This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering).
|
1837
|
+
clusters: ['clusters_example'], # Array<String> | This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering).
|
1838
|
+
aql: 'aql_example', # String | This parameter is used to supply a query in AYLIEN Query Language.
|
1839
|
+
aql_default_field: 'text', # String | This parameter is used to supply an optional default field name used in the AQL query.
|
1840
|
+
query: 'query_example' # String | This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string.
|
1808
1841
|
}
|
1809
1842
|
|
1810
1843
|
begin
|
@@ -1845,37 +1878,37 @@ Name | Type | Description | Notes
|
|
1845
1878
|
**categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for finding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
1846
1879
|
**not_categories_level** | [**Array<Integer>**](Integer.md)| This parameter is used for excluding stories by categories level. You can read more about working with categories [here](https://newsapi.aylien.com/docs/working-with-categories). | [optional]
|
1847
1880
|
**entities_title_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1848
|
-
**not_entities_title_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1849
|
-
**entities_title_surface_forms_text** |
|
1850
|
-
**not_entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1881
|
+
**not_entities_title_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1882
|
+
**entities_title_surface_forms_text** | **String**| This parameter is used to find stories based on the specified entities `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1883
|
+
**not_entities_title_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1851
1884
|
**entities_title_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1852
1885
|
**not_entities_title_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1853
1886
|
**entities_title_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1854
1887
|
**not_entities_title_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1855
|
-
**entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in
|
1856
|
-
**not_entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1888
|
+
**entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1889
|
+
**not_entities_title_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1857
1890
|
**entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1858
1891
|
**not_entities_title_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in story titles. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1859
|
-
**entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities
|
1860
|
-
**not_entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1861
|
-
**entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities
|
1862
|
-
**not_entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1892
|
+
**entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1893
|
+
**not_entities_title_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1894
|
+
**entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1895
|
+
**not_entities_title_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL in the title of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1863
1896
|
**entities_body_id** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1864
|
-
**not_entities_body_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1897
|
+
**not_entities_body_id** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `id` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1865
1898
|
**entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1866
|
-
**not_entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1899
|
+
**not_entities_body_surface_forms_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `surface_form` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1867
1900
|
**entities_body_text** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1868
1901
|
**not_entities_body_text** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `text` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1869
1902
|
**entities_body_type** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1870
1903
|
**not_entities_body_type** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities `type` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1871
1904
|
**entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1872
|
-
**not_entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1905
|
+
**not_entities_body_stock_ticker** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's `stock_ticker` in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1873
1906
|
**entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1874
1907
|
**not_entities_body_links_dbpedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entities dbpedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1875
1908
|
**entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1876
|
-
**not_entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1909
|
+
**not_entities_body_links_wikipedia** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikipedia URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1877
1910
|
**entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to find stories based on the specified entities wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1878
|
-
**not_entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified
|
1911
|
+
**not_entities_body_links_wikidata** | [**Array<String>**](String.md)| This parameter is used to exclude stories based on the specified entity's Wikidata URL in the body of stories. You can read more about working with entities [here](https://newsapi.aylien.com/docs/working-with-entities). | [optional]
|
1879
1912
|
**sentiment_title_polarity** | **String**| This parameter is used for finding stories whose title sentiment is the specified value. | [optional]
|
1880
1913
|
**not_sentiment_title_polarity** | **String**| This parameter is used for excluding stories whose title sentiment is the specified value. | [optional]
|
1881
1914
|
**sentiment_body_polarity** | **String**| This parameter is used for finding stories whose body sentiment is the specified value. | [optional]
|
@@ -1930,6 +1963,9 @@ Name | Type | Description | Notes
|
|
1930
1963
|
**social_shares_count_reddit_min** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is greater than or equal to the specified value. | [optional]
|
1931
1964
|
**social_shares_count_reddit_max** | **Integer**| This parameter is used for finding stories whose Reddit social shares count is less than or equal to the specified value. | [optional]
|
1932
1965
|
**clusters** | [**Array<String>**](String.md)| This parameter is used for finding stories with belonging to one of clusters in a specific set of clusters You can read more about working with clustering [here](https://newsapi.aylien.com/docs/working-with-clustering). | [optional]
|
1966
|
+
**aql** | **String**| This parameter is used to supply a query in AYLIEN Query Language. | [optional]
|
1967
|
+
**aql_default_field** | **String**| This parameter is used to supply an optional default field name used in the AQL query. | [optional] [default to 'text']
|
1968
|
+
**query** | **String**| This parameter is used to make an advanced query using $and, $or, $not logical operators and $eq for exact match, $text for a text search and $lt, $gt, $lte, $gte for range queries. value must be a json string. | [optional]
|
1933
1969
|
|
1934
1970
|
### Return type
|
1935
1971
|
|