@goperigon/perigon-ts 1.1.1 → 1.1.2
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 +11 -11
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -101,7 +101,7 @@ console.log(journalist.name);
|
|
|
101
101
|
|
|
102
102
|
### Articles – search and filter news (`/v1/all`)<br>
|
|
103
103
|
|
|
104
|
-
**Docs →** <https://
|
|
104
|
+
**Docs →** <https://dev.perigon.io/reference?endpoint=11>
|
|
105
105
|
|
|
106
106
|
```ts
|
|
107
107
|
const { articles } = await perigon.searchArticles({
|
|
@@ -112,7 +112,7 @@ const { articles } = await perigon.searchArticles({
|
|
|
112
112
|
|
|
113
113
|
### Articles – date range filter<br>
|
|
114
114
|
|
|
115
|
-
**Docs →** <https://
|
|
115
|
+
**Docs →** <https://dev.perigon.io/reference?endpoint=11>
|
|
116
116
|
|
|
117
117
|
```ts
|
|
118
118
|
await perigon.searchArticles({
|
|
@@ -124,7 +124,7 @@ await perigon.searchArticles({
|
|
|
124
124
|
|
|
125
125
|
### Articles – restrict to a source<br>
|
|
126
126
|
|
|
127
|
-
**Docs →** <https://
|
|
127
|
+
**Docs →** <https://dev.perigon.io/reference?endpoint=11>
|
|
128
128
|
|
|
129
129
|
```ts
|
|
130
130
|
await perigon.searchArticles({ source: ["nytimes.com"] });
|
|
@@ -132,7 +132,7 @@ await perigon.searchArticles({ source: ["nytimes.com"] });
|
|
|
132
132
|
|
|
133
133
|
### Companies – fetch structured company data (`/v1/companies`)<br>
|
|
134
134
|
|
|
135
|
-
**Docs →** <https://
|
|
135
|
+
**Docs →** <https://dev.perigon.io/reference?endpoint=2>
|
|
136
136
|
|
|
137
137
|
```ts
|
|
138
138
|
const { results } = await perigon.searchCompanies({
|
|
@@ -143,7 +143,7 @@ const { results } = await perigon.searchCompanies({
|
|
|
143
143
|
|
|
144
144
|
### Journalists – search and detail look‑up (`/v1/journalists`)<br>
|
|
145
145
|
|
|
146
|
-
**Docs →** <https://
|
|
146
|
+
**Docs →** <https://dev.perigon.io/reference?endpoint=2>
|
|
147
147
|
|
|
148
148
|
```ts
|
|
149
149
|
const { results } = await perigon.searchJournalists1({
|
|
@@ -155,7 +155,7 @@ const journalist = await perigon.getJournalistById({ id: results[0].id });
|
|
|
155
155
|
|
|
156
156
|
### Stories – discover related article clusters (`/v1/stories`)<br>
|
|
157
157
|
|
|
158
|
-
**Docs →** <https://
|
|
158
|
+
**Docs →** <https://dev.perigon.io/reference?endpoint=7>
|
|
159
159
|
|
|
160
160
|
```ts
|
|
161
161
|
await perigon.searchStories({ q: "climate change", size: 5 });
|
|
@@ -163,7 +163,7 @@ await perigon.searchStories({ q: "climate change", size: 5 });
|
|
|
163
163
|
|
|
164
164
|
### Wikipedia – search Wikipedia pages (`/v1/wikipedia`)<br>
|
|
165
165
|
|
|
166
|
-
**Docs →** <https://
|
|
166
|
+
**Docs →** <https://dev.perigon.io/reference?endpoint=13>
|
|
167
167
|
|
|
168
168
|
```ts
|
|
169
169
|
const { pages } = await perigon.searchWikipedia({
|
|
@@ -174,7 +174,7 @@ const { pages } = await perigon.searchWikipedia({
|
|
|
174
174
|
|
|
175
175
|
### Vector search – semantic retrieval (`/v1/vector`)<br>
|
|
176
176
|
|
|
177
|
-
**Docs →** <https://
|
|
177
|
+
**Docs →** <https://dev.perigon.io/reference?endpoint=10>
|
|
178
178
|
|
|
179
179
|
```ts
|
|
180
180
|
await perigon.vectorSearchArticles({
|
|
@@ -187,7 +187,7 @@ await perigon.vectorSearchArticles({
|
|
|
187
187
|
|
|
188
188
|
### Wikipedia vector search – semantic Wikipedia retrieval (`/v1/vector/wikipedia`)<br>
|
|
189
189
|
|
|
190
|
-
**Docs →** <https://
|
|
190
|
+
**Docs →** <https://dev.perigon.io/reference?endpoint=12>
|
|
191
191
|
|
|
192
192
|
```ts
|
|
193
193
|
await perigon.vectorSearchWikipedia({
|
|
@@ -200,7 +200,7 @@ await perigon.vectorSearchWikipedia({
|
|
|
200
200
|
|
|
201
201
|
### Summarizer – generate an instant summary (`/v1/summarizer`)<br>
|
|
202
202
|
|
|
203
|
-
**Docs →** <https://
|
|
203
|
+
**Docs →** <https://dev.perigon.io/reference?endpoint=8>
|
|
204
204
|
|
|
205
205
|
```ts
|
|
206
206
|
const { summary } = await perigon.searchSummarizer({
|
|
@@ -212,7 +212,7 @@ console.log(summary);
|
|
|
212
212
|
|
|
213
213
|
### Topics – explore taxonomy (`/v1/topics`)<br>
|
|
214
214
|
|
|
215
|
-
**Docs →** <https://
|
|
215
|
+
**Docs →** <https://dev.perigon.io/reference?endpoint=9>
|
|
216
216
|
|
|
217
217
|
```ts
|
|
218
218
|
await perigon.searchTopics({ size: 10 });
|