profoundai 0.7.0 → 0.8.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.
@@ -127,10 +127,19 @@ export interface ReportCitationsParams {
127
127
  >;
128
128
 
129
129
  /**
130
- * List of filters to apply to the report. Each filter has an operator, field, and
131
- * value.
130
+ * List of filters to apply to the citations report.
132
131
  */
133
- filters?: Array<ReportCitationsParams.Filter>;
132
+ filters?: Array<
133
+ | ReportCitationsParams.HostnameFilter
134
+ | ReportCitationsParams.AppModelsAnswerEngineInsightsFiltersPathFilter
135
+ | ReportCitationsParams.RegionIDFilter
136
+ | ReportCitationsParams.TopicIDFilter
137
+ | ReportCitationsParams.ModelIDFilter
138
+ | ReportCitationsParams.TagIDFilter
139
+ | ReportCitationsParams.URLFilter
140
+ | ReportCitationsParams.RootDomainFilter
141
+ | ReportCitationsParams.PromptTypeFilter
142
+ >;
134
143
 
135
144
  /**
136
145
  * Custom ordering of the report results.
@@ -153,8 +162,31 @@ export interface ReportCitationsParams {
153
162
  }
154
163
 
155
164
  export namespace ReportCitationsParams {
156
- export interface Filter {
157
- field: 'hostname' | 'path' | 'region' | 'topic' | 'model' | 'tag' | 'url' | 'root_domain' | 'prompt_type';
165
+ /**
166
+ * Filter by hostname
167
+ */
168
+ export interface HostnameFilter {
169
+ field: 'hostname';
170
+
171
+ operator:
172
+ | 'is'
173
+ | 'not_is'
174
+ | 'in'
175
+ | 'not_in'
176
+ | 'contains'
177
+ | 'not_contains'
178
+ | 'matches'
179
+ | 'contains_case_insensitive'
180
+ | 'not_contains_case_insensitive';
181
+
182
+ value: string | Array<string>;
183
+ }
184
+
185
+ /**
186
+ * Filter by URL path
187
+ */
188
+ export interface AppModelsAnswerEngineInsightsFiltersPathFilter {
189
+ field: 'path';
158
190
 
159
191
  operator:
160
192
  | 'is'
@@ -163,15 +195,115 @@ export namespace ReportCitationsParams {
163
195
  | 'not_in'
164
196
  | 'contains'
165
197
  | 'not_contains'
198
+ | 'matches'
166
199
  | 'contains_case_insensitive'
167
- | 'not_contains_case_insensitive'
168
- | 'matches';
200
+ | 'not_contains_case_insensitive';
201
+
202
+ value: string | Array<string>;
203
+ }
204
+
205
+ export interface RegionIDFilter {
206
+ /**
207
+ * - `region` - Deprecated
208
+ */
209
+ field: 'region_id' | 'region';
169
210
 
211
+ operator: 'is' | 'not_is' | 'in' | 'not_in';
212
+
213
+ value: string | Array<string>;
214
+ }
215
+
216
+ export interface TopicIDFilter {
217
+ /**
218
+ * - `topic` - Deprecated
219
+ */
220
+ field: 'topic_id' | 'topic';
221
+
222
+ operator: 'is' | 'not_is' | 'in' | 'not_in';
223
+
224
+ value: string | Array<string>;
225
+ }
226
+
227
+ export interface ModelIDFilter {
228
+ /**
229
+ * - `model` - Deprecated
230
+ */
231
+ field: 'model_id' | 'model';
232
+
233
+ operator: 'is' | 'not_is' | 'in' | 'not_in';
234
+
235
+ value: string | Array<string>;
236
+ }
237
+
238
+ export interface TagIDFilter {
170
239
  /**
171
- * Value for the filter. Can be a single value or a list of depending on the
172
- * operator.
240
+ * - `tag` - Deprecated
173
241
  */
174
- value: string | Array<string> | number | Array<number>;
242
+ field: 'tag_id' | 'tag';
243
+
244
+ operator: 'is' | 'not_is' | 'in' | 'not_in';
245
+
246
+ value: string | Array<string>;
247
+ }
248
+
249
+ /**
250
+ * Filter by URL
251
+ */
252
+ export interface URLFilter {
253
+ field: 'url';
254
+
255
+ operator:
256
+ | 'is'
257
+ | 'not_is'
258
+ | 'in'
259
+ | 'not_in'
260
+ | 'contains'
261
+ | 'not_contains'
262
+ | 'matches'
263
+ | 'contains_case_insensitive'
264
+ | 'not_contains_case_insensitive';
265
+
266
+ value: string | Array<string>;
267
+ }
268
+
269
+ /**
270
+ * Filter by root domain
271
+ */
272
+ export interface RootDomainFilter {
273
+ field: 'root_domain';
274
+
275
+ operator:
276
+ | 'is'
277
+ | 'not_is'
278
+ | 'in'
279
+ | 'not_in'
280
+ | 'contains'
281
+ | 'not_contains'
282
+ | 'matches'
283
+ | 'contains_case_insensitive'
284
+ | 'not_contains_case_insensitive';
285
+
286
+ value: string | Array<string>;
287
+ }
288
+
289
+ /**
290
+ * Filter by prompt type (visibility or sentiment)
291
+ */
292
+ export interface PromptTypeFilter {
293
+ field: 'prompt_type';
294
+
295
+ operator:
296
+ | 'is'
297
+ | 'not_is'
298
+ | 'in'
299
+ | 'not_in'
300
+ | 'contains'
301
+ | 'not_contains'
302
+ | 'matches'
303
+ | 'contains_case_insensitive'
304
+ | 'not_contains_case_insensitive';
305
+
306
+ value: 'visibility' | 'sentiment' | Array<'visibility' | 'sentiment'>;
175
307
  }
176
308
  }
177
309
 
@@ -203,10 +335,17 @@ export interface ReportSentimentParams {
203
335
  dimensions?: Array<'theme' | 'date' | 'region' | 'topic' | 'model' | 'asset_name' | 'tag' | 'prompt'>;
204
336
 
205
337
  /**
206
- * List of filters to apply to the report. Each filter has an operator, field, and
207
- * value.
338
+ * List of filters to apply to the sentiment report.
208
339
  */
209
- filters?: Array<ReportSentimentParams.Filter>;
340
+ filters?: Array<
341
+ | ReportSentimentParams.AssetNameFilter
342
+ | ReportSentimentParams.ThemeFilter
343
+ | ReportSentimentParams.RegionIDFilter
344
+ | ReportSentimentParams.TopicIDFilter
345
+ | ReportSentimentParams.ModelIDFilter
346
+ | ReportSentimentParams.TagIDFilter
347
+ | ReportSentimentParams.PromptFilter
348
+ >;
210
349
 
211
350
  /**
212
351
  * Custom ordering of the report results.
@@ -229,8 +368,11 @@ export interface ReportSentimentParams {
229
368
  }
230
369
 
231
370
  export namespace ReportSentimentParams {
232
- export interface Filter {
233
- field: 'asset_name' | 'theme' | 'region' | 'topic' | 'model' | 'tag';
371
+ /**
372
+ * Filter by asset name
373
+ */
374
+ export interface AssetNameFilter {
375
+ field: 'asset_name';
234
376
 
235
377
  operator:
236
378
  | 'is'
@@ -239,15 +381,95 @@ export namespace ReportSentimentParams {
239
381
  | 'not_in'
240
382
  | 'contains'
241
383
  | 'not_contains'
384
+ | 'matches'
242
385
  | 'contains_case_insensitive'
243
- | 'not_contains_case_insensitive'
244
- | 'matches';
386
+ | 'not_contains_case_insensitive';
245
387
 
388
+ value: string | Array<string>;
389
+ }
390
+
391
+ /**
392
+ * Filter by theme
393
+ */
394
+ export interface ThemeFilter {
395
+ field: 'theme';
396
+
397
+ operator:
398
+ | 'is'
399
+ | 'not_is'
400
+ | 'in'
401
+ | 'not_in'
402
+ | 'contains'
403
+ | 'not_contains'
404
+ | 'matches'
405
+ | 'contains_case_insensitive'
406
+ | 'not_contains_case_insensitive';
407
+
408
+ value: string | Array<string>;
409
+ }
410
+
411
+ export interface RegionIDFilter {
246
412
  /**
247
- * Value for the filter. Can be a single value or a list of depending on the
248
- * operator.
413
+ * - `region` - Deprecated
249
414
  */
250
- value: string | Array<string> | number | Array<number>;
415
+ field: 'region_id' | 'region';
416
+
417
+ operator: 'is' | 'not_is' | 'in' | 'not_in';
418
+
419
+ value: string | Array<string>;
420
+ }
421
+
422
+ export interface TopicIDFilter {
423
+ /**
424
+ * - `topic` - Deprecated
425
+ */
426
+ field: 'topic_id' | 'topic';
427
+
428
+ operator: 'is' | 'not_is' | 'in' | 'not_in';
429
+
430
+ value: string | Array<string>;
431
+ }
432
+
433
+ export interface ModelIDFilter {
434
+ /**
435
+ * - `model` - Deprecated
436
+ */
437
+ field: 'model_id' | 'model';
438
+
439
+ operator: 'is' | 'not_is' | 'in' | 'not_in';
440
+
441
+ value: string | Array<string>;
442
+ }
443
+
444
+ export interface TagIDFilter {
445
+ /**
446
+ * - `tag` - Deprecated
447
+ */
448
+ field: 'tag_id' | 'tag';
449
+
450
+ operator: 'is' | 'not_is' | 'in' | 'not_in';
451
+
452
+ value: string | Array<string>;
453
+ }
454
+
455
+ /**
456
+ * Filter by prompt text
457
+ */
458
+ export interface PromptFilter {
459
+ field: 'prompt';
460
+
461
+ operator:
462
+ | 'is'
463
+ | 'not_is'
464
+ | 'in'
465
+ | 'not_in'
466
+ | 'contains'
467
+ | 'not_contains'
468
+ | 'matches'
469
+ | 'contains_case_insensitive'
470
+ | 'not_contains_case_insensitive';
471
+
472
+ value: string | Array<string>;
251
473
  }
252
474
  }
253
475
 
@@ -279,10 +501,16 @@ export interface ReportVisibilityParams {
279
501
  dimensions?: Array<'date' | 'region' | 'topic' | 'model' | 'asset_name' | 'prompt' | 'tag'>;
280
502
 
281
503
  /**
282
- * List of filters to apply to the report. Each filter has an operator, field, and
283
- * value.
504
+ * List of filters to apply to the visibility report.
284
505
  */
285
- filters?: Array<ReportVisibilityParams.Filter>;
506
+ filters?: Array<
507
+ | ReportVisibilityParams.RegionIDFilter
508
+ | ReportVisibilityParams.ModelIDFilter
509
+ | ReportVisibilityParams.TopicIDFilter
510
+ | ReportVisibilityParams.AssetNameFilter
511
+ | ReportVisibilityParams.TagIDFilter
512
+ | ReportVisibilityParams.PromptFilter
513
+ >;
286
514
 
287
515
  /**
288
516
  * Custom ordering of the report results.
@@ -305,8 +533,44 @@ export interface ReportVisibilityParams {
305
533
  }
306
534
 
307
535
  export namespace ReportVisibilityParams {
308
- export interface Filter {
309
- field: 'region' | 'topic' | 'model' | 'asset_name' | 'prompt' | 'tag';
536
+ export interface RegionIDFilter {
537
+ /**
538
+ * - `region` - Deprecated
539
+ */
540
+ field: 'region_id' | 'region';
541
+
542
+ operator: 'is' | 'not_is' | 'in' | 'not_in';
543
+
544
+ value: string | Array<string>;
545
+ }
546
+
547
+ export interface ModelIDFilter {
548
+ /**
549
+ * - `model` - Deprecated
550
+ */
551
+ field: 'model_id' | 'model';
552
+
553
+ operator: 'is' | 'not_is' | 'in' | 'not_in';
554
+
555
+ value: string | Array<string>;
556
+ }
557
+
558
+ export interface TopicIDFilter {
559
+ /**
560
+ * - `topic` - Deprecated
561
+ */
562
+ field: 'topic_id' | 'topic';
563
+
564
+ operator: 'is' | 'not_is' | 'in' | 'not_in';
565
+
566
+ value: string | Array<string>;
567
+ }
568
+
569
+ /**
570
+ * Filter by asset name
571
+ */
572
+ export interface AssetNameFilter {
573
+ field: 'asset_name';
310
574
 
311
575
  operator:
312
576
  | 'is'
@@ -315,15 +579,42 @@ export namespace ReportVisibilityParams {
315
579
  | 'not_in'
316
580
  | 'contains'
317
581
  | 'not_contains'
582
+ | 'matches'
318
583
  | 'contains_case_insensitive'
319
- | 'not_contains_case_insensitive'
320
- | 'matches';
584
+ | 'not_contains_case_insensitive';
321
585
 
586
+ value: string | Array<string>;
587
+ }
588
+
589
+ export interface TagIDFilter {
322
590
  /**
323
- * Value for the filter. Can be a single value or a list of depending on the
324
- * operator.
591
+ * - `tag` - Deprecated
325
592
  */
326
- value: string | Array<string> | number | Array<number>;
593
+ field: 'tag_id' | 'tag';
594
+
595
+ operator: 'is' | 'not_is' | 'in' | 'not_in';
596
+
597
+ value: string | Array<string>;
598
+ }
599
+
600
+ /**
601
+ * Filter by prompt text
602
+ */
603
+ export interface PromptFilter {
604
+ field: 'prompt';
605
+
606
+ operator:
607
+ | 'is'
608
+ | 'not_is'
609
+ | 'in'
610
+ | 'not_in'
611
+ | 'contains'
612
+ | 'not_contains'
613
+ | 'matches'
614
+ | 'contains_case_insensitive'
615
+ | 'not_contains_case_insensitive';
616
+
617
+ value: string | Array<string>;
327
618
  }
328
619
  }
329
620
 
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.7.0'; // x-release-please-version
1
+ export const VERSION = '0.8.0'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.7.0";
1
+ export declare const VERSION = "0.8.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.7.0";
1
+ export declare const VERSION = "0.8.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '0.7.0'; // x-release-please-version
4
+ exports.VERSION = '0.8.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '0.7.0'; // x-release-please-version
1
+ export const VERSION = '0.8.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map