@miradorlabs/web-grpc 4.5.1 → 4.5.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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@miradorlabs/web-grpc",
3
- "version": "4.5.1",
3
+ "version": "4.5.2",
4
4
  "description": "Generated gRPC (grpc-js) client stubs for the Mirador web gateway.",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",
@@ -1437,10 +1437,11 @@ export function aIResourceDimensionToJSON(object: AIResourceDimension): string {
1437
1437
  export enum AIResourceRankingGroupBy {
1438
1438
  AI_RESOURCE_RANKING_GROUP_BY_UNSPECIFIED = 0,
1439
1439
  /**
1440
- * AI_RESOURCE_RANKING_GROUP_BY_PRINCIPAL - One ranking per principal on the source system that reported it, each what a request filtered to that principal's
1441
- * id and source returns: an event ranks under its user id and under its api key. Work that recorded neither ranks
1442
- * under an API_KEY principal with an empty id, which no filter selects alone (an empty api_key_ids entry also
1443
- * matches user-only work). SKILL / TOOL / COMMAND only.
1440
+ * AI_RESOURCE_RANKING_GROUP_BY_PRINCIPAL - One ranking per principal the filter names (a USER per non-empty user_ids entry, an API_KEY per api_key_ids entry)
1441
+ * on each source system that reported it, counting the events the whole filter matched that carry that principal: an
1442
+ * event ranks under its user id and under its api key, and a principal the filter did not name is left out. With one
1443
+ * kind of id filtered, a named id's ranking is what a request filtered to that id and source returns. An empty
1444
+ * api_key_ids entry names only the work that recorded neither id. SKILL / TOOL / COMMAND only.
1444
1445
  */
1445
1446
  AI_RESOURCE_RANKING_GROUP_BY_PRINCIPAL = 1,
1446
1447
  UNRECOGNIZED = -1,
@@ -3364,12 +3365,17 @@ export interface ProjectSessionRef {
3364
3365
  export interface ResourceRankingsRequest {
3365
3366
  organizationId: string;
3366
3367
  projectId: string;
3368
+ /** Each list holds at most 50 values; a longer one is STATUS_CODE_VALIDATION_ERROR. */
3367
3369
  filter: AISessionFilter | undefined;
3368
3370
  dimension: AIResourceDimension;
3369
- /** Splits the ranking into one top-limit list per group. Unspecified ranks the filtered set once. */
3371
+ /**
3372
+ * Splits the ranking into one top-limit list per group. Unspecified ranks the filtered set once. PRINCIPAL needs a
3373
+ * filter.user_ids or filter.api_key_ids entry, else STATUS_CODE_VALIDATION_ERROR, and returns only the principals
3374
+ * those name.
3375
+ */
3370
3376
  groupBy: AIResourceRankingGroupBy;
3371
3377
  timeWindow: AnalyticsTimeWindow;
3372
- /** Max rows, per group when group_by is set; 0 = the default 10, capped at 100. */
3378
+ /** Max rows, per group when group_by is set; 0 = the default 10, capped at 100, negative is a validation error. */
3373
3379
  limit: number;
3374
3380
  }
3375
3381