You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Api/AnalyticsApi.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,8 +41,8 @@ $apiInstance = new AskNews\Api\AnalyticsApi(
41
41
);
42
42
$asset = 'asset_example'; // string | The asset name to query for sentiment.
43
43
$metric = 'news_positive'; // string | The metric to obtain. Weighted metrics account for page-rank of original source. Higher page rank sources are weighted more heavily.
44
-
$date_from = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The start date in ISO format
45
-
$date_to = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The end date in ISO format
44
+
$date_from = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime | The start date in ISO format
45
+
$date_to = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime | The end date in ISO format
Copy file name to clipboardExpand all lines: docs/Api/NewsApi.md
+20-20Lines changed: 20 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -254,28 +254,28 @@ $return_type = 'dicts'; // string | Type of return value. 'string' means that th
254
254
$historical = false; // bool | Search on archive of historical news. Defaults to False, meaning that the search will only look through the most recent news (48 hours)
255
255
$method = 'kw'; // string | Method to use for searching. 'nl' means Natural Language, which is a string that can be any phrase, keyword, question, or paragraph that will be used for semantic search on the news. 'kw' means Keyword, which can also be any keyword(s), phrase, or paragraph, however the search is a direct keyword search on the database. 'both' means both methods will be used and results will be ranked according to IRR. 'both' may reduce latency by 10 pct in exchange for improved accuracy.
256
256
$similarity_score_threshold = 0.5; // float | Similarity score threshold to determine which articles to return. Lower means less similar results are allowed.
257
-
$offset = new \AskNews\Model\Offset(); // Offset | Offset for pagination. The n_articles is your page size, while your offset is the number of articles to skip to get to your page of interest. For example, if you want to get page 3 for n_article page size of 10, you would set offset to 20.
257
+
$offset = new \AskNews\Model\\AskNews\Model\Offset(); // \AskNews\Model\Offset | Offset for pagination. The n_articles is your page size, while your offset is the number of articles to skip to get to your page of interest. For example, if you want to get page 3 for n_article page size of 10, you would set offset to 20.
258
258
$categories = array('categories_example'); // string[] | Categories of news to filter on
$doc_end_delimiter = '</doc>'; // string | Document end delimiter for string return.
261
261
$provocative = 'all'; // string | Filter articles based on how provocative they are deemed based on the use of provocative language and emotional vocabulary.
262
-
$reporting_voice = new \AskNews\Model\ReportingVoice(); // ReportingVoice | Type of reporting voice to filer by.
263
-
$domain_url = new \AskNews\Model\DomainUrl(); // DomainUrl | filter by domain url of interest. This can be a single domain or a list of domains. For example, 'npr.org' or ['nature.com', 'npr.org']
264
-
$bad_domain_url = new \AskNews\Model\BadDomainUrl(); // BadDomainUrl | blacklist of domains that must be excluded from resultsThis can be a single domain url or a list of domain urls.
262
+
$reporting_voice = new \AskNews\Model\\AskNews\Model\ReportingVoice(); // \AskNews\Model\ReportingVoice | Type of reporting voice to filer by.
263
+
$domain_url = new \AskNews\Model\\AskNews\Model\DomainUrl(); // \AskNews\Model\DomainUrl | filter by domain url of interest. This can be a single domain or a list of domains. For example, 'npr.org' or ['nature.com', 'npr.org']
264
+
$bad_domain_url = new \AskNews\Model\\AskNews\Model\BadDomainUrl(); // \AskNews\Model\BadDomainUrl | blacklist of domains that must be excluded from resultsThis can be a single domain url or a list of domain urls.
265
265
$page_rank = 56; // int | Maximum allowed page rank for returned articles.
266
266
$diversify_sources = false; // bool | Ensure that the return set of articles are selected from diverse sources. This adds latency to the search, but attempts to balance the representation of sources by country and source origins. In summary, a net is cast around your search, then the diversity of sources is analyzed, and your final result matches the large net diversity distribution. This means that your search accuracy is reduced, but you gain more diverse perspectives.
267
267
$strategy = 'default'; // string | Strategy to use for searching. 'latest news' automatically setsmethod='nl', historical=False, and looks within the past 24 hours. 'news knowledge' automatically sets method='kw', historical=True, and looks within the past 60 days. 'news knowledge' will increase latency due to the larger search space in the archive. Use 'default' if you want to control start_timestamp, end_timestamp, historical, and method.
268
268
$hours_back = 24; // int | Can be set to easily control the look back on the search. This is the same as controlling the 'start_timestamp' parameter. The difference is that this is not a timestamp, it is the number of hours back to look from the current time. Defaults to 24 hours.
269
-
$string_guarantee = array(new \AskNews\Model\string[]()); // string[] | If defined, the search will only occur on articles that contain strings in this list.
269
+
$string_guarantee = array('string_guarantee_example'); // string[] | If defined, the search will only occur on articles that contain strings in this list.
270
270
$string_guarantee_op = 'AND'; // string | Operator to use for string guarantee list.
271
-
$reverse_string_guarantee = array(new \AskNews\Model\string[]()); // string[] | If defined, the search will only occur on articles that do not contain strings in this list.
272
-
$entity_guarantee = array(new \AskNews\Model\string[]()); // string[] | Entity guarantee to filter by. This is a list of strings, where each string includes entity type and entity value separated by a colon. The first element is the entity type and the second element is the entity value. For example ['Location:Paris', 'Person:John']
271
+
$reverse_string_guarantee = array('reverse_string_guarantee_example'); // string[] | If defined, the search will only occur on articles that do not contain strings in this list.
272
+
$entity_guarantee = array('entity_guarantee_example'); // string[] | Entity guarantee to filter by. This is a list of strings, where each string includes entity type and entity value separated by a colon. The first element is the entity type and the second element is the entity value. For example ['Location:Paris', 'Person:John']
273
273
$entity_guarantee_op = 'OR'; // string | Operator to use for entity guarantee list.
274
274
$return_graphs = false; // bool | Return graphs for the articles. Only available to Analyst tier and above.
275
275
$return_geo = false; // bool | Return GeoCoordinates associated with locations discussed inside the articles. Only available to Analyst tier and above.
276
-
$languages = array(new \AskNews\Model\string[]()); // string[] | Languages to filter by. This is the two-letter 'set 1' of the ISO 639-1 standard. For example: English is 'en'.
277
-
$countries = array(new \AskNews\Model\string[]()); // string[] | Countries to filter by, this is the two-letter ISO country codeFor example: United States is 'US', France is 'FR', Sweden is 'SE'.
$languages = array('languages_example'); // string[] | Languages to filter by. This is the two-letter 'set 1' of the ISO 639-1 standard. For example: English is 'en'.
277
+
$countries = array('countries_example'); // string[] | Countries to filter by, this is the two-letter ISO country codeFor example: United States is 'US', France is 'FR', Sweden is 'SE'.
278
+
$continents = array('continents_example'); // string[] | Continents to filter by.
$premium = false; // bool | Include premium sources.
281
281
@@ -300,28 +300,28 @@ try {
300
300
|**historical**|**bool**| Search on archive of historical news. Defaults to False, meaning that the search will only look through the most recent news (48 hours) |[optional][default to false]|
301
301
|**method**|**string**| Method to use for searching. 'nl' means Natural Language, which is a string that can be any phrase, keyword, question, or paragraph that will be used for semantic search on the news. 'kw' means Keyword, which can also be any keyword(s), phrase, or paragraph, however the search is a direct keyword search on the database. 'both' means both methods will be used and results will be ranked according to IRR. 'both' may reduce latency by 10 pct in exchange for improved accuracy. |[optional][default to 'kw']|
302
302
|**similarity_score_threshold**|**float**| Similarity score threshold to determine which articles to return. Lower means less similar results are allowed. |[optional][default to 0.5]|
303
-
|**offset**|[**Offset**](../Model/.md)| Offset for pagination. The n_articles is your page size, while your offset is the number of articles to skip to get to your page of interest. For example, if you want to get page 3 for n_article page size of 10, you would set offset to 20. |[optional]|
303
+
|**offset**|[**\AskNews\Model\Offset**](../Model/.md)| Offset for pagination. The n_articles is your page size, while your offset is the number of articles to skip to get to your page of interest. For example, if you want to get page 3 for n_article page size of 10, you would set offset to 20. |[optional]|
304
304
|**categories**|[**string[]**](../Model/string.md)| Categories of news to filter on |[optional]|
305
305
|**doc_start_delimiter**|**string**| Document start delimiter for string return. |[optional][default to '<doc>']|
306
306
|**doc_end_delimiter**|**string**| Document end delimiter for string return. |[optional][default to '</doc>']|
307
307
|**provocative**|**string**| Filter articles based on how provocative they are deemed based on the use of provocative language and emotional vocabulary. |[optional][default to 'all']|
308
-
|**reporting_voice**|[**ReportingVoice**](../Model/.md)| Type of reporting voice to filer by. |[optional]|
309
-
|**domain_url**|[**DomainUrl**](../Model/.md)| filter by domain url of interest. This can be a single domain or a list of domains. For example, 'npr.org' or ['nature.com', 'npr.org']|[optional]|
310
-
|**bad_domain_url**|[**BadDomainUrl**](../Model/.md)| blacklist of domains that must be excluded from resultsThis can be a single domain url or a list of domain urls. |[optional]|
308
+
|**reporting_voice**|[**\AskNews\Model\ReportingVoice**](../Model/.md)| Type of reporting voice to filer by. |[optional]|
309
+
|**domain_url**|[**\AskNews\Model\DomainUrl**](../Model/.md)| filter by domain url of interest. This can be a single domain or a list of domains. For example, 'npr.org' or ['nature.com', 'npr.org']|[optional]|
310
+
|**bad_domain_url**|[**\AskNews\Model\BadDomainUrl**](../Model/.md)| blacklist of domains that must be excluded from resultsThis can be a single domain url or a list of domain urls. |[optional]|
311
311
|**page_rank**|**int**| Maximum allowed page rank for returned articles. |[optional]|
312
312
|**diversify_sources**|**bool**| Ensure that the return set of articles are selected from diverse sources. This adds latency to the search, but attempts to balance the representation of sources by country and source origins. In summary, a net is cast around your search, then the diversity of sources is analyzed, and your final result matches the large net diversity distribution. This means that your search accuracy is reduced, but you gain more diverse perspectives. |[optional][default to false]|
313
313
|**strategy**|**string**| Strategy to use for searching. 'latest news' automatically setsmethod='nl', historical=False, and looks within the past 24 hours. 'news knowledge' automatically sets method='kw', historical=True, and looks within the past 60 days. 'news knowledge' will increase latency due to the larger search space in the archive. Use 'default' if you want to control start_timestamp, end_timestamp, historical, and method. |[optional][default to 'default']|
314
314
|**hours_back**|**int**| Can be set to easily control the look back on the search. This is the same as controlling the 'start_timestamp' parameter. The difference is that this is not a timestamp, it is the number of hours back to look from the current time. Defaults to 24 hours. |[optional][default to 24]|
315
-
|**string_guarantee**|[**string[]**](../Model/.md)| If defined, the search will only occur on articles that contain strings in this list. |[optional]|
315
+
|**string_guarantee**|[**string[]**](../Model/string.md)| If defined, the search will only occur on articles that contain strings in this list. |[optional]|
316
316
|**string_guarantee_op**|**string**| Operator to use for string guarantee list. |[optional][default to 'AND']|
317
-
|**reverse_string_guarantee**|[**string[]**](../Model/.md)| If defined, the search will only occur on articles that do not contain strings in this list. |[optional]|
318
-
|**entity_guarantee**|[**string[]**](../Model/.md)| Entity guarantee to filter by. This is a list of strings, where each string includes entity type and entity value separated by a colon. The first element is the entity type and the second element is the entity value. For example ['Location:Paris', 'Person:John']|[optional]|
317
+
|**reverse_string_guarantee**|[**string[]**](../Model/string.md)| If defined, the search will only occur on articles that do not contain strings in this list. |[optional]|
318
+
|**entity_guarantee**|[**string[]**](../Model/string.md)| Entity guarantee to filter by. This is a list of strings, where each string includes entity type and entity value separated by a colon. The first element is the entity type and the second element is the entity value. For example ['Location:Paris', 'Person:John']|[optional]|
319
319
|**entity_guarantee_op**|**string**| Operator to use for entity guarantee list. |[optional][default to 'OR']|
320
320
|**return_graphs**|**bool**| Return graphs for the articles. Only available to Analyst tier and above. |[optional][default to false]|
321
321
|**return_geo**|**bool**| Return GeoCoordinates associated with locations discussed inside the articles. Only available to Analyst tier and above. |[optional][default to false]|
322
-
|**languages**|[**string[]**](../Model/.md)| Languages to filter by. This is the two-letter 'set 1' of the ISO 639-1 standard. For example: English is 'en'. |[optional]|
323
-
|**countries**|[**string[]**](../Model/.md)| Countries to filter by, this is the two-letter ISO country codeFor example: United States is 'US', France is 'FR', Sweden is 'SE'. |[optional]|
324
-
|**continents**|[**string[]**](../Model/.md)| Continents to filter by. |[optional]|
322
+
|**languages**|[**string[]**](../Model/string.md)| Languages to filter by. This is the two-letter 'set 1' of the ISO 639-1 standard. For example: English is 'en'. |[optional]|
323
+
|**countries**|[**string[]**](../Model/string.md)| Countries to filter by, this is the two-letter ISO country codeFor example: United States is 'US', France is 'FR', Sweden is 'SE'. |[optional]|
324
+
|**continents**|[**string[]**](../Model/string.md)| Continents to filter by. |[optional]|
325
325
|**sentiment**|**string**| Sentiment to filter articles by. |[optional]|
326
326
|**premium**|**bool**| Include premium sources. |[optional][default to false]|
Copy file name to clipboardExpand all lines: docs/Api/StoriesApi.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,8 +47,8 @@ $start_timestamp = 56; // int | Start timestamp to filter results on.
47
47
$end_timestamp = 56; // int | End timestamp to filter results on.
48
48
$sort_by = 'sort_by_example'; // string | Which type of sorting to perform. published: Sort by published date. coverage: Sort by coverage. sentiment: Sort by sentiment. relevance: Sort by relevance of similarity score/ranking.
49
49
$sort_type = 'sort_type_example'; // string | Whether to sort results in ascending or descending order.
50
-
$continent = new \AskNews\Model\Continent(); // Continent | Continents to filter by.
51
-
$offset = new \AskNews\Model\Offset1(); // Offset1 | Offset to use
50
+
$continent = new \AskNews\Model\\AskNews\Model\Continent(); // \AskNews\Model\Continent | Continents to filter by.
51
+
$offset = new \AskNews\Model\\AskNews\Model\Offset1(); // \AskNews\Model\Offset1 | Offset to use
52
52
$limit = 10; // int | Limit to use
53
53
$expand_updates = false; // bool | Whether to expand updates
54
54
$max_updates = 2; // int | Max updates to use
@@ -80,8 +80,8 @@ try {
80
80
|**end_timestamp**|**int**| End timestamp to filter results on. |[optional]|
81
81
|**sort_by**|**string**| Which type of sorting to perform. published: Sort by published date. coverage: Sort by coverage. sentiment: Sort by sentiment. relevance: Sort by relevance of similarity score/ranking. |[optional]|
82
82
|**sort_type**|**string**| Whether to sort results in ascending or descending order. |[optional]|
83
-
|**continent**|[**Continent**](../Model/.md)| Continents to filter by. |[optional]|
84
-
|**offset**|[**Offset1**](../Model/.md)| Offset to use |[optional]|
83
+
|**continent**|[**\AskNews\Model\Continent**](../Model/.md)| Continents to filter by. |[optional]|
84
+
|**offset**|[**\AskNews\Model\Offset1**](../Model/.md)| Offset to use |[optional]|
85
85
|**limit**|**int**| Limit to use |[optional][default to 10]|
86
86
|**expand_updates**|**bool**| Whether to expand updates |[optional][default to false]|
87
87
|**max_updates**|**int**| Max updates to use |[optional][default to 2]|
0 commit comments