@google-cloud/vectorsearch 0.3.0 → 0.4.0

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.
@@ -269,21 +269,7 @@
269
269
  },
270
270
  "nested": {
271
271
  "IndexHint": {
272
- "oneofs": {
273
- "params": {
274
- "oneof": [
275
- "denseScannParams"
276
- ]
277
- }
278
- },
279
272
  "fields": {
280
- "denseScannParams": {
281
- "type": "DenseScannParams",
282
- "id": 2,
283
- "options": {
284
- "(google.api.field_behavior)": "OPTIONAL"
285
- }
286
- },
287
273
  "name": {
288
274
  "type": "string",
289
275
  "id": 1,
@@ -292,26 +278,6 @@
292
278
  "(google.api.resource_reference).type": "vectorsearch.googleapis.com/Index"
293
279
  }
294
280
  }
295
- },
296
- "nested": {
297
- "DenseScannParams": {
298
- "fields": {
299
- "searchLeavesPct": {
300
- "type": "int32",
301
- "id": 1,
302
- "options": {
303
- "(google.api.field_behavior)": "OPTIONAL"
304
- }
305
- },
306
- "initialCandidateCount": {
307
- "type": "int32",
308
- "id": 2,
309
- "options": {
310
- "(google.api.field_behavior)": "OPTIONAL"
311
- }
312
- }
313
- }
314
- }
315
281
  }
316
282
  },
317
283
  "KnnHint": {
@@ -771,8 +737,7 @@
771
737
  "oneofs": {
772
738
  "ranker": {
773
739
  "oneof": [
774
- "rrf",
775
- "vertex"
740
+ "rrf"
776
741
  ]
777
742
  }
778
743
  },
@@ -780,10 +745,6 @@
780
745
  "rrf": {
781
746
  "type": "ReciprocalRankFusion",
782
747
  "id": 1
783
- },
784
- "vertex": {
785
- "type": "VertexRanker",
786
- "id": 2
787
748
  }
788
749
  }
789
750
  },
@@ -799,38 +760,6 @@
799
760
  }
800
761
  }
801
762
  },
802
- "VertexRanker": {
803
- "fields": {
804
- "query": {
805
- "type": "string",
806
- "id": 1,
807
- "options": {
808
- "(google.api.field_behavior)": "REQUIRED"
809
- }
810
- },
811
- "titleTemplate": {
812
- "type": "string",
813
- "id": 2,
814
- "options": {
815
- "(google.api.field_behavior)": "OPTIONAL"
816
- }
817
- },
818
- "contentTemplate": {
819
- "type": "string",
820
- "id": 3,
821
- "options": {
822
- "(google.api.field_behavior)": "OPTIONAL"
823
- }
824
- },
825
- "model": {
826
- "type": "string",
827
- "id": 4,
828
- "options": {
829
- "(google.api.field_behavior)": "REQUIRED"
830
- }
831
- }
832
- }
833
- },
834
763
  "BatchSearchDataObjectsResponse": {
835
764
  "fields": {
836
765
  "results": {
@@ -2118,10 +2047,13 @@
2118
2047
  },
2119
2048
  "v1beta": {
2120
2049
  "options": {
2050
+ "csharp_namespace": "Google.Cloud.VectorSearch.V1Beta",
2121
2051
  "go_package": "cloud.google.com/go/vectorsearch/apiv1beta/vectorsearchpb;vectorsearchpb",
2122
2052
  "java_multiple_files": true,
2123
2053
  "java_outer_classname": "VectorSearchServiceProto",
2124
- "java_package": "com.google.cloud.vectorsearch.v1beta"
2054
+ "java_package": "com.google.cloud.vectorsearch.v1beta",
2055
+ "php_namespace": "Google\\Cloud\\VectorSearch\\V1beta",
2056
+ "ruby_package": "Google::Cloud::VectorSearch::V1beta"
2125
2057
  },
2126
2058
  "nested": {
2127
2059
  "DistanceMetric": {
@@ -2150,7 +2082,6 @@
2150
2082
  "type": "string",
2151
2083
  "id": 2,
2152
2084
  "options": {
2153
- "deprecated": true,
2154
2085
  "(google.api.field_behavior)": "OUTPUT_ONLY"
2155
2086
  }
2156
2087
  },
@@ -2182,6 +2113,13 @@
2182
2113
  "options": {
2183
2114
  "(google.api.field_behavior)": "OPTIONAL"
2184
2115
  }
2116
+ },
2117
+ "etag": {
2118
+ "type": "string",
2119
+ "id": 8,
2120
+ "options": {
2121
+ "(google.api.field_behavior)": "OPTIONAL"
2122
+ }
2185
2123
  }
2186
2124
  }
2187
2125
  },
@@ -2356,7 +2294,9 @@
2356
2294
  "indexType": {
2357
2295
  "oneof": [
2358
2296
  "useIndex",
2359
- "useKnn"
2297
+ "useKnn",
2298
+ "knnHint",
2299
+ "indexHint"
2360
2300
  ]
2361
2301
  }
2362
2302
  },
@@ -2365,12 +2305,28 @@
2365
2305
  "type": "IndexHint",
2366
2306
  "id": 1,
2367
2307
  "options": {
2308
+ "deprecated": true,
2368
2309
  "(google.api.field_behavior)": "OPTIONAL"
2369
2310
  }
2370
2311
  },
2371
2312
  "useKnn": {
2372
2313
  "type": "bool",
2373
2314
  "id": 2,
2315
+ "options": {
2316
+ "deprecated": true,
2317
+ "(google.api.field_behavior)": "OPTIONAL"
2318
+ }
2319
+ },
2320
+ "knnHint": {
2321
+ "type": "KnnHint",
2322
+ "id": 3,
2323
+ "options": {
2324
+ "(google.api.field_behavior)": "OPTIONAL"
2325
+ }
2326
+ },
2327
+ "indexHint": {
2328
+ "type": "IndexHint",
2329
+ "id": 4,
2374
2330
  "options": {
2375
2331
  "(google.api.field_behavior)": "OPTIONAL"
2376
2332
  }
@@ -2378,15 +2334,53 @@
2378
2334
  },
2379
2335
  "nested": {
2380
2336
  "IndexHint": {
2337
+ "oneofs": {
2338
+ "params": {
2339
+ "oneof": [
2340
+ "denseScannParams"
2341
+ ]
2342
+ }
2343
+ },
2381
2344
  "fields": {
2345
+ "denseScannParams": {
2346
+ "type": "DenseScannParams",
2347
+ "id": 2,
2348
+ "options": {
2349
+ "(google.api.field_behavior)": "OPTIONAL"
2350
+ }
2351
+ },
2382
2352
  "name": {
2383
2353
  "type": "string",
2384
2354
  "id": 1,
2385
2355
  "options": {
2386
- "(google.api.field_behavior)": "REQUIRED"
2356
+ "(google.api.field_behavior)": "REQUIRED",
2357
+ "(google.api.resource_reference).type": "vectorsearch.googleapis.com/Index"
2358
+ }
2359
+ }
2360
+ },
2361
+ "nested": {
2362
+ "DenseScannParams": {
2363
+ "fields": {
2364
+ "searchLeavesPct": {
2365
+ "type": "int32",
2366
+ "id": 1,
2367
+ "options": {
2368
+ "(google.api.field_behavior)": "OPTIONAL"
2369
+ }
2370
+ },
2371
+ "initialCandidateCount": {
2372
+ "type": "int32",
2373
+ "id": 2,
2374
+ "options": {
2375
+ "(google.api.field_behavior)": "OPTIONAL"
2376
+ }
2377
+ }
2387
2378
  }
2388
2379
  }
2389
2380
  }
2381
+ },
2382
+ "KnnHint": {
2383
+ "fields": {}
2390
2384
  }
2391
2385
  }
2392
2386
  },
@@ -2475,7 +2469,7 @@
2475
2469
  }
2476
2470
  },
2477
2471
  "distanceMetric": {
2478
- "type": "google.cloud.vectorsearch.v1beta.DistanceMetric",
2472
+ "type": "DistanceMetric",
2479
2473
  "id": 11,
2480
2474
  "options": {
2481
2475
  "(google.api.field_behavior)": "OPTIONAL"
@@ -2510,7 +2504,7 @@
2510
2504
  "type": "EmbeddingTaskType",
2511
2505
  "id": 5,
2512
2506
  "options": {
2513
- "(google.api.field_behavior)": "OPTIONAL"
2507
+ "(google.api.field_behavior)": "REQUIRED"
2514
2508
  }
2515
2509
  },
2516
2510
  "outputFields": {
@@ -2697,7 +2691,8 @@
2697
2691
  "type": "string",
2698
2692
  "id": 1,
2699
2693
  "options": {
2700
- "(google.api.field_behavior)": "OUTPUT_ONLY"
2694
+ "(google.api.field_behavior)": "OUTPUT_ONLY",
2695
+ "(google.api.resource_reference).type": "vectorsearch.googleapis.com/Index"
2701
2696
  }
2702
2697
  }
2703
2698
  }
@@ -2761,7 +2756,10 @@
2761
2756
  "aggregateResults": {
2762
2757
  "rule": "repeated",
2763
2758
  "type": "google.protobuf.Struct",
2764
- "id": 1
2759
+ "id": 1,
2760
+ "options": {
2761
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
2762
+ }
2765
2763
  }
2766
2764
  }
2767
2765
  },
@@ -2810,11 +2808,17 @@
2810
2808
  "dataObjects": {
2811
2809
  "rule": "repeated",
2812
2810
  "type": "DataObject",
2813
- "id": 4
2811
+ "id": 4,
2812
+ "options": {
2813
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
2814
+ }
2814
2815
  },
2815
2816
  "nextPageToken": {
2816
2817
  "type": "string",
2817
- "id": 3
2818
+ "id": 3,
2819
+ "options": {
2820
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
2821
+ }
2818
2822
  }
2819
2823
  }
2820
2824
  },
@@ -2876,8 +2880,7 @@
2876
2880
  "oneofs": {
2877
2881
  "ranker": {
2878
2882
  "oneof": [
2879
- "rrf",
2880
- "vertex"
2883
+ "rrf"
2881
2884
  ]
2882
2885
  }
2883
2886
  },
@@ -2885,10 +2888,6 @@
2885
2888
  "rrf": {
2886
2889
  "type": "ReciprocalRankFusion",
2887
2890
  "id": 1
2888
- },
2889
- "vertex": {
2890
- "type": "VertexRanker",
2891
- "id": 2
2892
2891
  }
2893
2892
  }
2894
2893
  },
@@ -2904,38 +2903,6 @@
2904
2903
  }
2905
2904
  }
2906
2905
  },
2907
- "VertexRanker": {
2908
- "fields": {
2909
- "query": {
2910
- "type": "string",
2911
- "id": 1,
2912
- "options": {
2913
- "(google.api.field_behavior)": "REQUIRED"
2914
- }
2915
- },
2916
- "titleTemplate": {
2917
- "type": "string",
2918
- "id": 2,
2919
- "options": {
2920
- "(google.api.field_behavior)": "OPTIONAL"
2921
- }
2922
- },
2923
- "contentTemplate": {
2924
- "type": "string",
2925
- "id": 3,
2926
- "options": {
2927
- "(google.api.field_behavior)": "OPTIONAL"
2928
- }
2929
- },
2930
- "model": {
2931
- "type": "string",
2932
- "id": 4,
2933
- "options": {
2934
- "(google.api.field_behavior)": "REQUIRED"
2935
- }
2936
- }
2937
- }
2938
- },
2939
2906
  "BatchSearchDataObjectsResponse": {
2940
2907
  "fields": {
2941
2908
  "results": {
@@ -3177,7 +3144,10 @@
3177
3144
  "dataObjects": {
3178
3145
  "rule": "repeated",
3179
3146
  "type": "DataObject",
3180
- "id": 1
3147
+ "id": 1,
3148
+ "options": {
3149
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
3150
+ }
3181
3151
  }
3182
3152
  }
3183
3153
  },
@@ -3243,6 +3213,13 @@
3243
3213
  "(google.api.field_behavior)": "REQUIRED",
3244
3214
  "(google.api.resource_reference).type": "vectorsearch.googleapis.com/DataObject"
3245
3215
  }
3216
+ },
3217
+ "etag": {
3218
+ "type": "string",
3219
+ "id": 2,
3220
+ "options": {
3221
+ "(google.api.field_behavior)": "OPTIONAL"
3222
+ }
3246
3223
  }
3247
3224
  }
3248
3225
  },
@@ -3804,7 +3781,33 @@
3804
3781
  "(google.api.resource).plural": "indexes",
3805
3782
  "(google.api.resource).singular": "index"
3806
3783
  },
3784
+ "oneofs": {
3785
+ "infraType": {
3786
+ "oneof": [
3787
+ "dedicatedInfrastructure"
3788
+ ]
3789
+ },
3790
+ "indexType": {
3791
+ "oneof": [
3792
+ "denseScann"
3793
+ ]
3794
+ }
3795
+ },
3807
3796
  "fields": {
3797
+ "dedicatedInfrastructure": {
3798
+ "type": "DedicatedInfrastructure",
3799
+ "id": 11,
3800
+ "options": {
3801
+ "(google.api.field_behavior)": "OPTIONAL"
3802
+ }
3803
+ },
3804
+ "denseScann": {
3805
+ "type": "DenseScannIndex",
3806
+ "id": 12,
3807
+ "options": {
3808
+ "(google.api.field_behavior)": "OPTIONAL"
3809
+ }
3810
+ },
3808
3811
  "name": {
3809
3812
  "type": "string",
3810
3813
  "id": 1,
@@ -3849,7 +3852,7 @@
3849
3852
  }
3850
3853
  },
3851
3854
  "distanceMetric": {
3852
- "type": "google.cloud.vectorsearch.v1beta.DistanceMetric",
3855
+ "type": "DistanceMetric",
3853
3856
  "id": 4,
3854
3857
  "options": {
3855
3858
  "(google.api.field_behavior)": "OPTIONAL"
@@ -4106,19 +4109,31 @@
4106
4109
  "fields": {
4107
4110
  "createTime": {
4108
4111
  "type": "google.protobuf.Timestamp",
4109
- "id": 1
4112
+ "id": 1,
4113
+ "options": {
4114
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
4115
+ }
4110
4116
  },
4111
4117
  "updateTime": {
4112
4118
  "type": "google.protobuf.Timestamp",
4113
- "id": 2
4119
+ "id": 2,
4120
+ "options": {
4121
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
4122
+ }
4114
4123
  },
4115
4124
  "successCount": {
4116
4125
  "type": "int64",
4117
- "id": 3
4126
+ "id": 3,
4127
+ "options": {
4128
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
4129
+ }
4118
4130
  },
4119
4131
  "failureCount": {
4120
4132
  "type": "int64",
4121
- "id": 4
4133
+ "id": 4,
4134
+ "options": {
4135
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
4136
+ }
4122
4137
  }
4123
4138
  }
4124
4139
  },
@@ -4185,16 +4200,95 @@
4185
4200
  "fields": {
4186
4201
  "createTime": {
4187
4202
  "type": "google.protobuf.Timestamp",
4188
- "id": 1
4203
+ "id": 1,
4204
+ "options": {
4205
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
4206
+ }
4189
4207
  },
4190
4208
  "finishTime": {
4191
4209
  "type": "google.protobuf.Timestamp",
4192
- "id": 2
4210
+ "id": 2,
4211
+ "options": {
4212
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
4213
+ }
4193
4214
  }
4194
4215
  }
4195
4216
  },
4196
4217
  "ExportDataObjectsResponse": {
4197
4218
  "fields": {}
4219
+ },
4220
+ "DedicatedInfrastructure": {
4221
+ "oneofs": {
4222
+ "_mode": {
4223
+ "oneof": [
4224
+ "mode"
4225
+ ]
4226
+ }
4227
+ },
4228
+ "fields": {
4229
+ "mode": {
4230
+ "type": "Mode",
4231
+ "id": 1,
4232
+ "options": {
4233
+ "(google.api.field_behavior)": "OPTIONAL",
4234
+ "proto3_optional": true
4235
+ }
4236
+ },
4237
+ "autoscalingSpec": {
4238
+ "type": "AutoscalingSpec",
4239
+ "id": 2,
4240
+ "options": {
4241
+ "(google.api.field_behavior)": "OPTIONAL"
4242
+ }
4243
+ }
4244
+ },
4245
+ "nested": {
4246
+ "AutoscalingSpec": {
4247
+ "fields": {
4248
+ "minReplicaCount": {
4249
+ "type": "int32",
4250
+ "id": 1,
4251
+ "options": {
4252
+ "(google.api.field_behavior)": "OPTIONAL"
4253
+ }
4254
+ },
4255
+ "maxReplicaCount": {
4256
+ "type": "int32",
4257
+ "id": 2,
4258
+ "options": {
4259
+ "(google.api.field_behavior)": "OPTIONAL"
4260
+ }
4261
+ }
4262
+ }
4263
+ },
4264
+ "Mode": {
4265
+ "values": {
4266
+ "MODE_UNSPECIFIED": 0,
4267
+ "STORAGE_OPTIMIZED": 1,
4268
+ "PERFORMANCE_OPTIMIZED": 2
4269
+ }
4270
+ }
4271
+ }
4272
+ },
4273
+ "DenseScannIndex": {
4274
+ "fields": {
4275
+ "featureNormType": {
4276
+ "type": "FeatureNormType",
4277
+ "id": 2,
4278
+ "options": {
4279
+ "(google.api.field_behavior)": "OPTIONAL"
4280
+ }
4281
+ }
4282
+ },
4283
+ "nested": {
4284
+ "FeatureNormType": {
4285
+ "values": {
4286
+ "FEATURE_NORM_TYPE_UNSPECIFIED": 0,
4287
+ "NONE": 1,
4288
+ "UNIT_L2_NORM": 2
4289
+ }
4290
+ }
4291
+ }
4198
4292
  }
4199
4293
  }
4200
4294
  }
@@ -188,7 +188,9 @@ export declare class DataObjectSearchServiceClient {
188
188
  * Required. The resource name of the Collection for which to search.
189
189
  * Format: `projects/{project}/locations/{location}/collections/{collection}`
190
190
  * @param {number} [request.pageSize]
191
- * Optional. The standard list page size.
191
+ * Optional. The standard list page size. Only supported for KNN. If not set,
192
+ * up to search_type.top_k results will be returned. The maximum value is
193
+ * 1000; values above 1000 will be coerced to 1000.
192
194
  * @param {string} [request.pageToken]
193
195
  * Optional. The standard list page token.
194
196
  * Typically obtained via
@@ -229,7 +231,9 @@ export declare class DataObjectSearchServiceClient {
229
231
  * Required. The resource name of the Collection for which to search.
230
232
  * Format: `projects/{project}/locations/{location}/collections/{collection}`
231
233
  * @param {number} [request.pageSize]
232
- * Optional. The standard list page size.
234
+ * Optional. The standard list page size. Only supported for KNN. If not set,
235
+ * up to search_type.top_k results will be returned. The maximum value is
236
+ * 1000; values above 1000 will be coerced to 1000.
233
237
  * @param {string} [request.pageToken]
234
238
  * Optional. The standard list page token.
235
239
  * Typically obtained via
@@ -265,7 +269,9 @@ export declare class DataObjectSearchServiceClient {
265
269
  * Required. The resource name of the Collection for which to search.
266
270
  * Format: `projects/{project}/locations/{location}/collections/{collection}`
267
271
  * @param {number} [request.pageSize]
268
- * Optional. The standard list page size.
272
+ * Optional. The standard list page size. Only supported for KNN. If not set,
273
+ * up to search_type.top_k results will be returned. The maximum value is
274
+ * 1000; values above 1000 will be coerced to 1000.
269
275
  * @param {string} [request.pageToken]
270
276
  * Optional. The standard list page token.
271
277
  * Typically obtained via
@@ -300,7 +306,8 @@ export declare class DataObjectSearchServiceClient {
300
306
  * @param {google.cloud.vectorsearch.v1beta.OutputFields} [request.outputFields]
301
307
  * Optional. Mask specifying which fields to return.
302
308
  * @param {number} [request.pageSize]
303
- * Optional. The standard list page size.
309
+ * Optional. The standard list page size. Default is 100.
310
+ * The maximum value is 1000; values above 1000 will be coerced to 1000.
304
311
  * @param {string} [request.pageToken]
305
312
  * Optional. The standard list page token.
306
313
  * Typically obtained via
@@ -340,7 +347,8 @@ export declare class DataObjectSearchServiceClient {
340
347
  * @param {google.cloud.vectorsearch.v1beta.OutputFields} [request.outputFields]
341
348
  * Optional. Mask specifying which fields to return.
342
349
  * @param {number} [request.pageSize]
343
- * Optional. The standard list page size.
350
+ * Optional. The standard list page size. Default is 100.
351
+ * The maximum value is 1000; values above 1000 will be coerced to 1000.
344
352
  * @param {string} [request.pageToken]
345
353
  * Optional. The standard list page token.
346
354
  * Typically obtained via
@@ -375,7 +383,8 @@ export declare class DataObjectSearchServiceClient {
375
383
  * @param {google.cloud.vectorsearch.v1beta.OutputFields} [request.outputFields]
376
384
  * Optional. Mask specifying which fields to return.
377
385
  * @param {number} [request.pageSize]
378
- * Optional. The standard list page size.
386
+ * Optional. The standard list page size. Default is 100.
387
+ * The maximum value is 1000; values above 1000 will be coerced to 1000.
379
388
  * @param {string} [request.pageToken]
380
389
  * Optional. The standard list page token.
381
390
  * Typically obtained via
@@ -401,7 +401,9 @@ class DataObjectSearchServiceClient {
401
401
  * Required. The resource name of the Collection for which to search.
402
402
  * Format: `projects/{project}/locations/{location}/collections/{collection}`
403
403
  * @param {number} [request.pageSize]
404
- * Optional. The standard list page size.
404
+ * Optional. The standard list page size. Only supported for KNN. If not set,
405
+ * up to search_type.top_k results will be returned. The maximum value is
406
+ * 1000; values above 1000 will be coerced to 1000.
405
407
  * @param {string} [request.pageToken]
406
408
  * Optional. The standard list page token.
407
409
  * Typically obtained via
@@ -450,7 +452,9 @@ class DataObjectSearchServiceClient {
450
452
  * Required. The resource name of the Collection for which to search.
451
453
  * Format: `projects/{project}/locations/{location}/collections/{collection}`
452
454
  * @param {number} [request.pageSize]
453
- * Optional. The standard list page size.
455
+ * Optional. The standard list page size. Only supported for KNN. If not set,
456
+ * up to search_type.top_k results will be returned. The maximum value is
457
+ * 1000; values above 1000 will be coerced to 1000.
454
458
  * @param {string} [request.pageToken]
455
459
  * Optional. The standard list page token.
456
460
  * Typically obtained via
@@ -528,7 +532,8 @@ class DataObjectSearchServiceClient {
528
532
  * @param {google.cloud.vectorsearch.v1beta.OutputFields} [request.outputFields]
529
533
  * Optional. Mask specifying which fields to return.
530
534
  * @param {number} [request.pageSize]
531
- * Optional. The standard list page size.
535
+ * Optional. The standard list page size. Default is 100.
536
+ * The maximum value is 1000; values above 1000 will be coerced to 1000.
532
537
  * @param {string} [request.pageToken]
533
538
  * Optional. The standard list page token.
534
539
  * Typically obtained via
@@ -576,7 +581,8 @@ class DataObjectSearchServiceClient {
576
581
  * @param {google.cloud.vectorsearch.v1beta.OutputFields} [request.outputFields]
577
582
  * Optional. Mask specifying which fields to return.
578
583
  * @param {number} [request.pageSize]
579
- * Optional. The standard list page size.
584
+ * Optional. The standard list page size. Default is 100.
585
+ * The maximum value is 1000; values above 1000 will be coerced to 1000.
580
586
  * @param {string} [request.pageToken]
581
587
  * Optional. The standard list page token.
582
588
  * Typically obtained via