hermes-client-typescript 1.7.11 → 1.7.15

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/dist/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
1
  export { HermesClient } from "./client";
2
- export { Document, SearchHit, SearchResponse, IndexInfo, SearchOptions, TermQuery, BooleanQueryDef, SparseVectorQueryDef, SparseTextQueryDef, DenseVectorQueryDef, RerankerDef, Combiner, RerankerCombiner, } from "./types";
3
- export { SearchServiceDefinition, IndexServiceDefinition, MultiValueCombiner, Query, TermQuery as PbTermQuery, BooleanQuery, BoostQuery, AllQuery, MatchQuery, SparseVectorQuery, DenseVectorQuery, Reranker, SearchRequest, SearchResponse as PbSearchResponse, SearchHit as PbSearchHit, FieldValue, FieldEntry, SparseVector, DenseVector, GetDocumentRequest, GetDocumentResponse, GetIndexInfoRequest, GetIndexInfoResponse, CreateIndexRequest, CreateIndexResponse, IndexDocumentRequest, IndexDocumentsResponse, BatchIndexDocumentsRequest, BatchIndexDocumentsResponse, NamedDocument, CommitRequest, CommitResponse, ForceMergeRequest, ForceMergeResponse, DeleteIndexRequest, DeleteIndexResponse, ListIndexesRequest, ListIndexesResponse, MemoryStats, IndexingBufferStats, SegmentReaderStats, OrdinalScore, } from "./generated/hermes";
2
+ export type { DocAddress, Document, SearchHit, SearchResponse, SearchTimings, IndexInfo, VectorFieldStats, SearchRequest, Query, TermQuery, MatchQuery, BooleanQuery, BoostQuery, AllQuery, SparseVectorQuery, DenseVectorQuery, Combiner, Reranker, Filter, } from "./types";
3
+ export { SearchServiceDefinition, IndexServiceDefinition, MultiValueCombiner, Query as PbQuery, TermQuery as PbTermQuery, BooleanQuery as PbBooleanQuery, BoostQuery as PbBoostQuery, AllQuery as PbAllQuery, MatchQuery as PbMatchQuery, SparseVectorQuery as PbSparseVectorQuery, DenseVectorQuery as PbDenseVectorQuery, Reranker as PbReranker, SearchRequest as PbSearchRequest, SearchResponse as PbSearchResponse, SearchHit as PbSearchHit, FieldValue, FieldEntry, SparseVector, DenseVector, GetDocumentRequest, DocAddress as PbDocAddress, GetDocumentResponse, GetIndexInfoRequest, GetIndexInfoResponse, CreateIndexRequest, CreateIndexResponse, IndexDocumentRequest, IndexDocumentsResponse, BatchIndexDocumentsRequest, BatchIndexDocumentsResponse, NamedDocument, CommitRequest, CommitResponse, ForceMergeRequest, ForceMergeResponse, DeleteIndexRequest, DeleteIndexResponse, ListIndexesRequest, ListIndexesResponse, MemoryStats, IndexingBufferStats, SegmentReaderStats, OrdinalScore, Filter as PbFilter, } from "./generated/hermes";
4
4
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EACL,QAAQ,EACR,SAAS,EACT,cAAc,EACd,SAAS,EACT,aAAa,EACb,SAAS,EACT,eAAe,EACf,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,WAAW,EACX,QAAQ,EACR,gBAAgB,GACjB,MAAM,SAAS,CAAC;AAEjB,OAAO,EACL,uBAAuB,EACvB,sBAAsB,EACtB,kBAAkB,EAClB,KAAK,EACL,SAAS,IAAI,WAAW,EACxB,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,UAAU,EACV,iBAAiB,EACjB,gBAAgB,EAChB,QAAQ,EACR,aAAa,EACb,cAAc,IAAI,gBAAgB,EAClC,SAAS,IAAI,WAAW,EACxB,UAAU,EACV,UAAU,EACV,YAAY,EACZ,WAAW,EACX,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,sBAAsB,EACtB,0BAA0B,EAC1B,2BAA2B,EAC3B,aAAa,EACb,aAAa,EACb,cAAc,EACd,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACnB,kBAAkB,EAClB,mBAAmB,EACnB,WAAW,EACX,mBAAmB,EACnB,kBAAkB,EAClB,YAAY,GACb,MAAM,oBAAoB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,YAAY,EACV,UAAU,EACV,QAAQ,EACR,SAAS,EACT,cAAc,EACd,aAAa,EACb,SAAS,EACT,gBAAgB,EAChB,aAAa,EACb,KAAK,EACL,SAAS,EACT,UAAU,EACV,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,iBAAiB,EACjB,gBAAgB,EAChB,QAAQ,EACR,QAAQ,EACR,MAAM,GACP,MAAM,SAAS,CAAC;AAEjB,OAAO,EACL,uBAAuB,EACvB,sBAAsB,EACtB,kBAAkB,EAClB,KAAK,IAAI,OAAO,EAChB,SAAS,IAAI,WAAW,EACxB,YAAY,IAAI,cAAc,EAC9B,UAAU,IAAI,YAAY,EAC1B,QAAQ,IAAI,UAAU,EACtB,UAAU,IAAI,YAAY,EAC1B,iBAAiB,IAAI,mBAAmB,EACxC,gBAAgB,IAAI,kBAAkB,EACtC,QAAQ,IAAI,UAAU,EACtB,aAAa,IAAI,eAAe,EAChC,cAAc,IAAI,gBAAgB,EAClC,SAAS,IAAI,WAAW,EACxB,UAAU,EACV,UAAU,EACV,YAAY,EACZ,WAAW,EACX,kBAAkB,EAClB,UAAU,IAAI,YAAY,EAC1B,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,sBAAsB,EACtB,0BAA0B,EAC1B,2BAA2B,EAC3B,aAAa,EACb,aAAa,EACb,cAAc,EACd,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACnB,kBAAkB,EAClB,mBAAmB,EACnB,WAAW,EACX,mBAAmB,EACnB,kBAAkB,EAClB,YAAY,EACZ,MAAM,IAAI,QAAQ,GACnB,MAAM,oBAAoB,CAAC"}
package/dist/index.js CHANGED
@@ -1,22 +1,22 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.OrdinalScore = exports.SegmentReaderStats = exports.IndexingBufferStats = exports.MemoryStats = exports.ListIndexesResponse = exports.ListIndexesRequest = exports.DeleteIndexResponse = exports.DeleteIndexRequest = exports.ForceMergeResponse = exports.ForceMergeRequest = exports.CommitResponse = exports.CommitRequest = exports.NamedDocument = exports.BatchIndexDocumentsResponse = exports.BatchIndexDocumentsRequest = exports.IndexDocumentsResponse = exports.IndexDocumentRequest = exports.CreateIndexResponse = exports.CreateIndexRequest = exports.GetIndexInfoResponse = exports.GetIndexInfoRequest = exports.GetDocumentResponse = exports.GetDocumentRequest = exports.DenseVector = exports.SparseVector = exports.FieldEntry = exports.FieldValue = exports.PbSearchHit = exports.PbSearchResponse = exports.SearchRequest = exports.Reranker = exports.DenseVectorQuery = exports.SparseVectorQuery = exports.MatchQuery = exports.AllQuery = exports.BoostQuery = exports.BooleanQuery = exports.PbTermQuery = exports.Query = exports.MultiValueCombiner = exports.IndexServiceDefinition = exports.SearchServiceDefinition = exports.HermesClient = void 0;
3
+ exports.PbFilter = exports.OrdinalScore = exports.SegmentReaderStats = exports.IndexingBufferStats = exports.MemoryStats = exports.ListIndexesResponse = exports.ListIndexesRequest = exports.DeleteIndexResponse = exports.DeleteIndexRequest = exports.ForceMergeResponse = exports.ForceMergeRequest = exports.CommitResponse = exports.CommitRequest = exports.NamedDocument = exports.BatchIndexDocumentsResponse = exports.BatchIndexDocumentsRequest = exports.IndexDocumentsResponse = exports.IndexDocumentRequest = exports.CreateIndexResponse = exports.CreateIndexRequest = exports.GetIndexInfoResponse = exports.GetIndexInfoRequest = exports.GetDocumentResponse = exports.PbDocAddress = exports.GetDocumentRequest = exports.DenseVector = exports.SparseVector = exports.FieldEntry = exports.FieldValue = exports.PbSearchHit = exports.PbSearchResponse = exports.PbSearchRequest = exports.PbReranker = exports.PbDenseVectorQuery = exports.PbSparseVectorQuery = exports.PbMatchQuery = exports.PbAllQuery = exports.PbBoostQuery = exports.PbBooleanQuery = exports.PbTermQuery = exports.PbQuery = exports.MultiValueCombiner = exports.IndexServiceDefinition = exports.SearchServiceDefinition = exports.HermesClient = void 0;
4
4
  var client_1 = require("./client");
5
5
  Object.defineProperty(exports, "HermesClient", { enumerable: true, get: function () { return client_1.HermesClient; } });
6
6
  var hermes_1 = require("./generated/hermes");
7
7
  Object.defineProperty(exports, "SearchServiceDefinition", { enumerable: true, get: function () { return hermes_1.SearchServiceDefinition; } });
8
8
  Object.defineProperty(exports, "IndexServiceDefinition", { enumerable: true, get: function () { return hermes_1.IndexServiceDefinition; } });
9
9
  Object.defineProperty(exports, "MultiValueCombiner", { enumerable: true, get: function () { return hermes_1.MultiValueCombiner; } });
10
- Object.defineProperty(exports, "Query", { enumerable: true, get: function () { return hermes_1.Query; } });
10
+ Object.defineProperty(exports, "PbQuery", { enumerable: true, get: function () { return hermes_1.Query; } });
11
11
  Object.defineProperty(exports, "PbTermQuery", { enumerable: true, get: function () { return hermes_1.TermQuery; } });
12
- Object.defineProperty(exports, "BooleanQuery", { enumerable: true, get: function () { return hermes_1.BooleanQuery; } });
13
- Object.defineProperty(exports, "BoostQuery", { enumerable: true, get: function () { return hermes_1.BoostQuery; } });
14
- Object.defineProperty(exports, "AllQuery", { enumerable: true, get: function () { return hermes_1.AllQuery; } });
15
- Object.defineProperty(exports, "MatchQuery", { enumerable: true, get: function () { return hermes_1.MatchQuery; } });
16
- Object.defineProperty(exports, "SparseVectorQuery", { enumerable: true, get: function () { return hermes_1.SparseVectorQuery; } });
17
- Object.defineProperty(exports, "DenseVectorQuery", { enumerable: true, get: function () { return hermes_1.DenseVectorQuery; } });
18
- Object.defineProperty(exports, "Reranker", { enumerable: true, get: function () { return hermes_1.Reranker; } });
19
- Object.defineProperty(exports, "SearchRequest", { enumerable: true, get: function () { return hermes_1.SearchRequest; } });
12
+ Object.defineProperty(exports, "PbBooleanQuery", { enumerable: true, get: function () { return hermes_1.BooleanQuery; } });
13
+ Object.defineProperty(exports, "PbBoostQuery", { enumerable: true, get: function () { return hermes_1.BoostQuery; } });
14
+ Object.defineProperty(exports, "PbAllQuery", { enumerable: true, get: function () { return hermes_1.AllQuery; } });
15
+ Object.defineProperty(exports, "PbMatchQuery", { enumerable: true, get: function () { return hermes_1.MatchQuery; } });
16
+ Object.defineProperty(exports, "PbSparseVectorQuery", { enumerable: true, get: function () { return hermes_1.SparseVectorQuery; } });
17
+ Object.defineProperty(exports, "PbDenseVectorQuery", { enumerable: true, get: function () { return hermes_1.DenseVectorQuery; } });
18
+ Object.defineProperty(exports, "PbReranker", { enumerable: true, get: function () { return hermes_1.Reranker; } });
19
+ Object.defineProperty(exports, "PbSearchRequest", { enumerable: true, get: function () { return hermes_1.SearchRequest; } });
20
20
  Object.defineProperty(exports, "PbSearchResponse", { enumerable: true, get: function () { return hermes_1.SearchResponse; } });
21
21
  Object.defineProperty(exports, "PbSearchHit", { enumerable: true, get: function () { return hermes_1.SearchHit; } });
22
22
  Object.defineProperty(exports, "FieldValue", { enumerable: true, get: function () { return hermes_1.FieldValue; } });
@@ -24,6 +24,7 @@ Object.defineProperty(exports, "FieldEntry", { enumerable: true, get: function (
24
24
  Object.defineProperty(exports, "SparseVector", { enumerable: true, get: function () { return hermes_1.SparseVector; } });
25
25
  Object.defineProperty(exports, "DenseVector", { enumerable: true, get: function () { return hermes_1.DenseVector; } });
26
26
  Object.defineProperty(exports, "GetDocumentRequest", { enumerable: true, get: function () { return hermes_1.GetDocumentRequest; } });
27
+ Object.defineProperty(exports, "PbDocAddress", { enumerable: true, get: function () { return hermes_1.DocAddress; } });
27
28
  Object.defineProperty(exports, "GetDocumentResponse", { enumerable: true, get: function () { return hermes_1.GetDocumentResponse; } });
28
29
  Object.defineProperty(exports, "GetIndexInfoRequest", { enumerable: true, get: function () { return hermes_1.GetIndexInfoRequest; } });
29
30
  Object.defineProperty(exports, "GetIndexInfoResponse", { enumerable: true, get: function () { return hermes_1.GetIndexInfoResponse; } });
@@ -46,4 +47,5 @@ Object.defineProperty(exports, "MemoryStats", { enumerable: true, get: function
46
47
  Object.defineProperty(exports, "IndexingBufferStats", { enumerable: true, get: function () { return hermes_1.IndexingBufferStats; } });
47
48
  Object.defineProperty(exports, "SegmentReaderStats", { enumerable: true, get: function () { return hermes_1.SegmentReaderStats; } });
48
49
  Object.defineProperty(exports, "OrdinalScore", { enumerable: true, get: function () { return hermes_1.OrdinalScore; } });
50
+ Object.defineProperty(exports, "PbFilter", { enumerable: true, get: function () { return hermes_1.Filter; } });
49
51
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,mCAAwC;AAA/B,sGAAA,YAAY,OAAA;AAiBrB,6CA2C4B;AA1C1B,iHAAA,uBAAuB,OAAA;AACvB,gHAAA,sBAAsB,OAAA;AACtB,4GAAA,kBAAkB,OAAA;AAClB,+FAAA,KAAK,OAAA;AACL,qGAAA,SAAS,OAAe;AACxB,sGAAA,YAAY,OAAA;AACZ,oGAAA,UAAU,OAAA;AACV,kGAAA,QAAQ,OAAA;AACR,oGAAA,UAAU,OAAA;AACV,2GAAA,iBAAiB,OAAA;AACjB,0GAAA,gBAAgB,OAAA;AAChB,kGAAA,QAAQ,OAAA;AACR,uGAAA,aAAa,OAAA;AACb,0GAAA,cAAc,OAAoB;AAClC,qGAAA,SAAS,OAAe;AACxB,oGAAA,UAAU,OAAA;AACV,oGAAA,UAAU,OAAA;AACV,sGAAA,YAAY,OAAA;AACZ,qGAAA,WAAW,OAAA;AACX,4GAAA,kBAAkB,OAAA;AAClB,6GAAA,mBAAmB,OAAA;AACnB,6GAAA,mBAAmB,OAAA;AACnB,8GAAA,oBAAoB,OAAA;AACpB,4GAAA,kBAAkB,OAAA;AAClB,6GAAA,mBAAmB,OAAA;AACnB,8GAAA,oBAAoB,OAAA;AACpB,gHAAA,sBAAsB,OAAA;AACtB,oHAAA,0BAA0B,OAAA;AAC1B,qHAAA,2BAA2B,OAAA;AAC3B,uGAAA,aAAa,OAAA;AACb,uGAAA,aAAa,OAAA;AACb,wGAAA,cAAc,OAAA;AACd,2GAAA,iBAAiB,OAAA;AACjB,4GAAA,kBAAkB,OAAA;AAClB,4GAAA,kBAAkB,OAAA;AAClB,6GAAA,mBAAmB,OAAA;AACnB,4GAAA,kBAAkB,OAAA;AAClB,6GAAA,mBAAmB,OAAA;AACnB,qGAAA,WAAW,OAAA;AACX,6GAAA,mBAAmB,OAAA;AACnB,4GAAA,kBAAkB,OAAA;AAClB,sGAAA,YAAY,OAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,mCAAwC;AAA/B,sGAAA,YAAY,OAAA;AAuBrB,6CA6C4B;AA5C1B,iHAAA,uBAAuB,OAAA;AACvB,gHAAA,sBAAsB,OAAA;AACtB,4GAAA,kBAAkB,OAAA;AAClB,iGAAA,KAAK,OAAW;AAChB,qGAAA,SAAS,OAAe;AACxB,wGAAA,YAAY,OAAkB;AAC9B,sGAAA,UAAU,OAAgB;AAC1B,oGAAA,QAAQ,OAAc;AACtB,sGAAA,UAAU,OAAgB;AAC1B,6GAAA,iBAAiB,OAAuB;AACxC,4GAAA,gBAAgB,OAAsB;AACtC,oGAAA,QAAQ,OAAc;AACtB,yGAAA,aAAa,OAAmB;AAChC,0GAAA,cAAc,OAAoB;AAClC,qGAAA,SAAS,OAAe;AACxB,oGAAA,UAAU,OAAA;AACV,oGAAA,UAAU,OAAA;AACV,sGAAA,YAAY,OAAA;AACZ,qGAAA,WAAW,OAAA;AACX,4GAAA,kBAAkB,OAAA;AAClB,sGAAA,UAAU,OAAgB;AAC1B,6GAAA,mBAAmB,OAAA;AACnB,6GAAA,mBAAmB,OAAA;AACnB,8GAAA,oBAAoB,OAAA;AACpB,4GAAA,kBAAkB,OAAA;AAClB,6GAAA,mBAAmB,OAAA;AACnB,8GAAA,oBAAoB,OAAA;AACpB,gHAAA,sBAAsB,OAAA;AACtB,oHAAA,0BAA0B,OAAA;AAC1B,qHAAA,2BAA2B,OAAA;AAC3B,uGAAA,aAAa,OAAA;AACb,uGAAA,aAAa,OAAA;AACb,wGAAA,cAAc,OAAA;AACd,2GAAA,iBAAiB,OAAA;AACjB,4GAAA,kBAAkB,OAAA;AAClB,4GAAA,kBAAkB,OAAA;AAClB,6GAAA,mBAAmB,OAAA;AACnB,4GAAA,kBAAkB,OAAA;AAClB,6GAAA,mBAAmB,OAAA;AACnB,qGAAA,WAAW,OAAA;AACX,6GAAA,mBAAmB,OAAA;AACnB,4GAAA,kBAAkB,OAAA;AAClB,sGAAA,YAAY,OAAA;AACZ,kGAAA,MAAM,OAAY"}
package/dist/types.d.ts CHANGED
@@ -2,9 +2,14 @@
2
2
  export interface Document {
3
3
  fields: Record<string, any>;
4
4
  }
5
+ /** Unique document address: segment + local doc_id. */
6
+ export interface DocAddress {
7
+ segmentId: string;
8
+ docId: number;
9
+ }
5
10
  /** A single search result. */
6
11
  export interface SearchHit {
7
- docId: number;
12
+ address: DocAddress;
8
13
  score: number;
9
14
  fields: Record<string, any>;
10
15
  }
@@ -22,48 +27,130 @@ export interface SearchResponse {
22
27
  tookMs: number;
23
28
  timings?: SearchTimings;
24
29
  }
30
+ /** Per-field vector statistics. */
31
+ export interface VectorFieldStats {
32
+ fieldName: string;
33
+ vectorType: string;
34
+ totalVectors: number;
35
+ dimension: number;
36
+ }
25
37
  /** Information about an index. */
26
38
  export interface IndexInfo {
27
39
  indexName: string;
28
40
  numDocs: number;
29
41
  numSegments: number;
30
42
  schema: string;
43
+ vectorStats: VectorFieldStats[];
44
+ }
45
+ export type Combiner = "log_sum_exp" | "max" | "avg" | "sum" | "weighted_top_k";
46
+ export interface TermQuery {
47
+ field: string;
48
+ term: string;
49
+ }
50
+ export interface MatchQuery {
51
+ field: string;
52
+ text: string;
53
+ }
54
+ export interface BooleanQuery {
55
+ must?: Query[];
56
+ should?: Query[];
57
+ mustNot?: Query[];
58
+ }
59
+ export interface BoostQuery {
60
+ query: Query;
61
+ boost: number;
62
+ }
63
+ export interface AllQuery {
31
64
  }
32
- /** Term query: (field, term) */
33
- export type TermQuery = [string, string];
34
- /** Boolean query with must/should/mustNot clauses */
35
- export interface BooleanQueryDef {
36
- must?: TermQuery[];
37
- should?: TermQuery[];
38
- mustNot?: TermQuery[];
39
- }
40
- /** Sparse vector query: (field, indices, values) */
41
- export type SparseVectorQueryDef = [string, number[], number[]];
42
- /** Sparse text query: (field, text) */
43
- export type SparseTextQueryDef = [string, string];
44
- /** Dense vector query: (field, vector) */
45
- export type DenseVectorQueryDef = [string, number[]];
46
- /** Reranker: (field, queryVector, l1Limit) */
47
- export type RerankerDef = [string, number[], number];
48
- /** Score combiner for multi-value fields */
49
- export type Combiner = "sum" | "max" | "avg";
50
- /** Reranker combiner */
51
- export type RerankerCombiner = "log_sum_exp" | "max" | "avg" | "sum" | "weighted_top_k";
52
- /** Search options */
53
- export interface SearchOptions {
54
- term?: TermQuery;
55
- boolean?: BooleanQueryDef;
56
- sparseVector?: SparseVectorQueryDef;
57
- sparseText?: SparseTextQueryDef;
58
- denseVector?: DenseVectorQueryDef;
65
+ export interface SparseVectorQuery {
66
+ field: string;
67
+ /** Pre-computed token indices */
68
+ indices?: number[];
69
+ /** Pre-computed token values */
70
+ values?: number[];
71
+ /** Raw text (tokenized server-side if tokenizer configured) */
72
+ text?: string;
73
+ combiner?: Combiner;
74
+ /** Approximate search factor (1.0 = exact, 0.8 = ~20% faster) */
75
+ heapFactor?: number;
76
+ /** Temperature for LogSumExp combiner (default: 1.5) */
77
+ combinerTemperature?: number;
78
+ /** K for WeightedTopK combiner (default: 5) */
79
+ combinerTopK?: number;
80
+ /** Decay for WeightedTopK combiner (default: 0.7) */
81
+ combinerDecay?: number;
82
+ /** Min abs(weight) for query dims (0 = no filtering) */
83
+ weightThreshold?: number;
84
+ /** Max query dimensions to process (0 = all) */
85
+ maxQueryDims?: number;
86
+ /** Fraction of query dims to keep (0-1, e.g. 0.1 = top 10%) */
87
+ pruning?: number;
88
+ }
89
+ export interface DenseVectorQuery {
90
+ field: string;
91
+ vector: number[];
92
+ /** Number of clusters to probe (for IVF indexes) */
59
93
  nprobe?: number;
94
+ /** Re-ranking factor (multiplied by k) */
60
95
  rerankFactor?: number;
61
- heapFactor?: number;
62
96
  combiner?: Combiner;
97
+ /** Temperature for LogSumExp combiner (default: 1.5) */
98
+ combinerTemperature?: number;
99
+ /** K for WeightedTopK combiner (default: 5) */
100
+ combinerTopK?: number;
101
+ /** Decay for WeightedTopK combiner (default: 0.7) */
102
+ combinerDecay?: number;
103
+ }
104
+ /** Discriminated union matching proto Query oneof. Exactly one key must be set. */
105
+ export type Query = {
106
+ term: TermQuery;
107
+ } | {
108
+ match: MatchQuery;
109
+ } | {
110
+ boolean: BooleanQuery;
111
+ } | {
112
+ sparseVector: SparseVectorQuery;
113
+ } | {
114
+ denseVector: DenseVectorQuery;
115
+ } | {
116
+ boost: BoostQuery;
117
+ } | {
118
+ all: AllQuery;
119
+ };
120
+ export interface Reranker {
121
+ field: string;
122
+ vector: number[];
123
+ /** L1 candidate count (0 = 10x final limit) */
124
+ limit?: number;
125
+ combiner?: Combiner;
126
+ combinerTemperature?: number;
127
+ combinerTopK?: number;
128
+ combinerDecay?: number;
129
+ /** Matryoshka pre-filter dims (0 = disabled) */
130
+ matryoshkaDims?: number;
131
+ }
132
+ export interface Filter {
133
+ field: string;
134
+ eqU64?: number;
135
+ eqI64?: number;
136
+ eqF64?: number;
137
+ eqText?: string;
138
+ range?: {
139
+ min?: number;
140
+ max?: number;
141
+ };
142
+ inValues?: {
143
+ textValues?: string[];
144
+ u64Values?: number[];
145
+ i64Values?: number[];
146
+ };
147
+ }
148
+ export interface SearchRequest {
149
+ query: Query;
63
150
  limit?: number;
64
151
  offset?: number;
65
152
  fieldsToLoad?: string[];
66
- reranker?: RerankerDef;
67
- rerankerCombiner?: RerankerCombiner;
153
+ reranker?: Reranker;
154
+ filters?: Filter[];
68
155
  }
69
156
  //# sourceMappingURL=types.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,oCAAoC;AACpC,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC7B;AAED,8BAA8B;AAC9B,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC7B;AAED,gFAAgF;AAChF,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,8CAA8C;AAC9C,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,SAAS,EAAE,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,aAAa,CAAC;CACzB;AAED,kCAAkC;AAClC,MAAM,WAAW,SAAS;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,gCAAgC;AAChC,MAAM,MAAM,SAAS,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAEzC,qDAAqD;AACrD,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,SAAS,EAAE,CAAC;IACnB,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC;IACrB,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC;CACvB;AAED,oDAAoD;AACpD,MAAM,MAAM,oBAAoB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;AAEhE,uCAAuC;AACvC,MAAM,MAAM,kBAAkB,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAElD,0CAA0C;AAC1C,MAAM,MAAM,mBAAmB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;AAErD,8CAA8C;AAC9C,MAAM,MAAM,WAAW,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,MAAM,CAAC,CAAC;AAErD,4CAA4C;AAC5C,MAAM,MAAM,QAAQ,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;AAE7C,wBAAwB;AACxB,MAAM,MAAM,gBAAgB,GACxB,aAAa,GACb,KAAK,GACL,KAAK,GACL,KAAK,GACL,gBAAgB,CAAC;AAErB,qBAAqB;AACrB,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B,YAAY,CAAC,EAAE,oBAAoB,CAAC;IACpC,UAAU,CAAC,EAAE,kBAAkB,CAAC;IAChC,WAAW,CAAC,EAAE,mBAAmB,CAAC;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,QAAQ,CAAC,EAAE,WAAW,CAAC;IACvB,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAIA,oCAAoC;AACpC,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC7B;AAED,uDAAuD;AACvD,MAAM,WAAW,UAAU;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,8BAA8B;AAC9B,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,UAAU,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC7B;AAED,gFAAgF;AAChF,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,8CAA8C;AAC9C,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,SAAS,EAAE,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,aAAa,CAAC;CACzB;AAED,mCAAmC;AACnC,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,kCAAkC;AAClC,MAAM,WAAW,SAAS;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,gBAAgB,EAAE,CAAC;CACjC;AAMD,MAAM,MAAM,QAAQ,GAAG,aAAa,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,gBAAgB,CAAC;AAMhF,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC;IACf,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC;IACjB,OAAO,CAAC,EAAE,KAAK,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,KAAK,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,QAAQ;CAAG;AAE5B,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,iCAAiC;IACjC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,gCAAgC;IAChC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,+DAA+D;IAC/D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,iEAAiE;IACjE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,wDAAwD;IACxD,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,+CAA+C;IAC/C,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,qDAAqD;IACrD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,wDAAwD;IACxD,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gDAAgD;IAChD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,+DAA+D;IAC/D,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,oDAAoD;IACpD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,0CAA0C;IAC1C,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,wDAAwD;IACxD,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,+CAA+C;IAC/C,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,qDAAqD;IACrD,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,mFAAmF;AACnF,MAAM,MAAM,KAAK,GACb;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GACnB;IAAE,KAAK,EAAE,UAAU,CAAA;CAAE,GACrB;IAAE,OAAO,EAAE,YAAY,CAAA;CAAE,GACzB;IAAE,YAAY,EAAE,iBAAiB,CAAA;CAAE,GACnC;IAAE,WAAW,EAAE,gBAAgB,CAAA;CAAE,GACjC;IAAE,KAAK,EAAE,UAAU,CAAA;CAAE,GACrB;IAAE,GAAG,EAAE,QAAQ,CAAA;CAAE,CAAC;AAMtB,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,+CAA+C;IAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,gDAAgD;IAChD,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAMD,MAAM,WAAW,MAAM;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACvC,QAAQ,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;CAClF;AAMD,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,KAAK,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB"}
package/dist/types.js CHANGED
@@ -1,3 +1,6 @@
1
1
  "use strict";
2
+ // =============================================================================
3
+ // Response types
4
+ // =============================================================================
2
5
  Object.defineProperty(exports, "__esModule", { value: true });
3
6
  //# sourceMappingURL=types.js.map
package/dist/types.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,iBAAiB;AACjB,gFAAgF"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "hermes-client-typescript",
3
- "version": "1.7.11",
3
+ "version": "1.7.15",
4
4
  "description": "TypeScript client for Hermes search server",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",