@goperigon/perigon-ts 1.0.4 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -0
- package/dist/index.cjs +2 -2
- package/dist/index.d.ts +1251 -410
- package/dist/index.js +2 -2
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -2007,7 +2007,7 @@ declare function ArticleToJSONTyped(value?: Article | null, ignoreDiscriminator?
|
|
|
2007
2007
|
* Do not edit the class manually.
|
|
2008
2008
|
*/
|
|
2009
2009
|
/**
|
|
2010
|
-
* Filter
|
|
2010
|
+
* Filter articles from publishers based at specific geographic locations. Uses latitude, longitude, and radius parameters to define a circular search area for publisher locations.
|
|
2011
2011
|
* @export
|
|
2012
2012
|
* @interface CoordinateFilter
|
|
2013
2013
|
*/
|
|
@@ -2053,169 +2053,169 @@ declare function CoordinateFilterToJSONTyped(value?: CoordinateFilter | null, ig
|
|
|
2053
2053
|
*/
|
|
2054
2054
|
|
|
2055
2055
|
/**
|
|
2056
|
-
*
|
|
2056
|
+
* Complex filter structure for article searches that supports nested logical operations (AND, OR, NOT) and multiple filtering criteria.
|
|
2057
2057
|
* @export
|
|
2058
2058
|
* @interface ArticleSearchFilter
|
|
2059
2059
|
*/
|
|
2060
2060
|
interface ArticleSearchFilter {
|
|
2061
2061
|
/**
|
|
2062
|
-
* Filter by specific article
|
|
2062
|
+
* Filter by specific article identifiers. Accepts either a single ID or an array of IDs. Returns only articles matching these IDs.
|
|
2063
2063
|
* @type {Array<string>}
|
|
2064
2064
|
* @memberof ArticleSearchFilter
|
|
2065
2065
|
*/
|
|
2066
2066
|
articleId?: Array<string> | null;
|
|
2067
2067
|
/**
|
|
2068
|
-
* Filter by specific
|
|
2068
|
+
* Filter by specific story identifiers. Accepts either a single ID or an array of IDs. Returns only articles belonging to these stories.
|
|
2069
2069
|
* @type {Array<string>}
|
|
2070
2070
|
* @memberof ArticleSearchFilter
|
|
2071
2071
|
*/
|
|
2072
2072
|
clusterId?: Array<string> | null;
|
|
2073
2073
|
/**
|
|
2074
|
-
* Filter by specific
|
|
2074
|
+
* Filter articles by specific publisher domains or subdomains. Accepts either a single domain or an array of domains. Multiple values create an OR filter.
|
|
2075
2075
|
* @type {Array<string>}
|
|
2076
2076
|
* @memberof ArticleSearchFilter
|
|
2077
2077
|
*/
|
|
2078
2078
|
source?: Array<string> | null;
|
|
2079
2079
|
/**
|
|
2080
|
-
*
|
|
2080
|
+
* Exclude articles from specific publisher domains or subdomains. Accepts either a single domain or an array of domains. Multiple values create an AND-exclude filter.
|
|
2081
2081
|
* @type {Array<string>}
|
|
2082
2082
|
* @memberof ArticleSearchFilter
|
|
2083
2083
|
*/
|
|
2084
2084
|
excludeSource?: Array<string> | null;
|
|
2085
2085
|
/**
|
|
2086
|
-
* Filter
|
|
2086
|
+
* Filter articles using Perigon's curated publisher bundles (e.g., top100, top25tech). Accepts either a single source group or an array. Multiple values create an OR filter to include articles from any of the specified bundles.
|
|
2087
2087
|
* @type {Array<string>}
|
|
2088
2088
|
* @memberof ArticleSearchFilter
|
|
2089
2089
|
*/
|
|
2090
2090
|
sourceGroup?: Array<string> | null;
|
|
2091
2091
|
/**
|
|
2092
|
-
*
|
|
2092
|
+
* Filter articles by their language using ISO-639 two-letter codes in lowercase (e.g., en, es, fr). Accepts either a single language code or an array. Multiple values create an OR filter.
|
|
2093
2093
|
* @type {Array<string>}
|
|
2094
2094
|
* @memberof ArticleSearchFilter
|
|
2095
2095
|
*/
|
|
2096
2096
|
language?: Array<string> | null;
|
|
2097
2097
|
/**
|
|
2098
|
-
*
|
|
2098
|
+
* Exclude articles in specific languages using ISO-639 two-letter codes in lowercase. Accepts either a single language code or an array. Multiple values create an AND-exclude filter.
|
|
2099
2099
|
* @type {Array<string>}
|
|
2100
2100
|
* @memberof ArticleSearchFilter
|
|
2101
2101
|
*/
|
|
2102
2102
|
excludeLanguage?: Array<string> | null;
|
|
2103
2103
|
/**
|
|
2104
|
-
*
|
|
2104
|
+
* Filter articles by editorial labels such as Opinion, Paid-news, Non-news, Fact Check, or Press Release. View our docs for an exhaustive list of labels. Accepts either a single label or an array. Multiple values create an OR filter.
|
|
2105
2105
|
* @type {Array<string>}
|
|
2106
2106
|
* @memberof ArticleSearchFilter
|
|
2107
2107
|
*/
|
|
2108
2108
|
label?: Array<string> | null;
|
|
2109
2109
|
/**
|
|
2110
|
-
* Exclude
|
|
2110
|
+
* Exclude articles with specific editorial labels. Accepts either a single label or an array. Multiple values create an AND-exclude filter, removing all content with any of these labels.
|
|
2111
2111
|
* @type {Array<string>}
|
|
2112
2112
|
* @memberof ArticleSearchFilter
|
|
2113
2113
|
*/
|
|
2114
2114
|
excludeLabel?: Array<string> | null;
|
|
2115
2115
|
/**
|
|
2116
|
-
*
|
|
2116
|
+
* Filter by Google Content Categories. Must pass the full hierarchical path of the category. Accepts either a single path or an array. Example: taxonomy=/Finance/Banking/Other,/Finance/Investing/Funds. Multiple values create an OR filter.
|
|
2117
2117
|
* @type {Array<string>}
|
|
2118
2118
|
* @memberof ArticleSearchFilter
|
|
2119
2119
|
*/
|
|
2120
2120
|
taxonomy?: Array<string> | null;
|
|
2121
2121
|
/**
|
|
2122
|
-
* Filter by
|
|
2122
|
+
* Filter by broad content categories such as Politics, Tech, Sports, Business, or Finance. Accepts either a single category or an array. Use none to find uncategorized articles. Multiple values create an OR filter.
|
|
2123
2123
|
* @type {Array<string>}
|
|
2124
2124
|
* @memberof ArticleSearchFilter
|
|
2125
2125
|
*/
|
|
2126
2126
|
category?: Array<string> | null;
|
|
2127
2127
|
/**
|
|
2128
|
-
* Filter by topics
|
|
2128
|
+
* Filter by specific topics such as Markets, Crime, Cryptocurrency, or College Sports. Accepts either a single topic or an array. Topics are more granular than categories, and articles can have multiple topics. Multiple values create an OR filter.
|
|
2129
2129
|
* @type {Array<string>}
|
|
2130
2130
|
* @memberof ArticleSearchFilter
|
|
2131
2131
|
*/
|
|
2132
2132
|
topic?: Array<string> | null;
|
|
2133
2133
|
/**
|
|
2134
|
-
*
|
|
2134
|
+
* Exclude articles with specific topics. Accepts either a single topic or an array. Multiple values create an AND-exclude filter, removing all content with any of these topics.
|
|
2135
2135
|
* @type {Array<string>}
|
|
2136
2136
|
* @memberof ArticleSearchFilter
|
|
2137
2137
|
*/
|
|
2138
2138
|
excludeTopic?: Array<string> | null;
|
|
2139
2139
|
/**
|
|
2140
|
-
*
|
|
2140
|
+
* Filter articles by countries they mention using two-letter country codes in lowercase (e.g., us, gb, jp). Accepts either a single country code or an array. Multiple values create an OR filter. See documentation for supported country codes.
|
|
2141
2141
|
* @type {Array<string>}
|
|
2142
2142
|
* @memberof ArticleSearchFilter
|
|
2143
2143
|
*/
|
|
2144
2144
|
country?: Array<string> | null;
|
|
2145
2145
|
/**
|
|
2146
|
-
*
|
|
2146
|
+
* Exclude articles from specific countries using two-letter country codes in lowercase. Accepts either a single country code or an array. Multiple values create an AND-exclude filter. See documentation for supported country codes.
|
|
2147
2147
|
* @type {Array<string>}
|
|
2148
2148
|
* @memberof ArticleSearchFilter
|
|
2149
2149
|
*/
|
|
2150
2150
|
excludeCountry?: Array<string> | null;
|
|
2151
2151
|
/**
|
|
2152
|
-
*
|
|
2152
|
+
* Filter articles where specified countries play a central role in the content, not just mentioned. Uses two-letter country codes in lowercase. Accepts either a single country code or an array. Multiple values create an OR filter. See documentation for supported country codes.
|
|
2153
2153
|
* @type {Array<string>}
|
|
2154
2154
|
* @memberof ArticleSearchFilter
|
|
2155
2155
|
*/
|
|
2156
2156
|
locationsCountry?: Array<string> | null;
|
|
2157
2157
|
/**
|
|
2158
|
-
*
|
|
2158
|
+
* Exclude articles where specified countries play a central role in the content. Accepts either a single country code or an array. Multiple values create an AND-exclude filter, removing articles focused on any of these countries. See documentation for supported country codes.
|
|
2159
2159
|
* @type {Array<string>}
|
|
2160
2160
|
* @memberof ArticleSearchFilter
|
|
2161
2161
|
*/
|
|
2162
2162
|
excludeLocationsCountry?: Array<string> | null;
|
|
2163
2163
|
/**
|
|
2164
|
-
*
|
|
2164
|
+
* Filter articles where specified states play a central role in the content. Accepts either a single state code or an array. Multiple values create an OR filter. Uses two-letter state codes in lowercase. See documentation for supported state codes.
|
|
2165
2165
|
* @type {Array<string>}
|
|
2166
2166
|
* @memberof ArticleSearchFilter
|
|
2167
2167
|
*/
|
|
2168
2168
|
state?: Array<string> | null;
|
|
2169
2169
|
/**
|
|
2170
|
-
*
|
|
2170
|
+
* Exclude articles where specified states play a central role. Accepts either a single state code or an array. Multiple values create an AND-exclude filter, removing articles focused on any of these states. See documentation for supported state codes.
|
|
2171
2171
|
* @type {Array<string>}
|
|
2172
2172
|
* @memberof ArticleSearchFilter
|
|
2173
2173
|
*/
|
|
2174
2174
|
excludeState?: Array<string> | null;
|
|
2175
2175
|
/**
|
|
2176
|
-
*
|
|
2176
|
+
* Filter articles that mention or are related to specific counties. Accepts either a single county name or an array. Multiple values create an OR filter. County names typically include the word 'County' (e.g., Los Angeles County).
|
|
2177
2177
|
* @type {Array<string>}
|
|
2178
2178
|
* @memberof ArticleSearchFilter
|
|
2179
2179
|
*/
|
|
2180
2180
|
county?: Array<string> | null;
|
|
2181
2181
|
/**
|
|
2182
|
-
*
|
|
2182
|
+
* Exclude articles that mention or are related to specific counties. Accepts either a single county name or an array. Multiple values create an AND-exclude filter. County names should match the format in article metadata (e.g., Los Angeles County, Cook County).
|
|
2183
2183
|
* @type {Array<string>}
|
|
2184
2184
|
* @memberof ArticleSearchFilter
|
|
2185
2185
|
*/
|
|
2186
2186
|
excludeCounty?: Array<string> | null;
|
|
2187
2187
|
/**
|
|
2188
|
-
*
|
|
2188
|
+
* Filter articles that mention or are related to specific cities. Accepts either a single city name or an array. Multiple values create an OR filter.
|
|
2189
2189
|
* @type {Array<string>}
|
|
2190
2190
|
* @memberof ArticleSearchFilter
|
|
2191
2191
|
*/
|
|
2192
2192
|
city?: Array<string> | null;
|
|
2193
2193
|
/**
|
|
2194
|
-
*
|
|
2194
|
+
* Exclude articles that mention or are related to specific cities. Accepts either a single city name or an array. Multiple values create an AND-exclude filter.
|
|
2195
2195
|
* @type {Array<string>}
|
|
2196
2196
|
* @memberof ArticleSearchFilter
|
|
2197
2197
|
*/
|
|
2198
2198
|
excludeCity?: Array<string> | null;
|
|
2199
2199
|
/**
|
|
2200
|
-
*
|
|
2200
|
+
* Filter for articles from publishers based in specific countries. Accepts either a single country code or an array. Uses two-letter country codes in lowercase (e.g., us, gb). See documentation for supported country codes.
|
|
2201
2201
|
* @type {Array<string>}
|
|
2202
2202
|
* @memberof ArticleSearchFilter
|
|
2203
2203
|
*/
|
|
2204
2204
|
sourceCountry?: Array<string> | null;
|
|
2205
2205
|
/**
|
|
2206
|
-
*
|
|
2206
|
+
* Filter for articles from publishers based in specific states or regions. Accepts either a single state code or an array. Uses two-letter state codes in lowercase. See documentation for supported state codes.
|
|
2207
2207
|
* @type {Array<string>}
|
|
2208
2208
|
* @memberof ArticleSearchFilter
|
|
2209
2209
|
*/
|
|
2210
2210
|
sourceState?: Array<string> | null;
|
|
2211
2211
|
/**
|
|
2212
|
-
*
|
|
2212
|
+
* Filter for articles from publishers based in specific counties. Accepts either a single county name or an array. Multiple values create an OR filter.
|
|
2213
2213
|
* @type {Array<string>}
|
|
2214
2214
|
* @memberof ArticleSearchFilter
|
|
2215
2215
|
*/
|
|
2216
2216
|
sourceCounty?: Array<string> | null;
|
|
2217
2217
|
/**
|
|
2218
|
-
*
|
|
2218
|
+
* Filter for articles from publishers based in specific cities. Accepts either a single city name or an array. Multiple values create an OR filter.
|
|
2219
2219
|
* @type {Array<string>}
|
|
2220
2220
|
* @memberof ArticleSearchFilter
|
|
2221
2221
|
*/
|
|
@@ -2233,67 +2233,67 @@ interface ArticleSearchFilter {
|
|
|
2233
2233
|
*/
|
|
2234
2234
|
sourceCoordinates?: CoordinateFilter;
|
|
2235
2235
|
/**
|
|
2236
|
-
*
|
|
2236
|
+
* Filter articles by company identifiers. Accepts either a single ID or an array. Multiple values create an OR filter. For a complete list of tracked companies and their IDs, refer to the /companies endpoint.
|
|
2237
2237
|
* @type {Array<string>}
|
|
2238
2238
|
* @memberof ArticleSearchFilter
|
|
2239
2239
|
*/
|
|
2240
2240
|
companyId?: Array<string> | null;
|
|
2241
2241
|
/**
|
|
2242
|
-
*
|
|
2242
|
+
* Exclude articles mentioning companies with specific identifiers. Accepts either a single ID or an array. Multiple values create an AND-exclude filter. For a complete list of tracked companies and their IDs, refer to the /companies endpoint.
|
|
2243
2243
|
* @type {Array<string>}
|
|
2244
2244
|
* @memberof ArticleSearchFilter
|
|
2245
2245
|
*/
|
|
2246
2246
|
excludeCompanyId?: Array<string> | null;
|
|
2247
2247
|
/**
|
|
2248
|
-
*
|
|
2248
|
+
* Filter articles by company domains (e.g., apple.com). Accepts either a single domain or an array. Multiple values create an OR filter. For a complete list of tracked companies and their domains, refer to the /companies endpoint.
|
|
2249
2249
|
* @type {Array<string>}
|
|
2250
2250
|
* @memberof ArticleSearchFilter
|
|
2251
2251
|
*/
|
|
2252
2252
|
companyDomain?: Array<string> | null;
|
|
2253
2253
|
/**
|
|
2254
|
-
*
|
|
2254
|
+
* Exclude articles related to companies with specific domains. Accepts either a single domain or an array. Multiple values create an AND-exclude filter. For a complete list of tracked companies and their domains, refer to the /companies endpoint.
|
|
2255
2255
|
* @type {Array<string>}
|
|
2256
2256
|
* @memberof ArticleSearchFilter
|
|
2257
2257
|
*/
|
|
2258
2258
|
excludeCompanyDomain?: Array<string> | null;
|
|
2259
2259
|
/**
|
|
2260
|
-
*
|
|
2260
|
+
* Filter articles by company stock symbols (e.g., AAPL, MSFT). Accepts either a single symbol or an array. Multiple values create an OR filter. For a complete list of tracked companies and their symbols, refer to the /companies endpoint.
|
|
2261
2261
|
* @type {Array<string>}
|
|
2262
2262
|
* @memberof ArticleSearchFilter
|
|
2263
2263
|
*/
|
|
2264
2264
|
companySymbol?: Array<string> | null;
|
|
2265
2265
|
/**
|
|
2266
|
-
*
|
|
2266
|
+
* Exclude articles related to companies with specific stock symbols. Accepts either a single symbol or an array. Multiple values create an AND-exclude filter. For a complete list of tracked companies and their symbols, refer to the /companies endpoint.
|
|
2267
2267
|
* @type {Array<string>}
|
|
2268
2268
|
* @memberof ArticleSearchFilter
|
|
2269
2269
|
*/
|
|
2270
2270
|
excludeCompanySymbol?: Array<string> | null;
|
|
2271
2271
|
/**
|
|
2272
|
-
*
|
|
2272
|
+
* Filter articles by company name mentions. Accepts either a single name or an array. Performs exact matching on company names. Multiple values create an OR filter. For a complete list of tracked companies and their names, refer to the /companies endpoint.
|
|
2273
2273
|
* @type {Array<string>}
|
|
2274
2274
|
* @memberof ArticleSearchFilter
|
|
2275
2275
|
*/
|
|
2276
2276
|
companyName?: Array<string> | null;
|
|
2277
2277
|
/**
|
|
2278
|
-
*
|
|
2278
|
+
* Filter articles by Wikidata IDs of mentioned people. Accepts either a single ID or an array. Multiple values create an OR filter. For a complete list of tracked individuals and their Wikidata IDs, refer to the /people endpoint.
|
|
2279
2279
|
* @type {Array<string>}
|
|
2280
2280
|
* @memberof ArticleSearchFilter
|
|
2281
2281
|
*/
|
|
2282
2282
|
personWikidataId?: Array<string> | null;
|
|
2283
2283
|
/**
|
|
2284
|
-
*
|
|
2284
|
+
* Exclude articles mentioning people with specific Wikidata IDs. Accepts either a single ID or an array. Multiple values create an AND-exclude filter. For a complete list of tracked individuals and their Wikidata IDs, refer to the /people endpoint.
|
|
2285
2285
|
* @type {Array<string>}
|
|
2286
2286
|
* @memberof ArticleSearchFilter
|
|
2287
2287
|
*/
|
|
2288
2288
|
excludePersonWikidataId?: Array<string> | null;
|
|
2289
2289
|
/**
|
|
2290
|
-
*
|
|
2290
|
+
* Filter articles by exact person name matches. Accepts either a single name or an array. Does not support Boolean operators or wildcards. Multiple values create an OR filter. For a complete list of tracked individuals and their names, refer to the /people endpoint.
|
|
2291
2291
|
* @type {Array<string>}
|
|
2292
2292
|
* @memberof ArticleSearchFilter
|
|
2293
2293
|
*/
|
|
2294
2294
|
personName?: Array<string> | null;
|
|
2295
2295
|
/**
|
|
2296
|
-
*
|
|
2296
|
+
* Exclude articles mentioning specific people by name. Accepts either a single name or an array. Multiple values create an AND-exclude filter. For a complete list of tracked individuals and their names, refer to the /people endpoint.
|
|
2297
2297
|
* @type {Array<string>}
|
|
2298
2298
|
* @memberof ArticleSearchFilter
|
|
2299
2299
|
*/
|
|
@@ -2386,33 +2386,95 @@ interface ArticleSearchParams {
|
|
|
2386
2386
|
* @memberof ArticleSearchParams
|
|
2387
2387
|
*/
|
|
2388
2388
|
page?: number | null;
|
|
2389
|
+
}
|
|
2390
|
+
/**
|
|
2391
|
+
* Check if a given object implements the ArticleSearchParams interface.
|
|
2392
|
+
*/
|
|
2393
|
+
declare function instanceOfArticleSearchParams(value: object): value is ArticleSearchParams;
|
|
2394
|
+
declare function ArticleSearchParamsFromJSON(json: any): ArticleSearchParams;
|
|
2395
|
+
declare function ArticleSearchParamsFromJSONTyped(json: any, ignoreDiscriminator: boolean): ArticleSearchParams;
|
|
2396
|
+
declare function ArticleSearchParamsToJSON(json: any): ArticleSearchParams;
|
|
2397
|
+
declare function ArticleSearchParamsToJSONTyped(value?: ArticleSearchParams | null, ignoreDiscriminator?: boolean): any;
|
|
2398
|
+
|
|
2399
|
+
/**
|
|
2400
|
+
* Perigon API
|
|
2401
|
+
* The Perigon API provides access to comprehensive news and web content data. To use the API, simply sign up for a Perigon Business Solutions account to obtain your API key. Your available features may vary based on your plan. See the Authentication section for details on how to use your API key.
|
|
2402
|
+
*
|
|
2403
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2404
|
+
* Contact: data@perigon.io
|
|
2405
|
+
*
|
|
2406
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2407
|
+
* https://openapi-generator.tech
|
|
2408
|
+
* Do not edit the class manually.
|
|
2409
|
+
*/
|
|
2410
|
+
|
|
2411
|
+
/**
|
|
2412
|
+
*
|
|
2413
|
+
* @export
|
|
2414
|
+
* @interface ScoredDataArticle
|
|
2415
|
+
*/
|
|
2416
|
+
interface ScoredDataArticle {
|
|
2389
2417
|
/**
|
|
2390
2418
|
*
|
|
2391
|
-
* @type {
|
|
2392
|
-
* @memberof
|
|
2419
|
+
* @type {number}
|
|
2420
|
+
* @memberof ScoredDataArticle
|
|
2393
2421
|
*/
|
|
2394
|
-
|
|
2422
|
+
score?: number | null;
|
|
2395
2423
|
/**
|
|
2396
2424
|
*
|
|
2397
|
-
* @type {
|
|
2398
|
-
* @memberof
|
|
2425
|
+
* @type {Article}
|
|
2426
|
+
* @memberof ScoredDataArticle
|
|
2399
2427
|
*/
|
|
2400
|
-
|
|
2428
|
+
data?: Article;
|
|
2429
|
+
}
|
|
2430
|
+
/**
|
|
2431
|
+
* Check if a given object implements the ScoredDataArticle interface.
|
|
2432
|
+
*/
|
|
2433
|
+
declare function instanceOfScoredDataArticle(value: object): value is ScoredDataArticle;
|
|
2434
|
+
declare function ScoredDataArticleFromJSON(json: any): ScoredDataArticle;
|
|
2435
|
+
declare function ScoredDataArticleFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScoredDataArticle;
|
|
2436
|
+
declare function ScoredDataArticleToJSON(json: any): ScoredDataArticle;
|
|
2437
|
+
declare function ScoredDataArticleToJSONTyped(value?: ScoredDataArticle | null, ignoreDiscriminator?: boolean): any;
|
|
2438
|
+
|
|
2439
|
+
/**
|
|
2440
|
+
* Perigon API
|
|
2441
|
+
* The Perigon API provides access to comprehensive news and web content data. To use the API, simply sign up for a Perigon Business Solutions account to obtain your API key. Your available features may vary based on your plan. See the Authentication section for details on how to use your API key.
|
|
2442
|
+
*
|
|
2443
|
+
* The version of the OpenAPI document: 1.0.0
|
|
2444
|
+
* Contact: data@perigon.io
|
|
2445
|
+
*
|
|
2446
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2447
|
+
* https://openapi-generator.tech
|
|
2448
|
+
* Do not edit the class manually.
|
|
2449
|
+
*/
|
|
2450
|
+
|
|
2451
|
+
/**
|
|
2452
|
+
* Articles vector search result
|
|
2453
|
+
* @export
|
|
2454
|
+
* @interface ArticlesVectorSearchResult
|
|
2455
|
+
*/
|
|
2456
|
+
interface ArticlesVectorSearchResult {
|
|
2401
2457
|
/**
|
|
2402
2458
|
*
|
|
2403
2459
|
* @type {number}
|
|
2404
|
-
* @memberof
|
|
2460
|
+
* @memberof ArticlesVectorSearchResult
|
|
2405
2461
|
*/
|
|
2406
|
-
|
|
2462
|
+
status: number;
|
|
2463
|
+
/**
|
|
2464
|
+
*
|
|
2465
|
+
* @type {Array<ScoredDataArticle>}
|
|
2466
|
+
* @memberof ArticlesVectorSearchResult
|
|
2467
|
+
*/
|
|
2468
|
+
results: Array<ScoredDataArticle>;
|
|
2407
2469
|
}
|
|
2408
2470
|
/**
|
|
2409
|
-
* Check if a given object implements the
|
|
2471
|
+
* Check if a given object implements the ArticlesVectorSearchResult interface.
|
|
2410
2472
|
*/
|
|
2411
|
-
declare function
|
|
2412
|
-
declare function
|
|
2413
|
-
declare function
|
|
2414
|
-
declare function
|
|
2415
|
-
declare function
|
|
2473
|
+
declare function instanceOfArticlesVectorSearchResult(value: object): value is ArticlesVectorSearchResult;
|
|
2474
|
+
declare function ArticlesVectorSearchResultFromJSON(json: any): ArticlesVectorSearchResult;
|
|
2475
|
+
declare function ArticlesVectorSearchResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): ArticlesVectorSearchResult;
|
|
2476
|
+
declare function ArticlesVectorSearchResultToJSON(json: any): ArticlesVectorSearchResult;
|
|
2477
|
+
declare function ArticlesVectorSearchResultToJSONTyped(value?: ArticlesVectorSearchResult | null, ignoreDiscriminator?: boolean): any;
|
|
2416
2478
|
|
|
2417
2479
|
/**
|
|
2418
2480
|
* Perigon API
|
|
@@ -2428,66 +2490,66 @@ declare function ArticleSearchParamsToJSONTyped(value?: ArticleSearchParams | nu
|
|
|
2428
2490
|
/**
|
|
2429
2491
|
*
|
|
2430
2492
|
* @export
|
|
2431
|
-
* @interface
|
|
2493
|
+
* @interface AuthExceptionCauseStackTraceInner
|
|
2432
2494
|
*/
|
|
2433
|
-
interface
|
|
2495
|
+
interface AuthExceptionCauseStackTraceInner {
|
|
2434
2496
|
/**
|
|
2435
2497
|
*
|
|
2436
2498
|
* @type {string}
|
|
2437
|
-
* @memberof
|
|
2499
|
+
* @memberof AuthExceptionCauseStackTraceInner
|
|
2438
2500
|
*/
|
|
2439
2501
|
classLoaderName?: string;
|
|
2440
2502
|
/**
|
|
2441
2503
|
*
|
|
2442
2504
|
* @type {string}
|
|
2443
|
-
* @memberof
|
|
2505
|
+
* @memberof AuthExceptionCauseStackTraceInner
|
|
2444
2506
|
*/
|
|
2445
2507
|
moduleName?: string;
|
|
2446
2508
|
/**
|
|
2447
2509
|
*
|
|
2448
2510
|
* @type {string}
|
|
2449
|
-
* @memberof
|
|
2511
|
+
* @memberof AuthExceptionCauseStackTraceInner
|
|
2450
2512
|
*/
|
|
2451
2513
|
moduleVersion?: string;
|
|
2452
2514
|
/**
|
|
2453
2515
|
*
|
|
2454
2516
|
* @type {string}
|
|
2455
|
-
* @memberof
|
|
2517
|
+
* @memberof AuthExceptionCauseStackTraceInner
|
|
2456
2518
|
*/
|
|
2457
2519
|
methodName?: string;
|
|
2458
2520
|
/**
|
|
2459
2521
|
*
|
|
2460
2522
|
* @type {string}
|
|
2461
|
-
* @memberof
|
|
2523
|
+
* @memberof AuthExceptionCauseStackTraceInner
|
|
2462
2524
|
*/
|
|
2463
2525
|
fileName?: string;
|
|
2464
2526
|
/**
|
|
2465
2527
|
*
|
|
2466
2528
|
* @type {number}
|
|
2467
|
-
* @memberof
|
|
2529
|
+
* @memberof AuthExceptionCauseStackTraceInner
|
|
2468
2530
|
*/
|
|
2469
2531
|
lineNumber?: number;
|
|
2470
2532
|
/**
|
|
2471
2533
|
*
|
|
2472
2534
|
* @type {boolean}
|
|
2473
|
-
* @memberof
|
|
2535
|
+
* @memberof AuthExceptionCauseStackTraceInner
|
|
2474
2536
|
*/
|
|
2475
2537
|
nativeMethod?: boolean;
|
|
2476
2538
|
/**
|
|
2477
2539
|
*
|
|
2478
2540
|
* @type {string}
|
|
2479
|
-
* @memberof
|
|
2541
|
+
* @memberof AuthExceptionCauseStackTraceInner
|
|
2480
2542
|
*/
|
|
2481
2543
|
className?: string;
|
|
2482
2544
|
}
|
|
2483
2545
|
/**
|
|
2484
|
-
* Check if a given object implements the
|
|
2546
|
+
* Check if a given object implements the AuthExceptionCauseStackTraceInner interface.
|
|
2485
2547
|
*/
|
|
2486
|
-
declare function
|
|
2487
|
-
declare function
|
|
2488
|
-
declare function
|
|
2489
|
-
declare function
|
|
2490
|
-
declare function
|
|
2548
|
+
declare function instanceOfAuthExceptionCauseStackTraceInner(value: object): value is AuthExceptionCauseStackTraceInner;
|
|
2549
|
+
declare function AuthExceptionCauseStackTraceInnerFromJSON(json: any): AuthExceptionCauseStackTraceInner;
|
|
2550
|
+
declare function AuthExceptionCauseStackTraceInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuthExceptionCauseStackTraceInner;
|
|
2551
|
+
declare function AuthExceptionCauseStackTraceInnerToJSON(json: any): AuthExceptionCauseStackTraceInner;
|
|
2552
|
+
declare function AuthExceptionCauseStackTraceInnerToJSONTyped(value?: AuthExceptionCauseStackTraceInner | null, ignoreDiscriminator?: boolean): any;
|
|
2491
2553
|
|
|
2492
2554
|
/**
|
|
2493
2555
|
* Perigon API
|
|
@@ -2504,36 +2566,36 @@ declare function TooManyRequestsExceptionCauseStackTraceInnerToJSONTyped(value?:
|
|
|
2504
2566
|
/**
|
|
2505
2567
|
*
|
|
2506
2568
|
* @export
|
|
2507
|
-
* @interface
|
|
2569
|
+
* @interface AuthExceptionCause
|
|
2508
2570
|
*/
|
|
2509
|
-
interface
|
|
2571
|
+
interface AuthExceptionCause {
|
|
2510
2572
|
/**
|
|
2511
2573
|
*
|
|
2512
|
-
* @type {Array<
|
|
2513
|
-
* @memberof
|
|
2574
|
+
* @type {Array<AuthExceptionCauseStackTraceInner>}
|
|
2575
|
+
* @memberof AuthExceptionCause
|
|
2514
2576
|
*/
|
|
2515
|
-
stackTrace?: Array<
|
|
2577
|
+
stackTrace?: Array<AuthExceptionCauseStackTraceInner>;
|
|
2516
2578
|
/**
|
|
2517
2579
|
*
|
|
2518
2580
|
* @type {string}
|
|
2519
|
-
* @memberof
|
|
2581
|
+
* @memberof AuthExceptionCause
|
|
2520
2582
|
*/
|
|
2521
2583
|
message?: string;
|
|
2522
2584
|
/**
|
|
2523
2585
|
*
|
|
2524
2586
|
* @type {string}
|
|
2525
|
-
* @memberof
|
|
2587
|
+
* @memberof AuthExceptionCause
|
|
2526
2588
|
*/
|
|
2527
2589
|
localizedMessage?: string;
|
|
2528
2590
|
}
|
|
2529
2591
|
/**
|
|
2530
|
-
* Check if a given object implements the
|
|
2592
|
+
* Check if a given object implements the AuthExceptionCause interface.
|
|
2531
2593
|
*/
|
|
2532
|
-
declare function
|
|
2533
|
-
declare function
|
|
2534
|
-
declare function
|
|
2535
|
-
declare function
|
|
2536
|
-
declare function
|
|
2594
|
+
declare function instanceOfAuthExceptionCause(value: object): value is AuthExceptionCause;
|
|
2595
|
+
declare function AuthExceptionCauseFromJSON(json: any): AuthExceptionCause;
|
|
2596
|
+
declare function AuthExceptionCauseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuthExceptionCause;
|
|
2597
|
+
declare function AuthExceptionCauseToJSON(json: any): AuthExceptionCause;
|
|
2598
|
+
declare function AuthExceptionCauseToJSONTyped(value?: AuthExceptionCause | null, ignoreDiscriminator?: boolean): any;
|
|
2537
2599
|
|
|
2538
2600
|
/**
|
|
2539
2601
|
* Perigon API
|
|
@@ -2550,36 +2612,36 @@ declare function TooManyRequestsExceptionCauseToJSONTyped(value?: TooManyRequest
|
|
|
2550
2612
|
/**
|
|
2551
2613
|
*
|
|
2552
2614
|
* @export
|
|
2553
|
-
* @interface
|
|
2615
|
+
* @interface AuthExceptionSuppressedInner
|
|
2554
2616
|
*/
|
|
2555
|
-
interface
|
|
2617
|
+
interface AuthExceptionSuppressedInner {
|
|
2556
2618
|
/**
|
|
2557
2619
|
*
|
|
2558
|
-
* @type {Array<
|
|
2559
|
-
* @memberof
|
|
2620
|
+
* @type {Array<AuthExceptionCauseStackTraceInner>}
|
|
2621
|
+
* @memberof AuthExceptionSuppressedInner
|
|
2560
2622
|
*/
|
|
2561
|
-
stackTrace?: Array<
|
|
2623
|
+
stackTrace?: Array<AuthExceptionCauseStackTraceInner>;
|
|
2562
2624
|
/**
|
|
2563
2625
|
*
|
|
2564
2626
|
* @type {string}
|
|
2565
|
-
* @memberof
|
|
2627
|
+
* @memberof AuthExceptionSuppressedInner
|
|
2566
2628
|
*/
|
|
2567
2629
|
message?: string;
|
|
2568
2630
|
/**
|
|
2569
2631
|
*
|
|
2570
2632
|
* @type {string}
|
|
2571
|
-
* @memberof
|
|
2633
|
+
* @memberof AuthExceptionSuppressedInner
|
|
2572
2634
|
*/
|
|
2573
2635
|
localizedMessage?: string;
|
|
2574
2636
|
}
|
|
2575
2637
|
/**
|
|
2576
|
-
* Check if a given object implements the
|
|
2638
|
+
* Check if a given object implements the AuthExceptionSuppressedInner interface.
|
|
2577
2639
|
*/
|
|
2578
|
-
declare function
|
|
2579
|
-
declare function
|
|
2580
|
-
declare function
|
|
2581
|
-
declare function
|
|
2582
|
-
declare function
|
|
2640
|
+
declare function instanceOfAuthExceptionSuppressedInner(value: object): value is AuthExceptionSuppressedInner;
|
|
2641
|
+
declare function AuthExceptionSuppressedInnerFromJSON(json: any): AuthExceptionSuppressedInner;
|
|
2642
|
+
declare function AuthExceptionSuppressedInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuthExceptionSuppressedInner;
|
|
2643
|
+
declare function AuthExceptionSuppressedInnerToJSON(json: any): AuthExceptionSuppressedInner;
|
|
2644
|
+
declare function AuthExceptionSuppressedInnerToJSONTyped(value?: AuthExceptionSuppressedInner | null, ignoreDiscriminator?: boolean): any;
|
|
2583
2645
|
|
|
2584
2646
|
/**
|
|
2585
2647
|
* Perigon API
|
|
@@ -2601,16 +2663,16 @@ declare function TooManyRequestsExceptionSuppressedInnerToJSONTyped(value?: TooM
|
|
|
2601
2663
|
interface AuthException {
|
|
2602
2664
|
/**
|
|
2603
2665
|
*
|
|
2604
|
-
* @type {
|
|
2666
|
+
* @type {AuthExceptionCause}
|
|
2605
2667
|
* @memberof AuthException
|
|
2606
2668
|
*/
|
|
2607
|
-
cause?:
|
|
2669
|
+
cause?: AuthExceptionCause | null;
|
|
2608
2670
|
/**
|
|
2609
2671
|
*
|
|
2610
|
-
* @type {Array<
|
|
2672
|
+
* @type {Array<AuthExceptionCauseStackTraceInner>}
|
|
2611
2673
|
* @memberof AuthException
|
|
2612
2674
|
*/
|
|
2613
|
-
stackTrace?: Array<
|
|
2675
|
+
stackTrace?: Array<AuthExceptionCauseStackTraceInner> | null;
|
|
2614
2676
|
/**
|
|
2615
2677
|
*
|
|
2616
2678
|
* @type {string}
|
|
@@ -2625,10 +2687,10 @@ interface AuthException {
|
|
|
2625
2687
|
message?: string | null;
|
|
2626
2688
|
/**
|
|
2627
2689
|
*
|
|
2628
|
-
* @type {Array<
|
|
2690
|
+
* @type {Array<AuthExceptionSuppressedInner>}
|
|
2629
2691
|
* @memberof AuthException
|
|
2630
2692
|
*/
|
|
2631
|
-
suppressed?: Array<
|
|
2693
|
+
suppressed?: Array<AuthExceptionSuppressedInner> | null;
|
|
2632
2694
|
/**
|
|
2633
2695
|
*
|
|
2634
2696
|
* @type {string}
|
|
@@ -3173,16 +3235,16 @@ declare function CompanySearchResultToJSONTyped(value?: CompanySearchResult | nu
|
|
|
3173
3235
|
interface IllegalParameterException {
|
|
3174
3236
|
/**
|
|
3175
3237
|
*
|
|
3176
|
-
* @type {
|
|
3238
|
+
* @type {AuthExceptionCause}
|
|
3177
3239
|
* @memberof IllegalParameterException
|
|
3178
3240
|
*/
|
|
3179
|
-
cause?:
|
|
3241
|
+
cause?: AuthExceptionCause | null;
|
|
3180
3242
|
/**
|
|
3181
3243
|
*
|
|
3182
|
-
* @type {Array<
|
|
3244
|
+
* @type {Array<AuthExceptionCauseStackTraceInner>}
|
|
3183
3245
|
* @memberof IllegalParameterException
|
|
3184
3246
|
*/
|
|
3185
|
-
stackTrace?: Array<
|
|
3247
|
+
stackTrace?: Array<AuthExceptionCauseStackTraceInner> | null;
|
|
3186
3248
|
/**
|
|
3187
3249
|
*
|
|
3188
3250
|
* @type {string}
|
|
@@ -3191,10 +3253,10 @@ interface IllegalParameterException {
|
|
|
3191
3253
|
message?: string | null;
|
|
3192
3254
|
/**
|
|
3193
3255
|
*
|
|
3194
|
-
* @type {Array<
|
|
3256
|
+
* @type {Array<AuthExceptionSuppressedInner>}
|
|
3195
3257
|
* @memberof IllegalParameterException
|
|
3196
3258
|
*/
|
|
3197
|
-
suppressed?: Array<
|
|
3259
|
+
suppressed?: Array<AuthExceptionSuppressedInner> | null;
|
|
3198
3260
|
/**
|
|
3199
3261
|
*
|
|
3200
3262
|
* @type {string}
|
|
@@ -3264,16 +3326,16 @@ declare function ImageHolderToJSONTyped(value?: ImageHolder | null, ignoreDiscri
|
|
|
3264
3326
|
interface InternalErrorException {
|
|
3265
3327
|
/**
|
|
3266
3328
|
*
|
|
3267
|
-
* @type {
|
|
3329
|
+
* @type {AuthExceptionCause}
|
|
3268
3330
|
* @memberof InternalErrorException
|
|
3269
3331
|
*/
|
|
3270
|
-
cause?:
|
|
3332
|
+
cause?: AuthExceptionCause | null;
|
|
3271
3333
|
/**
|
|
3272
3334
|
*
|
|
3273
|
-
* @type {Array<
|
|
3335
|
+
* @type {Array<AuthExceptionCauseStackTraceInner>}
|
|
3274
3336
|
* @memberof InternalErrorException
|
|
3275
3337
|
*/
|
|
3276
|
-
stackTrace?: Array<
|
|
3338
|
+
stackTrace?: Array<AuthExceptionCauseStackTraceInner> | null;
|
|
3277
3339
|
/**
|
|
3278
3340
|
*
|
|
3279
3341
|
* @type {string}
|
|
@@ -3282,10 +3344,10 @@ interface InternalErrorException {
|
|
|
3282
3344
|
message?: string | null;
|
|
3283
3345
|
/**
|
|
3284
3346
|
*
|
|
3285
|
-
* @type {Array<
|
|
3347
|
+
* @type {Array<AuthExceptionSuppressedInner>}
|
|
3286
3348
|
* @memberof InternalErrorException
|
|
3287
3349
|
*/
|
|
3288
|
-
suppressed?: Array<
|
|
3350
|
+
suppressed?: Array<AuthExceptionSuppressedInner> | null;
|
|
3289
3351
|
/**
|
|
3290
3352
|
*
|
|
3291
3353
|
* @type {string}
|
|
@@ -3368,16 +3430,16 @@ declare function JournalistSearchResultToJSONTyped(value?: JournalistSearchResul
|
|
|
3368
3430
|
interface NotFoundException {
|
|
3369
3431
|
/**
|
|
3370
3432
|
*
|
|
3371
|
-
* @type {
|
|
3433
|
+
* @type {AuthExceptionCause}
|
|
3372
3434
|
* @memberof NotFoundException
|
|
3373
3435
|
*/
|
|
3374
|
-
cause?:
|
|
3436
|
+
cause?: AuthExceptionCause | null;
|
|
3375
3437
|
/**
|
|
3376
3438
|
*
|
|
3377
|
-
* @type {Array<
|
|
3439
|
+
* @type {Array<AuthExceptionCauseStackTraceInner>}
|
|
3378
3440
|
* @memberof NotFoundException
|
|
3379
3441
|
*/
|
|
3380
|
-
stackTrace?: Array<
|
|
3442
|
+
stackTrace?: Array<AuthExceptionCauseStackTraceInner> | null;
|
|
3381
3443
|
/**
|
|
3382
3444
|
*
|
|
3383
3445
|
* @type {string}
|
|
@@ -3386,10 +3448,10 @@ interface NotFoundException {
|
|
|
3386
3448
|
message?: string | null;
|
|
3387
3449
|
/**
|
|
3388
3450
|
*
|
|
3389
|
-
* @type {Array<
|
|
3451
|
+
* @type {Array<AuthExceptionSuppressedInner>}
|
|
3390
3452
|
* @memberof NotFoundException
|
|
3391
3453
|
*/
|
|
3392
|
-
suppressed?: Array<
|
|
3454
|
+
suppressed?: Array<AuthExceptionSuppressedInner> | null;
|
|
3393
3455
|
/**
|
|
3394
3456
|
*
|
|
3395
3457
|
* @type {string}
|
|
@@ -3813,30 +3875,148 @@ declare function QuerySearchResultToJSONTyped(value?: QuerySearchResult | null,
|
|
|
3813
3875
|
/**
|
|
3814
3876
|
*
|
|
3815
3877
|
* @export
|
|
3816
|
-
* @interface
|
|
3878
|
+
* @interface WikiData
|
|
3879
|
+
*/
|
|
3880
|
+
interface WikiData {
|
|
3881
|
+
/**
|
|
3882
|
+
*
|
|
3883
|
+
* @type {string}
|
|
3884
|
+
* @memberof WikiData
|
|
3885
|
+
*/
|
|
3886
|
+
pageId?: string | null;
|
|
3887
|
+
/**
|
|
3888
|
+
*
|
|
3889
|
+
* @type {string}
|
|
3890
|
+
* @memberof WikiData
|
|
3891
|
+
*/
|
|
3892
|
+
sectionId?: string | null;
|
|
3893
|
+
/**
|
|
3894
|
+
*
|
|
3895
|
+
* @type {number}
|
|
3896
|
+
* @memberof WikiData
|
|
3897
|
+
*/
|
|
3898
|
+
wikiPageId?: number | null;
|
|
3899
|
+
/**
|
|
3900
|
+
*
|
|
3901
|
+
* @type {number}
|
|
3902
|
+
* @memberof WikiData
|
|
3903
|
+
*/
|
|
3904
|
+
wikiRevisionId?: number | null;
|
|
3905
|
+
/**
|
|
3906
|
+
*
|
|
3907
|
+
* @type {string}
|
|
3908
|
+
* @memberof WikiData
|
|
3909
|
+
*/
|
|
3910
|
+
wikiRevisionTs?: string | null;
|
|
3911
|
+
/**
|
|
3912
|
+
*
|
|
3913
|
+
* @type {string}
|
|
3914
|
+
* @memberof WikiData
|
|
3915
|
+
*/
|
|
3916
|
+
wikiCode?: string | null;
|
|
3917
|
+
/**
|
|
3918
|
+
*
|
|
3919
|
+
* @type {number}
|
|
3920
|
+
* @memberof WikiData
|
|
3921
|
+
*/
|
|
3922
|
+
wikiNamespace?: number | null;
|
|
3923
|
+
/**
|
|
3924
|
+
*
|
|
3925
|
+
* @type {string}
|
|
3926
|
+
* @memberof WikiData
|
|
3927
|
+
*/
|
|
3928
|
+
wikiTitle?: string | null;
|
|
3929
|
+
/**
|
|
3930
|
+
*
|
|
3931
|
+
* @type {string}
|
|
3932
|
+
* @memberof WikiData
|
|
3933
|
+
*/
|
|
3934
|
+
wikidataId?: string | null;
|
|
3935
|
+
/**
|
|
3936
|
+
*
|
|
3937
|
+
* @type {Array<WikidataLabelHolder>}
|
|
3938
|
+
* @memberof WikiData
|
|
3939
|
+
*/
|
|
3940
|
+
wikidataInstanceOf?: Array<WikidataLabelHolder> | null;
|
|
3941
|
+
/**
|
|
3942
|
+
*
|
|
3943
|
+
* @type {Array<string>}
|
|
3944
|
+
* @memberof WikiData
|
|
3945
|
+
*/
|
|
3946
|
+
redirectTitles?: Array<string> | null;
|
|
3947
|
+
/**
|
|
3948
|
+
*
|
|
3949
|
+
* @type {number}
|
|
3950
|
+
* @memberof WikiData
|
|
3951
|
+
*/
|
|
3952
|
+
pageviews?: number | null;
|
|
3953
|
+
/**
|
|
3954
|
+
*
|
|
3955
|
+
* @type {string}
|
|
3956
|
+
* @memberof WikiData
|
|
3957
|
+
*/
|
|
3958
|
+
title?: string | null;
|
|
3959
|
+
/**
|
|
3960
|
+
*
|
|
3961
|
+
* @type {number}
|
|
3962
|
+
* @memberof WikiData
|
|
3963
|
+
*/
|
|
3964
|
+
styleLevel?: number | null;
|
|
3965
|
+
/**
|
|
3966
|
+
*
|
|
3967
|
+
* @type {string}
|
|
3968
|
+
* @memberof WikiData
|
|
3969
|
+
*/
|
|
3970
|
+
content?: string | null;
|
|
3971
|
+
}
|
|
3972
|
+
/**
|
|
3973
|
+
* Check if a given object implements the WikiData interface.
|
|
3974
|
+
*/
|
|
3975
|
+
declare function instanceOfWikiData(value: object): value is WikiData;
|
|
3976
|
+
declare function WikiDataFromJSON(json: any): WikiData;
|
|
3977
|
+
declare function WikiDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): WikiData;
|
|
3978
|
+
declare function WikiDataToJSON(json: any): WikiData;
|
|
3979
|
+
declare function WikiDataToJSONTyped(value?: WikiData | null, ignoreDiscriminator?: boolean): any;
|
|
3980
|
+
|
|
3981
|
+
/**
|
|
3982
|
+
* Perigon API
|
|
3983
|
+
* The Perigon API provides access to comprehensive news and web content data. To use the API, simply sign up for a Perigon Business Solutions account to obtain your API key. Your available features may vary based on your plan. See the Authentication section for details on how to use your API key.
|
|
3984
|
+
*
|
|
3985
|
+
* The version of the OpenAPI document: 1.0.0
|
|
3986
|
+
* Contact: data@perigon.io
|
|
3987
|
+
*
|
|
3988
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
3989
|
+
* https://openapi-generator.tech
|
|
3990
|
+
* Do not edit the class manually.
|
|
3991
|
+
*/
|
|
3992
|
+
|
|
3993
|
+
/**
|
|
3994
|
+
*
|
|
3995
|
+
* @export
|
|
3996
|
+
* @interface ScoredDataWikiData
|
|
3817
3997
|
*/
|
|
3818
|
-
interface
|
|
3998
|
+
interface ScoredDataWikiData {
|
|
3819
3999
|
/**
|
|
3820
4000
|
*
|
|
3821
4001
|
* @type {number}
|
|
3822
|
-
* @memberof
|
|
4002
|
+
* @memberof ScoredDataWikiData
|
|
3823
4003
|
*/
|
|
3824
4004
|
score?: number | null;
|
|
3825
4005
|
/**
|
|
3826
4006
|
*
|
|
3827
|
-
* @type {
|
|
3828
|
-
* @memberof
|
|
4007
|
+
* @type {WikiData}
|
|
4008
|
+
* @memberof ScoredDataWikiData
|
|
3829
4009
|
*/
|
|
3830
|
-
data?:
|
|
4010
|
+
data?: WikiData;
|
|
3831
4011
|
}
|
|
3832
4012
|
/**
|
|
3833
|
-
* Check if a given object implements the
|
|
4013
|
+
* Check if a given object implements the ScoredDataWikiData interface.
|
|
3834
4014
|
*/
|
|
3835
|
-
declare function
|
|
3836
|
-
declare function
|
|
3837
|
-
declare function
|
|
3838
|
-
declare function
|
|
3839
|
-
declare function
|
|
4015
|
+
declare function instanceOfScoredDataWikiData(value: object): value is ScoredDataWikiData;
|
|
4016
|
+
declare function ScoredDataWikiDataFromJSON(json: any): ScoredDataWikiData;
|
|
4017
|
+
declare function ScoredDataWikiDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScoredDataWikiData;
|
|
4018
|
+
declare function ScoredDataWikiDataToJSON(json: any): ScoredDataWikiData;
|
|
4019
|
+
declare function ScoredDataWikiDataToJSONTyped(value?: ScoredDataWikiData | null, ignoreDiscriminator?: boolean): any;
|
|
3840
4020
|
|
|
3841
4021
|
/**
|
|
3842
4022
|
* Perigon API
|
|
@@ -4347,16 +4527,16 @@ declare function SummarySearchResultToJSONTyped(value?: SummarySearchResult | nu
|
|
|
4347
4527
|
interface TooManyRequestsException {
|
|
4348
4528
|
/**
|
|
4349
4529
|
*
|
|
4350
|
-
* @type {
|
|
4530
|
+
* @type {AuthExceptionCause}
|
|
4351
4531
|
* @memberof TooManyRequestsException
|
|
4352
4532
|
*/
|
|
4353
|
-
cause?:
|
|
4533
|
+
cause?: AuthExceptionCause | null;
|
|
4354
4534
|
/**
|
|
4355
4535
|
*
|
|
4356
|
-
* @type {Array<
|
|
4536
|
+
* @type {Array<AuthExceptionCauseStackTraceInner>}
|
|
4357
4537
|
* @memberof TooManyRequestsException
|
|
4358
4538
|
*/
|
|
4359
|
-
stackTrace?: Array<
|
|
4539
|
+
stackTrace?: Array<AuthExceptionCauseStackTraceInner> | null;
|
|
4360
4540
|
/**
|
|
4361
4541
|
*
|
|
4362
4542
|
* @type {string}
|
|
@@ -4371,10 +4551,10 @@ interface TooManyRequestsException {
|
|
|
4371
4551
|
message?: string | null;
|
|
4372
4552
|
/**
|
|
4373
4553
|
*
|
|
4374
|
-
* @type {Array<
|
|
4554
|
+
* @type {Array<AuthExceptionSuppressedInner>}
|
|
4375
4555
|
* @memberof TooManyRequestsException
|
|
4376
4556
|
*/
|
|
4377
|
-
suppressed?: Array<
|
|
4557
|
+
suppressed?: Array<AuthExceptionSuppressedInner> | null;
|
|
4378
4558
|
/**
|
|
4379
4559
|
*
|
|
4380
4560
|
* @type {string}
|
|
@@ -4613,34 +4793,57 @@ declare function TopicSearchResultToJSONTyped(value?: TopicSearchResult | null,
|
|
|
4613
4793
|
* https://openapi-generator.tech
|
|
4614
4794
|
* Do not edit the class manually.
|
|
4615
4795
|
*/
|
|
4616
|
-
|
|
4617
4796
|
/**
|
|
4618
|
-
*
|
|
4797
|
+
*
|
|
4619
4798
|
* @export
|
|
4620
|
-
* @interface
|
|
4799
|
+
* @interface WikiPageSectionHolder
|
|
4621
4800
|
*/
|
|
4622
|
-
interface
|
|
4801
|
+
interface WikiPageSectionHolder {
|
|
4802
|
+
/**
|
|
4803
|
+
*
|
|
4804
|
+
* @type {string}
|
|
4805
|
+
* @memberof WikiPageSectionHolder
|
|
4806
|
+
*/
|
|
4807
|
+
id?: string | null;
|
|
4808
|
+
/**
|
|
4809
|
+
*
|
|
4810
|
+
* @type {string}
|
|
4811
|
+
* @memberof WikiPageSectionHolder
|
|
4812
|
+
*/
|
|
4813
|
+
title?: string | null;
|
|
4623
4814
|
/**
|
|
4624
4815
|
*
|
|
4625
4816
|
* @type {number}
|
|
4626
|
-
* @memberof
|
|
4817
|
+
* @memberof WikiPageSectionHolder
|
|
4627
4818
|
*/
|
|
4628
|
-
|
|
4819
|
+
styleLevel?: number | null;
|
|
4820
|
+
/**
|
|
4821
|
+
*
|
|
4822
|
+
* @type {Array<number>}
|
|
4823
|
+
* @memberof WikiPageSectionHolder
|
|
4824
|
+
*/
|
|
4825
|
+
loc?: Array<number> | null;
|
|
4826
|
+
/**
|
|
4827
|
+
*
|
|
4828
|
+
* @type {string}
|
|
4829
|
+
* @memberof WikiPageSectionHolder
|
|
4830
|
+
*/
|
|
4831
|
+
textRaw?: string | null;
|
|
4629
4832
|
/**
|
|
4630
4833
|
*
|
|
4631
|
-
* @type {
|
|
4632
|
-
* @memberof
|
|
4834
|
+
* @type {string}
|
|
4835
|
+
* @memberof WikiPageSectionHolder
|
|
4633
4836
|
*/
|
|
4634
|
-
|
|
4837
|
+
textRich?: string | null;
|
|
4635
4838
|
}
|
|
4636
4839
|
/**
|
|
4637
|
-
* Check if a given object implements the
|
|
4840
|
+
* Check if a given object implements the WikiPageSectionHolder interface.
|
|
4638
4841
|
*/
|
|
4639
|
-
declare function
|
|
4640
|
-
declare function
|
|
4641
|
-
declare function
|
|
4642
|
-
declare function
|
|
4643
|
-
declare function
|
|
4842
|
+
declare function instanceOfWikiPageSectionHolder(value: object): value is WikiPageSectionHolder;
|
|
4843
|
+
declare function WikiPageSectionHolderFromJSON(json: any): WikiPageSectionHolder;
|
|
4844
|
+
declare function WikiPageSectionHolderFromJSONTyped(json: any, ignoreDiscriminator: boolean): WikiPageSectionHolder;
|
|
4845
|
+
declare function WikiPageSectionHolderToJSON(json: any): WikiPageSectionHolder;
|
|
4846
|
+
declare function WikiPageSectionHolderToJSONTyped(value?: WikiPageSectionHolder | null, ignoreDiscriminator?: boolean): any;
|
|
4644
4847
|
|
|
4645
4848
|
/**
|
|
4646
4849
|
* Perigon API
|
|
@@ -4654,96 +4857,499 @@ declare function VectorSearchResultToJSONTyped(value?: VectorSearchResult | null
|
|
|
4654
4857
|
* Do not edit the class manually.
|
|
4655
4858
|
*/
|
|
4656
4859
|
|
|
4657
|
-
|
|
4658
|
-
|
|
4659
|
-
|
|
4660
|
-
|
|
4661
|
-
|
|
4662
|
-
|
|
4663
|
-
}
|
|
4664
|
-
interface SearchArticlesRequest {
|
|
4860
|
+
/**
|
|
4861
|
+
*
|
|
4862
|
+
* @export
|
|
4863
|
+
* @interface WikiPage
|
|
4864
|
+
*/
|
|
4865
|
+
interface WikiPage {
|
|
4665
4866
|
/**
|
|
4666
|
-
*
|
|
4867
|
+
*
|
|
4868
|
+
* @type {string}
|
|
4869
|
+
* @memberof WikiPage
|
|
4667
4870
|
*/
|
|
4668
|
-
|
|
4871
|
+
id?: string | null;
|
|
4669
4872
|
/**
|
|
4670
|
-
*
|
|
4873
|
+
*
|
|
4874
|
+
* @type {string}
|
|
4875
|
+
* @memberof WikiPage
|
|
4671
4876
|
*/
|
|
4672
|
-
|
|
4877
|
+
scrapedAt?: string | null;
|
|
4673
4878
|
/**
|
|
4674
|
-
*
|
|
4879
|
+
*
|
|
4880
|
+
* @type {number}
|
|
4881
|
+
* @memberof WikiPage
|
|
4675
4882
|
*/
|
|
4676
|
-
|
|
4883
|
+
wikiPageId?: number | null;
|
|
4677
4884
|
/**
|
|
4678
|
-
*
|
|
4885
|
+
*
|
|
4886
|
+
* @type {number}
|
|
4887
|
+
* @memberof WikiPage
|
|
4679
4888
|
*/
|
|
4680
|
-
|
|
4889
|
+
wikiRevisionId?: number | null;
|
|
4681
4890
|
/**
|
|
4682
|
-
*
|
|
4891
|
+
*
|
|
4892
|
+
* @type {string}
|
|
4893
|
+
* @memberof WikiPage
|
|
4683
4894
|
*/
|
|
4684
|
-
|
|
4895
|
+
wikiRevisionTs?: string | null;
|
|
4685
4896
|
/**
|
|
4686
|
-
*
|
|
4897
|
+
*
|
|
4898
|
+
* @type {string}
|
|
4899
|
+
* @memberof WikiPage
|
|
4687
4900
|
*/
|
|
4688
|
-
|
|
4901
|
+
wikiCode?: string | null;
|
|
4689
4902
|
/**
|
|
4690
|
-
*
|
|
4903
|
+
*
|
|
4904
|
+
* @type {number}
|
|
4905
|
+
* @memberof WikiPage
|
|
4691
4906
|
*/
|
|
4692
|
-
|
|
4907
|
+
wikiNamespace?: number | null;
|
|
4693
4908
|
/**
|
|
4694
|
-
*
|
|
4909
|
+
*
|
|
4910
|
+
* @type {string}
|
|
4911
|
+
* @memberof WikiPage
|
|
4695
4912
|
*/
|
|
4696
|
-
|
|
4913
|
+
wikiTitle?: string | null;
|
|
4697
4914
|
/**
|
|
4698
|
-
*
|
|
4915
|
+
*
|
|
4916
|
+
* @type {string}
|
|
4917
|
+
* @memberof WikiPage
|
|
4699
4918
|
*/
|
|
4700
|
-
|
|
4919
|
+
url?: string | null;
|
|
4701
4920
|
/**
|
|
4702
|
-
*
|
|
4921
|
+
*
|
|
4922
|
+
* @type {string}
|
|
4923
|
+
* @memberof WikiPage
|
|
4703
4924
|
*/
|
|
4704
|
-
|
|
4925
|
+
topImage?: string | null;
|
|
4705
4926
|
/**
|
|
4706
|
-
*
|
|
4927
|
+
*
|
|
4928
|
+
* @type {string}
|
|
4929
|
+
* @memberof WikiPage
|
|
4707
4930
|
*/
|
|
4708
|
-
|
|
4931
|
+
wikidataId?: string | null;
|
|
4709
4932
|
/**
|
|
4710
|
-
*
|
|
4933
|
+
*
|
|
4934
|
+
* @type {Array<WikidataLabelHolder>}
|
|
4935
|
+
* @memberof WikiPage
|
|
4711
4936
|
*/
|
|
4712
|
-
|
|
4937
|
+
wikidataInstanceOf?: Array<WikidataLabelHolder> | null;
|
|
4713
4938
|
/**
|
|
4714
|
-
*
|
|
4939
|
+
*
|
|
4940
|
+
* @type {Array<string>}
|
|
4941
|
+
* @memberof WikiPage
|
|
4715
4942
|
*/
|
|
4716
|
-
|
|
4943
|
+
redirectTitles?: Array<string> | null;
|
|
4717
4944
|
/**
|
|
4718
|
-
*
|
|
4945
|
+
*
|
|
4946
|
+
* @type {string}
|
|
4947
|
+
* @memberof WikiPage
|
|
4719
4948
|
*/
|
|
4720
|
-
|
|
4949
|
+
summary?: string | null;
|
|
4721
4950
|
/**
|
|
4722
|
-
*
|
|
4951
|
+
*
|
|
4952
|
+
* @type {Array<WikiPageSectionHolder>}
|
|
4953
|
+
* @memberof WikiPage
|
|
4723
4954
|
*/
|
|
4724
|
-
|
|
4955
|
+
sections?: Array<WikiPageSectionHolder> | null;
|
|
4725
4956
|
/**
|
|
4726
|
-
*
|
|
4957
|
+
*
|
|
4958
|
+
* @type {Array<string>}
|
|
4959
|
+
* @memberof WikiPage
|
|
4727
4960
|
*/
|
|
4728
|
-
|
|
4961
|
+
categories?: Array<string> | null;
|
|
4729
4962
|
/**
|
|
4730
|
-
*
|
|
4963
|
+
*
|
|
4964
|
+
* @type {Array<string>}
|
|
4965
|
+
* @memberof WikiPage
|
|
4731
4966
|
*/
|
|
4732
|
-
|
|
4967
|
+
externalLinks?: Array<string> | null;
|
|
4733
4968
|
/**
|
|
4734
|
-
*
|
|
4969
|
+
*
|
|
4970
|
+
* @type {Array<string>}
|
|
4971
|
+
* @memberof WikiPage
|
|
4735
4972
|
*/
|
|
4736
|
-
|
|
4973
|
+
references?: Array<string> | null;
|
|
4737
4974
|
/**
|
|
4738
|
-
*
|
|
4975
|
+
*
|
|
4976
|
+
* @type {number}
|
|
4977
|
+
* @memberof WikiPage
|
|
4739
4978
|
*/
|
|
4740
|
-
|
|
4741
|
-
|
|
4742
|
-
|
|
4979
|
+
pageviews?: number | null;
|
|
4980
|
+
}
|
|
4981
|
+
/**
|
|
4982
|
+
* Check if a given object implements the WikiPage interface.
|
|
4983
|
+
*/
|
|
4984
|
+
declare function instanceOfWikiPage(value: object): value is WikiPage;
|
|
4985
|
+
declare function WikiPageFromJSON(json: any): WikiPage;
|
|
4986
|
+
declare function WikiPageFromJSONTyped(json: any, ignoreDiscriminator: boolean): WikiPage;
|
|
4987
|
+
declare function WikiPageToJSON(json: any): WikiPage;
|
|
4988
|
+
declare function WikiPageToJSONTyped(value?: WikiPage | null, ignoreDiscriminator?: boolean): any;
|
|
4989
|
+
|
|
4990
|
+
/**
|
|
4991
|
+
* Perigon API
|
|
4992
|
+
* The Perigon API provides access to comprehensive news and web content data. To use the API, simply sign up for a Perigon Business Solutions account to obtain your API key. Your available features may vary based on your plan. See the Authentication section for details on how to use your API key.
|
|
4993
|
+
*
|
|
4994
|
+
* The version of the OpenAPI document: 1.0.0
|
|
4995
|
+
* Contact: data@perigon.io
|
|
4996
|
+
*
|
|
4997
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
4998
|
+
* https://openapi-generator.tech
|
|
4999
|
+
* Do not edit the class manually.
|
|
5000
|
+
*/
|
|
5001
|
+
/**
|
|
5002
|
+
* Complex filter structure for Wikipedia page searches that supports nested logical operations (AND, OR, NOT) and multiple filtering criteria.
|
|
5003
|
+
* @export
|
|
5004
|
+
* @interface WikipediaSearchFilter
|
|
5005
|
+
*/
|
|
5006
|
+
interface WikipediaSearchFilter {
|
|
5007
|
+
/**
|
|
5008
|
+
* Filter by specific Perigon page identifiers. Accepts either a single ID or an array of IDs. Returns only pages matching these IDs.
|
|
5009
|
+
* @type {Array<string>}
|
|
5010
|
+
* @memberof WikipediaSearchFilter
|
|
5011
|
+
*/
|
|
5012
|
+
pageId?: Array<string> | null;
|
|
5013
|
+
/**
|
|
5014
|
+
* Filter by specific section identifiers. Accepts either a single ID or an array of IDs. Returns only pages containing these sections.
|
|
5015
|
+
* @type {Array<string>}
|
|
5016
|
+
* @memberof WikipediaSearchFilter
|
|
5017
|
+
*/
|
|
5018
|
+
sectionId?: Array<string> | null;
|
|
5019
|
+
/**
|
|
5020
|
+
* Filter by specific Wikipedia page identifiers. Accepts either a single ID or an array of IDs. Returns only pages matching these IDs.
|
|
5021
|
+
* @type {Array<number>}
|
|
5022
|
+
* @memberof WikipediaSearchFilter
|
|
5023
|
+
*/
|
|
5024
|
+
wikiPageId?: Array<number> | null;
|
|
5025
|
+
/**
|
|
5026
|
+
* Filter by specific Perigon page revision identifiers. Accepts either a single ID or an array of IDs. Returns only pages matching these IDs.
|
|
5027
|
+
* @type {Array<number>}
|
|
5028
|
+
* @memberof WikipediaSearchFilter
|
|
5029
|
+
*/
|
|
5030
|
+
wikiRevisionId?: Array<number> | null;
|
|
5031
|
+
/**
|
|
5032
|
+
* Filter by specific Wikipedia project codes. Returns only pages matching these projects.
|
|
5033
|
+
* @type {Array<string>}
|
|
5034
|
+
* @memberof WikipediaSearchFilter
|
|
5035
|
+
*/
|
|
5036
|
+
wikiCode?: Array<string> | null;
|
|
5037
|
+
/**
|
|
5038
|
+
* Filter by specific Wikipedia namespaces. Returns only pages matching these namespaces.
|
|
5039
|
+
* @type {Array<number>}
|
|
5040
|
+
* @memberof WikipediaSearchFilter
|
|
5041
|
+
*/
|
|
5042
|
+
wikiNamespace?: Array<number> | null;
|
|
5043
|
+
/**
|
|
5044
|
+
* Filter by specific Wikidata entity IDs. Returns only pages whose Wikidata entities match those ids.
|
|
5045
|
+
* @type {Array<string>}
|
|
5046
|
+
* @memberof WikipediaSearchFilter
|
|
5047
|
+
*/
|
|
5048
|
+
wikidataId?: Array<string> | null;
|
|
5049
|
+
/**
|
|
5050
|
+
* Filter by specific Wikidata entity IDs. Returns only pages whose Wikidata entities are instances of provided ids.
|
|
5051
|
+
* @type {Array<string>}
|
|
5052
|
+
* @memberof WikipediaSearchFilter
|
|
5053
|
+
*/
|
|
5054
|
+
wikidataInstanceOfId?: Array<string> | null;
|
|
5055
|
+
/**
|
|
5056
|
+
* Filter by specific Wikidata entity labels. Returns only pages whose Wikidata entities are instances of these labels.
|
|
5057
|
+
* @type {Array<string>}
|
|
5058
|
+
* @memberof WikipediaSearchFilter
|
|
5059
|
+
*/
|
|
5060
|
+
wikidataInstanceOfLabel?: Array<string> | null;
|
|
5061
|
+
/**
|
|
5062
|
+
* Adds additional AND filter objects. These objects must be of the same type as the original filter object and will be combined with the existing filter using the AND logical operator.
|
|
5063
|
+
* @type {Array<WikipediaSearchFilter>}
|
|
5064
|
+
* @memberof WikipediaSearchFilter
|
|
5065
|
+
*/
|
|
5066
|
+
aND?: Array<WikipediaSearchFilter> | null;
|
|
5067
|
+
/**
|
|
5068
|
+
* Adds additional OR filter objects. These objects must be of the same type as the original filter object and will be combined with the existing filter using the OR logical operator.
|
|
5069
|
+
* @type {Array<WikipediaSearchFilter>}
|
|
5070
|
+
* @memberof WikipediaSearchFilter
|
|
5071
|
+
*/
|
|
5072
|
+
oR?: Array<WikipediaSearchFilter> | null;
|
|
5073
|
+
/**
|
|
5074
|
+
* A filter object for logical NOT operations
|
|
5075
|
+
* @type {Array<WikipediaSearchFilter>}
|
|
5076
|
+
* @memberof WikipediaSearchFilter
|
|
5077
|
+
*/
|
|
5078
|
+
nOT?: Array<WikipediaSearchFilter> | null;
|
|
5079
|
+
}
|
|
5080
|
+
/**
|
|
5081
|
+
* Check if a given object implements the WikipediaSearchFilter interface.
|
|
5082
|
+
*/
|
|
5083
|
+
declare function instanceOfWikipediaSearchFilter(value: object): value is WikipediaSearchFilter;
|
|
5084
|
+
declare function WikipediaSearchFilterFromJSON(json: any): WikipediaSearchFilter;
|
|
5085
|
+
declare function WikipediaSearchFilterFromJSONTyped(json: any, ignoreDiscriminator: boolean): WikipediaSearchFilter;
|
|
5086
|
+
declare function WikipediaSearchFilterToJSON(json: any): WikipediaSearchFilter;
|
|
5087
|
+
declare function WikipediaSearchFilterToJSONTyped(value?: WikipediaSearchFilter | null, ignoreDiscriminator?: boolean): any;
|
|
5088
|
+
|
|
5089
|
+
/**
|
|
5090
|
+
* Perigon API
|
|
5091
|
+
* The Perigon API provides access to comprehensive news and web content data. To use the API, simply sign up for a Perigon Business Solutions account to obtain your API key. Your available features may vary based on your plan. See the Authentication section for details on how to use your API key.
|
|
5092
|
+
*
|
|
5093
|
+
* The version of the OpenAPI document: 1.0.0
|
|
5094
|
+
* Contact: data@perigon.io
|
|
5095
|
+
*
|
|
5096
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
5097
|
+
* https://openapi-generator.tech
|
|
5098
|
+
* Do not edit the class manually.
|
|
5099
|
+
*/
|
|
5100
|
+
|
|
5101
|
+
/**
|
|
5102
|
+
*
|
|
5103
|
+
* @export
|
|
5104
|
+
* @interface WikipediaSearchParams
|
|
5105
|
+
*/
|
|
5106
|
+
interface WikipediaSearchParams {
|
|
5107
|
+
/**
|
|
5108
|
+
* Natural language query to search the Wikipedia pages database
|
|
5109
|
+
* @type {string}
|
|
5110
|
+
* @memberof WikipediaSearchParams
|
|
5111
|
+
*/
|
|
5112
|
+
prompt: string;
|
|
5113
|
+
/**
|
|
5114
|
+
*
|
|
5115
|
+
* @type {WikipediaSearchFilter}
|
|
5116
|
+
* @memberof WikipediaSearchParams
|
|
5117
|
+
*/
|
|
5118
|
+
filter?: WikipediaSearchFilter;
|
|
5119
|
+
/**
|
|
5120
|
+
* 'wikiRevisionFrom' filter, will search pages modified after the specified date, the date could be passed as ISO or 'yyyy-mm-dd'. Date time in ISO format, ie. 2024-01-01T00:00:00.
|
|
5121
|
+
* @type {Date}
|
|
5122
|
+
* @memberof WikipediaSearchParams
|
|
5123
|
+
*/
|
|
5124
|
+
wikiRevisionFrom?: Date | null;
|
|
5125
|
+
/**
|
|
5126
|
+
* 'wikiRevisionFrom' filter, will search pages modified before the specified date, the date could be passed as ISO or 'yyyy-mm-dd'. Date time in ISO format, ie. 2024-01-01T00:00:00.
|
|
5127
|
+
* @type {Date}
|
|
5128
|
+
* @memberof WikipediaSearchParams
|
|
5129
|
+
*/
|
|
5130
|
+
wikiRevisionTo?: Date | null;
|
|
5131
|
+
/**
|
|
5132
|
+
* 'pageviewsFrom' filter, will search pages with at least the provided number of views per day.
|
|
5133
|
+
* @type {number}
|
|
5134
|
+
* @memberof WikipediaSearchParams
|
|
5135
|
+
*/
|
|
5136
|
+
pageviewsFrom?: number | null;
|
|
5137
|
+
/**
|
|
5138
|
+
* 'pageviewsFrom' filter, will search pages with at most the provided number of views per day.
|
|
5139
|
+
* @type {number}
|
|
5140
|
+
* @memberof WikipediaSearchParams
|
|
5141
|
+
*/
|
|
5142
|
+
pageviewsTo?: number | null;
|
|
5143
|
+
/**
|
|
5144
|
+
* The number of items per page.
|
|
5145
|
+
* @type {number}
|
|
5146
|
+
* @memberof WikipediaSearchParams
|
|
5147
|
+
*/
|
|
5148
|
+
size?: number | null;
|
|
5149
|
+
/**
|
|
5150
|
+
* The page number to retrieve.
|
|
5151
|
+
* @type {number}
|
|
5152
|
+
* @memberof WikipediaSearchParams
|
|
5153
|
+
*/
|
|
5154
|
+
page?: number | null;
|
|
5155
|
+
}
|
|
5156
|
+
/**
|
|
5157
|
+
* Check if a given object implements the WikipediaSearchParams interface.
|
|
5158
|
+
*/
|
|
5159
|
+
declare function instanceOfWikipediaSearchParams(value: object): value is WikipediaSearchParams;
|
|
5160
|
+
declare function WikipediaSearchParamsFromJSON(json: any): WikipediaSearchParams;
|
|
5161
|
+
declare function WikipediaSearchParamsFromJSONTyped(json: any, ignoreDiscriminator: boolean): WikipediaSearchParams;
|
|
5162
|
+
declare function WikipediaSearchParamsToJSON(json: any): WikipediaSearchParams;
|
|
5163
|
+
declare function WikipediaSearchParamsToJSONTyped(value?: WikipediaSearchParams | null, ignoreDiscriminator?: boolean): any;
|
|
5164
|
+
|
|
5165
|
+
/**
|
|
5166
|
+
* Perigon API
|
|
5167
|
+
* The Perigon API provides access to comprehensive news and web content data. To use the API, simply sign up for a Perigon Business Solutions account to obtain your API key. Your available features may vary based on your plan. See the Authentication section for details on how to use your API key.
|
|
5168
|
+
*
|
|
5169
|
+
* The version of the OpenAPI document: 1.0.0
|
|
5170
|
+
* Contact: data@perigon.io
|
|
5171
|
+
*
|
|
5172
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
5173
|
+
* https://openapi-generator.tech
|
|
5174
|
+
* Do not edit the class manually.
|
|
5175
|
+
*/
|
|
5176
|
+
|
|
5177
|
+
/**
|
|
5178
|
+
* Wikipedia search result
|
|
5179
|
+
* @export
|
|
5180
|
+
* @interface WikipediaSearchResult
|
|
5181
|
+
*/
|
|
5182
|
+
interface WikipediaSearchResult {
|
|
5183
|
+
/**
|
|
5184
|
+
*
|
|
5185
|
+
* @type {number}
|
|
5186
|
+
* @memberof WikipediaSearchResult
|
|
5187
|
+
*/
|
|
5188
|
+
status: number;
|
|
5189
|
+
/**
|
|
5190
|
+
*
|
|
5191
|
+
* @type {number}
|
|
5192
|
+
* @memberof WikipediaSearchResult
|
|
5193
|
+
*/
|
|
5194
|
+
numResults: number;
|
|
5195
|
+
/**
|
|
5196
|
+
*
|
|
5197
|
+
* @type {Array<WikiPage>}
|
|
5198
|
+
* @memberof WikipediaSearchResult
|
|
5199
|
+
*/
|
|
5200
|
+
results: Array<WikiPage>;
|
|
5201
|
+
}
|
|
5202
|
+
/**
|
|
5203
|
+
* Check if a given object implements the WikipediaSearchResult interface.
|
|
5204
|
+
*/
|
|
5205
|
+
declare function instanceOfWikipediaSearchResult(value: object): value is WikipediaSearchResult;
|
|
5206
|
+
declare function WikipediaSearchResultFromJSON(json: any): WikipediaSearchResult;
|
|
5207
|
+
declare function WikipediaSearchResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): WikipediaSearchResult;
|
|
5208
|
+
declare function WikipediaSearchResultToJSON(json: any): WikipediaSearchResult;
|
|
5209
|
+
declare function WikipediaSearchResultToJSONTyped(value?: WikipediaSearchResult | null, ignoreDiscriminator?: boolean): any;
|
|
5210
|
+
|
|
5211
|
+
/**
|
|
5212
|
+
* Perigon API
|
|
5213
|
+
* The Perigon API provides access to comprehensive news and web content data. To use the API, simply sign up for a Perigon Business Solutions account to obtain your API key. Your available features may vary based on your plan. See the Authentication section for details on how to use your API key.
|
|
5214
|
+
*
|
|
5215
|
+
* The version of the OpenAPI document: 1.0.0
|
|
5216
|
+
* Contact: data@perigon.io
|
|
5217
|
+
*
|
|
5218
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
5219
|
+
* https://openapi-generator.tech
|
|
5220
|
+
* Do not edit the class manually.
|
|
5221
|
+
*/
|
|
5222
|
+
|
|
5223
|
+
/**
|
|
5224
|
+
* Wikipedia vector search result
|
|
5225
|
+
* @export
|
|
5226
|
+
* @interface WikipediaVectorSearchResult
|
|
5227
|
+
*/
|
|
5228
|
+
interface WikipediaVectorSearchResult {
|
|
5229
|
+
/**
|
|
5230
|
+
*
|
|
5231
|
+
* @type {number}
|
|
5232
|
+
* @memberof WikipediaVectorSearchResult
|
|
5233
|
+
*/
|
|
5234
|
+
status: number;
|
|
5235
|
+
/**
|
|
5236
|
+
*
|
|
5237
|
+
* @type {Array<ScoredDataWikiData>}
|
|
5238
|
+
* @memberof WikipediaVectorSearchResult
|
|
5239
|
+
*/
|
|
5240
|
+
results: Array<ScoredDataWikiData>;
|
|
5241
|
+
}
|
|
5242
|
+
/**
|
|
5243
|
+
* Check if a given object implements the WikipediaVectorSearchResult interface.
|
|
5244
|
+
*/
|
|
5245
|
+
declare function instanceOfWikipediaVectorSearchResult(value: object): value is WikipediaVectorSearchResult;
|
|
5246
|
+
declare function WikipediaVectorSearchResultFromJSON(json: any): WikipediaVectorSearchResult;
|
|
5247
|
+
declare function WikipediaVectorSearchResultFromJSONTyped(json: any, ignoreDiscriminator: boolean): WikipediaVectorSearchResult;
|
|
5248
|
+
declare function WikipediaVectorSearchResultToJSON(json: any): WikipediaVectorSearchResult;
|
|
5249
|
+
declare function WikipediaVectorSearchResultToJSONTyped(value?: WikipediaVectorSearchResult | null, ignoreDiscriminator?: boolean): any;
|
|
5250
|
+
|
|
5251
|
+
/**
|
|
5252
|
+
* Perigon API
|
|
5253
|
+
* The Perigon API provides access to comprehensive news and web content data. To use the API, simply sign up for a Perigon Business Solutions account to obtain your API key. Your available features may vary based on your plan. See the Authentication section for details on how to use your API key.
|
|
5254
|
+
*
|
|
5255
|
+
* The version of the OpenAPI document: 1.0.0
|
|
5256
|
+
* Contact: data@perigon.io
|
|
5257
|
+
*
|
|
5258
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
5259
|
+
* https://openapi-generator.tech
|
|
5260
|
+
* Do not edit the class manually.
|
|
5261
|
+
*/
|
|
5262
|
+
|
|
5263
|
+
interface GetJournalistByIdRequest {
|
|
5264
|
+
/**
|
|
5265
|
+
* Parameter id
|
|
5266
|
+
* @required
|
|
5267
|
+
*/
|
|
5268
|
+
id: string;
|
|
5269
|
+
}
|
|
5270
|
+
interface SearchArticlesRequest {
|
|
5271
|
+
/**
|
|
5272
|
+
* Primary search query for filtering articles based on their title, description, and content. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching.
|
|
5273
|
+
*/
|
|
5274
|
+
q?: string;
|
|
5275
|
+
/**
|
|
5276
|
+
* Search specifically within article headlines/titles. Supports Boolean operators, exact phrases with quotes, and wildcards for matching title variations.
|
|
5277
|
+
*/
|
|
5278
|
+
title?: string;
|
|
5279
|
+
/**
|
|
5280
|
+
* Search within article description fields. Supports Boolean expressions, exact phrase matching with quotes, and wildcards for flexible pattern matching.
|
|
5281
|
+
*/
|
|
5282
|
+
desc?: string;
|
|
5283
|
+
/**
|
|
5284
|
+
* Search within the full article body content. Supports Boolean logic, exact phrase matching with quotes, and wildcards for comprehensive content searching.
|
|
5285
|
+
*/
|
|
5286
|
+
content?: string;
|
|
5287
|
+
/**
|
|
5288
|
+
* Search within article URLs to find content from specific website sections or domains. Supports wildcards (* and ?) for partial URL matching.
|
|
5289
|
+
*/
|
|
5290
|
+
url?: string;
|
|
5291
|
+
/**
|
|
5292
|
+
* Retrieve specific news articles by their unique article identifiers. Multiple IDs can be provided to return a collection of specific articles.
|
|
5293
|
+
*/
|
|
5294
|
+
articleId?: Array<string>;
|
|
5295
|
+
/**
|
|
5296
|
+
* Filter results to only show content within a specific related content cluster. Returns articles grouped together as part of Perigon Stories based on topic relevance.
|
|
5297
|
+
*/
|
|
5298
|
+
clusterId?: Array<string>;
|
|
5299
|
+
/**
|
|
5300
|
+
* Determines the article sorting order. Options include relevance (default), date/pubDate (newest publication date first), reverseDate (oldest publication date first), addDate (newest ingestion date first), reverseAddDate (oldest ingestion date first), and refreshDate (most recently updated in system first, often identical to addDate).
|
|
5301
|
+
*/
|
|
5302
|
+
sortBy?: AllEndpointSortBy;
|
|
5303
|
+
/**
|
|
5304
|
+
* The specific page of results to retrieve in the paginated response. Starts at 0.
|
|
5305
|
+
*/
|
|
5306
|
+
page?: number;
|
|
5307
|
+
/**
|
|
5308
|
+
* The number of articles to return per page in the paginated response.
|
|
5309
|
+
*/
|
|
5310
|
+
size?: number;
|
|
5311
|
+
/**
|
|
5312
|
+
* Filter for articles published after this date. Accepts ISO 8601 format (e.g., 2023-03-01T00:00:00) or yyyy-mm-dd format.
|
|
5313
|
+
*/
|
|
5314
|
+
from?: Date;
|
|
5315
|
+
/**
|
|
5316
|
+
* Filter for articles published before this date. Accepts ISO 8601 format (e.g., 2022-02-01T23:59:59) or yyyy-mm-dd format.
|
|
5317
|
+
*/
|
|
5318
|
+
to?: Date;
|
|
5319
|
+
/**
|
|
5320
|
+
* Filter for articles added to Perigon\'s system after this date. Accepts ISO 8601 format (e.g., 2022-02-01T00:00:00) or yyyy-mm-dd format.
|
|
5321
|
+
*/
|
|
5322
|
+
addDateFrom?: Date;
|
|
5323
|
+
/**
|
|
5324
|
+
* Filter for articles added to Perigon\'s system before this date. Accepts ISO 8601 format (e.g., 2022-02-01T23:59:59) or yyyy-mm-dd format.
|
|
5325
|
+
*/
|
|
5326
|
+
addDateTo?: Date;
|
|
5327
|
+
/**
|
|
5328
|
+
* Filter for articles refreshed/updated in Perigon\'s system after this date. In most cases yields similar results to addDateFrom but can differ for updated content. Accepts ISO 8601 format (e.g., 2022-02-01T00:00:00) or yyyy-mm-dd format.
|
|
5329
|
+
*/
|
|
5330
|
+
refreshDateFrom?: Date;
|
|
5331
|
+
/**
|
|
5332
|
+
* Filter for articles refreshed/updated in Perigon\'s system before this date. In most cases yields similar results to addDateTo but can differ for updated content. Accepts ISO 8601 format (e.g., 2022-02-01T23:59:59) or yyyy-mm-dd format.
|
|
5333
|
+
*/
|
|
5334
|
+
refreshDateTo?: Date;
|
|
5335
|
+
/**
|
|
5336
|
+
* Filter articles by their primary medium type. Accepts Article for written content or Video for video-based stories. Multiple values create an OR filter.
|
|
5337
|
+
*/
|
|
5338
|
+
medium?: Array<string>;
|
|
5339
|
+
/**
|
|
5340
|
+
* Filter articles by specific publisher domains or subdomains. Supports wildcards (* and ?) for pattern matching (e.g., *.cnn.com). Multiple values create an OR filter.
|
|
5341
|
+
*/
|
|
5342
|
+
source?: Array<string>;
|
|
5343
|
+
/**
|
|
5344
|
+
* Filter articles using Perigon\'s curated publisher bundles (e.g., top100, top25crypto). Multiple values create an OR filter to include articles from any of the specified bundles.
|
|
5345
|
+
*/
|
|
5346
|
+
sourceGroup?: Array<string>;
|
|
5347
|
+
/**
|
|
5348
|
+
* Exclude articles from specified Perigon source groups. Multiple values create an AND-exclude filter, removing content from publishers in any of the specified bundles (e.g., top10, top100).
|
|
4743
5349
|
*/
|
|
4744
5350
|
excludeSourceGroup?: Array<string>;
|
|
4745
5351
|
/**
|
|
4746
|
-
*
|
|
5352
|
+
* Exclude articles from specific publisher domains or subdomains. Supports wildcards (* and ?) for pattern matching (e.g., *.cnn.com). Multiple values create an AND-exclude filter.
|
|
4747
5353
|
*/
|
|
4748
5354
|
excludeSource?: Array<string>;
|
|
4749
5355
|
/**
|
|
@@ -4751,71 +5357,71 @@ interface SearchArticlesRequest {
|
|
|
4751
5357
|
*/
|
|
4752
5358
|
paywall?: boolean;
|
|
4753
5359
|
/**
|
|
4754
|
-
*
|
|
5360
|
+
* Filter articles by author bylines. Works as an exact match for each author name provided. Multiple values create an OR filter to find articles by any of the specified authors.
|
|
4755
5361
|
*/
|
|
4756
5362
|
byline?: Array<string>;
|
|
4757
5363
|
/**
|
|
4758
|
-
*
|
|
5364
|
+
* Filter articles by specific author names. Works as an exact match for each name. Multiple values create an OR filter to find articles by any of the specified authors.
|
|
4759
5365
|
*/
|
|
4760
5366
|
author?: Array<string>;
|
|
4761
5367
|
/**
|
|
4762
|
-
*
|
|
5368
|
+
* Exclude articles written by specific authors. Any article with an author name matching an entry in this list will be omitted from results. Multiple values create an AND-exclude filter.
|
|
4763
5369
|
*/
|
|
4764
5370
|
excludeAuthor?: Array<string>;
|
|
4765
5371
|
/**
|
|
4766
|
-
* Filter by
|
|
5372
|
+
* Filter by unique journalist identifiers which can be found through the Journalist API or in the matchedAuthors field. Multiple values create an OR filter.
|
|
4767
5373
|
*/
|
|
4768
5374
|
journalistId?: Array<string>;
|
|
4769
5375
|
/**
|
|
4770
|
-
*
|
|
5376
|
+
* Exclude articles written by specific journalists identified by their unique IDs. Multiple values create an AND-exclude filter.
|
|
4771
5377
|
*/
|
|
4772
5378
|
excludeJournalistId?: Array<string>;
|
|
4773
5379
|
/**
|
|
4774
|
-
*
|
|
5380
|
+
* Filter articles by their language using ISO-639 two-letter codes (e.g., en, es, fr). Multiple values create an OR filter.
|
|
4775
5381
|
*/
|
|
4776
5382
|
language?: Array<string>;
|
|
4777
5383
|
/**
|
|
4778
|
-
*
|
|
5384
|
+
* Exclude articles in specific languages using ISO-639 two-letter codes. Multiple values create an AND-exclude filter.
|
|
4779
5385
|
*/
|
|
4780
5386
|
excludeLanguage?: Array<string>;
|
|
4781
5387
|
/**
|
|
4782
|
-
* Expand
|
|
5388
|
+
* Expand search to include translated content fields for non-English articles. When true, searches translated title, description, and content fields.
|
|
4783
5389
|
*/
|
|
4784
5390
|
searchTranslation?: boolean;
|
|
4785
5391
|
/**
|
|
4786
|
-
*
|
|
5392
|
+
* Filter articles by editorial labels such as Opinion, Paid-news, Non-news, Fact Check, or Press Release. Multiple values create an OR filter.
|
|
4787
5393
|
*/
|
|
4788
5394
|
label?: Array<string>;
|
|
4789
5395
|
/**
|
|
4790
|
-
* Exclude
|
|
5396
|
+
* Exclude articles with specific editorial labels. Multiple values create an AND-exclude filter, removing all content with any of these labels.
|
|
4791
5397
|
*/
|
|
4792
5398
|
excludeLabel?: Array<string>;
|
|
4793
5399
|
/**
|
|
4794
|
-
* Filter by
|
|
5400
|
+
* Filter by broad content categories such as Politics, Tech, Sports, Business, or Finance. Use \'none\' to find uncategorized articles. Multiple values create an OR filter.
|
|
4795
5401
|
*/
|
|
4796
5402
|
category?: Array<string>;
|
|
4797
5403
|
/**
|
|
4798
|
-
*
|
|
5404
|
+
* Exclude articles with specific categories. Multiple values create an AND-exclude filter, removing all content with any of these categories.
|
|
4799
5405
|
*/
|
|
4800
5406
|
excludeCategory?: Array<string>;
|
|
4801
5407
|
/**
|
|
4802
|
-
*
|
|
5408
|
+
* Filter by specific topics such as Markets, Crime, Cryptocurrency, or College Sports. Topics are more granular than categories, and articles can have multiple topics. Use the /topics endpoint for a complete list of available topics. Multiple values create an OR filter.
|
|
4803
5409
|
*/
|
|
4804
5410
|
topic?: Array<string>;
|
|
4805
5411
|
/**
|
|
4806
|
-
*
|
|
5412
|
+
* Exclude articles with specific topics. Multiple values create an AND-exclude filter, removing all content with any of these topics.
|
|
4807
5413
|
*/
|
|
4808
5414
|
excludeTopic?: Array<string>;
|
|
4809
5415
|
/**
|
|
4810
|
-
* Returns only articles that
|
|
5416
|
+
* Returns only articles that contain links to the specified URL pattern. Matches against the \'links\' field in article responses.
|
|
4811
5417
|
*/
|
|
4812
5418
|
linkTo?: string;
|
|
4813
5419
|
/**
|
|
4814
|
-
*
|
|
5420
|
+
* Controls whether to include reprinted content in results. When true (default), shows syndicated articles from wire services like AP or Reuters that appear on multiple sites.
|
|
4815
5421
|
*/
|
|
4816
5422
|
showReprints?: boolean;
|
|
4817
5423
|
/**
|
|
4818
|
-
*
|
|
5424
|
+
* Returns all articles in a specific reprint group, including the original article and all its known reprints. Use when you want to see all versions of the same content.
|
|
4819
5425
|
*/
|
|
4820
5426
|
reprintGroupId?: string;
|
|
4821
5427
|
/**
|
|
@@ -4843,7 +5449,7 @@ interface SearchArticlesRequest {
|
|
|
4843
5449
|
*/
|
|
4844
5450
|
county?: Array<string>;
|
|
4845
5451
|
/**
|
|
4846
|
-
* Excludes articles from specific counties or administrative divisions in the
|
|
5452
|
+
* Excludes articles from specific counties or administrative divisions in the search results. Accepts either a single county name or a list of county names. County names should match the format used in article metadata (e.g., \'Los Angeles County\', \'Cook County\'). This parameter allows for more granular geographic filter
|
|
4847
5453
|
*/
|
|
4848
5454
|
excludeCounty?: Array<string>;
|
|
4849
5455
|
/**
|
|
@@ -4903,43 +5509,43 @@ interface SearchArticlesRequest {
|
|
|
4903
5509
|
*/
|
|
4904
5510
|
sourceMaxDistance?: number;
|
|
4905
5511
|
/**
|
|
4906
|
-
*
|
|
5512
|
+
* Filter articles by Wikidata IDs of mentioned people. Refer to the /people endpoint for a complete list of tracked individuals.
|
|
4907
5513
|
*/
|
|
4908
5514
|
personWikidataId?: Array<string>;
|
|
4909
5515
|
/**
|
|
4910
|
-
*
|
|
5516
|
+
* Exclude articles mentioning people with specific Wikidata IDs. Creates an AND-exclude filter to remove content about these individuals. Uses precise identifiers to avoid name ambiguity.
|
|
4911
5517
|
*/
|
|
4912
5518
|
excludePersonWikidataId?: Array<string>;
|
|
4913
5519
|
/**
|
|
4914
|
-
*
|
|
5520
|
+
* Filter articles by exact person name matches. Does not support Boolean or complex logic. For available person entities, consult the /people endpoint.
|
|
4915
5521
|
*/
|
|
4916
5522
|
personName?: Array<string>;
|
|
4917
5523
|
/**
|
|
4918
|
-
*
|
|
5524
|
+
* Exclude articles mentioning specific people by name. Creates an AND-exclude filter to remove content about these individuals.
|
|
4919
5525
|
*/
|
|
4920
5526
|
excludePersonName?: Array<string>;
|
|
4921
5527
|
/**
|
|
4922
|
-
*
|
|
5528
|
+
* Filter articles by company identifiers. For a complete list of tracked companies, refer to the /companies endpoint.
|
|
4923
5529
|
*/
|
|
4924
5530
|
companyId?: Array<string>;
|
|
4925
5531
|
/**
|
|
4926
|
-
*
|
|
5532
|
+
* Exclude articles mentioning companies with specific identifiers. Creates an AND-exclude filter to remove content about these corporate entities.
|
|
4927
5533
|
*/
|
|
4928
5534
|
excludeCompanyId?: Array<string>;
|
|
4929
5535
|
/**
|
|
4930
|
-
*
|
|
5536
|
+
* Filter articles by company name mentions. Performs an exact match on company names.
|
|
4931
5537
|
*/
|
|
4932
5538
|
companyName?: string;
|
|
4933
5539
|
/**
|
|
4934
|
-
*
|
|
5540
|
+
* Filter articles by company domains (e.g., apple.com). For available company entities, consult the /companies endpoint.
|
|
4935
5541
|
*/
|
|
4936
5542
|
companyDomain?: Array<string>;
|
|
4937
5543
|
/**
|
|
4938
|
-
*
|
|
5544
|
+
* Exclude articles related to companies with specific domains. Creates an AND-exclude filter to remove content about these companies.
|
|
4939
5545
|
*/
|
|
4940
5546
|
excludeCompanyDomain?: Array<string>;
|
|
4941
5547
|
/**
|
|
4942
|
-
*
|
|
5548
|
+
* Filter articles by company stock symbols. For available company entities and their symbols, consult the /companies endpoint.
|
|
4943
5549
|
*/
|
|
4944
5550
|
companySymbol?: Array<string>;
|
|
4945
5551
|
/**
|
|
@@ -4951,313 +5557,341 @@ interface SearchArticlesRequest {
|
|
|
4951
5557
|
*/
|
|
4952
5558
|
showNumResults?: boolean;
|
|
4953
5559
|
/**
|
|
4954
|
-
*
|
|
5560
|
+
* Filter articles with a positive sentiment score greater than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger positive tone.
|
|
4955
5561
|
*/
|
|
4956
5562
|
positiveSentimentFrom?: number;
|
|
4957
5563
|
/**
|
|
4958
|
-
*
|
|
5564
|
+
* Filter articles with a positive sentiment score less than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger positive tone.
|
|
4959
5565
|
*/
|
|
4960
5566
|
positiveSentimentTo?: number;
|
|
4961
5567
|
/**
|
|
4962
|
-
*
|
|
5568
|
+
* Filter articles with a neutral sentiment score greater than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger neutral tone.
|
|
4963
5569
|
*/
|
|
4964
5570
|
neutralSentimentFrom?: number;
|
|
4965
5571
|
/**
|
|
4966
|
-
*
|
|
5572
|
+
* Filter articles with a neutral sentiment score less than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger neutral tone.
|
|
4967
5573
|
*/
|
|
4968
5574
|
neutralSentimentTo?: number;
|
|
4969
5575
|
/**
|
|
4970
|
-
*
|
|
5576
|
+
* Filter articles with a negative sentiment score greater than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger negative tone.
|
|
4971
5577
|
*/
|
|
4972
5578
|
negativeSentimentFrom?: number;
|
|
4973
5579
|
/**
|
|
4974
|
-
*
|
|
5580
|
+
* Filter articles with a negative sentiment score less than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger negative tone.
|
|
4975
5581
|
*/
|
|
4976
5582
|
negativeSentimentTo?: number;
|
|
4977
5583
|
/**
|
|
4978
|
-
* Filters by Google Content Categories. This field will accept 1 or more categories, must pass the full name of the category. Example: taxonomy=/Finance/Banking/Other, /Finance/Investing/Funds
|
|
5584
|
+
* Filters by Google Content Categories. This field will accept 1 or more categories, must pass the full name of the category. Example: taxonomy=/Finance/Banking/Other, /Finance/Investing/Funds. [Full list](https://cloud.google.com/natural-language/docs/categories)
|
|
4979
5585
|
*/
|
|
4980
5586
|
taxonomy?: Array<string>;
|
|
4981
5587
|
/**
|
|
4982
5588
|
* Filters by Google Content Categories. This field will filter by the category prefix only. Example: prefixTaxonomy=/Finance
|
|
4983
5589
|
*/
|
|
4984
5590
|
prefixTaxonomy?: string;
|
|
5591
|
+
/**
|
|
5592
|
+
* When set to true, enables text highlighting in search results.
|
|
5593
|
+
*/
|
|
5594
|
+
showHighlighting?: boolean;
|
|
5595
|
+
/**
|
|
5596
|
+
* Specifies the size in characters of each highlighted text fragment. Defaults to 100 if not specified.
|
|
5597
|
+
*/
|
|
5598
|
+
highlightFragmentSize?: number;
|
|
5599
|
+
/**
|
|
5600
|
+
* Controls the maximum number of highlighted fragments to return per field.
|
|
5601
|
+
*/
|
|
5602
|
+
highlightNumFragments?: number;
|
|
5603
|
+
/**
|
|
5604
|
+
* Defines the HTML tag that appears before highlighted text. Defaults to \'<em>\' if not specified.
|
|
5605
|
+
*/
|
|
5606
|
+
highlightPreTag?: string;
|
|
5607
|
+
/**
|
|
5608
|
+
* Defines the HTML tag that appears after highlighted text. Defaults to \'</em>\' if not specified.
|
|
5609
|
+
*/
|
|
5610
|
+
highlightPostTag?: string;
|
|
5611
|
+
/**
|
|
5612
|
+
* Specifies a separate query for highlighting, allowing highlights based on terms different from the main search query. Example: main query \'q=climate change\' with \'highlightQ=renewable OR solar\' will highlight terms \'renewable\' and \'solar\' in results about climate change.
|
|
5613
|
+
*/
|
|
5614
|
+
highlightQ?: string;
|
|
4985
5615
|
}
|
|
4986
5616
|
interface SearchCompaniesRequest {
|
|
4987
5617
|
/**
|
|
4988
|
-
*
|
|
5618
|
+
* Filter by unique company identifiers. Multiple values create an OR filter.
|
|
4989
5619
|
*/
|
|
4990
5620
|
id?: Array<string>;
|
|
4991
5621
|
/**
|
|
4992
|
-
*
|
|
5622
|
+
* Filter by company stock ticker symbols (e.g., AAPL, MSFT, GOOGL). Multiple values create an OR filter.
|
|
4993
5623
|
*/
|
|
4994
5624
|
symbol?: Array<string>;
|
|
4995
5625
|
/**
|
|
4996
|
-
*
|
|
5626
|
+
* Filter by company domains or websites (e.g., apple.com, microsoft.com). Multiple values create an OR filter.
|
|
4997
5627
|
*/
|
|
4998
5628
|
domain?: Array<string>;
|
|
4999
5629
|
/**
|
|
5000
|
-
*
|
|
5630
|
+
* Filter by company headquarters country. Multiple values create an OR filter.
|
|
5001
5631
|
*/
|
|
5002
5632
|
country?: Array<string>;
|
|
5003
5633
|
/**
|
|
5004
|
-
*
|
|
5634
|
+
* Filter by stock exchange where companies are listed (e.g., NASDAQ, NYSE). Multiple values create an OR filter.
|
|
5005
5635
|
*/
|
|
5006
5636
|
exchange?: Array<string>;
|
|
5007
5637
|
/**
|
|
5008
|
-
*
|
|
5638
|
+
* Filter for companies with at least this many employees.
|
|
5009
5639
|
*/
|
|
5010
5640
|
numEmployeesFrom?: number;
|
|
5011
5641
|
/**
|
|
5012
|
-
*
|
|
5642
|
+
* Filter for companies with no more than this many employees.
|
|
5013
5643
|
*/
|
|
5014
5644
|
numEmployeesTo?: number;
|
|
5015
5645
|
/**
|
|
5016
|
-
*
|
|
5646
|
+
* Filter for companies that went public on or after this date. Accepts ISO 8601 format (e.g., 2023-01-01T00:00:00) or yyyy-mm-dd format.
|
|
5017
5647
|
*/
|
|
5018
5648
|
ipoFrom?: Date;
|
|
5019
5649
|
/**
|
|
5020
|
-
*
|
|
5650
|
+
* Filter for companies that went public on or before this date. Accepts ISO 8601 format (e.g., 2023-12-31T23:59:59) or yyyy-mm-dd format.
|
|
5021
5651
|
*/
|
|
5022
5652
|
ipoTo?: Date;
|
|
5023
5653
|
/**
|
|
5024
|
-
*
|
|
5654
|
+
* Primary search query for filtering companies across name, alternative names, domains, and ticker symbols. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching.
|
|
5025
5655
|
*/
|
|
5026
5656
|
q?: string;
|
|
5027
5657
|
/**
|
|
5028
|
-
* Search
|
|
5658
|
+
* Search within company names. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching.
|
|
5029
5659
|
*/
|
|
5030
5660
|
name?: string;
|
|
5031
5661
|
/**
|
|
5032
|
-
*
|
|
5662
|
+
* Filter by company industry classifications. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching.
|
|
5033
5663
|
*/
|
|
5034
5664
|
industry?: string;
|
|
5035
5665
|
/**
|
|
5036
|
-
*
|
|
5666
|
+
* Filter by company sector classifications. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching.
|
|
5037
5667
|
*/
|
|
5038
5668
|
sector?: string;
|
|
5039
5669
|
/**
|
|
5040
|
-
* The number of
|
|
5670
|
+
* The number of companies to return per page in the paginated response.
|
|
5041
5671
|
*/
|
|
5042
5672
|
size?: number;
|
|
5043
5673
|
/**
|
|
5044
|
-
* The page
|
|
5674
|
+
* The specific page of results to retrieve in the paginated response. Starts at 0.
|
|
5045
5675
|
*/
|
|
5046
5676
|
page?: number;
|
|
5047
5677
|
}
|
|
5048
|
-
interface
|
|
5678
|
+
interface SearchJournalistsRequest {
|
|
5049
5679
|
/**
|
|
5050
|
-
* Filter by journalist
|
|
5680
|
+
* Filter by unique journalist identifiers. Multiple values create an OR filter to find journalists matching any of the specified IDs.
|
|
5051
5681
|
*/
|
|
5052
5682
|
id?: Array<string>;
|
|
5053
5683
|
/**
|
|
5054
|
-
*
|
|
5684
|
+
* Primary search query for filtering journalists based on their name, title, and Twitter bio. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching.
|
|
5055
5685
|
*/
|
|
5056
5686
|
q?: string;
|
|
5057
5687
|
/**
|
|
5058
|
-
*
|
|
5688
|
+
* Search specifically within journalist names. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching.
|
|
5059
5689
|
*/
|
|
5060
5690
|
name?: string;
|
|
5061
5691
|
/**
|
|
5062
|
-
*
|
|
5692
|
+
* Filter journalists by their exact Twitter handle, without the @ symbol.
|
|
5063
5693
|
*/
|
|
5064
5694
|
twitter?: string;
|
|
5065
5695
|
/**
|
|
5066
|
-
* The number of
|
|
5696
|
+
* The number of journalists to return per page in the paginated response.
|
|
5067
5697
|
*/
|
|
5068
5698
|
size?: number;
|
|
5069
5699
|
/**
|
|
5070
|
-
* The page
|
|
5700
|
+
* The specific page of results to retrieve in the paginated response. Starts at 0.
|
|
5071
5701
|
*/
|
|
5072
5702
|
page?: number;
|
|
5073
5703
|
/**
|
|
5074
|
-
*
|
|
5704
|
+
* Filter journalists by the publisher domains they write for. Supports wildcards (* and ?) for pattern matching (e.g., *.cnn.com). Multiple values create an OR filter.
|
|
5075
5705
|
*/
|
|
5076
5706
|
source?: Array<string>;
|
|
5077
5707
|
/**
|
|
5078
|
-
*
|
|
5708
|
+
* Filter journalists by the topics they frequently cover. Multiple values create an OR filter to find journalists covering any of the specified topics.
|
|
5079
5709
|
*/
|
|
5080
5710
|
topic?: Array<string>;
|
|
5081
5711
|
/**
|
|
5082
|
-
* Filter by
|
|
5712
|
+
* Filter journalists by the content categories they typically write about (e.g., Politics, Tech, Sports, Business). Multiple values create an OR filter.
|
|
5083
5713
|
*/
|
|
5084
5714
|
category?: Array<string>;
|
|
5085
5715
|
/**
|
|
5086
|
-
* Filter journalists by
|
|
5716
|
+
* Filter journalists by the type of content they typically produce (e.g., Opinion, Paid-news, Non-news). Multiple values create an OR filter.
|
|
5087
5717
|
*/
|
|
5088
5718
|
label?: Array<string>;
|
|
5089
5719
|
/**
|
|
5090
|
-
*
|
|
5720
|
+
* Filter for journalists who publish at least this many articles per month. Used to identify more active journalists.
|
|
5091
5721
|
*/
|
|
5092
5722
|
minMonthlyPosts?: number;
|
|
5093
5723
|
/**
|
|
5094
|
-
*
|
|
5724
|
+
* Filter for journalists who publish no more than this many articles per month.
|
|
5095
5725
|
*/
|
|
5096
5726
|
maxMonthlyPosts?: number;
|
|
5097
5727
|
/**
|
|
5098
|
-
*
|
|
5728
|
+
* Filter journalists by countries they commonly cover in their reporting. Uses ISO 3166-1 alpha-2 two-letter country codes in lowercase (e.g., us, gb, jp). Multiple values create an OR filter.
|
|
5099
5729
|
*/
|
|
5100
5730
|
country?: Array<string>;
|
|
5101
5731
|
/**
|
|
5102
|
-
*
|
|
5732
|
+
* Filter for journalist profiles updated on or after this date. Accepts ISO 8601 format (e.g., 2023-03-01T00:00:00) or yyyy-mm-dd format.
|
|
5103
5733
|
*/
|
|
5104
5734
|
updatedAtFrom?: Date;
|
|
5105
5735
|
/**
|
|
5106
|
-
*
|
|
5736
|
+
* Filter for journalist profiles updated on or before this date. Accepts ISO 8601 format (e.g., 2023-03-01T23:59:59) or yyyy-mm-dd format.
|
|
5107
5737
|
*/
|
|
5108
5738
|
updatedAtTo?: Date;
|
|
5109
5739
|
/**
|
|
5110
|
-
*
|
|
5740
|
+
* Controls whether to return the exact result count. When false (default), counts are capped at 10,000 for performance reasons. Set to true for precise counts in smaller result sets.
|
|
5111
5741
|
*/
|
|
5112
5742
|
showNumResults?: boolean;
|
|
5113
5743
|
}
|
|
5114
5744
|
interface SearchPeopleRequest {
|
|
5115
5745
|
/**
|
|
5116
|
-
* Search by name
|
|
5746
|
+
* Search by person\'s name. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching.
|
|
5117
5747
|
*/
|
|
5118
5748
|
name?: string;
|
|
5119
5749
|
/**
|
|
5120
|
-
* Filter by Wikidata entity
|
|
5750
|
+
* Filter by Wikidata entity IDs (e.g., Q7747, Q937). These are unique identifiers from Wikidata.org that precisely identify public figures and eliminate name ambiguity. Multiple values create an OR filter.
|
|
5121
5751
|
*/
|
|
5122
5752
|
wikidataId?: Array<string>;
|
|
5123
5753
|
/**
|
|
5124
|
-
* Filter by Wikidata occupation
|
|
5754
|
+
* Filter by Wikidata occupation IDs (e.g., Q82955 for politician, Q33999 for actor, Q19546 for businessman). Finds people with specific professions. Multiple values create an OR filter.
|
|
5125
5755
|
*/
|
|
5126
5756
|
occupationId?: Array<string>;
|
|
5127
5757
|
/**
|
|
5128
|
-
* Search by occupation name.
|
|
5758
|
+
* Search by occupation name (e.g., politician, actor, CEO, athlete). Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching.
|
|
5129
5759
|
*/
|
|
5130
5760
|
occupationLabel?: string;
|
|
5131
5761
|
/**
|
|
5132
|
-
* The page
|
|
5762
|
+
* The specific page of results to retrieve in the paginated response. Starts at 0.
|
|
5133
5763
|
*/
|
|
5134
5764
|
page?: number;
|
|
5135
5765
|
/**
|
|
5136
|
-
* The number of
|
|
5766
|
+
* The number of people to return per page in the paginated response.
|
|
5137
5767
|
*/
|
|
5138
5768
|
size?: number;
|
|
5139
5769
|
}
|
|
5140
5770
|
interface SearchSourcesRequest {
|
|
5141
5771
|
/**
|
|
5142
|
-
*
|
|
5772
|
+
* Filter by specific publisher domains or subdomains. Supports wildcards (* and ?) for pattern matching (e.g., *.cnn.com, us?.nytimes.com). Multiple values create an OR filter.
|
|
5143
5773
|
*/
|
|
5144
5774
|
domain?: Array<string>;
|
|
5145
5775
|
/**
|
|
5146
|
-
* Search by name
|
|
5776
|
+
* Search by source name or alternative names. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching.
|
|
5147
5777
|
*/
|
|
5148
5778
|
name?: string;
|
|
5149
5779
|
/**
|
|
5150
|
-
*
|
|
5780
|
+
* Filter by predefined publisher bundles (e.g., top100, top50tech). Returns all sources within the specified group. See documentation for available source groups.
|
|
5151
5781
|
*/
|
|
5152
5782
|
sourceGroup?: string;
|
|
5153
5783
|
/**
|
|
5154
|
-
*
|
|
5784
|
+
* Determines the source sorting order. Options include relevance (default, best match to query), globalRank (by overall traffic and popularity), monthlyVisits (by total monthly visitor count), and avgMonthlyPosts (by number of articles published monthly).
|
|
5155
5785
|
*/
|
|
5156
5786
|
sortBy?: SortBy;
|
|
5157
5787
|
/**
|
|
5158
|
-
* The page
|
|
5788
|
+
* The specific page of results to retrieve in the paginated response. Starts at 0.
|
|
5159
5789
|
*/
|
|
5160
5790
|
page?: number;
|
|
5161
5791
|
/**
|
|
5162
|
-
* The number of
|
|
5792
|
+
* The number of sources to return per page in the paginated response.
|
|
5163
5793
|
*/
|
|
5164
5794
|
size?: number;
|
|
5165
5795
|
/**
|
|
5166
|
-
* Filter
|
|
5796
|
+
* Filter for sources with at least this many monthly visitors. Used to target publishers by audience size.
|
|
5167
5797
|
*/
|
|
5168
5798
|
minMonthlyVisits?: number;
|
|
5169
5799
|
/**
|
|
5170
|
-
*
|
|
5800
|
+
* Filter for sources with no more than this many monthly visitors. Used to target publishers by audience size.
|
|
5171
5801
|
*/
|
|
5172
5802
|
maxMonthlyVisits?: number;
|
|
5173
5803
|
/**
|
|
5174
|
-
*
|
|
5804
|
+
* Filter for sources that publish at least this many articles per month. Used to target publishers by content volume.
|
|
5175
5805
|
*/
|
|
5176
5806
|
minMonthlyPosts?: number;
|
|
5177
5807
|
/**
|
|
5178
|
-
*
|
|
5808
|
+
* Filter for sources that publish no more than this many articles per month. Used to target publishers by content volume.
|
|
5179
5809
|
*/
|
|
5180
5810
|
maxMonthlyPosts?: number;
|
|
5181
5811
|
/**
|
|
5182
|
-
*
|
|
5812
|
+
* Filter sources by countries they commonly cover in their reporting. Uses ISO 3166-1 alpha-2 two-letter country codes in lowercase (e.g., us, gb, jp). See documentation for supported country codes. Multiple values create an OR filter.
|
|
5183
5813
|
*/
|
|
5184
5814
|
country?: Array<string>;
|
|
5185
5815
|
/**
|
|
5186
|
-
*
|
|
5816
|
+
* Filter for local publications based in specific countries. Uses ISO 3166-1 alpha-2 two-letter country codes in lowercase (e.g., us, gb, jp). See documentation for supported country codes. Multiple values create an OR filter.
|
|
5187
5817
|
*/
|
|
5188
5818
|
sourceCountry?: Array<string>;
|
|
5189
5819
|
/**
|
|
5190
|
-
*
|
|
5820
|
+
* Filter for local publications based in specific states or regions. Uses standard two-letter state codes in lowercase (e.g., ca, ny, tx). See documentation for supported state codes. Multiple values create an OR filter.
|
|
5191
5821
|
*/
|
|
5192
5822
|
sourceState?: Array<string>;
|
|
5193
5823
|
/**
|
|
5194
|
-
*
|
|
5824
|
+
* Filter for local publications based in specific counties. Multiple values create an OR filter.
|
|
5195
5825
|
*/
|
|
5196
5826
|
sourceCounty?: Array<string>;
|
|
5197
5827
|
/**
|
|
5198
|
-
*
|
|
5828
|
+
* Filter for local publications based in specific cities. Multiple values create an OR filter.
|
|
5199
5829
|
*/
|
|
5200
5830
|
sourceCity?: Array<string>;
|
|
5201
5831
|
/**
|
|
5202
|
-
* Latitude
|
|
5832
|
+
* Latitude coordinate for filtering local publications by geographic proximity. Used with sourceLon and sourceMaxDistance for radius search.
|
|
5203
5833
|
*/
|
|
5204
5834
|
sourceLat?: number;
|
|
5205
5835
|
/**
|
|
5206
|
-
* Longitude
|
|
5836
|
+
* Longitude coordinate for filtering local publications by geographic proximity. Used with sourceLat and sourceMaxDistance for radius search.
|
|
5207
5837
|
*/
|
|
5208
5838
|
sourceLon?: number;
|
|
5209
5839
|
/**
|
|
5210
|
-
* Maximum distance from
|
|
5840
|
+
* Maximum distance in kilometers from the coordinates defined by sourceLat and sourceLon. Defines the radius for local publication searches.
|
|
5211
5841
|
*/
|
|
5212
5842
|
sourceMaxDistance?: number;
|
|
5213
5843
|
/**
|
|
5214
|
-
* Filter by
|
|
5844
|
+
* Filter sources by their primary content categories such as Politics, Tech, Sports, Business, or Finance. Returns sources that frequently cover these topics. Multiple values create an OR filter.
|
|
5215
5845
|
*/
|
|
5216
5846
|
category?: Array<string>;
|
|
5217
5847
|
/**
|
|
5218
|
-
*
|
|
5848
|
+
* Filter sources by their frequently covered topics (e.g., Markets, Cryptocurrency, Climate Change). Returns sources where the specified topic is among their top 10 covered areas. Multiple values create an OR filter.
|
|
5219
5849
|
*/
|
|
5220
5850
|
topic?: Array<string>;
|
|
5221
5851
|
/**
|
|
5222
|
-
* Filter sources by label
|
|
5852
|
+
* Filter sources by their content label patterns (e.g., Opinion, Paid-news, Non-news). Returns sources where the specified label is common in their published content. See documentation for all available labels. Multiple values create an OR filter.
|
|
5223
5853
|
*/
|
|
5224
5854
|
label?: Array<string>;
|
|
5225
5855
|
/**
|
|
5226
|
-
*
|
|
5856
|
+
* Filter by paywall status. Set to true to find sources with paywalls, or false to find sources without paywalls.
|
|
5227
5857
|
*/
|
|
5228
5858
|
paywall?: boolean;
|
|
5229
5859
|
/**
|
|
5230
|
-
* Controls whether subdomains are included
|
|
5860
|
+
* Controls whether subdomains are included as separate results. When true (default), subdomains appear as distinct sources. When false, results are consolidated to parent domains only.
|
|
5231
5861
|
*/
|
|
5232
5862
|
showSubdomains?: boolean;
|
|
5233
5863
|
/**
|
|
5234
|
-
*
|
|
5864
|
+
* Controls whether to return the exact result count. When false (default), counts are capped at 10,000 for performance reasons. Set to true for precise counts in smaller result sets.
|
|
5235
5865
|
*/
|
|
5236
5866
|
showNumResults?: boolean;
|
|
5237
5867
|
}
|
|
5238
5868
|
interface SearchStoriesRequest {
|
|
5239
5869
|
/**
|
|
5240
|
-
*
|
|
5870
|
+
* Primary search query for filtering stories based on their name, summary, and key points. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching.
|
|
5241
5871
|
*/
|
|
5242
5872
|
q?: string;
|
|
5243
5873
|
/**
|
|
5244
|
-
* Search story
|
|
5874
|
+
* Search specifically within story names. Supports Boolean operators, exact phrases with quotes, and wildcards for matching name variations.
|
|
5245
5875
|
*/
|
|
5246
5876
|
name?: string;
|
|
5247
5877
|
/**
|
|
5248
|
-
* Filter to specific
|
|
5878
|
+
* Filter to specific stories using their unique identifiers. Each clusterId represents a distinct story that groups related articles. Multiple values create an OR filter.
|
|
5249
5879
|
*/
|
|
5250
5880
|
clusterId?: Array<string>;
|
|
5251
5881
|
/**
|
|
5252
|
-
*
|
|
5882
|
+
* Excludes specific stories from the results by their unique identifiers. Use this parameter to filter out unwanted or previously seen stories.
|
|
5883
|
+
*/
|
|
5884
|
+
excludeClusterId?: Array<string>;
|
|
5885
|
+
/**
|
|
5886
|
+
* Determines the story sorting order. Options include createdAt (default, when stories first emerged), updatedAt (when stories received new articles, best for tracking developing events), relevance (best match to query), count (by unique article count), and totalCount (by total article count including reprints).
|
|
5253
5887
|
*/
|
|
5254
5888
|
sortBy?: SortBy;
|
|
5255
5889
|
/**
|
|
5256
|
-
* The page
|
|
5890
|
+
* The specific page of results to retrieve in the paginated response. Starts at 0.
|
|
5257
5891
|
*/
|
|
5258
5892
|
page?: number;
|
|
5259
5893
|
/**
|
|
5260
|
-
* The number of
|
|
5894
|
+
* The number of articles to return per page in the paginated response.
|
|
5261
5895
|
*/
|
|
5262
5896
|
size?: number;
|
|
5263
5897
|
/**
|
|
@@ -5269,23 +5903,39 @@ interface SearchStoriesRequest {
|
|
|
5269
5903
|
*/
|
|
5270
5904
|
to?: Date;
|
|
5271
5905
|
/**
|
|
5272
|
-
* Filter
|
|
5906
|
+
* Filter for stories created after this date. Alternative parameter for filtering by story creation date.
|
|
5907
|
+
*/
|
|
5908
|
+
initializedFrom?: Date;
|
|
5909
|
+
/**
|
|
5910
|
+
* Filter for stories created before this date. Alternative parameter for filtering by story creation date.
|
|
5911
|
+
*/
|
|
5912
|
+
initializedTo?: Date;
|
|
5913
|
+
/**
|
|
5914
|
+
* Filter for stories that received new articles after this date. Useful for tracking developing news events or evolving storylines.
|
|
5915
|
+
*/
|
|
5916
|
+
updatedFrom?: Date;
|
|
5917
|
+
/**
|
|
5918
|
+
* Filter for stories that received new articles before this date. Useful for tracking developing news events or evolving storylines.
|
|
5919
|
+
*/
|
|
5920
|
+
updatedTo?: Date;
|
|
5921
|
+
/**
|
|
5922
|
+
* Filter stories by specific topics such as Markets, Crime, Cryptocurrency, or College Sports. Topics are more granular than categories, and stories can include multiple topics based on their constituent articles. Use the /topics endpoint for a complete list of available topics. Multiple values create an OR filter.
|
|
5273
5923
|
*/
|
|
5274
5924
|
topic?: Array<string>;
|
|
5275
5925
|
/**
|
|
5276
|
-
* Filter by categories
|
|
5926
|
+
* Filter stories by broad content categories such as Politics, Tech, Sports, Business, or Finance. Use \'none\' to find uncategorized stories. Categories are derived from the articles within each story. Multiple values create an OR filter.
|
|
5277
5927
|
*/
|
|
5278
5928
|
category?: Array<string>;
|
|
5279
5929
|
/**
|
|
5280
|
-
*
|
|
5930
|
+
* Filter stories by Google Content Categories. Must pass the full hierarchical path of the category. Example: taxonomy=/Finance/Banking/Other,/Finance/Investing/Funds. Stories are categorized based on their constituent articles. Multiple values create an OR filter.
|
|
5281
5931
|
*/
|
|
5282
5932
|
taxonomy?: Array<string>;
|
|
5283
5933
|
/**
|
|
5284
|
-
* Filter stories
|
|
5934
|
+
* Filter stories that contain articles from specific publisher domains or subdomains. Supports wildcards (* and ?) for pattern matching (e.g., *.cnn.com). A story will match if it contains at least one article from any of the specified sources. Multiple values create an OR filter.
|
|
5285
5935
|
*/
|
|
5286
5936
|
source?: Array<string>;
|
|
5287
5937
|
/**
|
|
5288
|
-
* Filter stories
|
|
5938
|
+
* Filter stories that contain articles from publishers in Perigon\'s curated bundles (e.g., top100, top25crypto). A story will match if it contains at least one article from any publisher in the specified bundles. Multiple values create an OR filter.
|
|
5289
5939
|
*/
|
|
5290
5940
|
sourceGroup?: Array<string>;
|
|
5291
5941
|
/**
|
|
@@ -5293,27 +5943,27 @@ interface SearchStoriesRequest {
|
|
|
5293
5943
|
*/
|
|
5294
5944
|
minUniqueSources?: number;
|
|
5295
5945
|
/**
|
|
5296
|
-
*
|
|
5946
|
+
* Filter stories by Wikidata IDs of top mentioned people. Returns stories where these individuals appear prominently. Refer to the /people endpoint for a complete list of tracked individuals.
|
|
5297
5947
|
*/
|
|
5298
5948
|
personWikidataId?: Array<string>;
|
|
5299
5949
|
/**
|
|
5300
|
-
*
|
|
5950
|
+
* Filter stories by exact name matches of top mentioned people. Does not support Boolean or complex logic. For available person entities, consult the /people endpoint.
|
|
5301
5951
|
*/
|
|
5302
5952
|
personName?: string;
|
|
5303
5953
|
/**
|
|
5304
|
-
*
|
|
5954
|
+
* Filter stories by identifiers of top mentioned companies. Returns stories where these companies appear prominently. For a complete list of tracked companies, refer to the /companies endpoint.
|
|
5305
5955
|
*/
|
|
5306
5956
|
companyId?: Array<string>;
|
|
5307
5957
|
/**
|
|
5308
|
-
*
|
|
5958
|
+
* Filter stories by names of top mentioned companies. Performs an exact match on company names in the topCompanies field.
|
|
5309
5959
|
*/
|
|
5310
5960
|
companyName?: string;
|
|
5311
5961
|
/**
|
|
5312
|
-
*
|
|
5962
|
+
* Filter stories by domains of top mentioned companies (e.g., apple.com). Returns stories where companies with these domains appear prominently. For available company entities, consult the /companies endpoint.
|
|
5313
5963
|
*/
|
|
5314
5964
|
companyDomain?: Array<string>;
|
|
5315
5965
|
/**
|
|
5316
|
-
*
|
|
5966
|
+
* Filter stories by stock symbols of top mentioned companies. Returns stories where companies with these symbols appear prominently. For available company entities and their symbols, consult the /companies endpoint.
|
|
5317
5967
|
*/
|
|
5318
5968
|
companySymbol?: Array<string>;
|
|
5319
5969
|
/**
|
|
@@ -5341,65 +5991,69 @@ interface SearchStoriesRequest {
|
|
|
5341
5991
|
*/
|
|
5342
5992
|
maxClusterSize?: number;
|
|
5343
5993
|
/**
|
|
5344
|
-
*
|
|
5994
|
+
* Filter to only include stories that have been assigned names. Defaults to true. Note that stories only receive names after they contain at least 5 unique articles.
|
|
5345
5995
|
*/
|
|
5346
5996
|
nameExists?: boolean;
|
|
5347
5997
|
/**
|
|
5348
|
-
*
|
|
5998
|
+
* Filter articles with an aggregate positive sentiment score greater than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger positive tone.
|
|
5349
5999
|
*/
|
|
5350
6000
|
positiveSentimentFrom?: number;
|
|
5351
6001
|
/**
|
|
5352
|
-
*
|
|
6002
|
+
* Filter articles with an aggregate positive sentiment score less than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger positive tone.
|
|
5353
6003
|
*/
|
|
5354
6004
|
positiveSentimentTo?: number;
|
|
5355
6005
|
/**
|
|
5356
|
-
*
|
|
6006
|
+
* Filter articles with an aggregate neutral sentiment score greater than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger neutral tone.
|
|
5357
6007
|
*/
|
|
5358
6008
|
neutralSentimentFrom?: number;
|
|
5359
6009
|
/**
|
|
5360
|
-
*
|
|
6010
|
+
* Filter articles with an aggregate neutral sentiment score less than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger neutral tone.
|
|
5361
6011
|
*/
|
|
5362
6012
|
neutralSentimentTo?: number;
|
|
5363
6013
|
/**
|
|
5364
|
-
*
|
|
6014
|
+
* Filter stories with an aggregate negative sentiment score greater than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger negative tone.
|
|
5365
6015
|
*/
|
|
5366
6016
|
negativeSentimentFrom?: number;
|
|
5367
6017
|
/**
|
|
5368
|
-
*
|
|
6018
|
+
* Filter articles with an aggregate negative sentiment score less than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger negative tone.
|
|
5369
6019
|
*/
|
|
5370
6020
|
negativeSentimentTo?: number;
|
|
5371
6021
|
/**
|
|
5372
|
-
*
|
|
6022
|
+
* Parameter showStoryPageInfo
|
|
5373
6023
|
*/
|
|
5374
|
-
|
|
6024
|
+
showStoryPageInfo?: boolean;
|
|
5375
6025
|
/**
|
|
5376
|
-
*
|
|
6026
|
+
* Show total number of results. By default set to false, will cap result count at 10000.
|
|
5377
6027
|
*/
|
|
5378
|
-
|
|
6028
|
+
showNumResults?: boolean;
|
|
5379
6029
|
/**
|
|
5380
|
-
*
|
|
6030
|
+
* Stories are deduplicated by default. If a story is deduplicated, all future articles are merged into the original story. duplicateOf field contains the original cluster Id. When showDuplicates=true, all stories are shown.
|
|
5381
6031
|
*/
|
|
5382
|
-
|
|
6032
|
+
showDuplicates?: boolean;
|
|
5383
6033
|
/**
|
|
5384
|
-
*
|
|
6034
|
+
* When set to true, enables text highlighting in search results.
|
|
5385
6035
|
*/
|
|
5386
|
-
|
|
6036
|
+
showHighlighting?: boolean;
|
|
5387
6037
|
/**
|
|
5388
|
-
*
|
|
6038
|
+
* Specifies the size in characters of each highlighted text fragment. Defaults to 100 if not specified.
|
|
5389
6039
|
*/
|
|
5390
|
-
|
|
6040
|
+
highlightFragmentSize?: number;
|
|
5391
6041
|
/**
|
|
5392
|
-
*
|
|
6042
|
+
* Controls the maximum number of highlighted fragments to return per field.
|
|
5393
6043
|
*/
|
|
5394
|
-
|
|
6044
|
+
highlightNumFragments?: number;
|
|
5395
6045
|
/**
|
|
5396
|
-
*
|
|
6046
|
+
* Defines the HTML tag that appears before highlighted text. Defaults to \'<em>\' if not specified.
|
|
5397
6047
|
*/
|
|
5398
|
-
|
|
6048
|
+
highlightPreTag?: string;
|
|
5399
6049
|
/**
|
|
5400
|
-
*
|
|
6050
|
+
* Defines the HTML tag that appears after highlighted text. Defaults to \'</em>\' if not specified.
|
|
5401
6051
|
*/
|
|
5402
|
-
|
|
6052
|
+
highlightPostTag?: string;
|
|
6053
|
+
/**
|
|
6054
|
+
* Specifies a separate query for highlighting, allowing highlights based on terms different from the main search query. Example: main query \'q=climate change\' with \'highlightQ=renewable OR solar\' will highlight terms \'renewable\' and \'solar\' in results about climate change.
|
|
6055
|
+
*/
|
|
6056
|
+
highlightQ?: string;
|
|
5403
6057
|
}
|
|
5404
6058
|
interface SearchSummarizerRequest {
|
|
5405
6059
|
/**
|
|
@@ -5408,87 +6062,87 @@ interface SearchSummarizerRequest {
|
|
|
5408
6062
|
*/
|
|
5409
6063
|
summaryBody: SummaryBody;
|
|
5410
6064
|
/**
|
|
5411
|
-
*
|
|
6065
|
+
* Primary search query for filtering articles based on their title, description, and content. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching.
|
|
5412
6066
|
*/
|
|
5413
6067
|
q?: string;
|
|
5414
6068
|
/**
|
|
5415
|
-
* Search article headlines/
|
|
6069
|
+
* Search specifically within article headlines/titles. Supports Boolean operators, exact phrases with quotes, and wildcards for matching title variations.
|
|
5416
6070
|
*/
|
|
5417
6071
|
title?: string;
|
|
5418
6072
|
/**
|
|
5419
|
-
* Search
|
|
6073
|
+
* Search within article description fields. Supports Boolean expressions, exact phrase matching with quotes, and wildcards for flexible pattern matching.
|
|
5420
6074
|
*/
|
|
5421
6075
|
desc?: string;
|
|
5422
6076
|
/**
|
|
5423
|
-
* Search
|
|
6077
|
+
* Search within the full article body content. Supports Boolean logic, exact phrase matching with quotes, and wildcards for comprehensive content searching.
|
|
5424
6078
|
*/
|
|
5425
6079
|
content?: string;
|
|
5426
6080
|
/**
|
|
5427
|
-
* Search
|
|
6081
|
+
* Search within article URLs to find content from specific website sections or domains. Supports wildcards (* and ?) for partial URL matching.
|
|
5428
6082
|
*/
|
|
5429
6083
|
url?: string;
|
|
5430
6084
|
/**
|
|
5431
|
-
*
|
|
6085
|
+
* Retrieve specific news articles by their unique article identifiers. Multiple IDs can be provided to return a collection of specific articles.
|
|
5432
6086
|
*/
|
|
5433
6087
|
articleId?: Array<string>;
|
|
5434
6088
|
/**
|
|
5435
|
-
*
|
|
6089
|
+
* Filter results to only show content within a specific related content cluster. Returns articles grouped together as part of Perigon Stories based on topic relevance.
|
|
5436
6090
|
*/
|
|
5437
6091
|
clusterId?: Array<string>;
|
|
5438
6092
|
/**
|
|
5439
|
-
*
|
|
6093
|
+
* Determines the article sorting order. Options include relevance (default), date/pubDate (newest publication date first), reverseDate (oldest publication date first), addDate (newest ingestion date first), reverseAddDate (oldest ingestion date first), and refreshDate (most recently updated in system first, often identical to addDate).
|
|
5440
6094
|
*/
|
|
5441
6095
|
sortBy?: AllEndpointSortBy;
|
|
5442
6096
|
/**
|
|
5443
|
-
* The page
|
|
6097
|
+
* The specific page of results to retrieve in the paginated response. Starts at 0.
|
|
5444
6098
|
*/
|
|
5445
6099
|
page?: number;
|
|
5446
6100
|
/**
|
|
5447
|
-
* The number of
|
|
6101
|
+
* The number of articles to return per page in the paginated response.
|
|
5448
6102
|
*/
|
|
5449
6103
|
size?: number;
|
|
5450
6104
|
/**
|
|
5451
|
-
*
|
|
6105
|
+
* Filter for articles published after this date. Accepts ISO 8601 format (e.g., 2023-03-01T00:00:00) or yyyy-mm-dd format.
|
|
5452
6106
|
*/
|
|
5453
6107
|
from?: Date;
|
|
5454
6108
|
/**
|
|
5455
|
-
*
|
|
6109
|
+
* Filter for articles published before this date. Accepts ISO 8601 format (e.g., 2022-02-01T23:59:59) or yyyy-mm-dd format.
|
|
5456
6110
|
*/
|
|
5457
6111
|
to?: Date;
|
|
5458
6112
|
/**
|
|
5459
|
-
*
|
|
6113
|
+
* Filter for articles added to Perigon\'s system after this date. Accepts ISO 8601 format (e.g., 2022-02-01T00:00:00) or yyyy-mm-dd format.
|
|
5460
6114
|
*/
|
|
5461
6115
|
addDateFrom?: Date;
|
|
5462
6116
|
/**
|
|
5463
|
-
*
|
|
6117
|
+
* Filter for articles added to Perigon\'s system before this date. Accepts ISO 8601 format (e.g., 2022-02-01T23:59:59) or yyyy-mm-dd format.
|
|
5464
6118
|
*/
|
|
5465
6119
|
addDateTo?: Date;
|
|
5466
6120
|
/**
|
|
5467
|
-
*
|
|
6121
|
+
* Filter for articles refreshed/updated in Perigon\'s system after this date. In most cases yields similar results to addDateFrom but can differ for updated content. Accepts ISO 8601 format (e.g., 2022-02-01T00:00:00) or yyyy-mm-dd format.
|
|
5468
6122
|
*/
|
|
5469
6123
|
refreshDateFrom?: Date;
|
|
5470
6124
|
/**
|
|
5471
|
-
*
|
|
6125
|
+
* Filter for articles refreshed/updated in Perigon\'s system before this date. In most cases yields similar results to addDateTo but can differ for updated content. Accepts ISO 8601 format (e.g., 2022-02-01T23:59:59) or yyyy-mm-dd format.
|
|
5472
6126
|
*/
|
|
5473
6127
|
refreshDateTo?: Date;
|
|
5474
6128
|
/**
|
|
5475
|
-
*
|
|
6129
|
+
* Filter articles by their primary medium type. Accepts Article for written content or Video for video-based stories. Multiple values create an OR filter.
|
|
5476
6130
|
*/
|
|
5477
6131
|
medium?: Array<string>;
|
|
5478
6132
|
/**
|
|
5479
|
-
*
|
|
6133
|
+
* Filter articles by specific publisher domains or subdomains. Supports wildcards (* and ?) for pattern matching (e.g., *.cnn.com). Multiple values create an OR filter.
|
|
5480
6134
|
*/
|
|
5481
6135
|
source?: Array<string>;
|
|
5482
6136
|
/**
|
|
5483
|
-
*
|
|
6137
|
+
* Filter articles using Perigon\'s curated publisher bundles (e.g., top100, top25crypto). Multiple values create an OR filter to include articles from any of the specified bundles.
|
|
5484
6138
|
*/
|
|
5485
6139
|
sourceGroup?: Array<string>;
|
|
5486
6140
|
/**
|
|
5487
|
-
*
|
|
6141
|
+
* Exclude articles from specified Perigon source groups. Multiple values create an AND-exclude filter, removing content from publishers in any of the specified bundles (e.g., top10, top100).
|
|
5488
6142
|
*/
|
|
5489
6143
|
excludeSourceGroup?: Array<string>;
|
|
5490
6144
|
/**
|
|
5491
|
-
*
|
|
6145
|
+
* Exclude articles from specific publisher domains or subdomains. Supports wildcards (* and ?) for pattern matching (e.g., *.cnn.com). Multiple values create an AND-exclude filter.
|
|
5492
6146
|
*/
|
|
5493
6147
|
excludeSource?: Array<string>;
|
|
5494
6148
|
/**
|
|
@@ -5496,71 +6150,71 @@ interface SearchSummarizerRequest {
|
|
|
5496
6150
|
*/
|
|
5497
6151
|
paywall?: boolean;
|
|
5498
6152
|
/**
|
|
5499
|
-
*
|
|
6153
|
+
* Filter articles by author bylines. Works as an exact match for each author name provided. Multiple values create an OR filter to find articles by any of the specified authors.
|
|
5500
6154
|
*/
|
|
5501
6155
|
byline?: Array<string>;
|
|
5502
6156
|
/**
|
|
5503
|
-
*
|
|
6157
|
+
* Filter articles by specific author names. Works as an exact match for each name. Multiple values create an OR filter to find articles by any of the specified authors.
|
|
5504
6158
|
*/
|
|
5505
6159
|
author?: Array<string>;
|
|
5506
6160
|
/**
|
|
5507
|
-
*
|
|
6161
|
+
* Exclude articles written by specific authors. Any article with an author name matching an entry in this list will be omitted from results. Multiple values create an AND-exclude filter.
|
|
5508
6162
|
*/
|
|
5509
6163
|
excludeAuthor?: Array<string>;
|
|
5510
6164
|
/**
|
|
5511
|
-
* Filter by
|
|
6165
|
+
* Filter by unique journalist identifiers which can be found through the Journalist API or in the matchedAuthors field. Multiple values create an OR filter.
|
|
5512
6166
|
*/
|
|
5513
6167
|
journalistId?: Array<string>;
|
|
5514
6168
|
/**
|
|
5515
|
-
*
|
|
6169
|
+
* Exclude articles written by specific journalists identified by their unique IDs. Multiple values create an AND-exclude filter.
|
|
5516
6170
|
*/
|
|
5517
6171
|
excludeJournalistId?: Array<string>;
|
|
5518
6172
|
/**
|
|
5519
|
-
*
|
|
6173
|
+
* Filter articles by their language using ISO-639 two-letter codes (e.g., en, es, fr). Multiple values create an OR filter.
|
|
5520
6174
|
*/
|
|
5521
6175
|
language?: Array<string>;
|
|
5522
6176
|
/**
|
|
5523
|
-
*
|
|
6177
|
+
* Exclude articles in specific languages using ISO-639 two-letter codes. Multiple values create an AND-exclude filter.
|
|
5524
6178
|
*/
|
|
5525
6179
|
excludeLanguage?: Array<string>;
|
|
5526
6180
|
/**
|
|
5527
|
-
* Expand
|
|
6181
|
+
* Expand search to include translated content fields for non-English articles. When true, searches translated title, description, and content fields.
|
|
5528
6182
|
*/
|
|
5529
6183
|
searchTranslation?: boolean;
|
|
5530
6184
|
/**
|
|
5531
|
-
*
|
|
6185
|
+
* Filter articles by editorial labels such as Opinion, Paid-news, Non-news, Fact Check, or Press Release. Multiple values create an OR filter.
|
|
5532
6186
|
*/
|
|
5533
6187
|
label?: Array<string>;
|
|
5534
6188
|
/**
|
|
5535
|
-
* Exclude
|
|
6189
|
+
* Exclude articles with specific editorial labels. Multiple values create an AND-exclude filter, removing all content with any of these labels.
|
|
5536
6190
|
*/
|
|
5537
6191
|
excludeLabel?: Array<string>;
|
|
5538
6192
|
/**
|
|
5539
|
-
* Filter by
|
|
6193
|
+
* Filter by broad content categories such as Politics, Tech, Sports, Business, or Finance. Use \'none\' to find uncategorized articles. Multiple values create an OR filter.
|
|
5540
6194
|
*/
|
|
5541
6195
|
category?: Array<string>;
|
|
5542
6196
|
/**
|
|
5543
|
-
*
|
|
6197
|
+
* Exclude articles with specific categories. Multiple values create an AND-exclude filter, removing all content with any of these categories.
|
|
5544
6198
|
*/
|
|
5545
6199
|
excludeCategory?: Array<string>;
|
|
5546
6200
|
/**
|
|
5547
|
-
*
|
|
6201
|
+
* Filter by specific topics such as Markets, Crime, Cryptocurrency, or College Sports. Topics are more granular than categories, and articles can have multiple topics. Use the /topics endpoint for a complete list of available topics. Multiple values create an OR filter.
|
|
5548
6202
|
*/
|
|
5549
6203
|
topic?: Array<string>;
|
|
5550
6204
|
/**
|
|
5551
|
-
*
|
|
6205
|
+
* Exclude articles with specific topics. Multiple values create an AND-exclude filter, removing all content with any of these topics.
|
|
5552
6206
|
*/
|
|
5553
6207
|
excludeTopic?: Array<string>;
|
|
5554
6208
|
/**
|
|
5555
|
-
* Returns only articles that
|
|
6209
|
+
* Returns only articles that contain links to the specified URL pattern. Matches against the \'links\' field in article responses.
|
|
5556
6210
|
*/
|
|
5557
6211
|
linkTo?: string;
|
|
5558
6212
|
/**
|
|
5559
|
-
*
|
|
6213
|
+
* Controls whether to include reprinted content in results. When true (default), shows syndicated articles from wire services like AP or Reuters that appear on multiple sites.
|
|
5560
6214
|
*/
|
|
5561
6215
|
showReprints?: boolean;
|
|
5562
6216
|
/**
|
|
5563
|
-
*
|
|
6217
|
+
* Returns all articles in a specific reprint group, including the original article and all its known reprints. Use when you want to see all versions of the same content.
|
|
5564
6218
|
*/
|
|
5565
6219
|
reprintGroupId?: string;
|
|
5566
6220
|
/**
|
|
@@ -5588,7 +6242,7 @@ interface SearchSummarizerRequest {
|
|
|
5588
6242
|
*/
|
|
5589
6243
|
county?: Array<string>;
|
|
5590
6244
|
/**
|
|
5591
|
-
* Excludes articles from specific counties or administrative divisions in the
|
|
6245
|
+
* Excludes articles from specific counties or administrative divisions in the search results. Accepts either a single county name or a list of county names. County names should match the format used in article metadata (e.g., \'Los Angeles County\', \'Cook County\'). This parameter allows for more granular geographic filter
|
|
5592
6246
|
*/
|
|
5593
6247
|
excludeCounty?: Array<string>;
|
|
5594
6248
|
/**
|
|
@@ -5648,43 +6302,43 @@ interface SearchSummarizerRequest {
|
|
|
5648
6302
|
*/
|
|
5649
6303
|
sourceMaxDistance?: number;
|
|
5650
6304
|
/**
|
|
5651
|
-
*
|
|
6305
|
+
* Filter articles by Wikidata IDs of mentioned people. Refer to the /people endpoint for a complete list of tracked individuals.
|
|
5652
6306
|
*/
|
|
5653
6307
|
personWikidataId?: Array<string>;
|
|
5654
6308
|
/**
|
|
5655
|
-
*
|
|
6309
|
+
* Exclude articles mentioning people with specific Wikidata IDs. Creates an AND-exclude filter to remove content about these individuals. Uses precise identifiers to avoid name ambiguity.
|
|
5656
6310
|
*/
|
|
5657
6311
|
excludePersonWikidataId?: Array<string>;
|
|
5658
6312
|
/**
|
|
5659
|
-
*
|
|
6313
|
+
* Filter articles by exact person name matches. Does not support Boolean or complex logic. For available person entities, consult the /people endpoint.
|
|
5660
6314
|
*/
|
|
5661
6315
|
personName?: Array<string>;
|
|
5662
6316
|
/**
|
|
5663
|
-
*
|
|
6317
|
+
* Exclude articles mentioning specific people by name. Creates an AND-exclude filter to remove content about these individuals.
|
|
5664
6318
|
*/
|
|
5665
6319
|
excludePersonName?: Array<string>;
|
|
5666
6320
|
/**
|
|
5667
|
-
*
|
|
6321
|
+
* Filter articles by company identifiers. For a complete list of tracked companies, refer to the /companies endpoint.
|
|
5668
6322
|
*/
|
|
5669
6323
|
companyId?: Array<string>;
|
|
5670
6324
|
/**
|
|
5671
|
-
*
|
|
6325
|
+
* Exclude articles mentioning companies with specific identifiers. Creates an AND-exclude filter to remove content about these corporate entities.
|
|
5672
6326
|
*/
|
|
5673
6327
|
excludeCompanyId?: Array<string>;
|
|
5674
6328
|
/**
|
|
5675
|
-
*
|
|
6329
|
+
* Filter articles by company name mentions. Performs an exact match on company names.
|
|
5676
6330
|
*/
|
|
5677
6331
|
companyName?: string;
|
|
5678
6332
|
/**
|
|
5679
|
-
*
|
|
6333
|
+
* Filter articles by company domains (e.g., apple.com). For available company entities, consult the /companies endpoint.
|
|
5680
6334
|
*/
|
|
5681
6335
|
companyDomain?: Array<string>;
|
|
5682
6336
|
/**
|
|
5683
|
-
*
|
|
6337
|
+
* Exclude articles related to companies with specific domains. Creates an AND-exclude filter to remove content about these companies.
|
|
5684
6338
|
*/
|
|
5685
6339
|
excludeCompanyDomain?: Array<string>;
|
|
5686
6340
|
/**
|
|
5687
|
-
*
|
|
6341
|
+
* Filter articles by company stock symbols. For available company entities and their symbols, consult the /companies endpoint.
|
|
5688
6342
|
*/
|
|
5689
6343
|
companySymbol?: Array<string>;
|
|
5690
6344
|
/**
|
|
@@ -5696,59 +6350,189 @@ interface SearchSummarizerRequest {
|
|
|
5696
6350
|
*/
|
|
5697
6351
|
showNumResults?: boolean;
|
|
5698
6352
|
/**
|
|
5699
|
-
*
|
|
6353
|
+
* Filter articles with a positive sentiment score greater than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger positive tone.
|
|
5700
6354
|
*/
|
|
5701
6355
|
positiveSentimentFrom?: number;
|
|
5702
6356
|
/**
|
|
5703
|
-
*
|
|
6357
|
+
* Filter articles with a positive sentiment score less than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger positive tone.
|
|
5704
6358
|
*/
|
|
5705
6359
|
positiveSentimentTo?: number;
|
|
5706
6360
|
/**
|
|
5707
|
-
*
|
|
6361
|
+
* Filter articles with a neutral sentiment score greater than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger neutral tone.
|
|
5708
6362
|
*/
|
|
5709
6363
|
neutralSentimentFrom?: number;
|
|
5710
6364
|
/**
|
|
5711
|
-
*
|
|
6365
|
+
* Filter articles with a neutral sentiment score less than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger neutral tone.
|
|
5712
6366
|
*/
|
|
5713
6367
|
neutralSentimentTo?: number;
|
|
5714
6368
|
/**
|
|
5715
|
-
*
|
|
6369
|
+
* Filter articles with a negative sentiment score greater than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger negative tone.
|
|
5716
6370
|
*/
|
|
5717
6371
|
negativeSentimentFrom?: number;
|
|
5718
6372
|
/**
|
|
5719
|
-
*
|
|
6373
|
+
* Filter articles with a negative sentiment score less than or equal to the specified value. Scores range from 0 to 1, with higher values indicating stronger negative tone.
|
|
5720
6374
|
*/
|
|
5721
6375
|
negativeSentimentTo?: number;
|
|
5722
6376
|
/**
|
|
5723
|
-
* Filters by Google Content Categories. This field will accept 1 or more categories, must pass the full name of the category. Example: taxonomy=/Finance/Banking/Other, /Finance/Investing/Funds
|
|
6377
|
+
* Filters by Google Content Categories. This field will accept 1 or more categories, must pass the full name of the category. Example: taxonomy=/Finance/Banking/Other, /Finance/Investing/Funds. [Full list](https://cloud.google.com/natural-language/docs/categories)
|
|
5724
6378
|
*/
|
|
5725
6379
|
taxonomy?: Array<string>;
|
|
5726
6380
|
/**
|
|
5727
6381
|
* Filters by Google Content Categories. This field will filter by the category prefix only. Example: prefixTaxonomy=/Finance
|
|
5728
6382
|
*/
|
|
5729
6383
|
prefixTaxonomy?: string;
|
|
6384
|
+
/**
|
|
6385
|
+
* When set to true, enables text highlighting in search results.
|
|
6386
|
+
*/
|
|
6387
|
+
showHighlighting?: boolean;
|
|
6388
|
+
/**
|
|
6389
|
+
* Specifies the size in characters of each highlighted text fragment. Defaults to 100 if not specified.
|
|
6390
|
+
*/
|
|
6391
|
+
highlightFragmentSize?: number;
|
|
6392
|
+
/**
|
|
6393
|
+
* Controls the maximum number of highlighted fragments to return per field.
|
|
6394
|
+
*/
|
|
6395
|
+
highlightNumFragments?: number;
|
|
6396
|
+
/**
|
|
6397
|
+
* Defines the HTML tag that appears before highlighted text. Defaults to \'<em>\' if not specified.
|
|
6398
|
+
*/
|
|
6399
|
+
highlightPreTag?: string;
|
|
6400
|
+
/**
|
|
6401
|
+
* Defines the HTML tag that appears after highlighted text. Defaults to \'</em>\' if not specified.
|
|
6402
|
+
*/
|
|
6403
|
+
highlightPostTag?: string;
|
|
6404
|
+
/**
|
|
6405
|
+
* Specifies a separate query for highlighting, allowing highlights based on terms different from the main search query. Example: main query \'q=climate change\' with \'highlightQ=renewable OR solar\' will highlight terms \'renewable\' and \'solar\' in results about climate change.
|
|
6406
|
+
*/
|
|
6407
|
+
highlightQ?: string;
|
|
5730
6408
|
}
|
|
5731
6409
|
interface SearchTopicsRequest {
|
|
5732
6410
|
/**
|
|
5733
|
-
* Search by name.
|
|
6411
|
+
* Search for topics by exact name or partial text match. Does not support wildcards. Examples include Markets, Cryptocurrency, Climate Change, etc.
|
|
5734
6412
|
*/
|
|
5735
6413
|
name?: string;
|
|
5736
6414
|
/**
|
|
5737
|
-
*
|
|
6415
|
+
* Filter topics by broad article categories such as Politics, Tech, Sports, Business, Finance, Entertainment, etc.
|
|
5738
6416
|
*/
|
|
5739
6417
|
category?: string;
|
|
5740
6418
|
/**
|
|
5741
|
-
*
|
|
6419
|
+
* Filter topics by their specific subcategory. Subcategories provide more granular classification beyond the main category, such as TV or Event.
|
|
5742
6420
|
*/
|
|
5743
6421
|
subcategory?: string;
|
|
5744
6422
|
/**
|
|
5745
|
-
* The page
|
|
6423
|
+
* The specific page of results to retrieve in the paginated response. Starts at 0.
|
|
5746
6424
|
*/
|
|
5747
6425
|
page?: number;
|
|
5748
6426
|
/**
|
|
5749
|
-
* The number of
|
|
6427
|
+
* The number of topics to return per page in the paginated response.
|
|
6428
|
+
*/
|
|
6429
|
+
size?: number;
|
|
6430
|
+
}
|
|
6431
|
+
interface SearchWikipediaRequest {
|
|
6432
|
+
/**
|
|
6433
|
+
* Primary search query for filtering pages based on their title, summary, and content. Supports Boolean operators (AND, OR, NOT), exact phrases with quotes, and wildcards (* and ?) for flexible searching.
|
|
6434
|
+
*/
|
|
6435
|
+
q?: string;
|
|
6436
|
+
/**
|
|
6437
|
+
* Search specifically within page titles. Supports Boolean operators, exact phrases with quotes, and wildcards for matching title variations.
|
|
6438
|
+
*/
|
|
6439
|
+
title?: string;
|
|
6440
|
+
/**
|
|
6441
|
+
* Search specifically within page summary. Supports Boolean operators, exact phrases with quotes, and wildcards for matching title variations.
|
|
6442
|
+
*/
|
|
6443
|
+
summary?: string;
|
|
6444
|
+
/**
|
|
6445
|
+
* Search specifically within the page\'s content (across all sections). Supports Boolean operators, exact phrases with quotes, and wildcards for matching title variations.
|
|
6446
|
+
*/
|
|
6447
|
+
text?: string;
|
|
6448
|
+
/**
|
|
6449
|
+
* Search specifically across page\'s references. Supports Boolean operators, exact phrases with quotes, and wildcards for matching title variations.
|
|
6450
|
+
*/
|
|
6451
|
+
reference?: string;
|
|
6452
|
+
/**
|
|
6453
|
+
* Retrieve specific pages by their unique Perigon identifiers. Multiple IDs can be provided to return a collection of specific pages.
|
|
6454
|
+
*/
|
|
6455
|
+
id?: Array<string>;
|
|
6456
|
+
/**
|
|
6457
|
+
* Retrieve specific pages by their Wikipedia identifiers. These are unique only in a combination with `wikiCode` parameter. Multiple IDs can be provided to return a collection of specific pages.
|
|
6458
|
+
*/
|
|
6459
|
+
wikiPageId?: Array<number>;
|
|
6460
|
+
/**
|
|
6461
|
+
* Retrieve specific pages by their Wikipedia revision identifiers. These are unique only in a combination with `wikiCode` parameter. Multiple IDs can be provided to return a collection of specific pages. This ID changes each time a page is edited.
|
|
6462
|
+
*/
|
|
6463
|
+
wikiRevisionId?: Array<number>;
|
|
6464
|
+
/**
|
|
6465
|
+
* Retrieve pages only from specified wiki projects. Currently, the only accepted value is `enwiki`.
|
|
6466
|
+
*/
|
|
6467
|
+
wikiCode?: Array<string>;
|
|
6468
|
+
/**
|
|
6469
|
+
* Retrieve pages only from specified wiki namespace. Currently, only the main namespace (0) is available.
|
|
6470
|
+
*/
|
|
6471
|
+
wikiNamespace?: Array<number>;
|
|
6472
|
+
/**
|
|
6473
|
+
* Retrieve pages by the ids corresponding to their Wikidata entities.
|
|
6474
|
+
*/
|
|
6475
|
+
wikidataId?: Array<string>;
|
|
6476
|
+
/**
|
|
6477
|
+
* Retrieve all pages whose Wikidata entities are instances of these provided ids.
|
|
6478
|
+
*/
|
|
6479
|
+
wikidataInstanceOfId?: Array<string>;
|
|
6480
|
+
/**
|
|
6481
|
+
* Retrieve all pages whose Wikidata entities are instances of these ids (provided as labels).
|
|
6482
|
+
*/
|
|
6483
|
+
wikidataInstanceOfLabel?: Array<string>;
|
|
6484
|
+
/**
|
|
6485
|
+
* Retrieve all pages for specified categories.
|
|
6486
|
+
*/
|
|
6487
|
+
category?: Array<string>;
|
|
6488
|
+
/**
|
|
6489
|
+
* Retrieve pages containing provided section ids. Each section ID is unique.
|
|
6490
|
+
*/
|
|
6491
|
+
sectionId?: Array<string>;
|
|
6492
|
+
/**
|
|
6493
|
+
* Retrieve pages modified after this date. Accepts ISO 8601 format (e.g., 2023-03-01T00:00:00) or yyyy-mm-dd format.
|
|
6494
|
+
*/
|
|
6495
|
+
wikiRevisionFrom?: Date;
|
|
6496
|
+
/**
|
|
6497
|
+
* Retrieve pages modified before this date. Accepts ISO 8601 format (e.g., 2023-03-01T00:00:00) or yyyy-mm-dd format.
|
|
6498
|
+
*/
|
|
6499
|
+
wikiRevisionTo?: Date;
|
|
6500
|
+
/**
|
|
6501
|
+
* Retrieve pages scraped after this date. Accepts ISO 8601 format (e.g., 2023-03-01T00:00:00) or yyyy-mm-dd format.
|
|
6502
|
+
*/
|
|
6503
|
+
scrapedAtFrom?: Date;
|
|
6504
|
+
/**
|
|
6505
|
+
* Retrieve pages scraped before this date. Accepts ISO 8601 format (e.g., 2023-03-01T00:00:00) or yyyy-mm-dd format.
|
|
6506
|
+
*/
|
|
6507
|
+
scrapedAtTo?: Date;
|
|
6508
|
+
/**
|
|
6509
|
+
* Retrieve pages with the average number of views per day higher than the provided value.
|
|
6510
|
+
*/
|
|
6511
|
+
pageviewsFrom?: number;
|
|
6512
|
+
/**
|
|
6513
|
+
* Retrieve pages with the average number of views per day lower than the provided value.
|
|
6514
|
+
*/
|
|
6515
|
+
pageviewsTo?: number;
|
|
6516
|
+
/**
|
|
6517
|
+
* Retrieve pages that have any viewership statistics available for them. If `false` (the default) - return all pages.
|
|
6518
|
+
*/
|
|
6519
|
+
withPageviews?: boolean;
|
|
6520
|
+
/**
|
|
6521
|
+
* Whether to show the total number of all matched pages. Default value is false which makes queries a bit more efficient but also counts up to 10000 pages.
|
|
6522
|
+
*/
|
|
6523
|
+
showNumResults?: boolean;
|
|
6524
|
+
/**
|
|
6525
|
+
* The specific page of results to retrieve in the paginated response. Starts at 0.
|
|
6526
|
+
*/
|
|
6527
|
+
page?: number;
|
|
6528
|
+
/**
|
|
6529
|
+
* The number of articles to return per page in the paginated response.
|
|
5750
6530
|
*/
|
|
5751
6531
|
size?: number;
|
|
6532
|
+
/**
|
|
6533
|
+
* Determines the Wikipedia page sorting order. Options include relevance (default), revisionTsDesc (recently edited first), revisionTsAsc (recently edited last), pageViewsDesc (highest viewership first), pageViewsAsc (highest viewership last), scrapedAtDesc (recently scraped first), scrapedAtAsc (recently scraped last).
|
|
6534
|
+
*/
|
|
6535
|
+
sortBy?: SortBy;
|
|
5752
6536
|
}
|
|
5753
6537
|
interface VectorSearchArticlesRequest {
|
|
5754
6538
|
/**
|
|
@@ -5757,6 +6541,13 @@ interface VectorSearchArticlesRequest {
|
|
|
5757
6541
|
*/
|
|
5758
6542
|
articleSearchParams: ArticleSearchParams;
|
|
5759
6543
|
}
|
|
6544
|
+
interface VectorSearchWikipediaRequest {
|
|
6545
|
+
/**
|
|
6546
|
+
* Parameter wikipediaSearchParams
|
|
6547
|
+
* @required
|
|
6548
|
+
*/
|
|
6549
|
+
wikipediaSearchParams: WikipediaSearchParams;
|
|
6550
|
+
}
|
|
5760
6551
|
/**
|
|
5761
6552
|
* V1Api - interface
|
|
5762
6553
|
*
|
|
@@ -5818,12 +6609,12 @@ interface V1ApiInterface {
|
|
|
5818
6609
|
* @throws {RequiredError}
|
|
5819
6610
|
* @memberof V1ApiInterface
|
|
5820
6611
|
*/
|
|
5821
|
-
|
|
6612
|
+
searchJournalistsRaw(requestParameters: SearchJournalistsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<JournalistSearchResult>>;
|
|
5822
6613
|
/**
|
|
5823
6614
|
* Search journalists using broad search attributes. Our database contains over 230,000 journalists from around the world and is refreshed frequently.
|
|
5824
6615
|
* Journalists
|
|
5825
6616
|
*/
|
|
5826
|
-
|
|
6617
|
+
searchJournalists(requestParameters: SearchJournalistsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<JournalistSearchResult>;
|
|
5827
6618
|
/**
|
|
5828
6619
|
* Search and retrieve additional information on known persons that exist within Perigon\'s entity database and as referenced in any article response object. Our database contains over 650,000 people from around the world and is refreshed frequently. People data is derived from Wikidata and includes a wikidataId field that can be used to lookup even more information on Wikidata\'s website.
|
|
5829
6620
|
* @summary People
|
|
@@ -5899,21 +6690,51 @@ interface V1ApiInterface {
|
|
|
5899
6690
|
* Topics
|
|
5900
6691
|
*/
|
|
5901
6692
|
searchTopics(requestParameters: SearchTopicsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<TopicSearchResult>;
|
|
6693
|
+
/**
|
|
6694
|
+
* Search and filter all Wikipedia pages available via the Perigon API. The result includes a list of individual pages that were matched to your specific criteria.
|
|
6695
|
+
* @summary Wikipedia
|
|
6696
|
+
* @param requestParameters - Request parameters (see interface for details)
|
|
6697
|
+
* @param initOverrides - Override the default HTTP request configuration
|
|
6698
|
+
* @returns {Promise<runtime.ApiResponse<WikipediaSearchResult>}} Raw API response
|
|
6699
|
+
* @throws {RequiredError}
|
|
6700
|
+
* @memberof V1ApiInterface
|
|
6701
|
+
*/
|
|
6702
|
+
searchWikipediaRaw(requestParameters: SearchWikipediaRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<WikipediaSearchResult>>;
|
|
6703
|
+
/**
|
|
6704
|
+
* Search and filter all Wikipedia pages available via the Perigon API. The result includes a list of individual pages that were matched to your specific criteria.
|
|
6705
|
+
* Wikipedia
|
|
6706
|
+
*/
|
|
6707
|
+
searchWikipedia(requestParameters: SearchWikipediaRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<WikipediaSearchResult>;
|
|
5902
6708
|
/**
|
|
5903
6709
|
* Perform a natural language search over news articles from the past 6 months using semantic relevance. The result includes a list of articles most closely matched to your query intent.
|
|
5904
6710
|
* @summary Vector
|
|
5905
6711
|
* @param requestParameters - Request parameters (see interface for details)
|
|
5906
6712
|
* @param initOverrides - Override the default HTTP request configuration
|
|
5907
|
-
* @returns {Promise<runtime.ApiResponse<
|
|
6713
|
+
* @returns {Promise<runtime.ApiResponse<ArticlesVectorSearchResult>}} Raw API response
|
|
5908
6714
|
* @throws {RequiredError}
|
|
5909
6715
|
* @memberof V1ApiInterface
|
|
5910
6716
|
*/
|
|
5911
|
-
vectorSearchArticlesRaw(requestParameters: VectorSearchArticlesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<
|
|
6717
|
+
vectorSearchArticlesRaw(requestParameters: VectorSearchArticlesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<ArticlesVectorSearchResult>>;
|
|
5912
6718
|
/**
|
|
5913
6719
|
* Perform a natural language search over news articles from the past 6 months using semantic relevance. The result includes a list of articles most closely matched to your query intent.
|
|
5914
6720
|
* Vector
|
|
5915
6721
|
*/
|
|
5916
|
-
vectorSearchArticles(requestParameters: VectorSearchArticlesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<
|
|
6722
|
+
vectorSearchArticles(requestParameters: VectorSearchArticlesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ArticlesVectorSearchResult>;
|
|
6723
|
+
/**
|
|
6724
|
+
* Perform a natural language search over Wikipedia pages using semantic relevance. The result includes a list of page sections most closely matched to your query intent.
|
|
6725
|
+
* @summary Vector
|
|
6726
|
+
* @param requestParameters - Request parameters (see interface for details)
|
|
6727
|
+
* @param initOverrides - Override the default HTTP request configuration
|
|
6728
|
+
* @returns {Promise<runtime.ApiResponse<WikipediaVectorSearchResult>}} Raw API response
|
|
6729
|
+
* @throws {RequiredError}
|
|
6730
|
+
* @memberof V1ApiInterface
|
|
6731
|
+
*/
|
|
6732
|
+
vectorSearchWikipediaRaw(requestParameters: VectorSearchWikipediaRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<WikipediaVectorSearchResult>>;
|
|
6733
|
+
/**
|
|
6734
|
+
* Perform a natural language search over Wikipedia pages using semantic relevance. The result includes a list of page sections most closely matched to your query intent.
|
|
6735
|
+
* Vector
|
|
6736
|
+
*/
|
|
6737
|
+
vectorSearchWikipedia(requestParameters: VectorSearchWikipediaRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<WikipediaVectorSearchResult>;
|
|
5917
6738
|
}
|
|
5918
6739
|
/**
|
|
5919
6740
|
*
|
|
@@ -5953,12 +6774,12 @@ declare class V1Api extends BaseAPI implements V1ApiInterface {
|
|
|
5953
6774
|
* Search journalists using broad search attributes. Our database contains over 230,000 journalists from around the world and is refreshed frequently.
|
|
5954
6775
|
* Journalists
|
|
5955
6776
|
*/
|
|
5956
|
-
|
|
6777
|
+
searchJournalistsRaw(requestParameters: SearchJournalistsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<JournalistSearchResult>>;
|
|
5957
6778
|
/**
|
|
5958
6779
|
* Search journalists using broad search attributes. Our database contains over 230,000 journalists from around the world and is refreshed frequently.
|
|
5959
6780
|
* Journalists
|
|
5960
6781
|
*/
|
|
5961
|
-
|
|
6782
|
+
searchJournalists(requestParameters?: SearchJournalistsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<JournalistSearchResult>;
|
|
5962
6783
|
/**
|
|
5963
6784
|
* Search and retrieve additional information on known persons that exist within Perigon\'s entity database and as referenced in any article response object. Our database contains over 650,000 people from around the world and is refreshed frequently. People data is derived from Wikidata and includes a wikidataId field that can be used to lookup even more information on Wikidata\'s website.
|
|
5964
6785
|
* People
|
|
@@ -6009,16 +6830,36 @@ declare class V1Api extends BaseAPI implements V1ApiInterface {
|
|
|
6009
6830
|
* Topics
|
|
6010
6831
|
*/
|
|
6011
6832
|
searchTopics(requestParameters?: SearchTopicsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<TopicSearchResult>;
|
|
6833
|
+
/**
|
|
6834
|
+
* Search and filter all Wikipedia pages available via the Perigon API. The result includes a list of individual pages that were matched to your specific criteria.
|
|
6835
|
+
* Wikipedia
|
|
6836
|
+
*/
|
|
6837
|
+
searchWikipediaRaw(requestParameters: SearchWikipediaRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<WikipediaSearchResult>>;
|
|
6838
|
+
/**
|
|
6839
|
+
* Search and filter all Wikipedia pages available via the Perigon API. The result includes a list of individual pages that were matched to your specific criteria.
|
|
6840
|
+
* Wikipedia
|
|
6841
|
+
*/
|
|
6842
|
+
searchWikipedia(requestParameters?: SearchWikipediaRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<WikipediaSearchResult>;
|
|
6012
6843
|
/**
|
|
6013
6844
|
* Perform a natural language search over news articles from the past 6 months using semantic relevance. The result includes a list of articles most closely matched to your query intent.
|
|
6014
6845
|
* Vector
|
|
6015
6846
|
*/
|
|
6016
|
-
vectorSearchArticlesRaw(requestParameters: VectorSearchArticlesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<
|
|
6847
|
+
vectorSearchArticlesRaw(requestParameters: VectorSearchArticlesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<ArticlesVectorSearchResult>>;
|
|
6017
6848
|
/**
|
|
6018
6849
|
* Perform a natural language search over news articles from the past 6 months using semantic relevance. The result includes a list of articles most closely matched to your query intent.
|
|
6019
6850
|
* Vector
|
|
6020
6851
|
*/
|
|
6021
|
-
vectorSearchArticles(requestParameters: VectorSearchArticlesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<
|
|
6852
|
+
vectorSearchArticles(requestParameters: VectorSearchArticlesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ArticlesVectorSearchResult>;
|
|
6853
|
+
/**
|
|
6854
|
+
* Perform a natural language search over Wikipedia pages using semantic relevance. The result includes a list of page sections most closely matched to your query intent.
|
|
6855
|
+
* Vector
|
|
6856
|
+
*/
|
|
6857
|
+
vectorSearchWikipediaRaw(requestParameters: VectorSearchWikipediaRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<WikipediaVectorSearchResult>>;
|
|
6858
|
+
/**
|
|
6859
|
+
* Perform a natural language search over Wikipedia pages using semantic relevance. The result includes a list of page sections most closely matched to your query intent.
|
|
6860
|
+
* Vector
|
|
6861
|
+
*/
|
|
6862
|
+
vectorSearchWikipedia(requestParameters: VectorSearchWikipediaRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<WikipediaVectorSearchResult>;
|
|
6022
6863
|
}
|
|
6023
6864
|
|
|
6024
|
-
export { AllEndpointSortBy, AllEndpointSortByFromJSON, AllEndpointSortByFromJSONTyped, AllEndpointSortByToJSON, AllEndpointSortByToJSONTyped, type ApiResponse, type Article, ArticleFromJSON, ArticleFromJSONTyped, type ArticleSearchFilter, ArticleSearchFilterFromJSON, ArticleSearchFilterFromJSONTyped, ArticleSearchFilterToJSON, ArticleSearchFilterToJSONTyped, type ArticleSearchParams, ArticleSearchParamsFromJSON, ArticleSearchParamsFromJSONTyped, ArticleSearchParamsToJSON, ArticleSearchParamsToJSONTyped, ArticleToJSON, ArticleToJSONTyped, type AuthException, AuthExceptionFromJSON, AuthExceptionFromJSONTyped, AuthExceptionStatusCodeEnum, AuthExceptionToJSON, AuthExceptionToJSONTyped, BASE_PATH, BaseAPI, BlobApiResponse, COLLECTION_FORMATS, type CategoryHolder, CategoryHolderFromJSON, CategoryHolderFromJSONTyped, CategoryHolderToJSON, CategoryHolderToJSONTyped, type CategoryWithScoreHolder, CategoryWithScoreHolderFromJSON, CategoryWithScoreHolderFromJSONTyped, CategoryWithScoreHolderToJSON, CategoryWithScoreHolderToJSONTyped, type Company, type CompanyCount, CompanyCountFromJSON, CompanyCountFromJSONTyped, CompanyCountToJSON, CompanyCountToJSONTyped, CompanyFromJSON, CompanyFromJSONTyped, type CompanyHolder, CompanyHolderFromJSON, CompanyHolderFromJSONTyped, CompanyHolderToJSON, CompanyHolderToJSONTyped, type CompanySearchResult, CompanySearchResultFromJSON, CompanySearchResultFromJSONTyped, CompanySearchResultToJSON, CompanySearchResultToJSONTyped, CompanyToJSON, CompanyToJSONTyped, Configuration, type ConfigurationParameters, type Consume, type Coordinate, type CoordinateFilter, CoordinateFilterFromJSON, CoordinateFilterFromJSONTyped, CoordinateFilterToJSON, CoordinateFilterToJSONTyped, CoordinateFromJSON, CoordinateFromJSONTyped, CoordinateToJSON, CoordinateToJSONTyped, DefaultConfig, type EntityHolder, EntityHolderFromJSON, EntityHolderFromJSONTyped, EntityHolderToJSON, EntityHolderToJSONTyped, type ErrorContext, type EventTypeHolder, EventTypeHolderFromJSON, EventTypeHolderFromJSONTyped, EventTypeHolderToJSON, EventTypeHolderToJSONTyped, type FetchAPI, FetchError, type FetchParams, type GetJournalistByIdRequest, type HTTPBody, type HTTPHeaders, type HTTPMethod, type HTTPQuery, type HTTPRequestInit, type IdNameHolder, IdNameHolderFromJSON, IdNameHolderFromJSONTyped, IdNameHolderToJSON, IdNameHolderToJSONTyped, type IllegalParameterException, IllegalParameterExceptionFromJSON, IllegalParameterExceptionFromJSONTyped, IllegalParameterExceptionToJSON, IllegalParameterExceptionToJSONTyped, type ImageHolder, ImageHolderFromJSON, ImageHolderFromJSONTyped, ImageHolderToJSON, ImageHolderToJSONTyped, type InitOverrideFunction, type InternalErrorException, InternalErrorExceptionFromJSON, InternalErrorExceptionFromJSONTyped, InternalErrorExceptionToJSON, InternalErrorExceptionToJSONTyped, JSONApiResponse, type Journalist, JournalistFromJSON, JournalistFromJSONTyped, type JournalistSearchResult, JournalistSearchResultFromJSON, JournalistSearchResultFromJSONTyped, JournalistSearchResultToJSON, JournalistSearchResultToJSONTyped, JournalistToJSON, JournalistToJSONTyped, type Json, type KeyPoint, KeyPointFromJSON, KeyPointFromJSONTyped, KeyPointToJSON, KeyPointToJSONTyped, type KeywordHolder, KeywordHolderFromJSON, KeywordHolderFromJSONTyped, KeywordHolderToJSON, KeywordHolderToJSONTyped, type LabelHolder, LabelHolderFromJSON, LabelHolderFromJSONTyped, LabelHolderToJSON, LabelHolderToJSONTyped, type LocationCount, LocationCountFromJSON, LocationCountFromJSONTyped, LocationCountToJSON, LocationCountToJSONTyped, type LocationHolder, LocationHolderFromJSON, LocationHolderFromJSONTyped, LocationHolderToJSON, LocationHolderToJSONTyped, type Middleware, type ModelPropertyNaming, type NameCount, NameCountFromJSON, NameCountFromJSONTyped, NameCountToJSON, NameCountToJSONTyped, type NewsCluster, NewsClusterFromJSON, NewsClusterFromJSONTyped, NewsClusterToJSON, NewsClusterToJSONTyped, type NotFoundException, NotFoundExceptionFromJSON, NotFoundExceptionFromJSONTyped, NotFoundExceptionToJSON, NotFoundExceptionToJSONTyped, type PeopleSearchResult, PeopleSearchResultFromJSON, PeopleSearchResultFromJSONTyped, PeopleSearchResultToJSON, PeopleSearchResultToJSONTyped, type Person, type PersonCount, PersonCountFromJSON, PersonCountFromJSONTyped, PersonCountToJSON, PersonCountToJSONTyped, PersonFromJSON, PersonFromJSONTyped, type PersonHolder, PersonHolderFromJSON, PersonHolderFromJSONTyped, PersonHolderToJSON, PersonHolderToJSONTyped, PersonToJSON, PersonToJSONTyped, type Place, PlaceFromJSON, PlaceFromJSONTyped, PlaceToJSON, PlaceToJSONTyped, type QuerySearchResult, QuerySearchResultFromJSON, QuerySearchResultFromJSONTyped, QuerySearchResultToJSON, QuerySearchResultToJSONTyped, type Question, QuestionFromJSON, QuestionFromJSONTyped, QuestionToJSON, QuestionToJSONTyped, type RecordStatHolder, RecordStatHolderFromJSON, RecordStatHolderFromJSONTyped, RecordStatHolderToJSON, RecordStatHolderToJSONTyped, type RequestContext, type RequestOpts, RequiredError, type ResponseContext, ResponseError, type ResponseTransformer, type ScoredArticle, ScoredArticleFromJSON, ScoredArticleFromJSONTyped, ScoredArticleToJSON, ScoredArticleToJSONTyped, type SearchArticlesRequest, type SearchCompaniesRequest, type SearchJournalists1Request, type SearchPeopleRequest, type SearchSourcesRequest, type SearchStoriesRequest, type SearchSummarizerRequest, type SearchTopicsRequest, type SentimentHolder, SentimentHolderFromJSON, SentimentHolderFromJSONTyped, SentimentHolderToJSON, SentimentHolderToJSONTyped, SortBy, SortByFromJSON, SortByFromJSONTyped, SortByToJSON, SortByToJSONTyped, type Source, SourceFromJSON, SourceFromJSONTyped, type SourceHolder, SourceHolderFromJSON, SourceHolderFromJSONTyped, SourceHolderToJSON, SourceHolderToJSONTyped, type SourceLocation, SourceLocationFromJSON, SourceLocationFromJSONTyped, SourceLocationToJSON, SourceLocationToJSONTyped, type SourceSearchResult, SourceSearchResultFromJSON, SourceSearchResultFromJSONTyped, SourceSearchResultToJSON, SourceSearchResultToJSONTyped, SourceToJSON, SourceToJSONTyped, type SourceTopStatHolder, SourceTopStatHolderFromJSON, SourceTopStatHolderFromJSONTyped, SourceTopStatHolderToJSON, SourceTopStatHolderToJSONTyped, type StorySearchResult, StorySearchResultFromJSON, StorySearchResultFromJSONTyped, StorySearchResultToJSON, StorySearchResultToJSONTyped, type SummaryBody, SummaryBodyFromJSON, SummaryBodyFromJSONTyped, SummaryBodyMethodEnum, SummaryBodyModelEnum, SummaryBodySummarizeFieldsEnum, SummaryBodyToJSON, SummaryBodyToJSONTyped, type SummarySearchResult, SummarySearchResultFromJSON, SummarySearchResultFromJSONTyped, SummarySearchResultToJSON, SummarySearchResultToJSONTyped, type SymbolHolder, SymbolHolderFromJSON, SymbolHolderFromJSONTyped, SymbolHolderToJSON, SymbolHolderToJSONTyped, TextApiResponse, type TooManyRequestsException, type TooManyRequestsExceptionCause, TooManyRequestsExceptionCauseFromJSON, TooManyRequestsExceptionCauseFromJSONTyped, type TooManyRequestsExceptionCauseStackTraceInner, TooManyRequestsExceptionCauseStackTraceInnerFromJSON, TooManyRequestsExceptionCauseStackTraceInnerFromJSONTyped, TooManyRequestsExceptionCauseStackTraceInnerToJSON, TooManyRequestsExceptionCauseStackTraceInnerToJSONTyped, TooManyRequestsExceptionCauseToJSON, TooManyRequestsExceptionCauseToJSONTyped, TooManyRequestsExceptionFromJSON, TooManyRequestsExceptionFromJSONTyped, TooManyRequestsExceptionStatusEnum, type TooManyRequestsExceptionSuppressedInner, TooManyRequestsExceptionSuppressedInnerFromJSON, TooManyRequestsExceptionSuppressedInnerFromJSONTyped, TooManyRequestsExceptionSuppressedInnerToJSON, TooManyRequestsExceptionSuppressedInnerToJSONTyped, TooManyRequestsExceptionToJSON, TooManyRequestsExceptionToJSONTyped, type TopicDto, TopicDtoFromJSON, TopicDtoFromJSONTyped, TopicDtoToJSON, TopicDtoToJSONTyped, type TopicHolder, TopicHolderFromJSON, TopicHolderFromJSONTyped, TopicHolderToJSON, TopicHolderToJSONTyped, type TopicLabels, TopicLabelsFromJSON, TopicLabelsFromJSONTyped, TopicLabelsToJSON, TopicLabelsToJSONTyped, type TopicSearchResult, TopicSearchResultFromJSON, TopicSearchResultFromJSONTyped, TopicSearchResultToJSON, TopicSearchResultToJSONTyped, V1Api, type V1ApiInterface, type VectorSearchArticlesRequest, type VectorSearchResult, VectorSearchResultFromJSON, VectorSearchResultFromJSONTyped, VectorSearchResultToJSON, VectorSearchResultToJSONTyped, VoidApiResponse, type WebResources, WebResourcesFromJSON, WebResourcesFromJSONTyped, WebResourcesToJSON, WebResourcesToJSONTyped, type WikidataDateHolder, WikidataDateHolderFromJSON, WikidataDateHolderFromJSONTyped, WikidataDateHolderToJSON, WikidataDateHolderToJSONTyped, type WikidataLabelHolder, WikidataLabelHolderFromJSON, WikidataLabelHolderFromJSONTyped, WikidataLabelHolderToJSON, WikidataLabelHolderToJSONTyped, type WikidataPoliticalPartyHolder, WikidataPoliticalPartyHolderFromJSON, WikidataPoliticalPartyHolderFromJSONTyped, WikidataPoliticalPartyHolderToJSON, WikidataPoliticalPartyHolderToJSONTyped, type WikidataPositionHolder, WikidataPositionHolderFromJSON, WikidataPositionHolderFromJSONTyped, WikidataPositionHolderToJSON, WikidataPositionHolderToJSONTyped, canConsumeForm, exists, instanceOfAllEndpointSortBy, instanceOfArticle, instanceOfArticleSearchFilter, instanceOfArticleSearchParams, instanceOfAuthException, instanceOfCategoryHolder, instanceOfCategoryWithScoreHolder, instanceOfCompany, instanceOfCompanyCount, instanceOfCompanyHolder, instanceOfCompanySearchResult, instanceOfCoordinate, instanceOfCoordinateFilter, instanceOfEntityHolder, instanceOfEventTypeHolder, instanceOfIdNameHolder, instanceOfIllegalParameterException, instanceOfImageHolder, instanceOfInternalErrorException, instanceOfJournalist, instanceOfJournalistSearchResult, instanceOfKeyPoint, instanceOfKeywordHolder, instanceOfLabelHolder, instanceOfLocationCount, instanceOfLocationHolder, instanceOfNameCount, instanceOfNewsCluster, instanceOfNotFoundException, instanceOfPeopleSearchResult, instanceOfPerson, instanceOfPersonCount, instanceOfPersonHolder, instanceOfPlace, instanceOfQuerySearchResult, instanceOfQuestion, instanceOfRecordStatHolder, instanceOfScoredArticle, instanceOfSentimentHolder, instanceOfSortBy, instanceOfSource, instanceOfSourceHolder, instanceOfSourceLocation, instanceOfSourceSearchResult, instanceOfSourceTopStatHolder, instanceOfStorySearchResult, instanceOfSummaryBody, instanceOfSummarySearchResult, instanceOfSymbolHolder, instanceOfTooManyRequestsException, instanceOfTooManyRequestsExceptionCause, instanceOfTooManyRequestsExceptionCauseStackTraceInner, instanceOfTooManyRequestsExceptionSuppressedInner, instanceOfTopicDto, instanceOfTopicHolder, instanceOfTopicLabels, instanceOfTopicSearchResult, instanceOfVectorSearchResult, instanceOfWebResources, instanceOfWikidataDateHolder, instanceOfWikidataLabelHolder, instanceOfWikidataPoliticalPartyHolder, instanceOfWikidataPositionHolder, mapValues, querystring };
|
|
6865
|
+
export { AllEndpointSortBy, AllEndpointSortByFromJSON, AllEndpointSortByFromJSONTyped, AllEndpointSortByToJSON, AllEndpointSortByToJSONTyped, type ApiResponse, type Article, ArticleFromJSON, ArticleFromJSONTyped, type ArticleSearchFilter, ArticleSearchFilterFromJSON, ArticleSearchFilterFromJSONTyped, ArticleSearchFilterToJSON, ArticleSearchFilterToJSONTyped, type ArticleSearchParams, ArticleSearchParamsFromJSON, ArticleSearchParamsFromJSONTyped, ArticleSearchParamsToJSON, ArticleSearchParamsToJSONTyped, ArticleToJSON, ArticleToJSONTyped, type ArticlesVectorSearchResult, ArticlesVectorSearchResultFromJSON, ArticlesVectorSearchResultFromJSONTyped, ArticlesVectorSearchResultToJSON, ArticlesVectorSearchResultToJSONTyped, type AuthException, type AuthExceptionCause, AuthExceptionCauseFromJSON, AuthExceptionCauseFromJSONTyped, type AuthExceptionCauseStackTraceInner, AuthExceptionCauseStackTraceInnerFromJSON, AuthExceptionCauseStackTraceInnerFromJSONTyped, AuthExceptionCauseStackTraceInnerToJSON, AuthExceptionCauseStackTraceInnerToJSONTyped, AuthExceptionCauseToJSON, AuthExceptionCauseToJSONTyped, AuthExceptionFromJSON, AuthExceptionFromJSONTyped, AuthExceptionStatusCodeEnum, type AuthExceptionSuppressedInner, AuthExceptionSuppressedInnerFromJSON, AuthExceptionSuppressedInnerFromJSONTyped, AuthExceptionSuppressedInnerToJSON, AuthExceptionSuppressedInnerToJSONTyped, AuthExceptionToJSON, AuthExceptionToJSONTyped, BASE_PATH, BaseAPI, BlobApiResponse, COLLECTION_FORMATS, type CategoryHolder, CategoryHolderFromJSON, CategoryHolderFromJSONTyped, CategoryHolderToJSON, CategoryHolderToJSONTyped, type CategoryWithScoreHolder, CategoryWithScoreHolderFromJSON, CategoryWithScoreHolderFromJSONTyped, CategoryWithScoreHolderToJSON, CategoryWithScoreHolderToJSONTyped, type Company, type CompanyCount, CompanyCountFromJSON, CompanyCountFromJSONTyped, CompanyCountToJSON, CompanyCountToJSONTyped, CompanyFromJSON, CompanyFromJSONTyped, type CompanyHolder, CompanyHolderFromJSON, CompanyHolderFromJSONTyped, CompanyHolderToJSON, CompanyHolderToJSONTyped, type CompanySearchResult, CompanySearchResultFromJSON, CompanySearchResultFromJSONTyped, CompanySearchResultToJSON, CompanySearchResultToJSONTyped, CompanyToJSON, CompanyToJSONTyped, Configuration, type ConfigurationParameters, type Consume, type Coordinate, type CoordinateFilter, CoordinateFilterFromJSON, CoordinateFilterFromJSONTyped, CoordinateFilterToJSON, CoordinateFilterToJSONTyped, CoordinateFromJSON, CoordinateFromJSONTyped, CoordinateToJSON, CoordinateToJSONTyped, DefaultConfig, type EntityHolder, EntityHolderFromJSON, EntityHolderFromJSONTyped, EntityHolderToJSON, EntityHolderToJSONTyped, type ErrorContext, type EventTypeHolder, EventTypeHolderFromJSON, EventTypeHolderFromJSONTyped, EventTypeHolderToJSON, EventTypeHolderToJSONTyped, type FetchAPI, FetchError, type FetchParams, type GetJournalistByIdRequest, type HTTPBody, type HTTPHeaders, type HTTPMethod, type HTTPQuery, type HTTPRequestInit, type IdNameHolder, IdNameHolderFromJSON, IdNameHolderFromJSONTyped, IdNameHolderToJSON, IdNameHolderToJSONTyped, type IllegalParameterException, IllegalParameterExceptionFromJSON, IllegalParameterExceptionFromJSONTyped, IllegalParameterExceptionToJSON, IllegalParameterExceptionToJSONTyped, type ImageHolder, ImageHolderFromJSON, ImageHolderFromJSONTyped, ImageHolderToJSON, ImageHolderToJSONTyped, type InitOverrideFunction, type InternalErrorException, InternalErrorExceptionFromJSON, InternalErrorExceptionFromJSONTyped, InternalErrorExceptionToJSON, InternalErrorExceptionToJSONTyped, JSONApiResponse, type Journalist, JournalistFromJSON, JournalistFromJSONTyped, type JournalistSearchResult, JournalistSearchResultFromJSON, JournalistSearchResultFromJSONTyped, JournalistSearchResultToJSON, JournalistSearchResultToJSONTyped, JournalistToJSON, JournalistToJSONTyped, type Json, type KeyPoint, KeyPointFromJSON, KeyPointFromJSONTyped, KeyPointToJSON, KeyPointToJSONTyped, type KeywordHolder, KeywordHolderFromJSON, KeywordHolderFromJSONTyped, KeywordHolderToJSON, KeywordHolderToJSONTyped, type LabelHolder, LabelHolderFromJSON, LabelHolderFromJSONTyped, LabelHolderToJSON, LabelHolderToJSONTyped, type LocationCount, LocationCountFromJSON, LocationCountFromJSONTyped, LocationCountToJSON, LocationCountToJSONTyped, type LocationHolder, LocationHolderFromJSON, LocationHolderFromJSONTyped, LocationHolderToJSON, LocationHolderToJSONTyped, type Middleware, type ModelPropertyNaming, type NameCount, NameCountFromJSON, NameCountFromJSONTyped, NameCountToJSON, NameCountToJSONTyped, type NewsCluster, NewsClusterFromJSON, NewsClusterFromJSONTyped, NewsClusterToJSON, NewsClusterToJSONTyped, type NotFoundException, NotFoundExceptionFromJSON, NotFoundExceptionFromJSONTyped, NotFoundExceptionToJSON, NotFoundExceptionToJSONTyped, type PeopleSearchResult, PeopleSearchResultFromJSON, PeopleSearchResultFromJSONTyped, PeopleSearchResultToJSON, PeopleSearchResultToJSONTyped, type Person, type PersonCount, PersonCountFromJSON, PersonCountFromJSONTyped, PersonCountToJSON, PersonCountToJSONTyped, PersonFromJSON, PersonFromJSONTyped, type PersonHolder, PersonHolderFromJSON, PersonHolderFromJSONTyped, PersonHolderToJSON, PersonHolderToJSONTyped, PersonToJSON, PersonToJSONTyped, type Place, PlaceFromJSON, PlaceFromJSONTyped, PlaceToJSON, PlaceToJSONTyped, type QuerySearchResult, QuerySearchResultFromJSON, QuerySearchResultFromJSONTyped, QuerySearchResultToJSON, QuerySearchResultToJSONTyped, type Question, QuestionFromJSON, QuestionFromJSONTyped, QuestionToJSON, QuestionToJSONTyped, type RecordStatHolder, RecordStatHolderFromJSON, RecordStatHolderFromJSONTyped, RecordStatHolderToJSON, RecordStatHolderToJSONTyped, type RequestContext, type RequestOpts, RequiredError, type ResponseContext, ResponseError, type ResponseTransformer, type ScoredDataArticle, ScoredDataArticleFromJSON, ScoredDataArticleFromJSONTyped, ScoredDataArticleToJSON, ScoredDataArticleToJSONTyped, type ScoredDataWikiData, ScoredDataWikiDataFromJSON, ScoredDataWikiDataFromJSONTyped, ScoredDataWikiDataToJSON, ScoredDataWikiDataToJSONTyped, type SearchArticlesRequest, type SearchCompaniesRequest, type SearchJournalistsRequest, type SearchPeopleRequest, type SearchSourcesRequest, type SearchStoriesRequest, type SearchSummarizerRequest, type SearchTopicsRequest, type SearchWikipediaRequest, type SentimentHolder, SentimentHolderFromJSON, SentimentHolderFromJSONTyped, SentimentHolderToJSON, SentimentHolderToJSONTyped, SortBy, SortByFromJSON, SortByFromJSONTyped, SortByToJSON, SortByToJSONTyped, type Source, SourceFromJSON, SourceFromJSONTyped, type SourceHolder, SourceHolderFromJSON, SourceHolderFromJSONTyped, SourceHolderToJSON, SourceHolderToJSONTyped, type SourceLocation, SourceLocationFromJSON, SourceLocationFromJSONTyped, SourceLocationToJSON, SourceLocationToJSONTyped, type SourceSearchResult, SourceSearchResultFromJSON, SourceSearchResultFromJSONTyped, SourceSearchResultToJSON, SourceSearchResultToJSONTyped, SourceToJSON, SourceToJSONTyped, type SourceTopStatHolder, SourceTopStatHolderFromJSON, SourceTopStatHolderFromJSONTyped, SourceTopStatHolderToJSON, SourceTopStatHolderToJSONTyped, type StorySearchResult, StorySearchResultFromJSON, StorySearchResultFromJSONTyped, StorySearchResultToJSON, StorySearchResultToJSONTyped, type SummaryBody, SummaryBodyFromJSON, SummaryBodyFromJSONTyped, SummaryBodyMethodEnum, SummaryBodyModelEnum, SummaryBodySummarizeFieldsEnum, SummaryBodyToJSON, SummaryBodyToJSONTyped, type SummarySearchResult, SummarySearchResultFromJSON, SummarySearchResultFromJSONTyped, SummarySearchResultToJSON, SummarySearchResultToJSONTyped, type SymbolHolder, SymbolHolderFromJSON, SymbolHolderFromJSONTyped, SymbolHolderToJSON, SymbolHolderToJSONTyped, TextApiResponse, type TooManyRequestsException, TooManyRequestsExceptionFromJSON, TooManyRequestsExceptionFromJSONTyped, TooManyRequestsExceptionStatusEnum, TooManyRequestsExceptionToJSON, TooManyRequestsExceptionToJSONTyped, type TopicDto, TopicDtoFromJSON, TopicDtoFromJSONTyped, TopicDtoToJSON, TopicDtoToJSONTyped, type TopicHolder, TopicHolderFromJSON, TopicHolderFromJSONTyped, TopicHolderToJSON, TopicHolderToJSONTyped, type TopicLabels, TopicLabelsFromJSON, TopicLabelsFromJSONTyped, TopicLabelsToJSON, TopicLabelsToJSONTyped, type TopicSearchResult, TopicSearchResultFromJSON, TopicSearchResultFromJSONTyped, TopicSearchResultToJSON, TopicSearchResultToJSONTyped, V1Api, type V1ApiInterface, type VectorSearchArticlesRequest, type VectorSearchWikipediaRequest, VoidApiResponse, type WebResources, WebResourcesFromJSON, WebResourcesFromJSONTyped, WebResourcesToJSON, WebResourcesToJSONTyped, type WikiData, WikiDataFromJSON, WikiDataFromJSONTyped, WikiDataToJSON, WikiDataToJSONTyped, type WikiPage, WikiPageFromJSON, WikiPageFromJSONTyped, type WikiPageSectionHolder, WikiPageSectionHolderFromJSON, WikiPageSectionHolderFromJSONTyped, WikiPageSectionHolderToJSON, WikiPageSectionHolderToJSONTyped, WikiPageToJSON, WikiPageToJSONTyped, type WikidataDateHolder, WikidataDateHolderFromJSON, WikidataDateHolderFromJSONTyped, WikidataDateHolderToJSON, WikidataDateHolderToJSONTyped, type WikidataLabelHolder, WikidataLabelHolderFromJSON, WikidataLabelHolderFromJSONTyped, WikidataLabelHolderToJSON, WikidataLabelHolderToJSONTyped, type WikidataPoliticalPartyHolder, WikidataPoliticalPartyHolderFromJSON, WikidataPoliticalPartyHolderFromJSONTyped, WikidataPoliticalPartyHolderToJSON, WikidataPoliticalPartyHolderToJSONTyped, type WikidataPositionHolder, WikidataPositionHolderFromJSON, WikidataPositionHolderFromJSONTyped, WikidataPositionHolderToJSON, WikidataPositionHolderToJSONTyped, type WikipediaSearchFilter, WikipediaSearchFilterFromJSON, WikipediaSearchFilterFromJSONTyped, WikipediaSearchFilterToJSON, WikipediaSearchFilterToJSONTyped, type WikipediaSearchParams, WikipediaSearchParamsFromJSON, WikipediaSearchParamsFromJSONTyped, WikipediaSearchParamsToJSON, WikipediaSearchParamsToJSONTyped, type WikipediaSearchResult, WikipediaSearchResultFromJSON, WikipediaSearchResultFromJSONTyped, WikipediaSearchResultToJSON, WikipediaSearchResultToJSONTyped, type WikipediaVectorSearchResult, WikipediaVectorSearchResultFromJSON, WikipediaVectorSearchResultFromJSONTyped, WikipediaVectorSearchResultToJSON, WikipediaVectorSearchResultToJSONTyped, canConsumeForm, exists, instanceOfAllEndpointSortBy, instanceOfArticle, instanceOfArticleSearchFilter, instanceOfArticleSearchParams, instanceOfArticlesVectorSearchResult, instanceOfAuthException, instanceOfAuthExceptionCause, instanceOfAuthExceptionCauseStackTraceInner, instanceOfAuthExceptionSuppressedInner, instanceOfCategoryHolder, instanceOfCategoryWithScoreHolder, instanceOfCompany, instanceOfCompanyCount, instanceOfCompanyHolder, instanceOfCompanySearchResult, instanceOfCoordinate, instanceOfCoordinateFilter, instanceOfEntityHolder, instanceOfEventTypeHolder, instanceOfIdNameHolder, instanceOfIllegalParameterException, instanceOfImageHolder, instanceOfInternalErrorException, instanceOfJournalist, instanceOfJournalistSearchResult, instanceOfKeyPoint, instanceOfKeywordHolder, instanceOfLabelHolder, instanceOfLocationCount, instanceOfLocationHolder, instanceOfNameCount, instanceOfNewsCluster, instanceOfNotFoundException, instanceOfPeopleSearchResult, instanceOfPerson, instanceOfPersonCount, instanceOfPersonHolder, instanceOfPlace, instanceOfQuerySearchResult, instanceOfQuestion, instanceOfRecordStatHolder, instanceOfScoredDataArticle, instanceOfScoredDataWikiData, instanceOfSentimentHolder, instanceOfSortBy, instanceOfSource, instanceOfSourceHolder, instanceOfSourceLocation, instanceOfSourceSearchResult, instanceOfSourceTopStatHolder, instanceOfStorySearchResult, instanceOfSummaryBody, instanceOfSummarySearchResult, instanceOfSymbolHolder, instanceOfTooManyRequestsException, instanceOfTopicDto, instanceOfTopicHolder, instanceOfTopicLabels, instanceOfTopicSearchResult, instanceOfWebResources, instanceOfWikiData, instanceOfWikiPage, instanceOfWikiPageSectionHolder, instanceOfWikidataDateHolder, instanceOfWikidataLabelHolder, instanceOfWikidataPoliticalPartyHolder, instanceOfWikidataPositionHolder, instanceOfWikipediaSearchFilter, instanceOfWikipediaSearchParams, instanceOfWikipediaSearchResult, instanceOfWikipediaVectorSearchResult, mapValues, querystring };
|