@littlebigbrain/client 0.5.1 → 0.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.
Files changed (2) hide show
  1. package/dist/schema.d.ts +121 -3
  2. package/package.json +1 -1
package/dist/schema.d.ts CHANGED
@@ -2213,7 +2213,18 @@ export interface components {
2213
2213
  };
2214
2214
  /** @enum {string} */
2215
2215
  AskPlanExecutionModeV2: "entity_search" | "path_search" | "hybrid";
2216
+ AskPlanFailure: {
2217
+ code: components["schemas"]["AskPlanFailureCode"];
2218
+ /** @description True when retrying after the planner recovers can produce a plan. */
2219
+ retryable: boolean;
2220
+ stage: components["schemas"]["AskPlanFailureStage"];
2221
+ };
2222
+ /** @enum {string} */
2223
+ AskPlanFailureCode: "planner_disabled" | "planner_unavailable" | "no_class_candidates" | "generation_failed" | "validation_failed";
2224
+ /** @enum {string} */
2225
+ AskPlanFailureStage: "configuration" | "target_type" | "relation" | "anchor";
2216
2226
  AskQuery: {
2227
+ plan_failure?: null | components["schemas"]["AskPlanFailure"];
2217
2228
  /** @description The retrieval query text that was executed. */
2218
2229
  query: string;
2219
2230
  structured?: null | components["schemas"]["AskStructuredQuery"];
@@ -2828,9 +2839,24 @@ export interface components {
2828
2839
  reranked_candidates?: number;
2829
2840
  source: components["schemas"]["EmbeddingIndexSource"];
2830
2841
  spaces_searched: number;
2842
+ temporal_coverage?: null | components["schemas"]["SearchTemporalCoverage"];
2831
2843
  unindexed_tail_commits: number;
2832
2844
  };
2833
2845
  EmbeddingSearchRequest: {
2846
+ /**
2847
+ * Format: int64
2848
+ * @description Snapshot pin (transaction-time ceiling): results hide every event
2849
+ * committed after this sequence, reproducing that past snapshot. The ANN
2850
+ * run is selected as the newest run at or below the pin and the pin bounds
2851
+ * the forward overlay; candidate generation is never the correctness layer.
2852
+ * Omitted means the current head.
2853
+ */
2854
+ as_of_commit_seq?: number | null;
2855
+ /**
2856
+ * @description Valid-time cursor (RFC 3339): results reflect facts true at this
2857
+ * instant. Omitted means the latest valid time.
2858
+ */
2859
+ as_of_valid_time?: string | null;
2834
2860
  consistency?: null | components["schemas"]["SearchConsistency"];
2835
2861
  /** Format: int32 */
2836
2862
  dim?: number | null;
@@ -3297,10 +3323,25 @@ export interface components {
3297
3323
  overlay_candidates: number;
3298
3324
  ranged?: null | components["schemas"]["RangedReadStats"];
3299
3325
  source: components["schemas"]["FullTextIndexSource"];
3326
+ temporal_coverage?: null | components["schemas"]["SearchTemporalCoverage"];
3300
3327
  term_count: number;
3301
3328
  unindexed_tail_commits: number;
3302
3329
  };
3303
3330
  FullTextSearchRequest: {
3331
+ /**
3332
+ * Format: int64
3333
+ * @description Snapshot pin (transaction-time ceiling): results hide every event
3334
+ * committed after this sequence, reproducing that past snapshot. The BM25
3335
+ * run is selected as the newest run at or below the pin and the pin bounds
3336
+ * the forward overlay; candidate generation is never the correctness layer.
3337
+ * Omitted means the current head.
3338
+ */
3339
+ as_of_commit_seq?: number | null;
3340
+ /**
3341
+ * @description Valid-time cursor (RFC 3339): results reflect facts true at this
3342
+ * instant. Omitted means the latest valid time.
3343
+ */
3344
+ as_of_valid_time?: string | null;
3304
3345
  consistency?: null | components["schemas"]["SearchConsistency"];
3305
3346
  explain: boolean;
3306
3347
  facets?: components["schemas"]["FacetRequest"][] | null;
@@ -5620,6 +5661,12 @@ export interface components {
5620
5661
  terms: components["schemas"]["ResolutionResult"][];
5621
5662
  };
5622
5663
  ResolvedTerm: {
5664
+ /**
5665
+ * @description Ontology description/definition when the resolved schema term carries
5666
+ * one. Candidate-free class resolution preserves tenant-authored class
5667
+ * documentation instead of returning only a bare label.
5668
+ */
5669
+ description?: string | null;
5623
5670
  kind: components["schemas"]["SuggestKind"];
5624
5671
  provenance?: null | components["schemas"]["VocabularyProvenance"];
5625
5672
  /**
@@ -5628,6 +5675,7 @@ export interface components {
5628
5675
  */
5629
5676
  score: number;
5630
5677
  text: string;
5678
+ type_signature?: null | components["schemas"]["VocabularyTypeSignature"];
5631
5679
  };
5632
5680
  /** @description One edge to retract, identified the same way it was asserted. */
5633
5681
  RetractEdgeInput: {
@@ -6554,6 +6602,25 @@ export interface components {
6554
6602
  signature_forced?: boolean;
6555
6603
  text: string;
6556
6604
  };
6605
+ /**
6606
+ * @description How a temporally-pinned (or head) search resolved run selection: the
6607
+ * effective `as_of` ceiling, the base snapshot of the selected persisted
6608
+ * run(s), and the highest commit each leg's run+segments actually covered
6609
+ * (the forward WAL overlay covers `(covered_through, ceiling]`). Distinct from
6610
+ * the ontology-inspect `TemporalCoverage` type. Per-leg fields are `None` when
6611
+ * that leg served from an ephemeral rebuild (no persisted run at the ceiling).
6612
+ */
6613
+ SearchTemporalCoverage: {
6614
+ bm25_covered_through?: null | components["schemas"]["CommitSeq"];
6615
+ bm25_run_snapshot_commit_seq?: null | components["schemas"]["CommitSeq"];
6616
+ /**
6617
+ * @description Resolved transaction-time ceiling: the `as_of_commit_seq` pin, or the
6618
+ * head commit_seq when the query was unpinned.
6619
+ */
6620
+ ceiling_commit_seq: components["schemas"]["CommitSeq"];
6621
+ vector_covered_through?: null | components["schemas"]["CommitSeq"];
6622
+ vector_run_snapshot_commit_seq?: null | components["schemas"]["CommitSeq"];
6623
+ };
6557
6624
  SemanticGraphSearchRequest: {
6558
6625
  /**
6559
6626
  * Format: int64
@@ -6673,6 +6740,7 @@ export interface components {
6673
6740
  * candidate generation.
6674
6741
  */
6675
6742
  target_prep_ms?: number;
6743
+ temporal_coverage?: null | components["schemas"]["SearchTemporalCoverage"];
6676
6744
  /** Format: int64 */
6677
6745
  total_ms?: number;
6678
6746
  /**
@@ -6728,6 +6796,13 @@ export interface components {
6728
6796
  as_of_valid_time?: string | null;
6729
6797
  direction: components["schemas"]["ExpansionDirection"];
6730
6798
  explain: boolean;
6799
+ /**
6800
+ * @description Entity properties to project for every returned seed and path node.
6801
+ * Projections are reduced from the same snapshot used for authorization
6802
+ * and traversal. Requesting fields routes the operation through the exact
6803
+ * snapshot path rather than ranged adjacency.
6804
+ */
6805
+ fields?: string[];
6731
6806
  /**
6732
6807
  * Format: int64
6733
6808
  * @description Decoded adjacency-block working-set byte budget for persisted-vector
@@ -6753,6 +6828,15 @@ export interface components {
6753
6828
  SemanticTraverseResponse: {
6754
6829
  explain?: null | components["schemas"]["SemanticTraverseExplain"];
6755
6830
  paths: components["schemas"]["PathResult"][];
6831
+ /**
6832
+ * @description Requested properties keyed by entity id for every returned seed and
6833
+ * path node. Empty when `fields` was omitted.
6834
+ */
6835
+ projected_nodes?: {
6836
+ [key: string]: {
6837
+ [key: string]: unknown;
6838
+ };
6839
+ };
6756
6840
  ranged?: null | components["schemas"]["RangedTraverseStats"];
6757
6841
  seeds: components["schemas"]["ScoredEntityView"][];
6758
6842
  snapshot: components["schemas"]["SnapshotView"];
@@ -7098,6 +7182,13 @@ export interface components {
7098
7182
  ShadowEvalResponse: {
7099
7183
  challenger: components["schemas"]["ShadowArmResult"];
7100
7184
  champion: components["schemas"]["ShadowArmResult"];
7185
+ /**
7186
+ * @description Fail-closed promotion verdict over the same labeled queries and pinned
7187
+ * snapshot. Requires quality non-regression plus p50/p95/p99 latency
7188
+ * ratios within the configured ceiling; this endpoint still never
7189
+ * performs the promotion itself.
7190
+ */
7191
+ gate: components["schemas"]["TrainGateReport"];
7101
7192
  /** @description Labeled queries (those with `expected`) the hit rates are over. */
7102
7193
  labeled: number;
7103
7194
  /** Format: float */
@@ -7814,7 +7905,8 @@ export interface components {
7814
7905
  TrainGateReport: {
7815
7906
  /**
7816
7907
  * Format: float
7817
- * @description Challenger − champion hit-rate on the held-out eval slice.
7908
+ * @description Challenger − champion primary quality metric on the held-out eval
7909
+ * slice (nDCG for fusion and retrieval-profile comparisons).
7818
7910
  */
7819
7911
  effect: number;
7820
7912
  /** Format: float */
@@ -7823,7 +7915,18 @@ export interface components {
7823
7915
  labeled: number;
7824
7916
  /**
7825
7917
  * Format: double
7826
- * @description Challenger / champion mean-latency ratio on the eval slice.
7918
+ * @description Challenger / champion latency ratios at each reported percentile.
7919
+ */
7920
+ latency_p50_ratio?: number | null;
7921
+ /** Format: double */
7922
+ latency_p95_ratio?: number | null;
7923
+ /** Format: double */
7924
+ latency_p99_ratio?: number | null;
7925
+ /**
7926
+ * Format: double
7927
+ * @description Legacy decision latency ratio. For configuration shadow evaluation this
7928
+ * is the worst of p50/p95/p99; older trainer kinds may use their primary
7929
+ * latency statistic.
7827
7930
  */
7828
7931
  latency_ratio: number;
7829
7932
  /**
@@ -7856,7 +7959,8 @@ export interface components {
7856
7959
  reason: string;
7857
7960
  /**
7858
7961
  * Format: float
7859
- * @description Fusion-only paired held-out deltas. All must be non-negative.
7962
+ * @description Paired held-out retrieval deltas. When present, all must be
7963
+ * non-negative.
7860
7964
  */
7861
7965
  recall_delta?: number | null;
7862
7966
  };
@@ -8161,6 +8265,11 @@ export interface components {
8161
8265
  };
8162
8266
  /** @enum {string} */
8163
8267
  VocabularyOrigin: "builtin" | "tenant" | "imported";
8268
+ VocabularyPropertySignature: {
8269
+ name: string;
8270
+ required: boolean;
8271
+ value_type: string;
8272
+ };
8164
8273
  VocabularyProvenance: {
8165
8274
  candidate_id: string;
8166
8275
  namespace: string;
@@ -8169,6 +8278,15 @@ export interface components {
8169
8278
  origin: components["schemas"]["VocabularyOrigin"];
8170
8279
  source_reference: string;
8171
8280
  };
8281
+ VocabularyTypeSignature: {
8282
+ properties?: components["schemas"]["VocabularyPropertySignature"][];
8283
+ source_types?: string[];
8284
+ /** @description Frozen normalized schema identity. */
8285
+ stable_id: string;
8286
+ super_types?: string[];
8287
+ target_types?: string[];
8288
+ value_type?: string | null;
8289
+ };
8172
8290
  WalCompactRequest: {
8173
8291
  /**
8174
8292
  * @description When appending the new segment would leave the manifest with more
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@littlebigbrain/client",
3
- "version": "0.5.1",
3
+ "version": "0.5.2",
4
4
  "description": "TypeScript client for the little big brain graph + hybrid search HTTP API",
5
5
  "license": "Apache-2.0",
6
6
  "repository": {