@google-cloud/discoveryengine 1.2.0 → 1.3.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 (37) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +13 -0
  3. package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +39 -4
  4. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store.proto +98 -0
  5. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store_service.proto +307 -0
  6. package/build/protos/google/cloud/discoveryengine/v1alpha/engine.proto +370 -0
  7. package/build/protos/google/cloud/discoveryengine/v1alpha/engine_service.proto +336 -0
  8. package/build/protos/google/cloud/discoveryengine/v1alpha/recommendation_service.proto +9 -3
  9. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +26 -3
  10. package/build/protos/protos.d.ts +5578 -1800
  11. package/build/protos/protos.js +14034 -5272
  12. package/build/protos/protos.json +1337 -340
  13. package/build/src/v1alpha/completion_service_client.d.ts +42 -0
  14. package/build/src/v1alpha/completion_service_client.js +58 -0
  15. package/build/src/v1alpha/conversational_search_service_client.d.ts +42 -0
  16. package/build/src/v1alpha/conversational_search_service_client.js +58 -0
  17. package/build/src/v1alpha/data_store_service_client.d.ts +1060 -0
  18. package/build/src/v1alpha/data_store_service_client.js +1431 -0
  19. package/build/src/v1alpha/data_store_service_client_config.json +46 -0
  20. package/build/src/v1alpha/document_service_client.d.ts +117 -0
  21. package/build/src/v1alpha/document_service_client.js +162 -0
  22. package/build/src/v1alpha/engine_service_client.d.ts +1079 -0
  23. package/build/src/v1alpha/engine_service_client.js +1481 -0
  24. package/build/src/v1alpha/engine_service_client_config.json +58 -0
  25. package/build/src/v1alpha/index.d.ts +2 -0
  26. package/build/src/v1alpha/index.js +5 -1
  27. package/build/src/v1alpha/recommendation_service_client.d.ts +126 -3
  28. package/build/src/v1alpha/recommendation_service_client.js +162 -0
  29. package/build/src/v1alpha/schema_service_client.d.ts +42 -0
  30. package/build/src/v1alpha/schema_service_client.js +58 -0
  31. package/build/src/v1alpha/search_service_client.d.ts +195 -9
  32. package/build/src/v1alpha/search_service_client.js +214 -6
  33. package/build/src/v1alpha/site_search_engine_service_client.d.ts +117 -0
  34. package/build/src/v1alpha/site_search_engine_service_client.js +162 -0
  35. package/build/src/v1alpha/user_event_service_client.d.ts +42 -0
  36. package/build/src/v1alpha/user_event_service_client.js +58 -0
  37. package/package.json +3 -3
@@ -0,0 +1,46 @@
1
+ {
2
+ "interfaces": {
3
+ "google.cloud.discoveryengine.v1alpha.DataStoreService": {
4
+ "retry_codes": {
5
+ "non_idempotent": [],
6
+ "idempotent": [
7
+ "DEADLINE_EXCEEDED",
8
+ "UNAVAILABLE"
9
+ ]
10
+ },
11
+ "retry_params": {
12
+ "default": {
13
+ "initial_retry_delay_millis": 100,
14
+ "retry_delay_multiplier": 1.3,
15
+ "max_retry_delay_millis": 60000,
16
+ "initial_rpc_timeout_millis": 60000,
17
+ "rpc_timeout_multiplier": 1,
18
+ "max_rpc_timeout_millis": 60000,
19
+ "total_timeout_millis": 600000
20
+ }
21
+ },
22
+ "methods": {
23
+ "CreateDataStore": {
24
+ "retry_codes_name": "non_idempotent",
25
+ "retry_params_name": "default"
26
+ },
27
+ "GetDataStore": {
28
+ "retry_codes_name": "non_idempotent",
29
+ "retry_params_name": "default"
30
+ },
31
+ "ListDataStores": {
32
+ "retry_codes_name": "non_idempotent",
33
+ "retry_params_name": "default"
34
+ },
35
+ "DeleteDataStore": {
36
+ "retry_codes_name": "non_idempotent",
37
+ "retry_params_name": "default"
38
+ },
39
+ "UpdateDataStore": {
40
+ "retry_codes_name": "non_idempotent",
41
+ "retry_params_name": "default"
42
+ }
43
+ }
44
+ }
45
+ }
46
+ }
@@ -740,6 +740,90 @@ export declare class DocumentServiceClient {
740
740
  * ```
741
741
  */
742
742
  deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;
743
+ /**
744
+ * Return a fully-qualified engine resource name string.
745
+ *
746
+ * @param {string} project
747
+ * @param {string} location
748
+ * @param {string} collection
749
+ * @param {string} engine
750
+ * @returns {string} Resource name string.
751
+ */
752
+ enginePath(project: string, location: string, collection: string, engine: string): string;
753
+ /**
754
+ * Parse the project from Engine resource.
755
+ *
756
+ * @param {string} engineName
757
+ * A fully-qualified path representing Engine resource.
758
+ * @returns {string} A string representing the project.
759
+ */
760
+ matchProjectFromEngineName(engineName: string): string | number;
761
+ /**
762
+ * Parse the location from Engine resource.
763
+ *
764
+ * @param {string} engineName
765
+ * A fully-qualified path representing Engine resource.
766
+ * @returns {string} A string representing the location.
767
+ */
768
+ matchLocationFromEngineName(engineName: string): string | number;
769
+ /**
770
+ * Parse the collection from Engine resource.
771
+ *
772
+ * @param {string} engineName
773
+ * A fully-qualified path representing Engine resource.
774
+ * @returns {string} A string representing the collection.
775
+ */
776
+ matchCollectionFromEngineName(engineName: string): string | number;
777
+ /**
778
+ * Parse the engine from Engine resource.
779
+ *
780
+ * @param {string} engineName
781
+ * A fully-qualified path representing Engine resource.
782
+ * @returns {string} A string representing the engine.
783
+ */
784
+ matchEngineFromEngineName(engineName: string): string | number;
785
+ /**
786
+ * Return a fully-qualified projectLocationCollectionDataStore resource name string.
787
+ *
788
+ * @param {string} project
789
+ * @param {string} location
790
+ * @param {string} collection
791
+ * @param {string} data_store
792
+ * @returns {string} Resource name string.
793
+ */
794
+ projectLocationCollectionDataStorePath(project: string, location: string, collection: string, dataStore: string): string;
795
+ /**
796
+ * Parse the project from ProjectLocationCollectionDataStore resource.
797
+ *
798
+ * @param {string} projectLocationCollectionDataStoreName
799
+ * A fully-qualified path representing project_location_collection_data_store resource.
800
+ * @returns {string} A string representing the project.
801
+ */
802
+ matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
803
+ /**
804
+ * Parse the location from ProjectLocationCollectionDataStore resource.
805
+ *
806
+ * @param {string} projectLocationCollectionDataStoreName
807
+ * A fully-qualified path representing project_location_collection_data_store resource.
808
+ * @returns {string} A string representing the location.
809
+ */
810
+ matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
811
+ /**
812
+ * Parse the collection from ProjectLocationCollectionDataStore resource.
813
+ *
814
+ * @param {string} projectLocationCollectionDataStoreName
815
+ * A fully-qualified path representing project_location_collection_data_store resource.
816
+ * @returns {string} A string representing the collection.
817
+ */
818
+ matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
819
+ /**
820
+ * Parse the data_store from ProjectLocationCollectionDataStore resource.
821
+ *
822
+ * @param {string} projectLocationCollectionDataStoreName
823
+ * A fully-qualified path representing project_location_collection_data_store resource.
824
+ * @returns {string} A string representing the data_store.
825
+ */
826
+ matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
743
827
  /**
744
828
  * Return a fully-qualified projectLocationCollectionDataStoreBranch resource name string.
745
829
  *
@@ -953,6 +1037,39 @@ export declare class DocumentServiceClient {
953
1037
  * @returns {string} A string representing the schema.
954
1038
  */
955
1039
  matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
1040
+ /**
1041
+ * Return a fully-qualified projectLocationDataStore resource name string.
1042
+ *
1043
+ * @param {string} project
1044
+ * @param {string} location
1045
+ * @param {string} data_store
1046
+ * @returns {string} Resource name string.
1047
+ */
1048
+ projectLocationDataStorePath(project: string, location: string, dataStore: string): string;
1049
+ /**
1050
+ * Parse the project from ProjectLocationDataStore resource.
1051
+ *
1052
+ * @param {string} projectLocationDataStoreName
1053
+ * A fully-qualified path representing project_location_data_store resource.
1054
+ * @returns {string} A string representing the project.
1055
+ */
1056
+ matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
1057
+ /**
1058
+ * Parse the location from ProjectLocationDataStore resource.
1059
+ *
1060
+ * @param {string} projectLocationDataStoreName
1061
+ * A fully-qualified path representing project_location_data_store resource.
1062
+ * @returns {string} A string representing the location.
1063
+ */
1064
+ matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
1065
+ /**
1066
+ * Parse the data_store from ProjectLocationDataStore resource.
1067
+ *
1068
+ * @param {string} projectLocationDataStoreName
1069
+ * A fully-qualified path representing project_location_data_store resource.
1070
+ * @returns {string} A string representing the data_store.
1071
+ */
1072
+ matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
956
1073
  /**
957
1074
  * Return a fully-qualified projectLocationDataStoreBranch resource name string.
958
1075
  *
@@ -140,10 +140,13 @@ class DocumentServiceClient {
140
140
  // identifiers to uniquely identify resources within the API.
141
141
  // Create useful helper objects for these.
142
142
  this.pathTemplates = {
143
+ enginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}'),
144
+ projectLocationCollectionDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}'),
143
145
  projectLocationCollectionDataStoreBranchPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}'),
144
146
  projectLocationCollectionDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
145
147
  projectLocationCollectionDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}'),
146
148
  projectLocationCollectionDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}'),
149
+ projectLocationDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}'),
147
150
  projectLocationDataStoreBranchPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}'),
148
151
  projectLocationDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
149
152
  projectLocationDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}'),
@@ -843,6 +846,120 @@ class DocumentServiceClient {
843
846
  // --------------------
844
847
  // -- Path templates --
845
848
  // --------------------
849
+ /**
850
+ * Return a fully-qualified engine resource name string.
851
+ *
852
+ * @param {string} project
853
+ * @param {string} location
854
+ * @param {string} collection
855
+ * @param {string} engine
856
+ * @returns {string} Resource name string.
857
+ */
858
+ enginePath(project, location, collection, engine) {
859
+ return this.pathTemplates.enginePathTemplate.render({
860
+ project: project,
861
+ location: location,
862
+ collection: collection,
863
+ engine: engine,
864
+ });
865
+ }
866
+ /**
867
+ * Parse the project from Engine resource.
868
+ *
869
+ * @param {string} engineName
870
+ * A fully-qualified path representing Engine resource.
871
+ * @returns {string} A string representing the project.
872
+ */
873
+ matchProjectFromEngineName(engineName) {
874
+ return this.pathTemplates.enginePathTemplate.match(engineName).project;
875
+ }
876
+ /**
877
+ * Parse the location from Engine resource.
878
+ *
879
+ * @param {string} engineName
880
+ * A fully-qualified path representing Engine resource.
881
+ * @returns {string} A string representing the location.
882
+ */
883
+ matchLocationFromEngineName(engineName) {
884
+ return this.pathTemplates.enginePathTemplate.match(engineName).location;
885
+ }
886
+ /**
887
+ * Parse the collection from Engine resource.
888
+ *
889
+ * @param {string} engineName
890
+ * A fully-qualified path representing Engine resource.
891
+ * @returns {string} A string representing the collection.
892
+ */
893
+ matchCollectionFromEngineName(engineName) {
894
+ return this.pathTemplates.enginePathTemplate.match(engineName).collection;
895
+ }
896
+ /**
897
+ * Parse the engine from Engine resource.
898
+ *
899
+ * @param {string} engineName
900
+ * A fully-qualified path representing Engine resource.
901
+ * @returns {string} A string representing the engine.
902
+ */
903
+ matchEngineFromEngineName(engineName) {
904
+ return this.pathTemplates.enginePathTemplate.match(engineName).engine;
905
+ }
906
+ /**
907
+ * Return a fully-qualified projectLocationCollectionDataStore resource name string.
908
+ *
909
+ * @param {string} project
910
+ * @param {string} location
911
+ * @param {string} collection
912
+ * @param {string} data_store
913
+ * @returns {string} Resource name string.
914
+ */
915
+ projectLocationCollectionDataStorePath(project, location, collection, dataStore) {
916
+ return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.render({
917
+ project: project,
918
+ location: location,
919
+ collection: collection,
920
+ data_store: dataStore,
921
+ });
922
+ }
923
+ /**
924
+ * Parse the project from ProjectLocationCollectionDataStore resource.
925
+ *
926
+ * @param {string} projectLocationCollectionDataStoreName
927
+ * A fully-qualified path representing project_location_collection_data_store resource.
928
+ * @returns {string} A string representing the project.
929
+ */
930
+ matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
931
+ return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).project;
932
+ }
933
+ /**
934
+ * Parse the location from ProjectLocationCollectionDataStore resource.
935
+ *
936
+ * @param {string} projectLocationCollectionDataStoreName
937
+ * A fully-qualified path representing project_location_collection_data_store resource.
938
+ * @returns {string} A string representing the location.
939
+ */
940
+ matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
941
+ return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).location;
942
+ }
943
+ /**
944
+ * Parse the collection from ProjectLocationCollectionDataStore resource.
945
+ *
946
+ * @param {string} projectLocationCollectionDataStoreName
947
+ * A fully-qualified path representing project_location_collection_data_store resource.
948
+ * @returns {string} A string representing the collection.
949
+ */
950
+ matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
951
+ return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).collection;
952
+ }
953
+ /**
954
+ * Parse the data_store from ProjectLocationCollectionDataStore resource.
955
+ *
956
+ * @param {string} projectLocationCollectionDataStoreName
957
+ * A fully-qualified path representing project_location_collection_data_store resource.
958
+ * @returns {string} A string representing the data_store.
959
+ */
960
+ matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
961
+ return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).data_store;
962
+ }
846
963
  /**
847
964
  * Return a fully-qualified projectLocationCollectionDataStoreBranch resource name string.
848
965
  *
@@ -1131,6 +1248,51 @@ class DocumentServiceClient {
1131
1248
  matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
1132
1249
  return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).schema;
1133
1250
  }
1251
+ /**
1252
+ * Return a fully-qualified projectLocationDataStore resource name string.
1253
+ *
1254
+ * @param {string} project
1255
+ * @param {string} location
1256
+ * @param {string} data_store
1257
+ * @returns {string} Resource name string.
1258
+ */
1259
+ projectLocationDataStorePath(project, location, dataStore) {
1260
+ return this.pathTemplates.projectLocationDataStorePathTemplate.render({
1261
+ project: project,
1262
+ location: location,
1263
+ data_store: dataStore,
1264
+ });
1265
+ }
1266
+ /**
1267
+ * Parse the project from ProjectLocationDataStore resource.
1268
+ *
1269
+ * @param {string} projectLocationDataStoreName
1270
+ * A fully-qualified path representing project_location_data_store resource.
1271
+ * @returns {string} A string representing the project.
1272
+ */
1273
+ matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName) {
1274
+ return this.pathTemplates.projectLocationDataStorePathTemplate.match(projectLocationDataStoreName).project;
1275
+ }
1276
+ /**
1277
+ * Parse the location from ProjectLocationDataStore resource.
1278
+ *
1279
+ * @param {string} projectLocationDataStoreName
1280
+ * A fully-qualified path representing project_location_data_store resource.
1281
+ * @returns {string} A string representing the location.
1282
+ */
1283
+ matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName) {
1284
+ return this.pathTemplates.projectLocationDataStorePathTemplate.match(projectLocationDataStoreName).location;
1285
+ }
1286
+ /**
1287
+ * Parse the data_store from ProjectLocationDataStore resource.
1288
+ *
1289
+ * @param {string} projectLocationDataStoreName
1290
+ * A fully-qualified path representing project_location_data_store resource.
1291
+ * @returns {string} A string representing the data_store.
1292
+ */
1293
+ matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName) {
1294
+ return this.pathTemplates.projectLocationDataStorePathTemplate.match(projectLocationDataStoreName).data_store;
1295
+ }
1134
1296
  /**
1135
1297
  * Return a fully-qualified projectLocationDataStoreBranch resource name string.
1136
1298
  *