@elmohq/sdk 0.1.2 → 0.2.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.
@@ -46,6 +46,50 @@ type ModelFilter = string;
46
46
  /** Resource not found */
47
47
  type NotFoundError = Error;
48
48
  //#endregion
49
+ //#region src/types/shared/position.d.ts
50
+ /**
51
+ * **Experimental — the shape may still change.**
52
+ *
53
+ * The company's position among the tracked companies the answers name, 1 being named first.
54
+ * Companies that aren't tracked aren't ranked. Counted over every answer in the window, unlike
55
+ * `visibility.current` and the share-of-voice `mentions` and `share`, which count each prompt's
56
+ * latest result.
57
+ */
58
+ type Position = {
59
+ /**
60
+ * Average position to one decimal; null when no answer ranks it.
61
+ *
62
+ * @minimum 1
63
+ */
64
+ average: number | null;
65
+ };
66
+ /**
67
+ * **Experimental — the shape may still change.**
68
+ *
69
+ * Answers that mention the company, by the mention judge's sentiment toward it. An answer that only
70
+ * links to the company counts in none. All zero for history the judge hasn't re-judged yet. Counted
71
+ * over every answer in the window, unlike `visibility.current` and the share-of-voice `mentions`
72
+ * and `share`, which count each prompt's latest result.
73
+ */
74
+ type SentimentSummary = {
75
+ /** @minimum 0 */
76
+ mixed: number;
77
+ /** @minimum 0 */
78
+ negative: number;
79
+ /** @minimum 0 */
80
+ neutral: number;
81
+ /** @minimum 0 */
82
+ positive: number;
83
+ /**
84
+ * Net sentiment of the answers with a sentiment: positive counts 1, neutral and mixed 0.5,
85
+ * negative 0, averaged. 0.5 means neutral on balance. Ratio 0–1; null when there are none.
86
+ *
87
+ * @minimum 0
88
+ * @maximum 1
89
+ */
90
+ score: number | null;
91
+ };
92
+ //#endregion
49
93
  //#region src/types/shared/validation-error.d.ts
50
94
  /** Invalid request data */
51
95
  type ValidationError = Error;
@@ -77,8 +121,10 @@ type ShareOfVoiceEntry = {
77
121
  mentions: number;
78
122
  /** Brand or competitor name. */
79
123
  name: string;
124
+ position: Position;
80
125
  /** Distinct prompts this entity appeared in. */
81
126
  prompts: number;
127
+ sentiment: SentimentSummary;
82
128
  /**
83
129
  * This entity's share of all brand and competitor mentions. Ratio 0–1; multiply by 100 for a
84
130
  * percentage.
@@ -208,7 +254,9 @@ type PromptPerformance = {
208
254
  competitorMentionRate: number;
209
255
  firstEvaluatedAt: Date | null;
210
256
  lastRunAt: Date | null;
257
+ position: Position;
211
258
  promptId: string;
259
+ sentiment: SentimentSummary;
212
260
  tags: Array<string>;
213
261
  totalRuns: number;
214
262
  value: string;
@@ -224,7 +272,9 @@ type ModelVisibility = {
224
272
  citations: number;
225
273
  label: string;
226
274
  model: string;
275
+ position: Position;
227
276
  runs: number;
277
+ sentiment: SentimentSummary;
228
278
  /**
229
279
  * Share of this model's runs that mentioned the brand. Ratio 0–1; multiply by 100 for a
230
280
  * percentage.
@@ -236,16 +286,17 @@ type ModelVisibility = {
236
286
  };
237
287
  /**
238
288
  * Every non-paginated figure for a brand over one window. There is no parameter for selecting a
239
- * subset: the four computations behind this share one scope resolution and run concurrently, so a
240
- * subset would save a caller a fraction of one request and cost everyone a parameter to reason
241
- * about.
289
+ * subset: the computations behind this cover the same prompts and run concurrently, so a subset
290
+ * would save a caller a fraction of one request and cost everyone a parameter to reason about.
242
291
  */
243
292
  type BrandAnalytics = {
244
293
  brandId: string;
245
294
  brandName: string;
246
295
  /** Per-model visibility and run counts. Only models that produced a run in the window appear. */
247
296
  models: Array<ModelVisibility>;
297
+ position: BrandPosition;
248
298
  range: DateRange;
299
+ sentiment: BrandSentiment;
249
300
  /** The brand against its tracked competitors. */
250
301
  shareOfVoice: {
251
302
  /**
@@ -281,6 +332,44 @@ type BrandAnalytics = {
281
332
  series: Array<VisibilityPoint>;
282
333
  };
283
334
  };
335
+ /**
336
+ * **Experimental — the shape may still change.**
337
+ *
338
+ * The brand's sentiment over the window, with the counts for each day so a client can chart or
339
+ * smooth them.
340
+ */
341
+ type BrandSentiment = SentimentSummary & {
342
+ series: Array<{
343
+ date: string;
344
+ /** @minimum 0 */
345
+ mixed: number;
346
+ /** @minimum 0 */
347
+ negative: number;
348
+ /** @minimum 0 */
349
+ neutral: number;
350
+ /** @minimum 0 */
351
+ positive: number;
352
+ }>;
353
+ };
354
+ /**
355
+ * **Experimental — the shape may still change.**
356
+ *
357
+ * The brand's position among the tracked companies the answers name, 1 being named first, averaged
358
+ * over the window and per day.
359
+ */
360
+ type BrandPosition = {
361
+ /**
362
+ * Average position over the window, to one decimal; null when no answer ranks it.
363
+ *
364
+ * @minimum 1
365
+ */
366
+ average: number | null;
367
+ series: Array<{
368
+ /** @minimum 1 */
369
+ average: number | null;
370
+ date: string;
371
+ }>;
372
+ };
284
373
  /** Comma-separated prompt tags. Only prompts carrying at least one of them are counted. */
285
374
  type TagsFilter = string;
286
375
  type GetBrandAnalyticsErrors = {
@@ -1229,6 +1318,7 @@ type ListOrganizationsParams = {
1229
1318
  //#region src/types/runs.d.ts
1230
1319
  /** A single model answer, without its text. Fetch `prompts.runs.get()` for the answer itself. */
1231
1320
  type RunSummary = {
1321
+ assessments: RunAssessments;
1232
1322
  brandId: string;
1233
1323
  brandMentioned: boolean;
1234
1324
  citationCount: number;
@@ -1265,6 +1355,67 @@ type RunList = {
1265
1355
  data: Array<RunSummary>;
1266
1356
  pagination: Pagination;
1267
1357
  };
1358
+ /**
1359
+ * **Experimental — the shape may still change.**
1360
+ *
1361
+ * The mention judge's assessment of one brand or competitor named in an answer.
1362
+ */
1363
+ type MentionAssessment = {
1364
+ /**
1365
+ * How many times the answer mentions it. Null when the answer isn't counted as mentioning it.
1366
+ *
1367
+ * @minimum 1
1368
+ */
1369
+ mentionCount: number | null;
1370
+ /**
1371
+ * Whether the answer counts as mentioning this company. A name the judge can't call either way
1372
+ * counts.
1373
+ */
1374
+ mentioned: boolean;
1375
+ /**
1376
+ * 1 for the tracked company the answer names first, 2 for the next, and so on. Null when the
1377
+ * answer isn't counted as mentioning it.
1378
+ *
1379
+ * @minimum 1
1380
+ */
1381
+ position: number | null;
1382
+ /**
1383
+ * Calibrated probability that the answer mentions this company.
1384
+ *
1385
+ * @minimum 0
1386
+ * @maximum 1
1387
+ */
1388
+ probability: number;
1389
+ /**
1390
+ * When it isn't counted as a mention, the likeliest other reading: `other_meaning` (the name used
1391
+ * as an ordinary word), `other_company` (a different company with the same name) or `no_info`
1392
+ * (the answer says it knows nothing about it). Informational; not a stable enum.
1393
+ */
1394
+ reason: string | null;
1395
+ /**
1396
+ * The likeliest sentiment toward this company in the passages about it. Null when the answer
1397
+ * isn't about it, or when it only links to the company.
1398
+ */
1399
+ sentiment: 'positive' | 'neutral' | 'negative' | 'mixed' | null;
1400
+ /** Probability of each sentiment, keyed by label. */
1401
+ sentimentProbabilities: {
1402
+ [key: string]: number;
1403
+ } | null;
1404
+ };
1405
+ /**
1406
+ * **Experimental — the shape may still change.**
1407
+ *
1408
+ * The mention judge's assessments for one answer. Null when the run's mentions were matched by
1409
+ * name, before the judge, until a replay judges it.
1410
+ */
1411
+ type RunAssessments = {
1412
+ /** Null when the answer never names the brand. */
1413
+ brand: MentionAssessment | null;
1414
+ /** Keyed by competitor name; only competitors the answer names. */
1415
+ competitors: {
1416
+ [key: string]: MentionAssessment;
1417
+ };
1418
+ } | null;
1268
1419
  type ListPromptRunsErrors = {
1269
1420
  /** Invalid request data */
1270
1421
  400: ValidationError;
@@ -1387,10 +1538,12 @@ type PromptSnapshot = {
1387
1538
  /** End of the queried date range (YYYY-MM-DD) */
1388
1539
  endDate: string;
1389
1540
  mentions: MentionsSummary;
1541
+ position: Position;
1390
1542
  /** Unique identifier for the prompt */
1391
1543
  promptId: string;
1392
1544
  /** The prompt text */
1393
1545
  promptValue: string;
1546
+ sentiment: SentimentSummary;
1394
1547
  /** Start of the queried date range (YYYY-MM-DD) */
1395
1548
  startDate: string;
1396
1549
  };
@@ -1955,5 +2108,5 @@ type AnalyzeBrandParams = {
1955
2108
  maxPrompts?: number;
1956
2109
  };
1957
2110
  //#endregion
1958
- export { GetOrganizationBillingResponses as $, BrandOpportunities as $t, ListPromptsResponses as A, PromptPerformance as An, UpdateCompetitorResponses as At, MentionEntry as B, WindowStart as Bn, ListBrandsResponses as Bt, DeletePromptResponse as C, ListBrandCitationURLsErrors as Cn, GetCompetitorErrors as Ct, ListPromptsErrors as D, ListBrandPromptPerformanceParams as Dn, ListCompetitorsResponses as Dt, GetPromptResponses as E, ListBrandPromptPerformanceErrors as En, ListCompetitorsParams as Et, CitedURLEntry as F, VisibilityPoint as Fn, CreateBrandResponses as Ft, ListPromptRunsParams as G, UnauthorizedError as Gn, Page as Gt, GetRunErrors as H, ForbiddenError as Hn, UpdateBrandParams as Ht, GetPromptSnapshotErrors as I, ValidationError as In, GetBrandErrors as It, RunCitation as J, PaymentRequiredError as Jt, ListPromptRunsResponses as K, Limit as Kt, GetPromptSnapshotParams as L, NotFoundError as Ln, GetBrandResponses as Lt, UpdatePromptErrors as M, ShareOfVoiceEntry as Mn, BrandsList as Mt, UpdatePromptParams as N, ShareOfVoicePoint as Nn, CreateBrandErrors as Nt, ListPromptsParams as O, ListBrandPromptPerformanceResponses as On, UpdateCompetitorErrors as Ot, UpdatePromptResponses as P, TagsFilter as Pn, CreateBrandParams as Pt, GetOrganizationBillingErrors as Q, TagList as Qt, GetPromptSnapshotResponses as R, ModelFilter as Rn, ListBrandsErrors as Rt, DeletePromptErrors as S, ListBrandCitationDomainsResponses as Sn, DeleteCompetitorResponses as St, GetPromptErrors as T, ListBrandCitationURLsResponses as Tn, ListCompetitorsErrors as Tt, GetRunResponses as U, InternalServerError as Un, UpdateBrandResponses as Ut, MentionsSummary as V, Error as Vn, UpdateBrandErrors as Vt, ListPromptRunsErrors as W, RateLimitError as Wn, Pagination as Wt, RunSummary as X, ListBrandTagsResponses as Xt, RunList as Y, ListBrandTagsErrors as Yt, BillingPlan as Z, Tag as Zt, ReportPromptSnapshot as _, GetBrandQueryFanoutErrors as _n, CompetitorsList as _t, CreateReportErrors as a, BrandIdPath as an, Organization as at, CreatePromptParams as b, ListBrandCitationDomainsErrors as bn, CreateCompetitorResponses as bt, CreateReportResponses as c, CitationDomain as cn, PlanLimits as ct, GetReportResponse as d, CitationURLList as dn, Model as dt, CitedPage as en, GetOrganizationErrors as et, GetReportResponses as f, DateRange as fn, ModelList as ft, ListReportsResponses as g, GetBrandAnalyticsResponses as gn, Competitor as gt, ListReportsResponse as h, GetBrandAnalyticsParams as hn, GetMeResponses as ht, OnboardingSuggestion as i, OpportunityPrompt as in, ListOrganizationsResponses as it, Prompt as j, PromptPerformanceList as jn, Brand as jt, ListPromptsResponse as k, ModelVisibility as kn, UpdateCompetitorParams as kt, GetReportErrors as l, CitationDomainList as ln, ListModelsErrors as lt, ListReportsParams as m, GetBrandAnalyticsErrors as mn, GetMeErrors as mt, AnalyzeBrandParams as n, GetBrandOpportunitiesResponses as nn, ListOrganizationsErrors as nt, CreateReportParams as o, BrandAnalytics as on, OrganizationBilling as ot, ListReportsErrors as p, FanoutQuery as pn, APIKeyIdentity as pt, Run as q, ConflictError as qt, AnalyzeBrandResponses as r, Opportunity as rn, ListOrganizationsParams as rt, CreateReportResponse as s, BrandQueryFanout as sn, OrganizationList as st, AnalyzeBrandErrors as t, GetBrandOpportunitiesErrors as tn, GetOrganizationResponses as tt, GetReportParams as u, CitationURL as un, ListModelsResponses as ut, ReportSummary as v, GetBrandQueryFanoutParams as vn, CreateCompetitorErrors as vt, DeletePromptResponses as w, ListBrandCitationURLsParams as wn, GetCompetitorResponses as wt, CreatePromptResponses as x, ListBrandCitationDomainsParams as xn, DeleteCompetitorErrors as xt, CreatePromptErrors as y, GetBrandQueryFanoutResponses as yn, CreateCompetitorParams as yt, PromptSnapshot as z, WindowEnd as zn, ListBrandsParams as zt };
1959
- //# sourceMappingURL=tools-DpxrXc33.d.mts.map
2111
+ export { BillingPlan as $, Tag as $t, ListPromptsResponses as A, ListBrandPromptPerformanceErrors as An, UpdateCompetitorErrors as At, MentionEntry as B, ValidationError as Bn, ListBrandsErrors as Bt, DeletePromptResponse as C, GetBrandQueryFanoutResponses as Cn, DeleteCompetitorErrors as Ct, ListPromptsErrors as D, ListBrandCitationURLsErrors as Dn, ListCompetitorsErrors as Dt, GetPromptResponses as E, ListBrandCitationDomainsResponses as En, GetCompetitorResponses as Et, CitedURLEntry as F, PromptPerformanceList as Fn, CreateBrandErrors as Ft, ListPromptRunsParams as G, WindowEnd as Gn, UpdateBrandResponses as Gt, GetRunErrors as H, SentimentSummary as Hn, ListBrandsResponses as Ht, GetPromptSnapshotErrors as I, ShareOfVoiceEntry as In, CreateBrandParams as It, Run as J, ForbiddenError as Jn, Limit as Jt, ListPromptRunsResponses as K, WindowStart as Kn, Pagination as Kt, GetPromptSnapshotParams as L, ShareOfVoicePoint as Ln, CreateBrandResponses as Lt, UpdatePromptErrors as M, ListBrandPromptPerformanceResponses as Mn, UpdateCompetitorResponses as Mt, UpdatePromptParams as N, ModelVisibility as Nn, Brand as Nt, ListPromptsParams as O, ListBrandCitationURLsParams as On, ListCompetitorsParams as Ot, UpdatePromptResponses as P, PromptPerformance as Pn, BrandsList as Pt, RunSummary as Q, ListBrandTagsResponses as Qt, GetPromptSnapshotResponses as R, TagsFilter as Rn, GetBrandErrors as Rt, DeletePromptErrors as S, GetBrandQueryFanoutParams as Sn, CreateCompetitorResponses as St, GetPromptErrors as T, ListBrandCitationDomainsParams as Tn, GetCompetitorErrors as Tt, GetRunResponses as U, NotFoundError as Un, UpdateBrandErrors as Ut, MentionsSummary as V, Position as Vn, ListBrandsParams as Vt, ListPromptRunsErrors as W, ModelFilter as Wn, UpdateBrandParams as Wt, RunCitation as X, RateLimitError as Xn, PaymentRequiredError as Xt, RunAssessments as Y, InternalServerError as Yn, ConflictError as Yt, RunList as Z, UnauthorizedError as Zn, ListBrandTagsErrors as Zt, ReportPromptSnapshot as _, FanoutQuery as _n, GetMeResponses as _t, CreateReportErrors as a, Opportunity as an, ListOrganizationsParams as at, CreatePromptParams as b, GetBrandAnalyticsResponses as bn, CreateCompetitorErrors as bt, CreateReportResponses as c, BrandAnalytics as cn, OrganizationBilling as ct, GetReportResponse as d, BrandSentiment as dn, ListModelsErrors as dt, TagList as en, GetOrganizationBillingErrors as et, GetReportResponses as f, CitationDomain as fn, ListModelsResponses as ft, ListReportsResponses as g, DateRange as gn, GetMeErrors as gt, ListReportsResponse as h, CitationURLList as hn, APIKeyIdentity as ht, OnboardingSuggestion as i, GetBrandOpportunitiesResponses as in, ListOrganizationsErrors as it, Prompt as j, ListBrandPromptPerformanceParams as jn, UpdateCompetitorParams as jt, ListPromptsResponse as k, ListBrandCitationURLsResponses as kn, ListCompetitorsResponses as kt, GetReportErrors as l, BrandPosition as ln, OrganizationList as lt, ListReportsParams as m, CitationURL as mn, ModelList as mt, AnalyzeBrandParams as n, CitedPage as nn, GetOrganizationErrors as nt, CreateReportParams as o, OpportunityPrompt as on, ListOrganizationsResponses as ot, ListReportsErrors as p, CitationDomainList as pn, Model as pt, MentionAssessment as q, Error as qn, Page as qt, AnalyzeBrandResponses as r, GetBrandOpportunitiesErrors as rn, GetOrganizationResponses as rt, CreateReportResponse as s, BrandIdPath as sn, Organization as st, AnalyzeBrandErrors as t, BrandOpportunities as tn, GetOrganizationBillingResponses as tt, GetReportParams as u, BrandQueryFanout as un, PlanLimits as ut, ReportSummary as v, GetBrandAnalyticsErrors as vn, Competitor as vt, DeletePromptResponses as w, ListBrandCitationDomainsErrors as wn, DeleteCompetitorResponses as wt, CreatePromptResponses as x, GetBrandQueryFanoutErrors as xn, CreateCompetitorParams as xt, CreatePromptErrors as y, GetBrandAnalyticsParams as yn, CompetitorsList as yt, PromptSnapshot as z, VisibilityPoint as zn, GetBrandResponses as zt };
2112
+ //# sourceMappingURL=tools-B1qBnioW.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"tools-B1qBnioW.d.mts","names":[],"sources":["../src/types/shared/error.ts","../src/types/shared/model-filter.ts","../src/types/shared/not-found-error.ts","../src/types/shared/position.ts","../src/types/shared/validation-error.ts","../src/types/analytics.ts","../src/types/shared/brand-id-path.ts","../src/types/opportunities.ts","../src/types/tags.ts","../src/types/shared/conflict-error.ts","../src/types/shared/limit.ts","../src/types/shared/page.ts","../src/types/shared/pagination.ts","../src/types/brands.ts","../src/types/competitors.ts","../src/types/identity.ts","../src/types/models.ts","../src/types/organizations.ts","../src/types/runs.ts","../src/types/shared/mention-entry.ts","../src/types/snapshots.ts","../src/types/prompts.ts","../src/types/reports.ts","../src/types/tools.ts"],"mappings":";KAAY;;;;;;;;;EASV;;EAEA;;EAEA;;;KAIU,oBAAoB;KAEpB,sBAAsB;;;;;KAMtB,iBAAiB;;KAGjB,iBAAiB;;;;;;;;;KCtBjB,cAAc;;;;;;KAOd,YAAY;;KAGZ;;;;KCbA,gBAAgB;;;;;;;;;;;KCKhB;;;;;;EAMV;;;;;;;;;;KAWU;;EAEV;;EAEA;;EAEA;;EAEA;;;;;;;;EAQA;;;;;KCtCU,kBAAkB;;;;;;KCWlB;;EAEV,KAAK;;EAEL,OAAO;;KAGG;EACV;;;;;;;;EAQA;;KAGU;;EAEV;EACA;;EAEA;EACA,UAAU;;EAEV;EACA,WAAW;;;;;;;;EAQX;;KAGU;EACV;;;;;;;;EAQA;;KAGU;;EAEV;;;;;;;;;EAoBA;;EAEA;EACA;;EAEA;;EAEA;;;;;;;EAOA;;KAGU;EACV;;EAEA,MAAM,MAAM;EACZ,OAAO;EACP;IACE;IACA;IACA;;;KAIQ;;EAEV;EAYA;EACA;;EAEA;;EAEA;EAeA;EACA;EACA;;KAGU;EACV;;EAEA,MAAM,MAAM;EACZ,OAAO;EACP;IACE;IACA;IACA;;;KAIQ;EACV;;EAEA;EACA;;KAGU;EACV;EACA;;;;;;;;EAQA;;EAEA,MAAM,MAAM;;;;;EAKZ;EACA,OAAO;EACP;EACA;EACA;;KAGU;;;;;;;EAOV;;;;;;;;EAQA;EACA,kBAAkB;EAClB,WAAW;EACX,UAAU;EACV;EACA,WAAW;EACX,MAAM;EACN;EACA;;KAGU;EACV;;EAEA,MAAM,MAAM;EACZ,OAAO;;KAGG;EACV;EACA;EACA;EACA;EACA,UAAU;EACV;EACA,WAAW;;;;;;;;EAQX;;;;;;;KAQU;EACV;EACA;;EAEA,QAAQ,MAAM;EACd,UAAU;EACV,OAAO;EACP,WAAW;;EAEX;;;;;;;IAOE;;IAEA,SAAS,MAAM;;IAEf,QAAQ,MAAM;;EAEhB;IACE;;IAEA;IACA;IACA;IACA;;;EAGF;;;;;;;;IAQE;IACA,QAAQ,MAAM;;;;;;;;;KAUN,iBAAiB;EAC3B,QAAQ;IACN;;IAEA;;IAEA;;IAEA;;IAEA;;;;;;;;;KAUQ;;;;;;EAMV;EACA,QAAQ;;IAEN;IACA;;;;KAKQ;KAEA;;EAEV,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;;;;;;EAOV,OAAO;;;;;;EAMP,KAAK;;EAEL,QAAQ;;EAER,OAAO;;KAGG;;;;;;;EAOV,OAAO;;;;;;EAMP,KAAK;;EAEL,QAAQ;;EAER,OAAO;;KAGG;;;;;;;EAOV,OAAO;;;;;;EAMP,KAAK;;EAEL,QAAQ;;EAER,OAAO;;KAGG;;;;;;;EAOV,OAAO;;;;;;EAMP,KAAK;;EAEL,QAAQ;;EAER,OAAO;;KAGG;;;;;;;EAOV,OAAO;;;;;;EAMP,KAAK;;EAEL,QAAQ;;EAER,OAAO;;;;;KCxiBG;;;KCOA;;EAEV;;EAEA;;KAGU;EACV;EACA;EACA;;KAGU;;;;;;EAMV;;EAEA,qBAAqB,MAAM;;EAE3B,gBAAgB,MAAM;;EAEtB;;EAEA;;EAEA,eAAe,MAAM;;;;;;;;KASX;EACV;EACA,aAAa;;EAEb;;EAEA,eAAe,MAAM;;EAErB,OAAO;;;;;EAKP;;EAEA,SAAS;;KAGC;;EAEV,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;;;KC1EK;;EAEV;;EAEA;;;;;;EAMA;;KAGU;EACV;;EAEA,MAAM,MAAM;;KAGF;;EAEV,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;;;;KC1CK,gBAAgB;;KAGhB,uBAAuB;;;;;;;;;;KCCvB;;;;;;;;;KCDA;;;KCNA;EACV;EACA;;EAEA;EACA;;;;KCQU;EACV,SAAS;EACT,WAAW;;EAEX;;;;;EAKA,SAAS;EACT;;EAEA,eAAe;;EAEf;EACA;EACA;;EAEA;EACA,WAAW;;KAGD;;;;;;;EAOV,QAAQ,MAAM;;EAEd,MAAM,MAAM;EACZ,YAAY;;KAGF;;EAEV,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;EAEL,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;EAEL,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;;;;;;EAOV,OAAO;;;;;;;;EAQP,QAAQ;;;;;;KAOE;;EAEV;;EAEA;;;;;;;EAOA,SAAS;EACT,UAAU;EACV,cAAc;IACZ,UAAU;IACV,UAAU;;IAEV;;EAEF,UAAU;;IAER;IACA,OAAO;;IAEP;;;;;;;;;;;;;EAaF;;;;;;;;KASU;;EAEV;;;;;;;EAOA,UAAU;EACV,UAAU;;;;;;EAMV;;;;KCrNU;EACV,SAAS;EACT;EACA,WAAW;EACX,SAAS;EACT;EACA;EACA,WAAW;;KAGD;;;;;;;EAOV,aAAa,MAAM;;EAEnB,MAAM,MAAM;EACZ,YAAY;;KAGF;;EAEV,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;EAEL,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;EAEL,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;EAEL,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;EACV;;;;;;;EAOA,OAAO;;;;;;;;EAQP,QAAQ;;;KAIE;;EAEV;;EAEA;EACA,UAAU;EACV,UAAU;;;;;;KAOA;;EAEV;EACA,UAAU;EACV,UAAU;;;;KC3LA;;;;;;EAMV,UAAU;EACV,WAAW;;EAEX;;EAEA,WAAW;;EAEX;EACA,YAAY;;EAEZ;EACA;;;;;EAKA;IACE;IACA;;;EAGF,QAAQ;;KAGE;;EAEV,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;;;KC9CK;EACV,MAAM,MAAM;;KAGF;;EAEV;;EAEA;;EAEA;;EAEA;;KAGU;;EAEV,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;;;KC3BK;EACV;EACA,WAAW;EACX;EACA;EACA;;;KAIU;;EAEV;;EAEA;;EAEA,WAAW;;EAEX;;EAEA;EACA;EACA;;;;;;;;KASU;;EAEV;EACA,QAAQ;EACR;;EAEA,MAAM;EACN;IACE;IACA;IACA;;;KAIQ;EACV;;EAEA;;EAEA;;EAEA;EACA,YAAY;;;;;;EAMZ;;EAEA;;KAGU;EACV,MAAM,MAAM;EACZ,YAAY;;KAGF;;EAEV,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;;;;;;EAOV,OAAO;;;;;;;;EAQP,QAAQ;;;;;KC7IE;EACV,aAAa;EACb;EACA;EACA;EACA,sBAAsB;EACtB,WAAW;EACX;EACA;EACA;;EAEA;;EAEA,YAAY;;EAEZ;;KAGU;;EAEV;EACA;EACA;EACA;;;KAIU,MAAM;EAChB;;;;IAIE;;EAEF,WAAW,MAAM;;KAGP;EACV,MAAM,MAAM;EACZ,YAAY;;;;;;;KAQF;;;;;;EAMV;;;;;EAKA;;;;;;;EAOA;;;;;;;EAOA;;;;;;EAMA;;;;;EAKA;;EAEA;KACG;;;;;;;;;KAUO;;EAEV,OAAO;;EAEP;KACG,cAAc;;;KAIP;;EAEV,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;;;;;;EAOV,OAAO;;;;;;EAMP,KAAK;;EAEL,QAAQ;;;;;;;EAOR,OAAO;;;;;;;;EAQP,QAAQ;;;;;KClME;;EAEV;;;;;EAKA;;EAEA,cAAc,MAAM;;EAEpB;;KAGU;;EAEV;;EAEA;;;;KCRU;;EAEV;;EAEA;;EAEA;;KAGU;;EAEV;EACA;;IAEE;;IAEA;;IAEA,eAAe,MAAM;;IAErB;;;EAGF;EACA,UAAU;EACV,UAAU;;EAEV;;EAEA;EACA,WAAW;;EAEX;;KAGU;;EAEV,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV;;EAEA;;;;;;;;EAQA;;;;;;;;EAQA;;;;KC9EU;;EAEV;;EAEA,WAAW;;EAEX;;EAEA;;EAEA,eAAe;;EAEf,YAAY;;EAEZ,MAAM;;EAEN,WAAW;;EAEX;;KAGU;;EAEV,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV;;IAEE,MAAM,MAAM;IACZ;MACE;MACA;MACA;MACA;;;;;;;;IAQF,SAAS,MAAM;;;KAIP,sBAAsB,2BAA2B;KAEjD;;EAEV,KAAK;;EAEL,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;EAEL,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;IAEH;;;KAIQ,uBAAuB,4BAA4B;KAEnD;;EAEV,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV,KAAK;;EAEL,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;EAEV;;;;;;;EAOA,OAAO;;;;;;;;;;EAUP;;EAEA;;EAEA;;EAEA;;KAGU;;EAEV;;;;;;EAMA;;EAEA,OAAO;;KAGG;;;;;;EAMV;;EAEA;;EAEA,OAAO;;EAEP,gBAAgB;;;;KCxNN;;EAEV,cAAc;;EAEd;;EAEA;;EAEA,aAAa;;EAEb,WAAW;;EAEX;;EAEA;;;;;;KAOU;EACV,UAAU;;EAEV;;EAEA;;KAGU;;EAEV,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV;;IAEE,MAAM,MAAM;IACZ;MACE;MACA;MACA;MACA;;;;;;;;IAQF,SAAS,MAAM;;;KAIP,sBAAsB,2BAA2B;KAEjD;;EAEV,KAAK;;EAEL,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV;IACE,cAAc;IACd;IACA;IACA,WAAW;;IAEX;;IAEA;;;KAIQ,uBAAuB,4BAA4B;KAEnD;;EAEV,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;;;;EAKV;IACE,cAAc;IACd;IACA;IACA,aAAa;IACb,WAAW;;IAEX;;IAEA,UAAU,MAAM;IAChB;IACA;;;;;IAKA;;MAEE,cAAc;;QAEZ;;QAEA;;QAEA;;;;;;;;QAQA;;;;;;;QAOA;;;MAGF;;MAEA;;;;;;;;MAQA;;;;;MAKA;;MAEA;;;;;;;;MAQA;;;;KAKM,oBAAoB,yBAAyB;KAE7C;;;;;;;EAOV,OAAO;;;;;;;;EAQP,QAAQ;;KAGE;;;;;;EAMV;;;;;;;EAOA,eAAe;;;;;;;;EAQf;;EAEA,gBAAgB;;KAGN;;;;;;;;EAQV;;;;KC/PU;EACV,mBAAmB;EACnB,SAAS;EACT;EACA,aAAa;IACX,SAAS;IACT,SAAS;IACT;;EAEF,kBAAkB;IAChB;IACA,MAAM;;;EAGR;;KAGU;;EAEV,KAAK;;EAEL,KAAK;;EAEL,KAAK;;;;;EAKL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;EAEL,KAAK;;KAGK;;EAEV,KAAK;;KAGK;;;;;;;EAOV;;EAEA;;;;;;;;EAQA;;;;;;;;EAQA"}
@@ -1,2 +1,2 @@
1
- import { $ as GetOrganizationBillingResponses, $t as BrandOpportunities, A as ListPromptsResponses, An as PromptPerformance, At as UpdateCompetitorResponses, B as MentionEntry, Bn as WindowStart, Bt as ListBrandsResponses, C as DeletePromptResponse, Cn as ListBrandCitationURLsErrors, Ct as GetCompetitorErrors, D as ListPromptsErrors, Dn as ListBrandPromptPerformanceParams, Dt as ListCompetitorsResponses, E as GetPromptResponses, En as ListBrandPromptPerformanceErrors, Et as ListCompetitorsParams, F as CitedURLEntry, Fn as VisibilityPoint, Ft as CreateBrandResponses, G as ListPromptRunsParams, Gn as UnauthorizedError, Gt as Page, H as GetRunErrors, Hn as ForbiddenError, Ht as UpdateBrandParams, I as GetPromptSnapshotErrors, In as ValidationError, It as GetBrandErrors, J as RunCitation, Jt as PaymentRequiredError, K as ListPromptRunsResponses, Kt as Limit, L as GetPromptSnapshotParams, Ln as NotFoundError, Lt as GetBrandResponses, M as UpdatePromptErrors, Mn as ShareOfVoiceEntry, Mt as BrandsList, N as UpdatePromptParams, Nn as ShareOfVoicePoint, Nt as CreateBrandErrors, O as ListPromptsParams, On as ListBrandPromptPerformanceResponses, Ot as UpdateCompetitorErrors, P as UpdatePromptResponses, Pn as TagsFilter, Pt as CreateBrandParams, Q as GetOrganizationBillingErrors, Qt as TagList, R as GetPromptSnapshotResponses, Rn as ModelFilter, Rt as ListBrandsErrors, S as DeletePromptErrors, Sn as ListBrandCitationDomainsResponses, St as DeleteCompetitorResponses, T as GetPromptErrors, Tn as ListBrandCitationURLsResponses, Tt as ListCompetitorsErrors, U as GetRunResponses, Un as InternalServerError, Ut as UpdateBrandResponses, V as MentionsSummary, Vn as Error, Vt as UpdateBrandErrors, W as ListPromptRunsErrors, Wn as RateLimitError, Wt as Pagination, X as RunSummary, Xt as ListBrandTagsResponses, Y as RunList, Yt as ListBrandTagsErrors, Z as BillingPlan, Zt as Tag, _ as ReportPromptSnapshot, _n as GetBrandQueryFanoutErrors, _t as CompetitorsList, a as CreateReportErrors, an as BrandIdPath, at as Organization, b as CreatePromptParams, bn as ListBrandCitationDomainsErrors, bt as CreateCompetitorResponses, c as CreateReportResponses, cn as CitationDomain, ct as PlanLimits, d as GetReportResponse, dn as CitationURLList, dt as Model, en as CitedPage, et as GetOrganizationErrors, f as GetReportResponses, fn as DateRange, ft as ModelList, g as ListReportsResponses, gn as GetBrandAnalyticsResponses, gt as Competitor, h as ListReportsResponse, hn as GetBrandAnalyticsParams, ht as GetMeResponses, i as OnboardingSuggestion, in as OpportunityPrompt, it as ListOrganizationsResponses, j as Prompt, jn as PromptPerformanceList, jt as Brand, k as ListPromptsResponse, kn as ModelVisibility, kt as UpdateCompetitorParams, l as GetReportErrors, ln as CitationDomainList, lt as ListModelsErrors, m as ListReportsParams, mn as GetBrandAnalyticsErrors, mt as GetMeErrors, n as AnalyzeBrandParams, nn as GetBrandOpportunitiesResponses, nt as ListOrganizationsErrors, o as CreateReportParams, on as BrandAnalytics, ot as OrganizationBilling, p as ListReportsErrors, pn as FanoutQuery, pt as APIKeyIdentity, q as Run, qt as ConflictError, r as AnalyzeBrandResponses, rn as Opportunity, rt as ListOrganizationsParams, s as CreateReportResponse, sn as BrandQueryFanout, st as OrganizationList, t as AnalyzeBrandErrors, tn as GetBrandOpportunitiesErrors, tt as GetOrganizationResponses, u as GetReportParams, un as CitationURL, ut as ListModelsResponses, v as ReportSummary, vn as GetBrandQueryFanoutParams, vt as CreateCompetitorErrors, w as DeletePromptResponses, wn as ListBrandCitationURLsParams, wt as GetCompetitorResponses, x as CreatePromptResponses, xn as ListBrandCitationDomainsParams, xt as DeleteCompetitorErrors, y as CreatePromptErrors, yn as GetBrandQueryFanoutResponses, yt as CreateCompetitorParams, z as PromptSnapshot, zn as WindowEnd, zt as ListBrandsParams } from "../tools-DpxrXc33.mjs";
2
- export type { APIKeyIdentity, AnalyzeBrandErrors, AnalyzeBrandParams, AnalyzeBrandResponses, BillingPlan, Brand, BrandAnalytics, BrandIdPath, BrandOpportunities, BrandQueryFanout, BrandsList, CitationDomain, CitationDomainList, CitationURL, CitationURLList, CitedPage, CitedURLEntry, Competitor, CompetitorsList, ConflictError, CreateBrandErrors, CreateBrandParams, CreateBrandResponses, CreateCompetitorErrors, CreateCompetitorParams, CreateCompetitorResponses, CreatePromptErrors, CreatePromptParams, CreatePromptResponses, CreateReportErrors, CreateReportParams, CreateReportResponse, CreateReportResponses, DateRange, DeleteCompetitorErrors, DeleteCompetitorResponses, DeletePromptErrors, DeletePromptResponse, DeletePromptResponses, Error, FanoutQuery, ForbiddenError, GetBrandAnalyticsErrors, GetBrandAnalyticsParams, GetBrandAnalyticsResponses, GetBrandErrors, GetBrandOpportunitiesErrors, GetBrandOpportunitiesResponses, GetBrandQueryFanoutErrors, GetBrandQueryFanoutParams, GetBrandQueryFanoutResponses, GetBrandResponses, GetCompetitorErrors, GetCompetitorResponses, GetMeErrors, GetMeResponses, GetOrganizationBillingErrors, GetOrganizationBillingResponses, GetOrganizationErrors, GetOrganizationResponses, GetPromptErrors, GetPromptResponses, GetPromptSnapshotErrors, GetPromptSnapshotParams, GetPromptSnapshotResponses, GetReportErrors, GetReportParams, GetReportResponse, GetReportResponses, GetRunErrors, GetRunResponses, InternalServerError, Limit, ListBrandCitationDomainsErrors, ListBrandCitationDomainsParams, ListBrandCitationDomainsResponses, ListBrandCitationURLsErrors, ListBrandCitationURLsParams, ListBrandCitationURLsResponses, ListBrandPromptPerformanceErrors, ListBrandPromptPerformanceParams, ListBrandPromptPerformanceResponses, ListBrandTagsErrors, ListBrandTagsResponses, ListBrandsErrors, ListBrandsParams, ListBrandsResponses, ListCompetitorsErrors, ListCompetitorsParams, ListCompetitorsResponses, ListModelsErrors, ListModelsResponses, ListOrganizationsErrors, ListOrganizationsParams, ListOrganizationsResponses, ListPromptRunsErrors, ListPromptRunsParams, ListPromptRunsResponses, ListPromptsErrors, ListPromptsParams, ListPromptsResponse, ListPromptsResponses, ListReportsErrors, ListReportsParams, ListReportsResponse, ListReportsResponses, MentionEntry, MentionsSummary, Model, ModelFilter, ModelList, ModelVisibility, NotFoundError, OnboardingSuggestion, Opportunity, OpportunityPrompt, Organization, OrganizationBilling, OrganizationList, Page, Pagination, PaymentRequiredError, PlanLimits, Prompt, PromptPerformance, PromptPerformanceList, PromptSnapshot, RateLimitError, ReportPromptSnapshot, ReportSummary, Run, RunCitation, RunList, RunSummary, ShareOfVoiceEntry, ShareOfVoicePoint, Tag, TagList, TagsFilter, UnauthorizedError, UpdateBrandErrors, UpdateBrandParams, UpdateBrandResponses, UpdateCompetitorErrors, UpdateCompetitorParams, UpdateCompetitorResponses, UpdatePromptErrors, UpdatePromptParams, UpdatePromptResponses, ValidationError, VisibilityPoint, WindowEnd, WindowStart };
1
+ import { $ as BillingPlan, $t as Tag, A as ListPromptsResponses, An as ListBrandPromptPerformanceErrors, At as UpdateCompetitorErrors, B as MentionEntry, Bn as ValidationError, Bt as ListBrandsErrors, C as DeletePromptResponse, Cn as GetBrandQueryFanoutResponses, Ct as DeleteCompetitorErrors, D as ListPromptsErrors, Dn as ListBrandCitationURLsErrors, Dt as ListCompetitorsErrors, E as GetPromptResponses, En as ListBrandCitationDomainsResponses, Et as GetCompetitorResponses, F as CitedURLEntry, Fn as PromptPerformanceList, Ft as CreateBrandErrors, G as ListPromptRunsParams, Gn as WindowEnd, Gt as UpdateBrandResponses, H as GetRunErrors, Hn as SentimentSummary, Ht as ListBrandsResponses, I as GetPromptSnapshotErrors, In as ShareOfVoiceEntry, It as CreateBrandParams, J as Run, Jn as ForbiddenError, Jt as Limit, K as ListPromptRunsResponses, Kn as WindowStart, Kt as Pagination, L as GetPromptSnapshotParams, Ln as ShareOfVoicePoint, Lt as CreateBrandResponses, M as UpdatePromptErrors, Mn as ListBrandPromptPerformanceResponses, Mt as UpdateCompetitorResponses, N as UpdatePromptParams, Nn as ModelVisibility, Nt as Brand, O as ListPromptsParams, On as ListBrandCitationURLsParams, Ot as ListCompetitorsParams, P as UpdatePromptResponses, Pn as PromptPerformance, Pt as BrandsList, Q as RunSummary, Qt as ListBrandTagsResponses, R as GetPromptSnapshotResponses, Rn as TagsFilter, Rt as GetBrandErrors, S as DeletePromptErrors, Sn as GetBrandQueryFanoutParams, St as CreateCompetitorResponses, T as GetPromptErrors, Tn as ListBrandCitationDomainsParams, Tt as GetCompetitorErrors, U as GetRunResponses, Un as NotFoundError, Ut as UpdateBrandErrors, V as MentionsSummary, Vn as Position, Vt as ListBrandsParams, W as ListPromptRunsErrors, Wn as ModelFilter, Wt as UpdateBrandParams, X as RunCitation, Xn as RateLimitError, Xt as PaymentRequiredError, Y as RunAssessments, Yn as InternalServerError, Yt as ConflictError, Z as RunList, Zn as UnauthorizedError, Zt as ListBrandTagsErrors, _ as ReportPromptSnapshot, _n as FanoutQuery, _t as GetMeResponses, a as CreateReportErrors, an as Opportunity, at as ListOrganizationsParams, b as CreatePromptParams, bn as GetBrandAnalyticsResponses, bt as CreateCompetitorErrors, c as CreateReportResponses, cn as BrandAnalytics, ct as OrganizationBilling, d as GetReportResponse, dn as BrandSentiment, dt as ListModelsErrors, en as TagList, et as GetOrganizationBillingErrors, f as GetReportResponses, fn as CitationDomain, ft as ListModelsResponses, g as ListReportsResponses, gn as DateRange, gt as GetMeErrors, h as ListReportsResponse, hn as CitationURLList, ht as APIKeyIdentity, i as OnboardingSuggestion, in as GetBrandOpportunitiesResponses, it as ListOrganizationsErrors, j as Prompt, jn as ListBrandPromptPerformanceParams, jt as UpdateCompetitorParams, k as ListPromptsResponse, kn as ListBrandCitationURLsResponses, kt as ListCompetitorsResponses, l as GetReportErrors, ln as BrandPosition, lt as OrganizationList, m as ListReportsParams, mn as CitationURL, mt as ModelList, n as AnalyzeBrandParams, nn as CitedPage, nt as GetOrganizationErrors, o as CreateReportParams, on as OpportunityPrompt, ot as ListOrganizationsResponses, p as ListReportsErrors, pn as CitationDomainList, pt as Model, q as MentionAssessment, qn as Error, qt as Page, r as AnalyzeBrandResponses, rn as GetBrandOpportunitiesErrors, rt as GetOrganizationResponses, s as CreateReportResponse, sn as BrandIdPath, st as Organization, t as AnalyzeBrandErrors, tn as BrandOpportunities, tt as GetOrganizationBillingResponses, u as GetReportParams, un as BrandQueryFanout, ut as PlanLimits, v as ReportSummary, vn as GetBrandAnalyticsErrors, vt as Competitor, w as DeletePromptResponses, wn as ListBrandCitationDomainsErrors, wt as DeleteCompetitorResponses, x as CreatePromptResponses, xn as GetBrandQueryFanoutErrors, xt as CreateCompetitorParams, y as CreatePromptErrors, yn as GetBrandAnalyticsParams, yt as CompetitorsList, z as PromptSnapshot, zn as VisibilityPoint, zt as GetBrandResponses } from "../tools-B1qBnioW.mjs";
2
+ export type { APIKeyIdentity, AnalyzeBrandErrors, AnalyzeBrandParams, AnalyzeBrandResponses, BillingPlan, Brand, BrandAnalytics, BrandIdPath, BrandOpportunities, BrandPosition, BrandQueryFanout, BrandSentiment, BrandsList, CitationDomain, CitationDomainList, CitationURL, CitationURLList, CitedPage, CitedURLEntry, Competitor, CompetitorsList, ConflictError, CreateBrandErrors, CreateBrandParams, CreateBrandResponses, CreateCompetitorErrors, CreateCompetitorParams, CreateCompetitorResponses, CreatePromptErrors, CreatePromptParams, CreatePromptResponses, CreateReportErrors, CreateReportParams, CreateReportResponse, CreateReportResponses, DateRange, DeleteCompetitorErrors, DeleteCompetitorResponses, DeletePromptErrors, DeletePromptResponse, DeletePromptResponses, Error, FanoutQuery, ForbiddenError, GetBrandAnalyticsErrors, GetBrandAnalyticsParams, GetBrandAnalyticsResponses, GetBrandErrors, GetBrandOpportunitiesErrors, GetBrandOpportunitiesResponses, GetBrandQueryFanoutErrors, GetBrandQueryFanoutParams, GetBrandQueryFanoutResponses, GetBrandResponses, GetCompetitorErrors, GetCompetitorResponses, GetMeErrors, GetMeResponses, GetOrganizationBillingErrors, GetOrganizationBillingResponses, GetOrganizationErrors, GetOrganizationResponses, GetPromptErrors, GetPromptResponses, GetPromptSnapshotErrors, GetPromptSnapshotParams, GetPromptSnapshotResponses, GetReportErrors, GetReportParams, GetReportResponse, GetReportResponses, GetRunErrors, GetRunResponses, InternalServerError, Limit, ListBrandCitationDomainsErrors, ListBrandCitationDomainsParams, ListBrandCitationDomainsResponses, ListBrandCitationURLsErrors, ListBrandCitationURLsParams, ListBrandCitationURLsResponses, ListBrandPromptPerformanceErrors, ListBrandPromptPerformanceParams, ListBrandPromptPerformanceResponses, ListBrandTagsErrors, ListBrandTagsResponses, ListBrandsErrors, ListBrandsParams, ListBrandsResponses, ListCompetitorsErrors, ListCompetitorsParams, ListCompetitorsResponses, ListModelsErrors, ListModelsResponses, ListOrganizationsErrors, ListOrganizationsParams, ListOrganizationsResponses, ListPromptRunsErrors, ListPromptRunsParams, ListPromptRunsResponses, ListPromptsErrors, ListPromptsParams, ListPromptsResponse, ListPromptsResponses, ListReportsErrors, ListReportsParams, ListReportsResponse, ListReportsResponses, MentionAssessment, MentionEntry, MentionsSummary, Model, ModelFilter, ModelList, ModelVisibility, NotFoundError, OnboardingSuggestion, Opportunity, OpportunityPrompt, Organization, OrganizationBilling, OrganizationList, Page, Pagination, PaymentRequiredError, PlanLimits, Position, Prompt, PromptPerformance, PromptPerformanceList, PromptSnapshot, RateLimitError, ReportPromptSnapshot, ReportSummary, Run, RunAssessments, RunCitation, RunList, RunSummary, SentimentSummary, ShareOfVoiceEntry, ShareOfVoicePoint, Tag, TagList, TagsFilter, UnauthorizedError, UpdateBrandErrors, UpdateBrandParams, UpdateBrandResponses, UpdateCompetitorErrors, UpdateCompetitorParams, UpdateCompetitorResponses, UpdatePromptErrors, UpdatePromptParams, UpdatePromptResponses, ValidationError, VisibilityPoint, WindowEnd, WindowStart };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@elmohq/sdk",
3
- "version": "0.1.2",
3
+ "version": "0.2.0",
4
4
  "description": "TypeScript SDK for the Elmo API",
5
5
  "keywords": [
6
6
  "api",
package/src/client.ts CHANGED
@@ -173,6 +173,7 @@ import type { ModelFilter, WindowEnd, WindowStart } from './types/shared/model-f
173
173
  import type { NotFoundError as NotFoundErrorResponse } from './types/shared/not-found-error';
174
174
  import type { Page as PageParameter } from './types/shared/page';
175
175
  import type { Pagination } from './types/shared/pagination';
176
+ import type { Position, SentimentSummary } from './types/shared/position';
176
177
  import type { ValidationError } from './types/shared/validation-error';
177
178
  import type {
178
179
  AnalyzeBrandErrors,
@@ -182,7 +183,7 @@ import type {
182
183
  } from './types/tools';
183
184
 
184
185
  /** The version of this package. */
185
- export const VERSION = '0.1.2';
186
+ export const VERSION = '0.2.0';
186
187
 
187
188
  /** The address calls are sent to: a URL with its scheme. */
188
189
  export type BaseURL = `${string}://${string}/api/v1` | (string & {});
@@ -609,6 +610,7 @@ export declare namespace Elmo {
609
610
  PageResult,
610
611
  Pagination,
611
612
  PaymentRequiredErrorResponse,
613
+ Position,
612
614
  PreparedRequest,
613
615
  Prompt,
614
616
  Prompts,
@@ -623,6 +625,7 @@ export declare namespace Elmo {
623
625
  RetryAfterHeader,
624
626
  RetryOptions,
625
627
  RetryRules,
628
+ SentimentSummary,
626
629
  TagsFilter,
627
630
  TimeoutPolicy,
628
631
  TimeoutValue,
@@ -8,7 +8,9 @@ import type { Mutable } from '../internal/feature/validate';
8
8
  import { decoded, reviving } from '../internal/feature/validate';
9
9
  import type {
10
10
  BrandAnalytics,
11
+ BrandPosition,
11
12
  BrandQueryFanout,
13
+ BrandSentiment,
12
14
  CitationDomain,
13
15
  CitationDomainList,
14
16
  CitationURL,
@@ -296,6 +298,8 @@ export class QueryFanout extends ElmoResource {
296
298
  export declare namespace Analytics {
297
299
  export type {
298
300
  BrandAnalytics,
301
+ BrandPosition,
302
+ BrandSentiment,
299
303
  GetBrandAnalyticsErrors,
300
304
  GetBrandAnalyticsParams,
301
305
  GetBrandAnalyticsResponses,
@@ -13,7 +13,9 @@ import type { Mutable } from '../internal/feature/validate';
13
13
  import { decoded, reviving } from '../internal/feature/validate';
14
14
  import type {
15
15
  BrandAnalytics,
16
+ BrandPosition,
16
17
  BrandQueryFanout,
18
+ BrandSentiment,
17
19
  DateRange,
18
20
  FanoutQuery,
19
21
  GetBrandAnalyticsErrors,
@@ -239,7 +241,9 @@ export declare namespace Brands {
239
241
  BrandAnalytics,
240
242
  BrandIdPath,
241
243
  BrandOpportunities,
244
+ BrandPosition,
242
245
  BrandQueryFanout,
246
+ BrandSentiment,
243
247
  BrandsList,
244
248
  Citations,
245
249
  CitedPage,
@@ -34,7 +34,9 @@ import type {
34
34
  ListPromptRunsErrors,
35
35
  ListPromptRunsParams,
36
36
  ListPromptRunsResponses,
37
+ MentionAssessment,
37
38
  Run,
39
+ RunAssessments,
38
40
  RunCitation,
39
41
  RunList,
40
42
  RunSummary,
@@ -278,9 +280,11 @@ export declare namespace Prompts {
278
280
  ListPromptsParams,
279
281
  ListPromptsResponse,
280
282
  ListPromptsResponses,
283
+ MentionAssessment,
281
284
  Prompt,
282
285
  PromptSnapshot,
283
286
  Run,
287
+ RunAssessments,
284
288
  RunCitation,
285
289
  RunList,
286
290
  Runs,
@@ -13,7 +13,9 @@ import type {
13
13
  ListPromptRunsErrors,
14
14
  ListPromptRunsParams,
15
15
  ListPromptRunsResponses,
16
+ MentionAssessment,
16
17
  Run,
18
+ RunAssessments,
17
19
  RunCitation,
18
20
  RunList,
19
21
  RunSummary,
@@ -116,7 +118,9 @@ export declare namespace Runs {
116
118
  ListPromptRunsErrors,
117
119
  ListPromptRunsParams,
118
120
  ListPromptRunsResponses,
121
+ MentionAssessment,
119
122
  Run,
123
+ RunAssessments,
120
124
  RunCitation,
121
125
  RunList,
122
126
  RunSummary,
@@ -6,6 +6,7 @@ import type {
6
6
  } from './shared/error';
7
7
  import type { ModelFilter, WindowEnd, WindowStart } from './shared/model-filter';
8
8
  import type { NotFoundError } from './shared/not-found-error';
9
+ import type { Position, SentimentSummary } from './shared/position';
9
10
  import type { ValidationError } from './shared/validation-error';
10
11
 
11
12
  /**
@@ -36,8 +37,10 @@ export type ShareOfVoiceEntry = {
36
37
  mentions: number;
37
38
  /** Brand or competitor name. */
38
39
  name: string;
40
+ position: Position;
39
41
  /** Distinct prompts this entity appeared in. */
40
42
  prompts: number;
43
+ sentiment: SentimentSummary;
41
44
  /**
42
45
  * This entity's share of all brand and competitor mentions. Ratio 0–1; multiply by 100 for a
43
46
  * percentage.
@@ -211,7 +214,9 @@ export type PromptPerformance = {
211
214
  competitorMentionRate: number;
212
215
  firstEvaluatedAt: Date | null;
213
216
  lastRunAt: Date | null;
217
+ position: Position;
214
218
  promptId: string;
219
+ sentiment: SentimentSummary;
215
220
  tags: Array<string>;
216
221
  totalRuns: number;
217
222
  value: string;
@@ -229,7 +234,9 @@ export type ModelVisibility = {
229
234
  citations: number;
230
235
  label: string;
231
236
  model: string;
237
+ position: Position;
232
238
  runs: number;
239
+ sentiment: SentimentSummary;
233
240
  /**
234
241
  * Share of this model's runs that mentioned the brand. Ratio 0–1; multiply by 100 for a
235
242
  * percentage.
@@ -242,16 +249,17 @@ export type ModelVisibility = {
242
249
 
243
250
  /**
244
251
  * Every non-paginated figure for a brand over one window. There is no parameter for selecting a
245
- * subset: the four computations behind this share one scope resolution and run concurrently, so a
246
- * subset would save a caller a fraction of one request and cost everyone a parameter to reason
247
- * about.
252
+ * subset: the computations behind this cover the same prompts and run concurrently, so a subset
253
+ * would save a caller a fraction of one request and cost everyone a parameter to reason about.
248
254
  */
249
255
  export type BrandAnalytics = {
250
256
  brandId: string;
251
257
  brandName: string;
252
258
  /** Per-model visibility and run counts. Only models that produced a run in the window appear. */
253
259
  models: Array<ModelVisibility>;
260
+ position: BrandPosition;
254
261
  range: DateRange;
262
+ sentiment: BrandSentiment;
255
263
  /** The brand against its tracked competitors. */
256
264
  shareOfVoice: {
257
265
  /**
@@ -288,6 +296,46 @@ export type BrandAnalytics = {
288
296
  };
289
297
  };
290
298
 
299
+ /**
300
+ * **Experimental — the shape may still change.**
301
+ *
302
+ * The brand's sentiment over the window, with the counts for each day so a client can chart or
303
+ * smooth them.
304
+ */
305
+ export type BrandSentiment = SentimentSummary & {
306
+ series: Array<{
307
+ date: string;
308
+ /** @minimum 0 */
309
+ mixed: number;
310
+ /** @minimum 0 */
311
+ negative: number;
312
+ /** @minimum 0 */
313
+ neutral: number;
314
+ /** @minimum 0 */
315
+ positive: number;
316
+ }>;
317
+ };
318
+
319
+ /**
320
+ * **Experimental — the shape may still change.**
321
+ *
322
+ * The brand's position among the tracked companies the answers name, 1 being named first, averaged
323
+ * over the window and per day.
324
+ */
325
+ export type BrandPosition = {
326
+ /**
327
+ * Average position over the window, to one decimal; null when no answer ranks it.
328
+ *
329
+ * @minimum 1
330
+ */
331
+ average: number | null;
332
+ series: Array<{
333
+ /** @minimum 1 */
334
+ average: number | null;
335
+ date: string;
336
+ }>;
337
+ };
338
+
291
339
  /** Comma-separated prompt tags. Only prompts carrying at least one of them are counted. */
292
340
  export type TagsFilter = string;
293
341
 
@@ -1,6 +1,8 @@
1
1
  export type {
2
2
  BrandAnalytics,
3
+ BrandPosition,
3
4
  BrandQueryFanout,
5
+ BrandSentiment,
4
6
  CitationDomain,
5
7
  CitationDomainList,
6
8
  CitationURL,
@@ -126,7 +128,9 @@ export type {
126
128
  ListPromptRunsErrors,
127
129
  ListPromptRunsParams,
128
130
  ListPromptRunsResponses,
131
+ MentionAssessment,
129
132
  Run,
133
+ RunAssessments,
130
134
  RunCitation,
131
135
  RunList,
132
136
  RunSummary,
@@ -146,6 +150,7 @@ export type { ModelFilter, WindowEnd, WindowStart } from './shared/model-filter'
146
150
  export type { NotFoundError } from './shared/not-found-error';
147
151
  export type { Page } from './shared/page';
148
152
  export type { Pagination } from './shared/pagination';
153
+ export type { Position, SentimentSummary } from './shared/position';
149
154
  export type { ValidationError } from './shared/validation-error';
150
155
  export type {
151
156
  CitedURLEntry,
package/src/types/runs.ts CHANGED
@@ -13,6 +13,7 @@ import type { ValidationError } from './shared/validation-error';
13
13
 
14
14
  /** A single model answer, without its text. Fetch `prompts.runs.get()` for the answer itself. */
15
15
  export type RunSummary = {
16
+ assessments: RunAssessments;
16
17
  brandId: string;
17
18
  brandMentioned: boolean;
18
19
  citationCount: number;
@@ -53,6 +54,69 @@ export type RunList = {
53
54
  pagination: Pagination;
54
55
  };
55
56
 
57
+ /**
58
+ * **Experimental — the shape may still change.**
59
+ *
60
+ * The mention judge's assessment of one brand or competitor named in an answer.
61
+ */
62
+ export type MentionAssessment = {
63
+ /**
64
+ * How many times the answer mentions it. Null when the answer isn't counted as mentioning it.
65
+ *
66
+ * @minimum 1
67
+ */
68
+ mentionCount: number | null;
69
+ /**
70
+ * Whether the answer counts as mentioning this company. A name the judge can't call either way
71
+ * counts.
72
+ */
73
+ mentioned: boolean;
74
+ /**
75
+ * 1 for the tracked company the answer names first, 2 for the next, and so on. Null when the
76
+ * answer isn't counted as mentioning it.
77
+ *
78
+ * @minimum 1
79
+ */
80
+ position: number | null;
81
+ /**
82
+ * Calibrated probability that the answer mentions this company.
83
+ *
84
+ * @minimum 0
85
+ * @maximum 1
86
+ */
87
+ probability: number;
88
+ /**
89
+ * When it isn't counted as a mention, the likeliest other reading: `other_meaning` (the name used
90
+ * as an ordinary word), `other_company` (a different company with the same name) or `no_info`
91
+ * (the answer says it knows nothing about it). Informational; not a stable enum.
92
+ */
93
+ reason: string | null;
94
+ /**
95
+ * The likeliest sentiment toward this company in the passages about it. Null when the answer
96
+ * isn't about it, or when it only links to the company.
97
+ */
98
+ sentiment: 'positive' | 'neutral' | 'negative' | 'mixed' | null;
99
+ /** Probability of each sentiment, keyed by label. */
100
+ sentimentProbabilities: {
101
+ [key: string]: number;
102
+ } | null;
103
+ };
104
+
105
+ /**
106
+ * **Experimental — the shape may still change.**
107
+ *
108
+ * The mention judge's assessments for one answer. Null when the run's mentions were matched by
109
+ * name, before the judge, until a replay judges it.
110
+ */
111
+ export type RunAssessments = {
112
+ /** Null when the answer never names the brand. */
113
+ brand: MentionAssessment | null;
114
+ /** Keyed by competitor name; only competitors the answer names. */
115
+ competitors: {
116
+ [key: string]: MentionAssessment;
117
+ };
118
+ } | null;
119
+
56
120
  export type ListPromptRunsErrors = {
57
121
  /** Invalid request data */
58
122
  400: ValidationError;