@google-cloud/discoveryengine 1.2.0 → 1.3.1

Sign up to get free protection for your applications and to get access to all the features.
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
@@ -553,6 +553,48 @@ export declare class SchemaServiceClient {
553
553
  * ```
554
554
  */
555
555
  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>;
556
+ /**
557
+ * Return a fully-qualified engine resource name string.
558
+ *
559
+ * @param {string} project
560
+ * @param {string} location
561
+ * @param {string} collection
562
+ * @param {string} engine
563
+ * @returns {string} Resource name string.
564
+ */
565
+ enginePath(project: string, location: string, collection: string, engine: string): string;
566
+ /**
567
+ * Parse the project from Engine resource.
568
+ *
569
+ * @param {string} engineName
570
+ * A fully-qualified path representing Engine resource.
571
+ * @returns {string} A string representing the project.
572
+ */
573
+ matchProjectFromEngineName(engineName: string): string | number;
574
+ /**
575
+ * Parse the location from Engine resource.
576
+ *
577
+ * @param {string} engineName
578
+ * A fully-qualified path representing Engine resource.
579
+ * @returns {string} A string representing the location.
580
+ */
581
+ matchLocationFromEngineName(engineName: string): string | number;
582
+ /**
583
+ * Parse the collection from Engine resource.
584
+ *
585
+ * @param {string} engineName
586
+ * A fully-qualified path representing Engine resource.
587
+ * @returns {string} A string representing the collection.
588
+ */
589
+ matchCollectionFromEngineName(engineName: string): string | number;
590
+ /**
591
+ * Parse the engine from Engine resource.
592
+ *
593
+ * @param {string} engineName
594
+ * A fully-qualified path representing Engine resource.
595
+ * @returns {string} A string representing the engine.
596
+ */
597
+ matchEngineFromEngineName(engineName: string): string | number;
556
598
  /**
557
599
  * Return a fully-qualified projectLocationCollectionDataStore resource name string.
558
600
  *
@@ -757,6 +799,150 @@ export declare class SchemaServiceClient {
757
799
  * @returns {string} A string representing the schema.
758
800
  */
759
801
  matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
802
+ /**
803
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.
804
+ *
805
+ * @param {string} project
806
+ * @param {string} location
807
+ * @param {string} collection
808
+ * @param {string} data_store
809
+ * @returns {string} Resource name string.
810
+ */
811
+ projectLocationCollectionDataStoreSiteSearchEnginePath(project: string, location: string, collection: string, dataStore: string): string;
812
+ /**
813
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
814
+ *
815
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
816
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
817
+ * @returns {string} A string representing the project.
818
+ */
819
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
820
+ /**
821
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
822
+ *
823
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
824
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
825
+ * @returns {string} A string representing the location.
826
+ */
827
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
828
+ /**
829
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
830
+ *
831
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
832
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
833
+ * @returns {string} A string representing the collection.
834
+ */
835
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
836
+ /**
837
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
838
+ *
839
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
840
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
841
+ * @returns {string} A string representing the data_store.
842
+ */
843
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
844
+ /**
845
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
846
+ *
847
+ * @param {string} project
848
+ * @param {string} location
849
+ * @param {string} collection
850
+ * @param {string} data_store
851
+ * @param {string} target_site
852
+ * @returns {string} Resource name string.
853
+ */
854
+ projectLocationCollectionDataStoreSiteSearchEngineTargetSitePath(project: string, location: string, collection: string, dataStore: string, targetSite: string): string;
855
+ /**
856
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
857
+ *
858
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
859
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
860
+ * @returns {string} A string representing the project.
861
+ */
862
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
863
+ /**
864
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
865
+ *
866
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
867
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
868
+ * @returns {string} A string representing the location.
869
+ */
870
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
871
+ /**
872
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
873
+ *
874
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
875
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
876
+ * @returns {string} A string representing the collection.
877
+ */
878
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
879
+ /**
880
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
881
+ *
882
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
883
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
884
+ * @returns {string} A string representing the data_store.
885
+ */
886
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
887
+ /**
888
+ * Parse the target_site from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
889
+ *
890
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
891
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
892
+ * @returns {string} A string representing the target_site.
893
+ */
894
+ matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
895
+ /**
896
+ * Return a fully-qualified projectLocationCollectionEngineConversation resource name string.
897
+ *
898
+ * @param {string} project
899
+ * @param {string} location
900
+ * @param {string} collection
901
+ * @param {string} engine
902
+ * @param {string} conversation
903
+ * @returns {string} Resource name string.
904
+ */
905
+ projectLocationCollectionEngineConversationPath(project: string, location: string, collection: string, engine: string, conversation: string): string;
906
+ /**
907
+ * Parse the project from ProjectLocationCollectionEngineConversation resource.
908
+ *
909
+ * @param {string} projectLocationCollectionEngineConversationName
910
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
911
+ * @returns {string} A string representing the project.
912
+ */
913
+ matchProjectFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
914
+ /**
915
+ * Parse the location from ProjectLocationCollectionEngineConversation resource.
916
+ *
917
+ * @param {string} projectLocationCollectionEngineConversationName
918
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
919
+ * @returns {string} A string representing the location.
920
+ */
921
+ matchLocationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
922
+ /**
923
+ * Parse the collection from ProjectLocationCollectionEngineConversation resource.
924
+ *
925
+ * @param {string} projectLocationCollectionEngineConversationName
926
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
927
+ * @returns {string} A string representing the collection.
928
+ */
929
+ matchCollectionFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
930
+ /**
931
+ * Parse the engine from ProjectLocationCollectionEngineConversation resource.
932
+ *
933
+ * @param {string} projectLocationCollectionEngineConversationName
934
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
935
+ * @returns {string} A string representing the engine.
936
+ */
937
+ matchEngineFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
938
+ /**
939
+ * Parse the conversation from ProjectLocationCollectionEngineConversation resource.
940
+ *
941
+ * @param {string} projectLocationCollectionEngineConversationName
942
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
943
+ * @returns {string} A string representing the conversation.
944
+ */
945
+ matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
760
946
  /**
761
947
  * Return a fully-qualified projectLocationDataStore resource name string.
762
948
  *
@@ -925,6 +1111,81 @@ export declare class SchemaServiceClient {
925
1111
  * @returns {string} A string representing the schema.
926
1112
  */
927
1113
  matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
1114
+ /**
1115
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.
1116
+ *
1117
+ * @param {string} project
1118
+ * @param {string} location
1119
+ * @param {string} data_store
1120
+ * @returns {string} Resource name string.
1121
+ */
1122
+ projectLocationDataStoreSiteSearchEnginePath(project: string, location: string, dataStore: string): string;
1123
+ /**
1124
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngine resource.
1125
+ *
1126
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1127
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1128
+ * @returns {string} A string representing the project.
1129
+ */
1130
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
1131
+ /**
1132
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngine resource.
1133
+ *
1134
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1135
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1136
+ * @returns {string} A string representing the location.
1137
+ */
1138
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
1139
+ /**
1140
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngine resource.
1141
+ *
1142
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1143
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1144
+ * @returns {string} A string representing the data_store.
1145
+ */
1146
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
1147
+ /**
1148
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
1149
+ *
1150
+ * @param {string} project
1151
+ * @param {string} location
1152
+ * @param {string} data_store
1153
+ * @param {string} target_site
1154
+ * @returns {string} Resource name string.
1155
+ */
1156
+ projectLocationDataStoreSiteSearchEngineTargetSitePath(project: string, location: string, dataStore: string, targetSite: string): string;
1157
+ /**
1158
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1159
+ *
1160
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1161
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1162
+ * @returns {string} A string representing the project.
1163
+ */
1164
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1165
+ /**
1166
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1167
+ *
1168
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1169
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1170
+ * @returns {string} A string representing the location.
1171
+ */
1172
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1173
+ /**
1174
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1175
+ *
1176
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1177
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1178
+ * @returns {string} A string representing the data_store.
1179
+ */
1180
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1181
+ /**
1182
+ * Parse the target_site from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1183
+ *
1184
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1185
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1186
+ * @returns {string} A string representing the target_site.
1187
+ */
1188
+ matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
928
1189
  /**
929
1190
  * Terminate the gRPC channel and close the client.
930
1191
  *