hermes-client-typescript 1.8.132 → 1.8.134

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.
@@ -6,7 +6,7 @@
6
6
  // source: hermes.proto
7
7
  Object.defineProperty(exports, "__esModule", { value: true });
8
8
  exports.GetDocumentRequest = exports.SearchTimings = exports.FusionCandidate = exports.FusionCandidateList = exports.QueryTrace = exports.ShardSearchTrace = exports.SearchTrace = exports.SearchResponse = exports.DenseVector = exports.SparseVector = exports.FieldValue = exports.OrdinalScore = exports.FieldValueList = exports.PassageScores_ScoresEntry = exports.PassageScores = exports.CandidateScores_DocumentEntry = exports.CandidateScores = exports.RrfContribution = exports.SearchHit_FieldsEntry = exports.SearchHit = exports.DocAddress = exports.TermDocFreq = exports.TextFieldStats = exports.TextStats = exports.GetTextStatsResponse = exports.GetTextStatsRequest = exports.SearchRequest = exports.Reranker = exports.PrefixQuery = exports.PhraseQuery = exports.MatchQuery = exports.RangeQuery = exports.AllQuery = exports.BoostQuery = exports.BooleanQuery = exports.TermQuery = exports.BinaryDenseVectorQuery = exports.DenseVectorQuery = exports.SparseVectorQuery = exports.ScoreExport = exports.L1Ranking_MissingValuesEntry = exports.L1Ranking = exports.FusionQuery = exports.WeightedQuery = exports.Query = exports.VectorIndexAlterState = exports.MultiValueCombiner = exports.ScoreScope = exports.FusionMethod = exports.protobufPackage = void 0;
9
- exports.IndexServiceDefinition = exports.SearchServiceDefinition = exports.ReorderResponse = exports.ReorderRequest = exports.AlterVectorIndexResponse = exports.AlterVectorIndexRequest = exports.RetrainVectorIndexResponse = exports.RetrainVectorIndexRequest = exports.ListIndexesResponse = exports.ListIndexesRequest = exports.DeleteIndexResponse = exports.DeleteIndexRequest = exports.ForceMergeResponse = exports.ForceMergeRequest = exports.CommitResponse = exports.CommitRequest = exports.IndexDocumentsResponse = exports.IndexDocumentRequest = exports.DocumentError = exports.BatchIndexDocumentsResponse = exports.BatchIndexDocumentsRequest = exports.NamedDocument = exports.FieldEntry = exports.CreateIndexResponse = exports.CreateIndexRequest = exports.SegmentReaderStats = exports.IndexingBufferStats = exports.MemoryStats = exports.VectorFieldStats = exports.TextFieldInfo = exports.GetIndexInfoResponse = exports.GetIndexInfoRequest = exports.GetDocumentResponse_FieldsEntry = exports.GetDocumentResponse = void 0;
9
+ exports.IndexServiceDefinition = exports.SearchServiceDefinition = exports.ReorderResponse = exports.ReorderRequest = exports.AlterVectorIndexResponse = exports.AlterVectorIndexRequest = exports.RetrainVectorIndexResponse = exports.RetrainVectorIndexRequest = exports.ListIndexesResponse = exports.ListIndexesRequest = exports.DeleteIndexResponse = exports.DeleteIndexRequest = exports.ForceMergeResponse = exports.ForceMergeRequest = exports.CommitResponse = exports.CommitRequest = exports.IndexDocumentsResponse = exports.IndexDocumentRequest = exports.DocumentError = exports.DocumentMutationResponse = exports.UpsertDocumentsRequest = exports.DeleteDocumentsRequest = exports.BatchIndexDocumentsResponse = exports.BatchIndexDocumentsRequest = exports.NamedDocument = exports.FieldEntry = exports.CreateIndexResponse = exports.CreateIndexRequest = exports.SegmentReaderStats = exports.IndexingBufferStats = exports.MemoryStats = exports.VectorFieldStats = exports.TextFieldInfo = exports.GetIndexInfoResponse = exports.GetIndexInfoRequest = exports.GetDocumentResponse_FieldsEntry = exports.GetDocumentResponse = void 0;
10
10
  exports.fusionMethodFromJSON = fusionMethodFromJSON;
11
11
  exports.fusionMethodToJSON = fusionMethodToJSON;
12
12
  exports.scoreScopeFromJSON = scoreScopeFromJSON;
@@ -5708,6 +5708,9 @@ function createBaseGetIndexInfoResponse() {
5708
5708
  textFields: [],
5709
5709
  candidateScoringVersion: 0,
5710
5710
  unpreparedCandidateFields: [],
5711
+ physicalNumDocs: 0,
5712
+ numDeletedDocs: 0,
5713
+ deletedRatio: 0,
5711
5714
  };
5712
5715
  }
5713
5716
  exports.GetIndexInfoResponse = {
@@ -5739,6 +5742,15 @@ exports.GetIndexInfoResponse = {
5739
5742
  for (const v of message.unpreparedCandidateFields) {
5740
5743
  writer.uint32(74).string(v);
5741
5744
  }
5745
+ if (message.physicalNumDocs !== 0) {
5746
+ writer.uint32(80).uint64(message.physicalNumDocs);
5747
+ }
5748
+ if (message.numDeletedDocs !== 0) {
5749
+ writer.uint32(88).uint64(message.numDeletedDocs);
5750
+ }
5751
+ if (message.deletedRatio !== 0) {
5752
+ writer.uint32(97).double(message.deletedRatio);
5753
+ }
5742
5754
  return writer;
5743
5755
  },
5744
5756
  decode(input, length) {
@@ -5811,6 +5823,27 @@ exports.GetIndexInfoResponse = {
5811
5823
  message.unpreparedCandidateFields.push(reader.string());
5812
5824
  continue;
5813
5825
  }
5826
+ case 10: {
5827
+ if (tag !== 80) {
5828
+ break;
5829
+ }
5830
+ message.physicalNumDocs = longToNumber(reader.uint64());
5831
+ continue;
5832
+ }
5833
+ case 11: {
5834
+ if (tag !== 88) {
5835
+ break;
5836
+ }
5837
+ message.numDeletedDocs = longToNumber(reader.uint64());
5838
+ continue;
5839
+ }
5840
+ case 12: {
5841
+ if (tag !== 97) {
5842
+ break;
5843
+ }
5844
+ message.deletedRatio = reader.double();
5845
+ continue;
5846
+ }
5814
5847
  }
5815
5848
  if ((tag & 7) === 4 || tag === 0) {
5816
5849
  break;
@@ -5862,6 +5895,21 @@ exports.GetIndexInfoResponse = {
5862
5895
  : globalThis.Array.isArray(object?.unprepared_candidate_fields)
5863
5896
  ? object.unprepared_candidate_fields.map((e) => globalThis.String(e))
5864
5897
  : [],
5898
+ physicalNumDocs: isSet(object.physicalNumDocs)
5899
+ ? globalThis.Number(object.physicalNumDocs)
5900
+ : isSet(object.physical_num_docs)
5901
+ ? globalThis.Number(object.physical_num_docs)
5902
+ : 0,
5903
+ numDeletedDocs: isSet(object.numDeletedDocs)
5904
+ ? globalThis.Number(object.numDeletedDocs)
5905
+ : isSet(object.num_deleted_docs)
5906
+ ? globalThis.Number(object.num_deleted_docs)
5907
+ : 0,
5908
+ deletedRatio: isSet(object.deletedRatio)
5909
+ ? globalThis.Number(object.deletedRatio)
5910
+ : isSet(object.deleted_ratio)
5911
+ ? globalThis.Number(object.deleted_ratio)
5912
+ : 0,
5865
5913
  };
5866
5914
  },
5867
5915
  toJSON(message) {
@@ -5893,6 +5941,15 @@ exports.GetIndexInfoResponse = {
5893
5941
  if (message.unpreparedCandidateFields?.length) {
5894
5942
  obj.unpreparedCandidateFields = message.unpreparedCandidateFields;
5895
5943
  }
5944
+ if (message.physicalNumDocs !== 0) {
5945
+ obj.physicalNumDocs = Math.round(message.physicalNumDocs);
5946
+ }
5947
+ if (message.numDeletedDocs !== 0) {
5948
+ obj.numDeletedDocs = Math.round(message.numDeletedDocs);
5949
+ }
5950
+ if (message.deletedRatio !== 0) {
5951
+ obj.deletedRatio = message.deletedRatio;
5952
+ }
5896
5953
  return obj;
5897
5954
  },
5898
5955
  create(base) {
@@ -5911,6 +5968,9 @@ exports.GetIndexInfoResponse = {
5911
5968
  message.textFields = object.textFields?.map((e) => exports.TextFieldInfo.fromPartial(e)) || [];
5912
5969
  message.candidateScoringVersion = object.candidateScoringVersion ?? 0;
5913
5970
  message.unpreparedCandidateFields = object.unpreparedCandidateFields?.map((e) => e) || [];
5971
+ message.physicalNumDocs = object.physicalNumDocs ?? 0;
5972
+ message.numDeletedDocs = object.numDeletedDocs ?? 0;
5973
+ message.deletedRatio = object.deletedRatio ?? 0;
5914
5974
  return message;
5915
5975
  },
5916
5976
  };
@@ -7043,6 +7103,228 @@ exports.BatchIndexDocumentsResponse = {
7043
7103
  return message;
7044
7104
  },
7045
7105
  };
7106
+ function createBaseDeleteDocumentsRequest() {
7107
+ return { indexName: "", primaryKeys: [] };
7108
+ }
7109
+ exports.DeleteDocumentsRequest = {
7110
+ encode(message, writer = new wire_1.BinaryWriter()) {
7111
+ if (message.indexName !== "") {
7112
+ writer.uint32(10).string(message.indexName);
7113
+ }
7114
+ for (const v of message.primaryKeys) {
7115
+ writer.uint32(18).string(v);
7116
+ }
7117
+ return writer;
7118
+ },
7119
+ decode(input, length) {
7120
+ const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
7121
+ const end = length === undefined ? reader.len : reader.pos + length;
7122
+ const message = createBaseDeleteDocumentsRequest();
7123
+ while (reader.pos < end) {
7124
+ const tag = reader.uint32();
7125
+ switch (tag >>> 3) {
7126
+ case 1: {
7127
+ if (tag !== 10) {
7128
+ break;
7129
+ }
7130
+ message.indexName = reader.string();
7131
+ continue;
7132
+ }
7133
+ case 2: {
7134
+ if (tag !== 18) {
7135
+ break;
7136
+ }
7137
+ message.primaryKeys.push(reader.string());
7138
+ continue;
7139
+ }
7140
+ }
7141
+ if ((tag & 7) === 4 || tag === 0) {
7142
+ break;
7143
+ }
7144
+ reader.skip(tag & 7);
7145
+ }
7146
+ return message;
7147
+ },
7148
+ fromJSON(object) {
7149
+ return {
7150
+ indexName: isSet(object.indexName)
7151
+ ? globalThis.String(object.indexName)
7152
+ : isSet(object.index_name)
7153
+ ? globalThis.String(object.index_name)
7154
+ : "",
7155
+ primaryKeys: globalThis.Array.isArray(object?.primaryKeys)
7156
+ ? object.primaryKeys.map((e) => globalThis.String(e))
7157
+ : globalThis.Array.isArray(object?.primary_keys)
7158
+ ? object.primary_keys.map((e) => globalThis.String(e))
7159
+ : [],
7160
+ };
7161
+ },
7162
+ toJSON(message) {
7163
+ const obj = {};
7164
+ if (message.indexName !== "") {
7165
+ obj.indexName = message.indexName;
7166
+ }
7167
+ if (message.primaryKeys?.length) {
7168
+ obj.primaryKeys = message.primaryKeys;
7169
+ }
7170
+ return obj;
7171
+ },
7172
+ create(base) {
7173
+ return exports.DeleteDocumentsRequest.fromPartial(base ?? {});
7174
+ },
7175
+ fromPartial(object) {
7176
+ const message = createBaseDeleteDocumentsRequest();
7177
+ message.indexName = object.indexName ?? "";
7178
+ message.primaryKeys = object.primaryKeys?.map((e) => e) || [];
7179
+ return message;
7180
+ },
7181
+ };
7182
+ function createBaseUpsertDocumentsRequest() {
7183
+ return { indexName: "", documents: [] };
7184
+ }
7185
+ exports.UpsertDocumentsRequest = {
7186
+ encode(message, writer = new wire_1.BinaryWriter()) {
7187
+ if (message.indexName !== "") {
7188
+ writer.uint32(10).string(message.indexName);
7189
+ }
7190
+ for (const v of message.documents) {
7191
+ exports.NamedDocument.encode(v, writer.uint32(18).fork()).join();
7192
+ }
7193
+ return writer;
7194
+ },
7195
+ decode(input, length) {
7196
+ const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
7197
+ const end = length === undefined ? reader.len : reader.pos + length;
7198
+ const message = createBaseUpsertDocumentsRequest();
7199
+ while (reader.pos < end) {
7200
+ const tag = reader.uint32();
7201
+ switch (tag >>> 3) {
7202
+ case 1: {
7203
+ if (tag !== 10) {
7204
+ break;
7205
+ }
7206
+ message.indexName = reader.string();
7207
+ continue;
7208
+ }
7209
+ case 2: {
7210
+ if (tag !== 18) {
7211
+ break;
7212
+ }
7213
+ message.documents.push(exports.NamedDocument.decode(reader, reader.uint32()));
7214
+ continue;
7215
+ }
7216
+ }
7217
+ if ((tag & 7) === 4 || tag === 0) {
7218
+ break;
7219
+ }
7220
+ reader.skip(tag & 7);
7221
+ }
7222
+ return message;
7223
+ },
7224
+ fromJSON(object) {
7225
+ return {
7226
+ indexName: isSet(object.indexName)
7227
+ ? globalThis.String(object.indexName)
7228
+ : isSet(object.index_name)
7229
+ ? globalThis.String(object.index_name)
7230
+ : "",
7231
+ documents: globalThis.Array.isArray(object?.documents)
7232
+ ? object.documents.map((e) => exports.NamedDocument.fromJSON(e))
7233
+ : [],
7234
+ };
7235
+ },
7236
+ toJSON(message) {
7237
+ const obj = {};
7238
+ if (message.indexName !== "") {
7239
+ obj.indexName = message.indexName;
7240
+ }
7241
+ if (message.documents?.length) {
7242
+ obj.documents = message.documents.map((e) => exports.NamedDocument.toJSON(e));
7243
+ }
7244
+ return obj;
7245
+ },
7246
+ create(base) {
7247
+ return exports.UpsertDocumentsRequest.fromPartial(base ?? {});
7248
+ },
7249
+ fromPartial(object) {
7250
+ const message = createBaseUpsertDocumentsRequest();
7251
+ message.indexName = object.indexName ?? "";
7252
+ message.documents = object.documents?.map((e) => exports.NamedDocument.fromPartial(e)) || [];
7253
+ return message;
7254
+ },
7255
+ };
7256
+ function createBaseDocumentMutationResponse() {
7257
+ return { acceptedCount: 0, errors: [] };
7258
+ }
7259
+ exports.DocumentMutationResponse = {
7260
+ encode(message, writer = new wire_1.BinaryWriter()) {
7261
+ if (message.acceptedCount !== 0) {
7262
+ writer.uint32(8).uint32(message.acceptedCount);
7263
+ }
7264
+ for (const v of message.errors) {
7265
+ exports.DocumentError.encode(v, writer.uint32(18).fork()).join();
7266
+ }
7267
+ return writer;
7268
+ },
7269
+ decode(input, length) {
7270
+ const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
7271
+ const end = length === undefined ? reader.len : reader.pos + length;
7272
+ const message = createBaseDocumentMutationResponse();
7273
+ while (reader.pos < end) {
7274
+ const tag = reader.uint32();
7275
+ switch (tag >>> 3) {
7276
+ case 1: {
7277
+ if (tag !== 8) {
7278
+ break;
7279
+ }
7280
+ message.acceptedCount = reader.uint32();
7281
+ continue;
7282
+ }
7283
+ case 2: {
7284
+ if (tag !== 18) {
7285
+ break;
7286
+ }
7287
+ message.errors.push(exports.DocumentError.decode(reader, reader.uint32()));
7288
+ continue;
7289
+ }
7290
+ }
7291
+ if ((tag & 7) === 4 || tag === 0) {
7292
+ break;
7293
+ }
7294
+ reader.skip(tag & 7);
7295
+ }
7296
+ return message;
7297
+ },
7298
+ fromJSON(object) {
7299
+ return {
7300
+ acceptedCount: isSet(object.acceptedCount)
7301
+ ? globalThis.Number(object.acceptedCount)
7302
+ : isSet(object.accepted_count)
7303
+ ? globalThis.Number(object.accepted_count)
7304
+ : 0,
7305
+ errors: globalThis.Array.isArray(object?.errors) ? object.errors.map((e) => exports.DocumentError.fromJSON(e)) : [],
7306
+ };
7307
+ },
7308
+ toJSON(message) {
7309
+ const obj = {};
7310
+ if (message.acceptedCount !== 0) {
7311
+ obj.acceptedCount = Math.round(message.acceptedCount);
7312
+ }
7313
+ if (message.errors?.length) {
7314
+ obj.errors = message.errors.map((e) => exports.DocumentError.toJSON(e));
7315
+ }
7316
+ return obj;
7317
+ },
7318
+ create(base) {
7319
+ return exports.DocumentMutationResponse.fromPartial(base ?? {});
7320
+ },
7321
+ fromPartial(object) {
7322
+ const message = createBaseDocumentMutationResponse();
7323
+ message.acceptedCount = object.acceptedCount ?? 0;
7324
+ message.errors = object.errors?.map((e) => exports.DocumentError.fromPartial(e)) || [];
7325
+ return message;
7326
+ },
7327
+ };
7046
7328
  function createBaseDocumentError() {
7047
7329
  return { index: 0, error: "" };
7048
7330
  }
@@ -7385,13 +7667,16 @@ exports.CommitResponse = {
7385
7667
  },
7386
7668
  };
7387
7669
  function createBaseForceMergeRequest() {
7388
- return { indexName: "" };
7670
+ return { indexName: "", compact: false };
7389
7671
  }
7390
7672
  exports.ForceMergeRequest = {
7391
7673
  encode(message, writer = new wire_1.BinaryWriter()) {
7392
7674
  if (message.indexName !== "") {
7393
7675
  writer.uint32(10).string(message.indexName);
7394
7676
  }
7677
+ if (message.compact !== false) {
7678
+ writer.uint32(16).bool(message.compact);
7679
+ }
7395
7680
  return writer;
7396
7681
  },
7397
7682
  decode(input, length) {
@@ -7408,6 +7693,13 @@ exports.ForceMergeRequest = {
7408
7693
  message.indexName = reader.string();
7409
7694
  continue;
7410
7695
  }
7696
+ case 2: {
7697
+ if (tag !== 16) {
7698
+ break;
7699
+ }
7700
+ message.compact = reader.bool();
7701
+ continue;
7702
+ }
7411
7703
  }
7412
7704
  if ((tag & 7) === 4 || tag === 0) {
7413
7705
  break;
@@ -7423,6 +7715,7 @@ exports.ForceMergeRequest = {
7423
7715
  : isSet(object.index_name)
7424
7716
  ? globalThis.String(object.index_name)
7425
7717
  : "",
7718
+ compact: isSet(object.compact) ? globalThis.Boolean(object.compact) : false,
7426
7719
  };
7427
7720
  },
7428
7721
  toJSON(message) {
@@ -7430,6 +7723,9 @@ exports.ForceMergeRequest = {
7430
7723
  if (message.indexName !== "") {
7431
7724
  obj.indexName = message.indexName;
7432
7725
  }
7726
+ if (message.compact !== false) {
7727
+ obj.compact = message.compact;
7728
+ }
7433
7729
  return obj;
7434
7730
  },
7435
7731
  create(base) {
@@ -7438,6 +7734,7 @@ exports.ForceMergeRequest = {
7438
7734
  fromPartial(object) {
7439
7735
  const message = createBaseForceMergeRequest();
7440
7736
  message.indexName = object.indexName ?? "";
7737
+ message.compact = object.compact ?? false;
7441
7738
  return message;
7442
7739
  },
7443
7740
  };
@@ -8198,6 +8495,24 @@ exports.IndexServiceDefinition = {
8198
8495
  responseStream: false,
8199
8496
  options: {},
8200
8497
  },
8498
+ /** Stage whole-document deletions by exact primary key, including every chunk. */
8499
+ deleteDocuments: {
8500
+ name: "DeleteDocuments",
8501
+ requestType: exports.DeleteDocumentsRequest,
8502
+ requestStream: false,
8503
+ responseType: exports.DocumentMutationResponse,
8504
+ responseStream: false,
8505
+ options: {},
8506
+ },
8507
+ /** Stage complete replacements (inserts if absent). Commit publishes them. */
8508
+ upsertDocuments: {
8509
+ name: "UpsertDocuments",
8510
+ requestType: exports.UpsertDocumentsRequest,
8511
+ requestStream: false,
8512
+ responseType: exports.DocumentMutationResponse,
8513
+ responseStream: false,
8514
+ options: {},
8515
+ },
8201
8516
  /** Commit pending changes */
8202
8517
  commit: {
8203
8518
  name: "Commit",