@emergentmethods/asknews-typescript-sdk
Version:
Typescript SDK for AskNews API
688 lines (687 loc) • 25.5 kB
JavaScript
;
/* tslint:disable */
/* eslint-disable */
/**
* AskNews API
* AskNews API [](https://status.asknews.app/status/prod)
*
* The version of the OpenAPI document: 0.24.22
* Contact: contact@emergentmethods.ai
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.SearchNewsSentimentEnum = exports.SearchNewsContinentsEnum = exports.SearchNewsLanguagesEnum = exports.SearchNewsEntityGuaranteeOpEnum = exports.SearchNewsStringGuaranteeOpEnum = exports.SearchNewsStrategyEnum = exports.SearchNewsProvocativeEnum = exports.SearchNewsCategoriesEnum = exports.SearchNewsMethodEnum = exports.SearchNewsReturnTypeEnum = exports.SearchNewsTimeFilterEnum = exports.GetSourcesReportSamplingEnum = exports.GetSourcesReportMetricEnum = exports.GetIndexCountsSentimentEnum = exports.GetIndexCountsContinentsEnum = exports.GetIndexCountsLanguagesEnum = exports.GetIndexCountsEntityGuaranteeOpEnum = exports.GetIndexCountsStringGuaranteeOpEnum = exports.GetIndexCountsReportingVoiceEnum = exports.GetIndexCountsProvocativeEnum = exports.GetIndexCountsCategoriesEnum = exports.GetIndexCountsTimeFilterEnum = exports.GetIndexCountsSamplingEnum = exports.NewsApi = void 0;
const runtime = require("../runtime");
const index_1 = require("../models/index");
/**
*
*/
class NewsApi extends runtime.BaseAPI {
/**
* Get a single article given a UUID.
* Get an article by its UUID
*/
getArticleRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['articleId'] == null) {
throw new runtime.RequiredError('articleId', 'Required parameter "articleId" was null or undefined when calling getArticle().');
}
const queryParameters = {};
const headerParameters = {};
const response = yield this.request({
path: `/v1/news/{article_id}`.replace(`{${"article_id"}}`, encodeURIComponent(String(requestParameters['articleId']))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SearchResponseDictItemFromJSON)(jsonValue));
});
}
/**
* Get a single article given a UUID.
* Get an article by its UUID
*/
getArticle(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.getArticleRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* Get articles given a list of UUIDs.
* Get multiple articles by UUID
*/
getArticlesRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['articleIds'] == null) {
throw new runtime.RequiredError('articleIds', 'Required parameter "articleIds" was null or undefined when calling getArticles().');
}
const queryParameters = {};
if (requestParameters['articleIds'] != null) {
queryParameters['article_ids'] = requestParameters['articleIds'];
}
const headerParameters = {};
const response = yield this.request({
path: `/v1/news`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.SearchResponseDictItemFromJSON));
});
}
/**
* Get articles given a list of UUIDs.
* Get multiple articles by UUID
*/
getArticles(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.getArticlesRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* This endpoint is primarly used for the publisher dashboard, to show the number of articles indexed per source.
* Get the index counts underlying AskNews
*/
getIndexCountsRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const queryParameters = {};
if (requestParameters['startDatetime'] != null) {
queryParameters['start_datetime'] = requestParameters['startDatetime'].toISOString();
}
if (requestParameters['endDatetime'] != null) {
queryParameters['end_datetime'] = requestParameters['endDatetime'].toISOString();
}
if (requestParameters['domains'] != null) {
queryParameters['domains'] = requestParameters['domains'];
}
if (requestParameters['sampling'] != null) {
queryParameters['sampling'] = requestParameters['sampling'];
}
if (requestParameters['timeFilter'] != null) {
queryParameters['time_filter'] = requestParameters['timeFilter'];
}
if (requestParameters['categories'] != null) {
queryParameters['categories'] = requestParameters['categories'];
}
if (requestParameters['provocative'] != null) {
queryParameters['provocative'] = requestParameters['provocative'];
}
if (requestParameters['reportingVoice'] != null) {
queryParameters['reporting_voice'] = requestParameters['reportingVoice'];
}
if (requestParameters['badDomainUrl'] != null) {
queryParameters['bad_domain_url'] = requestParameters['badDomainUrl'];
}
if (requestParameters['pageRank'] != null) {
queryParameters['page_rank'] = requestParameters['pageRank'];
}
if (requestParameters['stringGuarantee'] != null) {
queryParameters['string_guarantee'] = requestParameters['stringGuarantee'];
}
if (requestParameters['stringGuaranteeOp'] != null) {
queryParameters['string_guarantee_op'] = requestParameters['stringGuaranteeOp'];
}
if (requestParameters['reverseStringGuarantee'] != null) {
queryParameters['reverse_string_guarantee'] = requestParameters['reverseStringGuarantee'];
}
if (requestParameters['entityGuarantee'] != null) {
queryParameters['entity_guarantee'] = requestParameters['entityGuarantee'];
}
if (requestParameters['entityGuaranteeOp'] != null) {
queryParameters['entity_guarantee_op'] = requestParameters['entityGuaranteeOp'];
}
if (requestParameters['languages'] != null) {
queryParameters['languages'] = requestParameters['languages'];
}
if (requestParameters['countries'] != null) {
queryParameters['countries'] = requestParameters['countries'];
}
if (requestParameters['countriesBlacklist'] != null) {
queryParameters['countries_blacklist'] = requestParameters['countriesBlacklist'];
}
if (requestParameters['continents'] != null) {
queryParameters['continents'] = requestParameters['continents'];
}
if (requestParameters['sentiment'] != null) {
queryParameters['sentiment'] = requestParameters['sentiment'];
}
const headerParameters = {};
const response = yield this.request({
path: `/v1/index_counts`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.IndexCountItemFromJSON));
});
}
/**
* This endpoint is primarly used for the publisher dashboard, to show the number of articles indexed per source.
* Get the index counts underlying AskNews
*/
getIndexCounts(requestParameters = {}, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.getIndexCountsRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* This endpoint is primarly used for transparency and monitoring the diversity of the data. Visualized at `https://asknews.app/transparency`. Get the distribution of sources/languages/countries underlying AskNews content.
* Get the sources underlying AskNews
*/
getSourcesReportRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const queryParameters = {};
if (requestParameters['nPoints'] != null) {
queryParameters['n_points'] = requestParameters['nPoints'];
}
if (requestParameters['startTimestamp'] != null) {
queryParameters['start_timestamp'] = requestParameters['startTimestamp'];
}
if (requestParameters['endTimestamp'] != null) {
queryParameters['end_timestamp'] = requestParameters['endTimestamp'];
}
if (requestParameters['metric'] != null) {
queryParameters['metric'] = requestParameters['metric'];
}
if (requestParameters['sampling'] != null) {
queryParameters['sampling'] = requestParameters['sampling'];
}
const headerParameters = {};
const response = yield this.request({
path: `/v1/sources`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.SourceReportItemFromJSON));
});
}
/**
* This endpoint is primarly used for transparency and monitoring the diversity of the data. Visualized at `https://asknews.app/transparency`. Get the distribution of sources/languages/countries underlying AskNews content.
* Get the sources underlying AskNews
*/
getSourcesReport(requestParameters = {}, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.getSourcesReportRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* Search for any news, up to the last 5 minutes or in our extensive historical archive filled with 100s of millions of articles. Geared toward low-latency applications, where time is of the essence. For example, this endpoint is commonly used for quickly getting news context for an LLM. This endpoint is also commonly used for synthetic data curation. For example, say you are fine-tuning a model for sports. You could filter with `classification=\"Sports\"` and build a dataset of sports articles. News articles come with an abundance of valuable metadata, including full summaries, sentiment, entities, reporting voice, page rank, language, and much much more. An example of this data in action can be found and interacted with at `https://asknews.app/chat`
* Search for enriched real-time news context
*/
searchNewsRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const queryParameters = {};
if (requestParameters['query'] != null) {
queryParameters['query'] = requestParameters['query'];
}
if (requestParameters['nArticles'] != null) {
queryParameters['n_articles'] = requestParameters['nArticles'];
}
if (requestParameters['startTimestamp'] != null) {
queryParameters['start_timestamp'] = requestParameters['startTimestamp'];
}
if (requestParameters['endTimestamp'] != null) {
queryParameters['end_timestamp'] = requestParameters['endTimestamp'];
}
if (requestParameters['timeFilter'] != null) {
queryParameters['time_filter'] = requestParameters['timeFilter'];
}
if (requestParameters['returnType'] != null) {
queryParameters['return_type'] = requestParameters['returnType'];
}
if (requestParameters['historical'] != null) {
queryParameters['historical'] = requestParameters['historical'];
}
if (requestParameters['method'] != null) {
queryParameters['method'] = requestParameters['method'];
}
if (requestParameters['similarityScoreThreshold'] != null) {
queryParameters['similarity_score_threshold'] = requestParameters['similarityScoreThreshold'];
}
if (requestParameters['offset'] != null) {
queryParameters['offset'] = requestParameters['offset'];
}
if (requestParameters['categories'] != null) {
queryParameters['categories'] = requestParameters['categories'];
}
if (requestParameters['docStartDelimiter'] != null) {
queryParameters['doc_start_delimiter'] = requestParameters['docStartDelimiter'];
}
if (requestParameters['docEndDelimiter'] != null) {
queryParameters['doc_end_delimiter'] = requestParameters['docEndDelimiter'];
}
if (requestParameters['provocative'] != null) {
queryParameters['provocative'] = requestParameters['provocative'];
}
if (requestParameters['reportingVoice'] != null) {
queryParameters['reporting_voice'] = requestParameters['reportingVoice'];
}
if (requestParameters['domainUrl'] != null) {
queryParameters['domain_url'] = requestParameters['domainUrl'];
}
if (requestParameters['badDomainUrl'] != null) {
queryParameters['bad_domain_url'] = requestParameters['badDomainUrl'];
}
if (requestParameters['pageRank'] != null) {
queryParameters['page_rank'] = requestParameters['pageRank'];
}
if (requestParameters['diversifySources'] != null) {
queryParameters['diversify_sources'] = requestParameters['diversifySources'];
}
if (requestParameters['strategy'] != null) {
queryParameters['strategy'] = requestParameters['strategy'];
}
if (requestParameters['hoursBack'] != null) {
queryParameters['hours_back'] = requestParameters['hoursBack'];
}
if (requestParameters['stringGuarantee'] != null) {
queryParameters['string_guarantee'] = requestParameters['stringGuarantee'];
}
if (requestParameters['stringGuaranteeOp'] != null) {
queryParameters['string_guarantee_op'] = requestParameters['stringGuaranteeOp'];
}
if (requestParameters['reverseStringGuarantee'] != null) {
queryParameters['reverse_string_guarantee'] = requestParameters['reverseStringGuarantee'];
}
if (requestParameters['entityGuarantee'] != null) {
queryParameters['entity_guarantee'] = requestParameters['entityGuarantee'];
}
if (requestParameters['reverseEntityGuarantee'] != null) {
queryParameters['reverse_entity_guarantee'] = requestParameters['reverseEntityGuarantee'];
}
if (requestParameters['entityGuaranteeOp'] != null) {
queryParameters['entity_guarantee_op'] = requestParameters['entityGuaranteeOp'];
}
if (requestParameters['returnGraphs'] != null) {
queryParameters['return_graphs'] = requestParameters['returnGraphs'];
}
if (requestParameters['returnGeo'] != null) {
queryParameters['return_geo'] = requestParameters['returnGeo'];
}
if (requestParameters['languages'] != null) {
queryParameters['languages'] = requestParameters['languages'];
}
if (requestParameters['countries'] != null) {
queryParameters['countries'] = requestParameters['countries'];
}
if (requestParameters['countriesBlacklist'] != null) {
queryParameters['countries_blacklist'] = requestParameters['countriesBlacklist'];
}
if (requestParameters['continents'] != null) {
queryParameters['continents'] = requestParameters['continents'];
}
if (requestParameters['sentiment'] != null) {
queryParameters['sentiment'] = requestParameters['sentiment'];
}
if (requestParameters['premium'] != null) {
queryParameters['premium'] = requestParameters['premium'];
}
if (requestParameters['authors'] != null) {
queryParameters['authors'] = requestParameters['authors'];
}
const headerParameters = {};
const response = yield this.request({
path: `/v1/news/search`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SearchResponseFromJSON)(jsonValue));
});
}
/**
* Search for any news, up to the last 5 minutes or in our extensive historical archive filled with 100s of millions of articles. Geared toward low-latency applications, where time is of the essence. For example, this endpoint is commonly used for quickly getting news context for an LLM. This endpoint is also commonly used for synthetic data curation. For example, say you are fine-tuning a model for sports. You could filter with `classification=\"Sports\"` and build a dataset of sports articles. News articles come with an abundance of valuable metadata, including full summaries, sentiment, entities, reporting voice, page rank, language, and much much more. An example of this data in action can be found and interacted with at `https://asknews.app/chat`
* Search for enriched real-time news context
*/
searchNews(requestParameters = {}, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.searchNewsRaw(requestParameters, initOverrides);
return yield response.value();
});
}
}
exports.NewsApi = NewsApi;
/**
* @export
*/
exports.GetIndexCountsSamplingEnum = {
_5m: '5m',
_1h: '1h',
_12h: '12h',
_1d: '1d',
_1w: '1w',
_1m: '1m'
};
/**
* @export
*/
exports.GetIndexCountsTimeFilterEnum = {
CrawlDate: 'crawl_date',
PubDate: 'pub_date'
};
/**
* @export
*/
exports.GetIndexCountsCategoriesEnum = {
All: 'All',
Business: 'Business',
Crime: 'Crime',
Politics: 'Politics',
Science: 'Science',
Sports: 'Sports',
Technology: 'Technology',
Military: 'Military',
Health: 'Health',
Entertainment: 'Entertainment',
Finance: 'Finance',
Culture: 'Culture',
Climate: 'Climate',
Environment: 'Environment',
World: 'World'
};
/**
* @export
*/
exports.GetIndexCountsProvocativeEnum = {
Unknown: 'unknown',
Low: 'low',
Medium: 'medium',
High: 'high',
All: 'all'
};
/**
* @export
*/
exports.GetIndexCountsReportingVoiceEnum = {
Objective: 'Objective',
Subjective: 'Subjective',
Investigative: 'Investigative',
Narrative: 'Narrative',
Analytical: 'Analytical',
Advocacy: 'Advocacy',
Conversational: 'Conversational',
Satirical: 'Satirical',
Emotive: 'Emotive',
Explanatory: 'Explanatory',
Persuasive: 'Persuasive',
Sensational: 'Sensational',
Unknown: 'Unknown',
All: 'all'
};
/**
* @export
*/
exports.GetIndexCountsStringGuaranteeOpEnum = {
And: 'AND',
Or: 'OR'
};
/**
* @export
*/
exports.GetIndexCountsEntityGuaranteeOpEnum = {
And: 'AND',
Or: 'OR'
};
/**
* @export
*/
exports.GetIndexCountsLanguagesEnum = {
Sq: 'sq',
Ar: 'ar',
Az: 'az',
Ca: 'ca',
Zh: 'zh',
Hr: 'hr',
Cs: 'cs',
Da: 'da',
Nl: 'nl',
En: 'en',
Eo: 'eo',
Fi: 'fi',
Fr: 'fr',
Gl: 'gl',
De: 'de',
El: 'el',
He: 'he',
Hi: 'hi',
Hu: 'hu',
Is: 'is',
Id: 'id',
Ia: 'ia',
It: 'it',
Ja: 'ja',
Kk: 'kk',
Km: 'km',
Ko: 'ko',
Ky: 'ky',
Ms: 'ms',
Mt: 'mt',
Mhr: 'mhr',
Mn: 'mn',
No: 'no',
Or: 'or',
Pl: 'pl',
Pt: 'pt',
Pa: 'pa',
Ro: 'ro',
Ru: 'ru',
Sr: 'sr',
Sk: 'sk',
Sl: 'sl',
Es: 'es',
Sv: 'sv',
Ta: 'ta',
Te: 'te',
Th: 'th',
Tr: 'tr',
Uk: 'uk',
Vi: 'vi',
Unknown: 'unknown'
};
/**
* @export
*/
exports.GetIndexCountsContinentsEnum = {
Africa: 'Africa',
Asia: 'Asia',
Oceania: 'Oceania',
Europe: 'Europe',
MiddleEast: 'Middle East',
NorthAmerica: 'North America',
SouthAmerica: 'South America'
};
/**
* @export
*/
exports.GetIndexCountsSentimentEnum = {
Negative: 'negative',
Neutral: 'neutral',
Positive: 'positive'
};
/**
* @export
*/
exports.GetSourcesReportMetricEnum = {
Duplication: 'duplication',
CountriesDiversity: 'countries_diversity',
LanguagesDiversity: 'languages_diversity',
SourcesDiversity: 'sources_diversity',
BucketLoss: 'bucket_loss'
};
/**
* @export
*/
exports.GetSourcesReportSamplingEnum = {
_5m: '5m',
_1h: '1h',
_4h: '4h',
_1d: '1d'
};
/**
* @export
*/
exports.SearchNewsTimeFilterEnum = {
CrawlDate: 'crawl_date',
PubDate: 'pub_date'
};
/**
* @export
*/
exports.SearchNewsReturnTypeEnum = {
String: 'string',
Dicts: 'dicts',
Both: 'both'
};
/**
* @export
*/
exports.SearchNewsMethodEnum = {
Nl: 'nl',
Kw: 'kw',
Both: 'both'
};
/**
* @export
*/
exports.SearchNewsCategoriesEnum = {
All: 'All',
Business: 'Business',
Crime: 'Crime',
Politics: 'Politics',
Science: 'Science',
Sports: 'Sports',
Technology: 'Technology',
Military: 'Military',
Health: 'Health',
Entertainment: 'Entertainment',
Finance: 'Finance',
Culture: 'Culture',
Climate: 'Climate',
Environment: 'Environment',
World: 'World'
};
/**
* @export
*/
exports.SearchNewsProvocativeEnum = {
Unknown: 'unknown',
Low: 'low',
Medium: 'medium',
High: 'high',
All: 'all'
};
/**
* @export
*/
exports.SearchNewsStrategyEnum = {
LatestNews: 'latest news',
NewsKnowledge: 'news knowledge',
Default: 'default'
};
/**
* @export
*/
exports.SearchNewsStringGuaranteeOpEnum = {
And: 'AND',
Or: 'OR'
};
/**
* @export
*/
exports.SearchNewsEntityGuaranteeOpEnum = {
And: 'AND',
Or: 'OR'
};
/**
* @export
*/
exports.SearchNewsLanguagesEnum = {
Sq: 'sq',
Ar: 'ar',
Az: 'az',
Ca: 'ca',
Zh: 'zh',
Hr: 'hr',
Cs: 'cs',
Da: 'da',
Nl: 'nl',
En: 'en',
Eo: 'eo',
Fi: 'fi',
Fr: 'fr',
Gl: 'gl',
De: 'de',
El: 'el',
He: 'he',
Hi: 'hi',
Hu: 'hu',
Is: 'is',
Id: 'id',
Ia: 'ia',
It: 'it',
Ja: 'ja',
Kk: 'kk',
Km: 'km',
Ko: 'ko',
Ky: 'ky',
Ms: 'ms',
Mt: 'mt',
Mhr: 'mhr',
Mn: 'mn',
No: 'no',
Or: 'or',
Pl: 'pl',
Pt: 'pt',
Pa: 'pa',
Ro: 'ro',
Ru: 'ru',
Sr: 'sr',
Sk: 'sk',
Sl: 'sl',
Es: 'es',
Sv: 'sv',
Ta: 'ta',
Te: 'te',
Th: 'th',
Tr: 'tr',
Uk: 'uk',
Vi: 'vi',
Unknown: 'unknown'
};
/**
* @export
*/
exports.SearchNewsContinentsEnum = {
Africa: 'Africa',
Asia: 'Asia',
Oceania: 'Oceania',
Europe: 'Europe',
MiddleEast: 'Middle East',
NorthAmerica: 'North America',
SouthAmerica: 'South America'
};
/**
* @export
*/
exports.SearchNewsSentimentEnum = {
Negative: 'negative',
Neutral: 'neutral',
Positive: 'positive'
};