@google-cloud/discoveryengine 1.2.0 → 1.3.1

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 (63) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +25 -0
  3. package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +38 -8
  4. package/build/protos/google/cloud/discoveryengine/v1alpha/conversation.proto +3 -0
  5. package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +39 -0
  6. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store.proto +98 -0
  7. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store_service.proto +307 -0
  8. package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +1 -1
  9. package/build/protos/google/cloud/discoveryengine/v1alpha/engine.proto +370 -0
  10. package/build/protos/google/cloud/discoveryengine/v1alpha/engine_service.proto +336 -0
  11. package/build/protos/google/cloud/discoveryengine/v1alpha/recommendation_service.proto +9 -3
  12. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +123 -3
  13. package/build/protos/google/cloud/discoveryengine/v1alpha/search_tuning_service.proto +147 -0
  14. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine.proto +164 -0
  15. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +540 -0
  16. package/build/protos/protos.d.ts +10923 -3222
  17. package/build/protos/protos.js +29891 -12914
  18. package/build/protos/protos.json +2367 -668
  19. package/build/src/index.js +1 -1
  20. package/build/src/v1/completion_service_client.js +1 -1
  21. package/build/src/v1/conversational_search_service_client.js +1 -1
  22. package/build/src/v1/document_service_client.js +1 -1
  23. package/build/src/v1/index.js +1 -1
  24. package/build/src/v1/schema_service_client.js +1 -1
  25. package/build/src/v1/search_service_client.js +1 -1
  26. package/build/src/v1/user_event_service_client.js +1 -1
  27. package/build/src/v1alpha/completion_service_client.d.ts +261 -0
  28. package/build/src/v1alpha/completion_service_client.js +360 -0
  29. package/build/src/v1alpha/conversational_search_service_client.d.ts +278 -0
  30. package/build/src/v1alpha/conversational_search_service_client.js +360 -0
  31. package/build/src/v1alpha/data_store_service_client.d.ts +1279 -0
  32. package/build/src/v1alpha/data_store_service_client.js +1739 -0
  33. package/build/src/v1alpha/data_store_service_client_config.json +46 -0
  34. package/build/src/v1alpha/document_service_client.d.ts +336 -0
  35. package/build/src/v1alpha/document_service_client.js +472 -2
  36. package/build/src/v1alpha/engine_service_client.d.ts +1298 -0
  37. package/build/src/v1alpha/engine_service_client.js +1789 -0
  38. package/build/src/v1alpha/engine_service_client_config.json +58 -0
  39. package/build/src/v1alpha/index.d.ts +3 -0
  40. package/build/src/v1alpha/index.js +7 -1
  41. package/build/src/v1alpha/recommendation_service_client.d.ts +345 -3
  42. package/build/src/v1alpha/recommendation_service_client.js +464 -0
  43. package/build/src/v1alpha/schema_service_client.d.ts +261 -0
  44. package/build/src/v1alpha/schema_service_client.js +368 -2
  45. package/build/src/v1alpha/search_service_client.d.ts +453 -9
  46. package/build/src/v1alpha/search_service_client.js +542 -6
  47. package/build/src/v1alpha/search_tuning_service_client.d.ts +968 -0
  48. package/build/src/v1alpha/search_tuning_service_client.js +1452 -0
  49. package/build/src/v1alpha/search_tuning_service_client_config.json +30 -0
  50. package/build/src/v1alpha/site_search_engine_service_client.d.ts +856 -1
  51. package/build/src/v1alpha/site_search_engine_service_client.js +993 -34
  52. package/build/src/v1alpha/site_search_engine_service_client_config.json +44 -0
  53. package/build/src/v1alpha/user_event_service_client.d.ts +261 -0
  54. package/build/src/v1alpha/user_event_service_client.js +368 -2
  55. package/build/src/v1beta/completion_service_client.js +1 -1
  56. package/build/src/v1beta/conversational_search_service_client.js +1 -1
  57. package/build/src/v1beta/document_service_client.js +1 -1
  58. package/build/src/v1beta/index.js +1 -1
  59. package/build/src/v1beta/recommendation_service_client.js +1 -1
  60. package/build/src/v1beta/schema_service_client.js +1 -1
  61. package/build/src/v1beta/search_service_client.js +1 -1
  62. package/build/src/v1beta/user_event_service_client.js +1 -1
  63. package/package.json +4 -4
@@ -20,9 +20,53 @@
20
20
  }
21
21
  },
22
22
  "methods": {
23
+ "GetSiteSearchEngine": {
24
+ "retry_codes_name": "non_idempotent",
25
+ "retry_params_name": "default"
26
+ },
27
+ "CreateTargetSite": {
28
+ "retry_codes_name": "non_idempotent",
29
+ "retry_params_name": "default"
30
+ },
31
+ "BatchCreateTargetSites": {
32
+ "retry_codes_name": "non_idempotent",
33
+ "retry_params_name": "default"
34
+ },
35
+ "GetTargetSite": {
36
+ "retry_codes_name": "non_idempotent",
37
+ "retry_params_name": "default"
38
+ },
39
+ "UpdateTargetSite": {
40
+ "retry_codes_name": "non_idempotent",
41
+ "retry_params_name": "default"
42
+ },
43
+ "DeleteTargetSite": {
44
+ "retry_codes_name": "non_idempotent",
45
+ "retry_params_name": "default"
46
+ },
47
+ "ListTargetSites": {
48
+ "retry_codes_name": "non_idempotent",
49
+ "retry_params_name": "default"
50
+ },
51
+ "EnableAdvancedSiteSearch": {
52
+ "retry_codes_name": "non_idempotent",
53
+ "retry_params_name": "default"
54
+ },
55
+ "DisableAdvancedSiteSearch": {
56
+ "retry_codes_name": "non_idempotent",
57
+ "retry_params_name": "default"
58
+ },
23
59
  "RecrawlUris": {
24
60
  "retry_codes_name": "non_idempotent",
25
61
  "retry_params_name": "default"
62
+ },
63
+ "BatchVerifyTargetSites": {
64
+ "retry_codes_name": "non_idempotent",
65
+ "retry_params_name": "default"
66
+ },
67
+ "FetchDomainVerificationStatus": {
68
+ "retry_codes_name": "non_idempotent",
69
+ "retry_params_name": "default"
26
70
  }
27
71
  }
28
72
  }
@@ -471,6 +471,48 @@ export declare class UserEventServiceClient {
471
471
  * ```
472
472
  */
473
473
  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>;
474
+ /**
475
+ * Return a fully-qualified engine resource name string.
476
+ *
477
+ * @param {string} project
478
+ * @param {string} location
479
+ * @param {string} collection
480
+ * @param {string} engine
481
+ * @returns {string} Resource name string.
482
+ */
483
+ enginePath(project: string, location: string, collection: string, engine: string): string;
484
+ /**
485
+ * Parse the project from Engine resource.
486
+ *
487
+ * @param {string} engineName
488
+ * A fully-qualified path representing Engine resource.
489
+ * @returns {string} A string representing the project.
490
+ */
491
+ matchProjectFromEngineName(engineName: string): string | number;
492
+ /**
493
+ * Parse the location from Engine resource.
494
+ *
495
+ * @param {string} engineName
496
+ * A fully-qualified path representing Engine resource.
497
+ * @returns {string} A string representing the location.
498
+ */
499
+ matchLocationFromEngineName(engineName: string): string | number;
500
+ /**
501
+ * Parse the collection from Engine resource.
502
+ *
503
+ * @param {string} engineName
504
+ * A fully-qualified path representing Engine resource.
505
+ * @returns {string} A string representing the collection.
506
+ */
507
+ matchCollectionFromEngineName(engineName: string): string | number;
508
+ /**
509
+ * Parse the engine from Engine resource.
510
+ *
511
+ * @param {string} engineName
512
+ * A fully-qualified path representing Engine resource.
513
+ * @returns {string} A string representing the engine.
514
+ */
515
+ matchEngineFromEngineName(engineName: string): string | number;
474
516
  /**
475
517
  * Return a fully-qualified projectLocationCollectionDataStore resource name string.
476
518
  *
@@ -675,6 +717,150 @@ export declare class UserEventServiceClient {
675
717
  * @returns {string} A string representing the schema.
676
718
  */
677
719
  matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
720
+ /**
721
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.
722
+ *
723
+ * @param {string} project
724
+ * @param {string} location
725
+ * @param {string} collection
726
+ * @param {string} data_store
727
+ * @returns {string} Resource name string.
728
+ */
729
+ projectLocationCollectionDataStoreSiteSearchEnginePath(project: string, location: string, collection: string, dataStore: string): string;
730
+ /**
731
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
732
+ *
733
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
734
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
735
+ * @returns {string} A string representing the project.
736
+ */
737
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
738
+ /**
739
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
740
+ *
741
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
742
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
743
+ * @returns {string} A string representing the location.
744
+ */
745
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
746
+ /**
747
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
748
+ *
749
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
750
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
751
+ * @returns {string} A string representing the collection.
752
+ */
753
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
754
+ /**
755
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
756
+ *
757
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
758
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
759
+ * @returns {string} A string representing the data_store.
760
+ */
761
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
762
+ /**
763
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
764
+ *
765
+ * @param {string} project
766
+ * @param {string} location
767
+ * @param {string} collection
768
+ * @param {string} data_store
769
+ * @param {string} target_site
770
+ * @returns {string} Resource name string.
771
+ */
772
+ projectLocationCollectionDataStoreSiteSearchEngineTargetSitePath(project: string, location: string, collection: string, dataStore: string, targetSite: string): string;
773
+ /**
774
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
775
+ *
776
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
777
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
778
+ * @returns {string} A string representing the project.
779
+ */
780
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
781
+ /**
782
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
783
+ *
784
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
785
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
786
+ * @returns {string} A string representing the location.
787
+ */
788
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
789
+ /**
790
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
791
+ *
792
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
793
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
794
+ * @returns {string} A string representing the collection.
795
+ */
796
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
797
+ /**
798
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
799
+ *
800
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
801
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
802
+ * @returns {string} A string representing the data_store.
803
+ */
804
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
805
+ /**
806
+ * Parse the target_site from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
807
+ *
808
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
809
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
810
+ * @returns {string} A string representing the target_site.
811
+ */
812
+ matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
813
+ /**
814
+ * Return a fully-qualified projectLocationCollectionEngineConversation resource name string.
815
+ *
816
+ * @param {string} project
817
+ * @param {string} location
818
+ * @param {string} collection
819
+ * @param {string} engine
820
+ * @param {string} conversation
821
+ * @returns {string} Resource name string.
822
+ */
823
+ projectLocationCollectionEngineConversationPath(project: string, location: string, collection: string, engine: string, conversation: string): string;
824
+ /**
825
+ * Parse the project from ProjectLocationCollectionEngineConversation resource.
826
+ *
827
+ * @param {string} projectLocationCollectionEngineConversationName
828
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
829
+ * @returns {string} A string representing the project.
830
+ */
831
+ matchProjectFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
832
+ /**
833
+ * Parse the location from ProjectLocationCollectionEngineConversation resource.
834
+ *
835
+ * @param {string} projectLocationCollectionEngineConversationName
836
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
837
+ * @returns {string} A string representing the location.
838
+ */
839
+ matchLocationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
840
+ /**
841
+ * Parse the collection from ProjectLocationCollectionEngineConversation resource.
842
+ *
843
+ * @param {string} projectLocationCollectionEngineConversationName
844
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
845
+ * @returns {string} A string representing the collection.
846
+ */
847
+ matchCollectionFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
848
+ /**
849
+ * Parse the engine from ProjectLocationCollectionEngineConversation resource.
850
+ *
851
+ * @param {string} projectLocationCollectionEngineConversationName
852
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
853
+ * @returns {string} A string representing the engine.
854
+ */
855
+ matchEngineFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
856
+ /**
857
+ * Parse the conversation from ProjectLocationCollectionEngineConversation resource.
858
+ *
859
+ * @param {string} projectLocationCollectionEngineConversationName
860
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
861
+ * @returns {string} A string representing the conversation.
862
+ */
863
+ matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
678
864
  /**
679
865
  * Return a fully-qualified projectLocationDataStore resource name string.
680
866
  *
@@ -843,6 +1029,81 @@ export declare class UserEventServiceClient {
843
1029
  * @returns {string} A string representing the schema.
844
1030
  */
845
1031
  matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
1032
+ /**
1033
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.
1034
+ *
1035
+ * @param {string} project
1036
+ * @param {string} location
1037
+ * @param {string} data_store
1038
+ * @returns {string} Resource name string.
1039
+ */
1040
+ projectLocationDataStoreSiteSearchEnginePath(project: string, location: string, dataStore: string): string;
1041
+ /**
1042
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngine resource.
1043
+ *
1044
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1045
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1046
+ * @returns {string} A string representing the project.
1047
+ */
1048
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
1049
+ /**
1050
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngine resource.
1051
+ *
1052
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1053
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1054
+ * @returns {string} A string representing the location.
1055
+ */
1056
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
1057
+ /**
1058
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngine resource.
1059
+ *
1060
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1061
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1062
+ * @returns {string} A string representing the data_store.
1063
+ */
1064
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
1065
+ /**
1066
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
1067
+ *
1068
+ * @param {string} project
1069
+ * @param {string} location
1070
+ * @param {string} data_store
1071
+ * @param {string} target_site
1072
+ * @returns {string} Resource name string.
1073
+ */
1074
+ projectLocationDataStoreSiteSearchEngineTargetSitePath(project: string, location: string, dataStore: string, targetSite: string): string;
1075
+ /**
1076
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1077
+ *
1078
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1079
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1080
+ * @returns {string} A string representing the project.
1081
+ */
1082
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1083
+ /**
1084
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1085
+ *
1086
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1087
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1088
+ * @returns {string} A string representing the location.
1089
+ */
1090
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1091
+ /**
1092
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1093
+ *
1094
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1095
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1096
+ * @returns {string} A string representing the data_store.
1097
+ */
1098
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1099
+ /**
1100
+ * Parse the target_site from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1101
+ *
1102
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1103
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1104
+ * @returns {string} A string representing the target_site.
1105
+ */
1106
+ matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
846
1107
  /**
847
1108
  * Terminate the gRPC channel and close the client.
848
1109
  *