@hydradb/sdk 2.1.4 → 2.1.6

package/dist/api/types/MemoriesConversationTurn.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/MemoriesForcefulRelations.d.ts

@@ -0,0 +1,11 @@
+/**
+ * ForcefulRelations are the contexts the caller says this one relates to,
+ * by context_id, with optional properties stored on each edge. They are
+ * followed at query time (follow_forceful_relations) and returned as
+ * `forceful_relations[]`. Any item may declare them; on the split surface
+ * only a knowledge item could.
+ */
+export interface MemoriesForcefulRelations {
+    contextIds?: string[];
+    properties?: Record<string, unknown>;
+}

package/dist/api/types/MemoriesForcefulRelations.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/MemoriesIngestItem.d.ts

@@ -0,0 +1,56 @@
+import type * as HydraDB from "../index.js";
+export interface MemoriesIngestItem {
+    /**
+     * ACL is the item's access-control list (PRO-1684), the same contract as
+     * an app_knowledge item's `acl` on a split database: bare emails,
+     * user_email:/group:/domain: principals, or the __public__/__private__
+     * sentinels. Omitted (nil) leaves the context unrestricted; an explicitly
+     * empty list stores __private__. Normalised here, all-or-nothing, so a
+     * malformed principal is a 400 on the request rather than a silently
+     * mis-scoped context. Enforced by every read that takes `acl`.
+     */
+    acl?: string[];
+    attributes?: Record<string, unknown>;
+    /**
+     * ContextCategory files this context under one of the three buckets
+     * (PRO-1618). Omitted or "auto" leaves it to HydraDB; naming a bucket pins
+     * it and inference will not overwrite it. See
+     * domain/ingestion/context_category.go.
+     */
+    contextCategory?: HydraDB.MemoriesIngestItemContextCategory;
+    contextId?: string;
+    /**
+     * Conversation is the shape a developer already builds for OpenAI or
+     * Anthropic: `[{role, content}]`.
+     */
+    conversation?: HydraDB.MemoriesConversationTurn[];
+    customAttributes?: Record<string, unknown>;
+    enrich?: boolean;
+    forcefulRelations?: HydraDB.MemoriesForcefulRelations;
+    happenedAt?: string;
+    /**
+     * Instructions steer enrichment for this item. The request-level value is
+     * the default when an item names none.
+     */
+    instructions?: string;
+    text?: string;
+    /**
+     * Title names the context. It becomes the context's document title, and it
+     * is what distinguishes two items whose text is identical: the document id
+     * is generated from the title, so without one they collide.
+     */
+    title?: string;
+    /**
+     * Upsert decides, for THIS item, whether an existing context with the same
+     * context_id is replaced. The request-level value is the default. This is
+     * what lets one call replace some contexts and append others.
+     */
+    upsert?: boolean;
+    /**
+     * UserName is the speaker identity for the item, on both shapes: a text
+     * item is what that person said, a conversation's user turns are theirs.
+     * Empty ends up as "User", matching the split path, so the pipeline is
+     * never handed a blank.
+     */
+    userName?: string;
+}

package/dist/api/types/MemoriesIngestItem.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/MemoriesIngestItemContextCategory.d.ts

@@ -0,0 +1,13 @@
+/**
+ * ContextCategory files this context under one of the three buckets
+ * (PRO-1618). Omitted or "auto" leaves it to HydraDB; naming a bucket pins
+ * it and inference will not overwrite it. See
+ * domain/ingestion/context_category.go.
+ */
+export declare const MemoriesIngestItemContextCategory: {
+    readonly Auto: "auto";
+    readonly UserPreference: "user_preference";
+    readonly BusinessKnowledge: "business_knowledge";
+    readonly DecisionTrace: "decision_trace";
+};
+export type MemoriesIngestItemContextCategory = (typeof MemoriesIngestItemContextCategory)[keyof typeof MemoriesIngestItemContextCategory];

package/dist/api/types/MemoriesIngestItemContextCategory.js

@@ -0,0 +1,16 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MemoriesIngestItemContextCategory = void 0;
+/**
+ * ContextCategory files this context under one of the three buckets
+ * (PRO-1618). Omitted or "auto" leaves it to HydraDB; naming a bucket pins
+ * it and inference will not overwrite it. See
+ * domain/ingestion/context_category.go.
+ */
+exports.MemoriesIngestItemContextCategory = {
+    Auto: "auto",
+    UserPreference: "user_preference",
+    BusinessKnowledge: "business_knowledge",
+    DecisionTrace: "decision_trace",
+};

package/dist/api/types/MemoriesUnifiedIngestRequest.d.ts

@@ -0,0 +1,26 @@
+import type * as HydraDB from "../index.js";
+export interface MemoriesUnifiedIngestRequest {
+    /** Collection scope. Defaults to the default collection when omitted. Formerly `sub_tenant_id`; the `sub_tenant_id` alias is still accepted (deprecated). */
+    collection?: string;
+    /** Context is the list of contexts to ingest. */
+    context?: HydraDB.MemoriesIngestItem[];
+    /** Owning database. Formerly `tenant_id`; the `tenant_id` alias is still accepted (deprecated). */
+    database?: string;
+    enrich?: boolean;
+    /**
+     * GraphPayload is the bring-your-own-graph map, keyed by context_id. Every
+     * key must name an item in this request, so a typo cannot silently drop a
+     * graph.
+     */
+    graphPayload?: Record<string, HydraDB.IngestionGraphPayload>;
+    instructions?: string;
+    /** deprecated: use collection */
+    subTenantId?: string;
+    /** deprecated: use database */
+    tenantId?: string;
+    /**
+     * Upsert, Enrich and Instructions are the request-level defaults for the
+     * item-level fields of the same name: true, true and "" when absent.
+     */
+    upsert?: boolean;
+}

package/dist/api/types/MemoriesUnifiedIngestRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/SearchAliasExpansionNote.d.ts

@@ -0,0 +1,4 @@
+export interface SearchAliasExpansionNote {
+    alias?: string;
+    canonical?: string;
+}

package/dist/api/types/SearchAliasExpansionNote.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/SearchAppSearchFusionDiagnostics.d.ts

@@ -0,0 +1,31 @@
+import type * as HydraDB from "../index.js";
+/**
+ * AppSearchFusion is the diagnostic block of the query_apps fusion
+ * (PRO-1882): per-chunk lane attribution and counts. Present only when
+ * query_apps was on, the request was not ACL-scoped, and attributed chunks
+ * survived final filtering. Identifier maps cover only returned chunks.
+ */
+export interface SearchAppSearchFusionDiagnostics {
+    /**
+     * AppRecipes maps the chunk_uuid of each final chunk the app lane returned to
+     * the recipe that produced it (exact_id, recall, dated, bm25, broad, ...),
+     * including chunks the normal lane also had, so a consensus can be
+     * attributed to a recipe.
+     */
+    appRecipes?: Record<string, string>;
+    /**
+     * ChunkOrigins maps every returned chunk_uuid to where the fusion placed it
+     * from: "normal" (normal lane only), "both" (both lanes, normal position
+     * kept), "exact_id" (promoted from the app lane's exact-identifier
+     * recipe), "app_tail" (appended from the app lane).
+     */
+    chunkOrigins?: Record<string, string>;
+    /** Counts for the first or only fusion pass before postprocessing, not final response counts or totals across alias alternatives. The entire diagnostic block is omitted for ACL-scoped requests. */
+    stats?: HydraDB.SearchAppSearchFusionStats;
+    /**
+     * StatsByPass preserves each independent fusion's accounting when results
+     * combine multiple passes, in merge order (original before alternate when
+     * both have diagnostics). Counts overlap; they are not unique totals.
+     */
+    statsByPass?: HydraDB.SearchAppSearchFusionStats[];
+}

package/dist/api/types/SearchAppSearchFusionDiagnostics.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/SearchAppSearchFusionStats.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Stats describes the first (or only) fusion pass before postprocessing,
+ * not final counts or a sum across alias alternatives/fan-out branches.
+ */
+export interface SearchAppSearchFusionStats {
+    /** AppChunks is what the app lane returned. */
+    appChunks?: number;
+    /** AppHasExactIDs mirrors the app plan's exact-identifier marker. */
+    appHasExactIds?: boolean;
+    /**
+     * AppLaneEmptyText is true when the app lane returned no chunks (sources
+     * or side context only).
+     */
+    appLaneEmptyText?: boolean;
+    /**
+     * Consensus counts app chunks the normal lane already had; they keep the
+     * normal lane's position.
+     */
+    consensus?: number;
+    /**
+     * ExactCandidates counts app chunks the exact-identifier recipe found;
+     * ExactPromoted is how many of them were placed above the normal lane.
+     */
+    exactCandidates?: number;
+    /** Exact-identifier chunks placed above the normal lane. */
+    exactPromoted?: number;
+    /** Limit is the final chunk limit the fusion applied. */
+    limit?: number;
+    /** NormalChunks is what the normal lane returned. */
+    normalChunks?: number;
+    /**
+     * NormalDisplaced counts normal-lane chunks the promoted block and the
+     * tail pushed past the limit.
+     */
+    normalDisplaced?: number;
+    /** App-only chunks appended within the tail budget. */
+    tailAdded?: number;
+    /**
+     * TailCandidates counts app-only chunks eligible for the tail; TailAdded
+     * is how many were appended within the tail budget.
+     */
+    tailCandidates?: number;
+}

package/dist/api/types/SearchAppSearchFusionStats.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/SearchChunkInspectResult.d.ts

@@ -0,0 +1,24 @@
+import type * as HydraDB from "../index.js";
+export interface SearchChunkInspectResult {
+    chunks?: HydraDB.SearchVectorStoreChunk[];
+    /**
+     * IsTruncated reports that the source has more chunks than the limit
+     * returned, so the reader knows the text they see is a prefix of the
+     * document and not the whole of it.
+     */
+    isTruncated?: boolean;
+    /** Human-readable result message. */
+    message?: string;
+    /**
+     * MissingChunkIDs are ids the caller asked for that have no chunk row in
+     * either store. An expected, documented state rather than an error: on
+     * staging 61% of one Slack collection's sources had graph relations but no
+     * chunk_data row at all (see attributedSourceID), and the vector store is
+     * not guaranteed to still hold a re-ingested source's older chunk ids.
+     * Always empty for a source-scoped read, which discovers ids rather than
+     * being handed them.
+     */
+    missingChunkIds?: string[];
+    /** Whether the request succeeded. */
+    success?: boolean;
+}

package/dist/api/types/SearchChunkInspectResult.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/SearchCodeSearchRepoResult.d.ts

@@ -0,0 +1,11 @@
+export interface SearchCodeSearchRepoResult {
+    answer?: string;
+    durationMs?: number;
+    /** Error message, empty string on success. */
+    error?: string;
+    repo?: string;
+    /** Current lifecycle or processing state. */
+    status?: string;
+    truncated?: boolean;
+    unsigned?: boolean;
+}

package/dist/api/types/SearchCodeSearchRepoResult.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/SearchCodeSearchResult.d.ts

@@ -0,0 +1,24 @@
+import type * as HydraDB from "../index.js";
+/**
+ * CodeSearch is the repository code-search branch's answer, when routed.
+ */
+export interface SearchCodeSearchResult {
+    /**
+     * DecidedBy names the signal that routed the query: "request" (caller
+     * forced it), "planner" (is_code_query) or "stage2" (embedding router).
+     */
+    decidedBy?: string;
+    /** DurationMS is the wall time the branch took. */
+    durationMs?: number;
+    /** Reason explains a non-ok status in one sentence. */
+    reason?: string;
+    /** Repos lists each repository searched with its own status and answer. */
+    repos?: HydraDB.SearchCodeSearchRepoResult[];
+    /**
+     * Status is "ok" when at least one repository answered, "not_found" when
+     * none had an archive, "error"/"timeout" when the branch failed, or
+     * "skipped" with a Reason when it was not attempted (no repositories
+     * connected, caller opted out).
+     */
+    status?: string;
+}

package/dist/api/types/SearchCodeSearchResult.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/SearchEntityProfileView.d.ts

@@ -0,0 +1,18 @@
+import type * as HydraDB from "../index.js";
+export interface SearchEntityProfileView {
+    compiledAt?: string;
+    /** Unique identifier for this entity in the graph. */
+    entityId?: string;
+    entityType?: string;
+    entries?: HydraDB.SearchProfileEntry[];
+    headline?: string;
+    /** Human-readable label for this resource. */
+    name?: string;
+    pendingImportance?: number;
+    perspective?: string;
+    subject?: string;
+    summary?: string;
+    summaryCites?: string[];
+    unknown?: string[];
+    version?: number;
+}

package/dist/api/types/SearchEntityProfileView.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/SearchForcefulRelationEntry.d.ts

@@ -0,0 +1,5 @@
+import type * as HydraDB from "../index.js";
+export interface SearchForcefulRelationEntry {
+    chunk?: HydraDB.SearchV2Chunk;
+    via?: HydraDB.SearchRelationVia;
+}

package/dist/api/types/SearchForcefulRelationEntry.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/SearchForcefulRelationsBucket.d.ts

@@ -0,0 +1,11 @@
+import type * as HydraDB from "../index.js";
+/**
+ * ForcefulRelations is the caller-declared relation bucket, carrying the
+ * from->to edge that additional_context discards when it flattens these
+ * into a chunk-uuid map. Always present, so a caller can read it
+ * unconditionally.
+ */
+export interface SearchForcefulRelationsBucket {
+    declared?: HydraDB.SearchForcefulRelationEntry[];
+    inferred?: HydraDB.SearchForcefulRelationEntry[];
+}

package/dist/api/types/SearchForcefulRelationsBucket.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/SearchGraphPath.d.ts

@@ -0,0 +1,10 @@
+import type * as HydraDB from "../index.js";
+export interface SearchGraphPath {
+    chunkIds?: string[];
+    /** Merged text from all chunk passages in this relation path. */
+    combinedContext?: string;
+    /** Relevance score for this item against the query. */
+    relevancyScore?: number;
+    /** Knowledge-graph triplets that make up this relation path. */
+    triplets?: HydraDB.SearchPathTriplet[];
+}

package/dist/api/types/SearchGraphPath.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/SearchGraphPlane.d.ts

@@ -0,0 +1,11 @@
+import type * as HydraDB from "../index.js";
+/**
+ * Graph is the consolidated graph plane: query_paths and
+ * chunk_relations consolidated into one ordered paths[] list, with each
+ * path carrying the chunk ids it supports so the caller no longer joins
+ * against chunk_id_to_group_ids. Populated whenever graph_context is on;
+ * graph_context stays populated beside it.
+ */
+export interface SearchGraphPlane {
+    paths?: HydraDB.SearchGraphPath[];
+}

package/dist/api/types/SearchGraphPlane.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/SearchMetadataFilters.d.ts

@@ -1,4 +1,4 @@
 /**
- * Filters results by source metadata. Top-level keys target tenant metadata (for example department, priority, active, or tags). Nested additional_metadata keys target document metadata. Separate keys are ANDed. A scalar value is an exact match; an array means match ANY one of the listed values (OR) - there is no ALL/AND operator within a single key. Arrays are supported on VARCHAR fields only: an array passed for a declared field of any other type is rejected with 400 VALIDATION_ERROR. Size limits: each list may hold at most 500 values, and the whole metadata_filters object is capped at 64 KiB measured on its compact JSON encoding in UTF-8 bytes (keys and punctuation count). Exceeding either returns 400 naming the offending key or the actual byte count.
+ * DEPRECATED: use `attributes`, which is an operator language pushed into the vector search rather than bare equality applied after it. `metadata_filters` keeps working, and is still the only way to filter on per-context custom_attributes, which `attributes` does not cover yet. Filters results by context metadata. Top-level keys target tenant metadata (for example department, priority, active, or tags). Nested additional_metadata keys target document metadata. Separate keys are ANDed. Each top-level key accepts an operator object naming the comparison: {"contains": value} matches sources whose field holds that value (multi-value fields are stored comma-joined, so this matches one member); {"contains_any": [values]} matches sources holding ANY one of the listed values; {"equals": value} matches sources whose field is exactly that value. The bare forms remain supported and unchanged but are deprecated in favour of the operators, because the comparison they perform is inferred from the JSON shape rather than stated: a bare scalar behaves as equals, a bare array as contains_any, and a bare single-element array as contains. Operators apply to top-level keys only; inside additional_metadata use the bare scalar or array forms. An operator used inside additional_metadata is NOT rejected - it is read as an exact-match filter against a stored object, so on a normal field it matches nothing and the request returns 200 with an empty result rather than an error. A known operator given the wrong operand type, or several operators in one object, is rejected with 400 VALIDATION_ERROR rather than silently matching nothing. A MISSPELLED operator is not: {"contian": "x"} is indistinguishable from a filter for a stored object with that key, so it is left alone and matches nothing. An object whose keys are not operator names is likewise treated as an exact-match filter against a stored object, unchanged. RESERVED NAMES: contains, contains_any and equals are reserved as the keys of a top-level filter object, so an object built only from them is read as an operator and is no longer available for exact object matching -- {"f": {"contains": "x"}} is read as the operator, and an object whose keys are ALL operator names is rejected with 400. A caller matching such an object in a JSON-typed field must rename the nested key or the field. Mixing an operator name with any other key ({"contains": "a", "other": 1}) is unaffected and still exact-matches. There is no ALL/AND operator within a single key. contains, contains_any and arrays are supported on VARCHAR fields only: any of them passed for a declared field of another type is rejected with 400 VALIDATION_ERROR. equals works on every declared type, so {"priority": {"equals": 7}} is valid on an INT64 field. Size limits: each list may hold at most 500 values, and the whole metadata_filters object is capped at 64 KiB measured on its compact JSON encoding in UTF-8 bytes AFTER operator objects are reduced to their values, so {"contains": "x"} is measured as ["x"] and the operator keyword itself costs nothing. The cap bounds the cost of the resulting vector-store expression, which the operator spelling does not change. Field names and punctuation count. Exceeding either returns 400 naming the offending key or the actual byte count.
  */
 export type SearchMetadataFilters = Record<string, unknown>;

package/dist/api/types/SearchProfileContext.d.ts

@@ -0,0 +1,17 @@
+import type * as HydraDB from "../index.js";
+/**
+ * ProfileContext/ProfileFilter surface the entity-profile block when the
+ * request named a profile_subject (PRO-1797); omitted otherwise.
+ */
+export interface SearchProfileContext {
+    /** Unique identifier for this entity in the graph. */
+    entityId?: string;
+    entries?: HydraDB.SearchProfileEntry[];
+    headline?: string;
+    /** Human-readable label for this resource. */
+    name?: string;
+    perspective?: string;
+    subject?: string;
+    summary?: string;
+    version?: number;
+}

package/dist/api/types/SearchProfileContext.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/SearchProfileEntry.d.ts

@@ -0,0 +1,11 @@
+export interface SearchProfileEntry {
+    /** Confidence score, from 0 to 1. */
+    confidence?: number;
+    facet?: string;
+    since?: string;
+    slot?: string;
+    /** stated | observed | inferred | record */
+    state?: string;
+    statementKeys?: string[];
+    text?: string;
+}

package/dist/api/types/SearchProfileEntry.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/SearchProfileFilterInfo.d.ts

@@ -0,0 +1,10 @@
+export interface SearchProfileFilterInfo {
+    applied?: boolean;
+    degraded?: boolean;
+    /** Unique identifier for this entity in the graph. */
+    entityId?: string;
+    found?: boolean;
+    selectedEntries?: number;
+    subject?: string;
+    version?: number;
+}

package/dist/api/types/SearchProfileFilterInfo.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/SearchQueryChunk.d.ts

@@ -0,0 +1,19 @@
+import type * as HydraDB from "../index.js";
+export interface SearchQueryChunk {
+    /** The chunk's id. Every graph hop names the chunk it was extracted from by this id. */
+    chunkId: string;
+    /** The chunk's own text. Enrichment is not concatenated into it. */
+    content: string;
+    /** The id of the context (source) the chunk belongs to. */
+    contextId: string;
+    /** What enrichment produced for the chunk, kept apart from content. Absent when nothing was produced. */
+    enrichment?: string;
+    /** The context_category the author declared at ingest (user_preference, business_knowledge or decision_trace). Never inferred. Absent when none was declared. */
+    enrichmentKind?: HydraDB.SearchQueryChunkEnrichmentKind;
+    /** When the context this chunk belongs to was received (RFC 3339). This is the ingest time, not the caller's happened_at, which is not echoed here. Omitted when the store holds no receipt time for the row (older rows); it is never sent empty. */
+    receivedAt?: string;
+    /** Relevance after reranking. */
+    score: number;
+    /** Dated facts extracted from the chunk. Present only when the query engaged temporal reasoning. */
+    temporal?: HydraDB.SearchQueryChunkTemporal[];
+}

package/dist/api/types/SearchQueryChunk.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/SearchQueryChunkEnrichmentKind.d.ts

@@ -0,0 +1,7 @@
+/** The context_category the author declared at ingest (user_preference, business_knowledge or decision_trace). Never inferred. Absent when none was declared. */
+export declare const SearchQueryChunkEnrichmentKind: {
+    readonly UserPreference: "user_preference";
+    readonly BusinessKnowledge: "business_knowledge";
+    readonly DecisionTrace: "decision_trace";
+};
+export type SearchQueryChunkEnrichmentKind = (typeof SearchQueryChunkEnrichmentKind)[keyof typeof SearchQueryChunkEnrichmentKind];

package/dist/api/types/SearchQueryChunkEnrichmentKind.js

@@ -0,0 +1,10 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchQueryChunkEnrichmentKind = void 0;
+/** The context_category the author declared at ingest (user_preference, business_knowledge or decision_trace). Never inferred. Absent when none was declared. */
+exports.SearchQueryChunkEnrichmentKind = {
+    UserPreference: "user_preference",
+    BusinessKnowledge: "business_knowledge",
+    DecisionTrace: "decision_trace",
+};

package/dist/api/types/SearchQueryChunkTemporal.d.ts

@@ -0,0 +1,8 @@
+export interface SearchQueryChunkTemporal {
+    /** The fact as a sentence with its dates embedded. */
+    content: string;
+    /** End of the fact's window, YYYY-MM-DD, or null. */
+    endDate: string | null;
+    /** Start of the fact's window, YYYY-MM-DD, or null. */
+    startDate: string | null;
+}

package/dist/api/types/SearchQueryChunkTemporal.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/SearchQueryForcefulRelation.d.ts

@@ -0,0 +1,6 @@
+import type * as HydraDB from "../index.js";
+export interface SearchQueryForcefulRelation {
+    chunk: HydraDB.SearchQueryChunk;
+    /** The declared edge that pulled the chunk in: from is the context that declared it, to is the chunk's own context. */
+    via: HydraDB.SearchRelationVia;
+}

package/dist/api/types/SearchQueryForcefulRelation.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/SearchQueryGraphEdge.d.ts

@@ -0,0 +1,13 @@
+export interface SearchQueryGraphEdge {
+    /** The chunk the relation was extracted from. For a chunk_relation path this is the returned chunk the path hangs under. */
+    chunkId: string;
+    /** The sentence the relation was extracted from. */
+    context: string;
+    /** The relation between the two entities. */
+    predicate: string;
+    /** The relation's stable id. */
+    relationshipId: string;
+    /** When the relation held, as extraction phrased it. */
+    temporalDetails?: string;
+    timestamp?: number | null;
+}

package/dist/api/types/SearchQueryGraphEdge.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/SearchQueryGraphEntity.d.ts

@@ -0,0 +1,4 @@
+export interface SearchQueryGraphEntity {
+    entityId: string;
+    name: string;
+}

package/dist/api/types/SearchQueryGraphEntity.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/SearchQueryGraphPath.d.ts

@@ -0,0 +1,9 @@
+import type * as HydraDB from "../index.js";
+export interface SearchQueryGraphPath {
+    /** Which lane found the path: query_path (grown from the entities in the query) or chunk_relation (the neighbourhood of a returned chunk). */
+    origin: HydraDB.SearchQueryGraphPathOrigin;
+    /** The path narrated as one sentence. */
+    pathSummary: string;
+    /** The path's hops, in order. */
+    triplets: HydraDB.SearchQueryGraphTriplet[];
+}

package/dist/api/types/SearchQueryGraphPath.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/SearchQueryGraphPathOrigin.d.ts

@@ -0,0 +1,6 @@
+/** Which lane found the path: query_path (grown from the entities in the query) or chunk_relation (the neighbourhood of a returned chunk). */
+export declare const SearchQueryGraphPathOrigin: {
+    readonly QueryPath: "query_path";
+    readonly ChunkRelation: "chunk_relation";
+};
+export type SearchQueryGraphPathOrigin = (typeof SearchQueryGraphPathOrigin)[keyof typeof SearchQueryGraphPathOrigin];

package/dist/api/types/SearchQueryGraphPathOrigin.js

@@ -0,0 +1,9 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchQueryGraphPathOrigin = void 0;
+/** Which lane found the path: query_path (grown from the entities in the query) or chunk_relation (the neighbourhood of a returned chunk). */
+exports.SearchQueryGraphPathOrigin = {
+    QueryPath: "query_path",
+    ChunkRelation: "chunk_relation",
+};