@google-cloud/vectorsearch 0.3.0 → 0.5.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.
Files changed (23) hide show
  1. package/README.md +1 -0
  2. package/build/protos/google/cloud/vectorsearch/v1/data_object_search_service.proto +0 -40
  3. package/build/protos/google/cloud/vectorsearch/v1/vectorsearch_service.proto +72 -3
  4. package/build/protos/google/cloud/vectorsearch/v1beta/common.proto +4 -1
  5. package/build/protos/google/cloud/vectorsearch/v1beta/data_object.proto +8 -3
  6. package/build/protos/google/cloud/vectorsearch/v1beta/data_object_search_service.proto +71 -40
  7. package/build/protos/google/cloud/vectorsearch/v1beta/data_object_service.proto +11 -2
  8. package/build/protos/google/cloud/vectorsearch/v1beta/embedding_config.proto +3 -0
  9. package/build/protos/google/cloud/vectorsearch/v1beta/vectorsearch_service.proto +85 -15
  10. package/build/protos/protos.d.ts +3059 -2409
  11. package/build/protos/protos.js +9804 -8313
  12. package/build/protos/protos.json +318 -128
  13. package/build/src/v1/gapic_metadata.json +10 -0
  14. package/build/src/v1/vector_search_service_client.d.ts +41 -0
  15. package/build/src/v1/vector_search_service_client.js +53 -2
  16. package/build/src/v1/vector_search_service_client.js.map +1 -1
  17. package/build/src/v1/vector_search_service_client_config.json +4 -0
  18. package/build/src/v1beta/data_object_search_service_client.d.ts +15 -6
  19. package/build/src/v1beta/data_object_search_service_client.js +10 -4
  20. package/build/src/v1beta/data_object_search_service_client.js.map +1 -1
  21. package/build/src/v1beta/data_object_service_client.d.ts +4 -0
  22. package/build/src/v1beta/data_object_service_client.js.map +1 -1
  23. package/package.json +1 -1
package/build/protos/protos.json CHANGED
@@ -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": {
@@ -1408,6 +1337,30 @@
1408
1337
  }
1409
1338
  }
1410
1339
  ]
1340
+ },
1341
+ "ExportDataObjects": {
1342
+ "requestType": "ExportDataObjectsRequest",
1343
+ "responseType": "google.longrunning.Operation",
1344
+ "options": {
1345
+ "(google.api.http).post": "/v1/{name=projects/*/locations/*/collections/*}:exportDataObjects",
1346
+ "(google.api.http).body": "*",
1347
+ "(google.longrunning.operation_info).response_type": "ExportDataObjectsResponse",
1348
+ "(google.longrunning.operation_info).metadata_type": "ExportDataObjectsMetadata"
1349
+ },
1350
+ "parsedOptions": [
1351
+ {
1352
+ "(google.api.http)": {
1353
+ "post": "/v1/{name=projects/*/locations/*/collections/*}:exportDataObjects",
1354
+ "body": "*"
1355
+ }
1356
+ },
1357
+ {
1358
+ "(google.longrunning.operation_info)": {
1359
+ "response_type": "ExportDataObjectsResponse",
1360
+ "metadata_type": "ExportDataObjectsMetadata"
1361
+ }
1362
+ }
1363
+ ]
1411
1364
  }
1412
1365
  }
1413
1366
  },
@@ -2041,6 +1994,78 @@
2041
1994
  }
2042
1995
  }
2043
1996
  },
1997
+ "ExportDataObjectsRequest": {
1998
+ "oneofs": {
1999
+ "destination": {
2000
+ "oneof": [
2001
+ "gcsDestination"
2002
+ ]
2003
+ }
2004
+ },
2005
+ "fields": {
2006
+ "gcsDestination": {
2007
+ "type": "GcsExportDestination",
2008
+ "id": 2
2009
+ },
2010
+ "name": {
2011
+ "type": "string",
2012
+ "id": 1,
2013
+ "options": {
2014
+ "(google.api.field_behavior)": "REQUIRED",
2015
+ "(google.api.resource_reference).type": "vectorsearch.googleapis.com/Collection"
2016
+ }
2017
+ }
2018
+ },
2019
+ "nested": {
2020
+ "GcsExportDestination": {
2021
+ "fields": {
2022
+ "exportUri": {
2023
+ "type": "string",
2024
+ "id": 1,
2025
+ "options": {
2026
+ "(google.api.field_behavior)": "REQUIRED"
2027
+ }
2028
+ },
2029
+ "format": {
2030
+ "type": "Format",
2031
+ "id": 2,
2032
+ "options": {
2033
+ "(google.api.field_behavior)": "REQUIRED"
2034
+ }
2035
+ }
2036
+ },
2037
+ "nested": {
2038
+ "Format": {
2039
+ "values": {
2040
+ "FORMAT_UNSPECIFIED": 0,
2041
+ "JSONL": 2
2042
+ }
2043
+ }
2044
+ }
2045
+ }
2046
+ }
2047
+ },
2048
+ "ExportDataObjectsMetadata": {
2049
+ "fields": {
2050
+ "createTime": {
2051
+ "type": "google.protobuf.Timestamp",
2052
+ "id": 1,
2053
+ "options": {
2054
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
2055
+ }
2056
+ },
2057
+ "finishTime": {
2058
+ "type": "google.protobuf.Timestamp",
2059
+ "id": 2,
2060
+ "options": {
2061
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
2062
+ }
2063
+ }
2064
+ }
2065
+ },
2066
+ "ExportDataObjectsResponse": {
2067
+ "fields": {}
2068
+ },
2044
2069
  "DedicatedInfrastructure": {
2045
2070
  "oneofs": {
2046
2071
  "_mode": {
@@ -2118,10 +2143,13 @@
2118
2143
  },
2119
2144
  "v1beta": {
2120
2145
  "options": {
2146
+ "csharp_namespace": "Google.Cloud.VectorSearch.V1Beta",
2121
2147
  "go_package": "cloud.google.com/go/vectorsearch/apiv1beta/vectorsearchpb;vectorsearchpb",
2122
2148
  "java_multiple_files": true,
2123
2149
  "java_outer_classname": "VectorSearchServiceProto",
2124
- "java_package": "com.google.cloud.vectorsearch.v1beta"
2150
+ "java_package": "com.google.cloud.vectorsearch.v1beta",
2151
+ "php_namespace": "Google\\Cloud\\VectorSearch\\V1beta",
2152
+ "ruby_package": "Google::Cloud::VectorSearch::V1beta"
2125
2153
  },
2126
2154
  "nested": {
2127
2155
  "DistanceMetric": {
@@ -2150,7 +2178,6 @@
2150
2178
  "type": "string",
2151
2179
  "id": 2,
2152
2180
  "options": {
2153
- "deprecated": true,
2154
2181
  "(google.api.field_behavior)": "OUTPUT_ONLY"
2155
2182
  }
2156
2183
  },
@@ -2182,6 +2209,13 @@
2182
2209
  "options": {
2183
2210
  "(google.api.field_behavior)": "OPTIONAL"
2184
2211
  }
2212
+ },
2213
+ "etag": {
2214
+ "type": "string",
2215
+ "id": 8,
2216
+ "options": {
2217
+ "(google.api.field_behavior)": "OPTIONAL"
2218
+ }
2185
2219
  }
2186
2220
  }
2187
2221
  },
@@ -2356,7 +2390,9 @@
2356
2390
  "indexType": {
2357
2391
  "oneof": [
2358
2392
  "useIndex",
2359
- "useKnn"
2393
+ "useKnn",
2394
+ "knnHint",
2395
+ "indexHint"
2360
2396
  ]
2361
2397
  }
2362
2398
  },
@@ -2365,12 +2401,28 @@
2365
2401
  "type": "IndexHint",
2366
2402
  "id": 1,
2367
2403
  "options": {
2404
+ "deprecated": true,
2368
2405
  "(google.api.field_behavior)": "OPTIONAL"
2369
2406
  }
2370
2407
  },
2371
2408
  "useKnn": {
2372
2409
  "type": "bool",
2373
2410
  "id": 2,
2411
+ "options": {
2412
+ "deprecated": true,
2413
+ "(google.api.field_behavior)": "OPTIONAL"
2414
+ }
2415
+ },
2416
+ "knnHint": {
2417
+ "type": "KnnHint",
2418
+ "id": 3,
2419
+ "options": {
2420
+ "(google.api.field_behavior)": "OPTIONAL"
2421
+ }
2422
+ },
2423
+ "indexHint": {
2424
+ "type": "IndexHint",
2425
+ "id": 4,
2374
2426
  "options": {
2375
2427
  "(google.api.field_behavior)": "OPTIONAL"
2376
2428
  }
@@ -2378,15 +2430,53 @@
2378
2430
  },
2379
2431
  "nested": {
2380
2432
  "IndexHint": {
2433
+ "oneofs": {
2434
+ "params": {
2435
+ "oneof": [
2436
+ "denseScannParams"
2437
+ ]
2438
+ }
2439
+ },
2381
2440
  "fields": {
2441
+ "denseScannParams": {
2442
+ "type": "DenseScannParams",
2443
+ "id": 2,
2444
+ "options": {
2445
+ "(google.api.field_behavior)": "OPTIONAL"
2446
+ }
2447
+ },
2382
2448
  "name": {
2383
2449
  "type": "string",
2384
2450
  "id": 1,
2385
2451
  "options": {
2386
- "(google.api.field_behavior)": "REQUIRED"
2452
+ "(google.api.field_behavior)": "REQUIRED",
2453
+ "(google.api.resource_reference).type": "vectorsearch.googleapis.com/Index"
2454
+ }
2455
+ }
2456
+ },
2457
+ "nested": {
2458
+ "DenseScannParams": {
2459
+ "fields": {
2460
+ "searchLeavesPct": {
2461
+ "type": "int32",
2462
+ "id": 1,
2463
+ "options": {
2464
+ "(google.api.field_behavior)": "OPTIONAL"
2465
+ }
2466
+ },
2467
+ "initialCandidateCount": {
2468
+ "type": "int32",
2469
+ "id": 2,
2470
+ "options": {
2471
+ "(google.api.field_behavior)": "OPTIONAL"
2472
+ }
2473
+ }
2387
2474
  }
2388
2475
  }
2389
2476
  }
2477
+ },
2478
+ "KnnHint": {
2479
+ "fields": {}
2390
2480
  }
2391
2481
  }
2392
2482
  },
@@ -2475,7 +2565,7 @@
2475
2565
  }
2476
2566
  },
2477
2567
  "distanceMetric": {
2478
- "type": "google.cloud.vectorsearch.v1beta.DistanceMetric",
2568
+ "type": "DistanceMetric",
2479
2569
  "id": 11,
2480
2570
  "options": {
2481
2571
  "(google.api.field_behavior)": "OPTIONAL"
@@ -2510,7 +2600,7 @@
2510
2600
  "type": "EmbeddingTaskType",
2511
2601
  "id": 5,
2512
2602
  "options": {
2513
- "(google.api.field_behavior)": "OPTIONAL"
2603
+ "(google.api.field_behavior)": "REQUIRED"
2514
2604
  }
2515
2605
  },
2516
2606
  "outputFields": {
@@ -2697,7 +2787,8 @@
2697
2787
  "type": "string",
2698
2788
  "id": 1,
2699
2789
  "options": {
2700
- "(google.api.field_behavior)": "OUTPUT_ONLY"
2790
+ "(google.api.field_behavior)": "OUTPUT_ONLY",
2791
+ "(google.api.resource_reference).type": "vectorsearch.googleapis.com/Index"
2701
2792
  }
2702
2793
  }
2703
2794
  }
@@ -2761,7 +2852,10 @@
2761
2852
  "aggregateResults": {
2762
2853
  "rule": "repeated",
2763
2854
  "type": "google.protobuf.Struct",
2764
- "id": 1
2855
+ "id": 1,
2856
+ "options": {
2857
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
2858
+ }
2765
2859
  }
2766
2860
  }
2767
2861
  },
@@ -2810,11 +2904,17 @@
2810
2904
  "dataObjects": {
2811
2905
  "rule": "repeated",
2812
2906
  "type": "DataObject",
2813
- "id": 4
2907
+ "id": 4,
2908
+ "options": {
2909
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
2910
+ }
2814
2911
  },
2815
2912
  "nextPageToken": {
2816
2913
  "type": "string",
2817
- "id": 3
2914
+ "id": 3,
2915
+ "options": {
2916
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
2917
+ }
2818
2918
  }
2819
2919
  }
2820
2920
  },
@@ -2876,8 +2976,7 @@
2876
2976
  "oneofs": {
2877
2977
  "ranker": {
2878
2978
  "oneof": [
2879
- "rrf",
2880
- "vertex"
2979
+ "rrf"
2881
2980
  ]
2882
2981
  }
2883
2982
  },
@@ -2885,10 +2984,6 @@
2885
2984
  "rrf": {
2886
2985
  "type": "ReciprocalRankFusion",
2887
2986
  "id": 1
2888
- },
2889
- "vertex": {
2890
- "type": "VertexRanker",
2891
- "id": 2
2892
2987
  }
2893
2988
  }
2894
2989
  },
@@ -2904,38 +2999,6 @@
2904
2999
  }
2905
3000
  }
2906
3001
  },
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
3002
  "BatchSearchDataObjectsResponse": {
2940
3003
  "fields": {
2941
3004
  "results": {
@@ -3177,7 +3240,10 @@
3177
3240
  "dataObjects": {
3178
3241
  "rule": "repeated",
3179
3242
  "type": "DataObject",
3180
- "id": 1
3243
+ "id": 1,
3244
+ "options": {
3245
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
3246
+ }
3181
3247
  }
3182
3248
  }
3183
3249
  },
@@ -3243,6 +3309,13 @@
3243
3309
  "(google.api.field_behavior)": "REQUIRED",
3244
3310
  "(google.api.resource_reference).type": "vectorsearch.googleapis.com/DataObject"
3245
3311
  }
3312
+ },
3313
+ "etag": {
3314
+ "type": "string",
3315
+ "id": 2,
3316
+ "options": {
3317
+ "(google.api.field_behavior)": "OPTIONAL"
3318
+ }
3246
3319
  }
3247
3320
  }
3248
3321
  },
@@ -3804,7 +3877,33 @@
3804
3877
  "(google.api.resource).plural": "indexes",
3805
3878
  "(google.api.resource).singular": "index"
3806
3879
  },
3880
+ "oneofs": {
3881
+ "infraType": {
3882
+ "oneof": [
3883
+ "dedicatedInfrastructure"
3884
+ ]
3885
+ },
3886
+ "indexType": {
3887
+ "oneof": [
3888
+ "denseScann"
3889
+ ]
3890
+ }
3891
+ },
3807
3892
  "fields": {
3893
+ "dedicatedInfrastructure": {
3894
+ "type": "DedicatedInfrastructure",
3895
+ "id": 11,
3896
+ "options": {
3897
+ "(google.api.field_behavior)": "OPTIONAL"
3898
+ }
3899
+ },
3900
+ "denseScann": {
3901
+ "type": "DenseScannIndex",
3902
+ "id": 12,
3903
+ "options": {
3904
+ "(google.api.field_behavior)": "OPTIONAL"
3905
+ }
3906
+ },
3808
3907
  "name": {
3809
3908
  "type": "string",
3810
3909
  "id": 1,
@@ -3849,7 +3948,7 @@
3849
3948
  }
3850
3949
  },
3851
3950
  "distanceMetric": {
3852
- "type": "google.cloud.vectorsearch.v1beta.DistanceMetric",
3951
+ "type": "DistanceMetric",
3853
3952
  "id": 4,
3854
3953
  "options": {
3855
3954
  "(google.api.field_behavior)": "OPTIONAL"
@@ -4106,19 +4205,31 @@
4106
4205
  "fields": {
4107
4206
  "createTime": {
4108
4207
  "type": "google.protobuf.Timestamp",
4109
- "id": 1
4208
+ "id": 1,
4209
+ "options": {
4210
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
4211
+ }
4110
4212
  },
4111
4213
  "updateTime": {
4112
4214
  "type": "google.protobuf.Timestamp",
4113
- "id": 2
4215
+ "id": 2,
4216
+ "options": {
4217
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
4218
+ }
4114
4219
  },
4115
4220
  "successCount": {
4116
4221
  "type": "int64",
4117
- "id": 3
4222
+ "id": 3,
4223
+ "options": {
4224
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
4225
+ }
4118
4226
  },
4119
4227
  "failureCount": {
4120
4228
  "type": "int64",
4121
- "id": 4
4229
+ "id": 4,
4230
+ "options": {
4231
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
4232
+ }
4122
4233
  }
4123
4234
  }
4124
4235
  },
@@ -4185,16 +4296,95 @@
4185
4296
  "fields": {
4186
4297
  "createTime": {
4187
4298
  "type": "google.protobuf.Timestamp",
4188
- "id": 1
4299
+ "id": 1,
4300
+ "options": {
4301
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
4302
+ }
4189
4303
  },
4190
4304
  "finishTime": {
4191
4305
  "type": "google.protobuf.Timestamp",
4192
- "id": 2
4306
+ "id": 2,
4307
+ "options": {
4308
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
4309
+ }
4193
4310
  }
4194
4311
  }
4195
4312
  },
4196
4313
  "ExportDataObjectsResponse": {
4197
4314
  "fields": {}
4315
+ },
4316
+ "DedicatedInfrastructure": {
4317
+ "oneofs": {
4318
+ "_mode": {
4319
+ "oneof": [
4320
+ "mode"
4321
+ ]
4322
+ }
4323
+ },
4324
+ "fields": {
4325
+ "mode": {
4326
+ "type": "Mode",
4327
+ "id": 1,
4328
+ "options": {
4329
+ "(google.api.field_behavior)": "OPTIONAL",
4330
+ "proto3_optional": true
4331
+ }
4332
+ },
4333
+ "autoscalingSpec": {
4334
+ "type": "AutoscalingSpec",
4335
+ "id": 2,
4336
+ "options": {
4337
+ "(google.api.field_behavior)": "OPTIONAL"
4338
+ }
4339
+ }
4340
+ },
4341
+ "nested": {
4342
+ "AutoscalingSpec": {
4343
+ "fields": {
4344
+ "minReplicaCount": {
4345
+ "type": "int32",
4346
+ "id": 1,
4347
+ "options": {
4348
+ "(google.api.field_behavior)": "OPTIONAL"
4349
+ }
4350
+ },
4351
+ "maxReplicaCount": {
4352
+ "type": "int32",
4353
+ "id": 2,
4354
+ "options": {
4355
+ "(google.api.field_behavior)": "OPTIONAL"
4356
+ }
4357
+ }
4358
+ }
4359
+ },
4360
+ "Mode": {
4361
+ "values": {
4362
+ "MODE_UNSPECIFIED": 0,
4363
+ "STORAGE_OPTIMIZED": 1,
4364
+ "PERFORMANCE_OPTIMIZED": 2
4365
+ }
4366
+ }
4367
+ }
4368
+ },
4369
+ "DenseScannIndex": {
4370
+ "fields": {
4371
+ "featureNormType": {
4372
+ "type": "FeatureNormType",
4373
+ "id": 2,
4374
+ "options": {
4375
+ "(google.api.field_behavior)": "OPTIONAL"
4376
+ }
4377
+ }
4378
+ },
4379
+ "nested": {
4380
+ "FeatureNormType": {
4381
+ "values": {
4382
+ "FEATURE_NORM_TYPE_UNSPECIFIED": 0,
4383
+ "NONE": 1,
4384
+ "UNIT_L2_NORM": 2
4385
+ }
4386
+ }
4387
+ }
4198
4388
  }
4199
4389
  }
4200
4390
  }