@google-cloud/discoveryengine 1.12.0 → 1.13.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 (45) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +4 -0
  3. package/build/protos/google/cloud/discoveryengine/v1alpha/answer.proto +55 -2
  4. package/build/protos/google/cloud/discoveryengine/v1alpha/chunk.proto +1 -1
  5. package/build/protos/google/cloud/discoveryengine/v1alpha/completion.proto +31 -0
  6. package/build/protos/google/cloud/discoveryengine/v1alpha/completion_service.proto +38 -0
  7. package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +28 -9
  8. package/build/protos/google/cloud/discoveryengine/v1alpha/custom_tuning_model.proto +7 -1
  9. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store.proto +23 -0
  10. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store_service.proto +11 -1
  11. package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +4 -1
  12. package/build/protos/google/cloud/discoveryengine/v1alpha/document_processing_config.proto +6 -2
  13. package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +1 -1
  14. package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +114 -0
  15. package/build/protos/google/cloud/discoveryengine/v1alpha/purge_config.proto +57 -0
  16. package/build/protos/google/cloud/discoveryengine/v1alpha/schema.proto +5 -0
  17. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +407 -11
  18. package/build/protos/google/cloud/discoveryengine/v1alpha/serving_config.proto +14 -5
  19. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +126 -0
  20. package/build/protos/google/cloud/discoveryengine/v1alpha/user_event_service.proto +3 -0
  21. package/build/protos/protos.d.ts +3703 -219
  22. package/build/protos/protos.js +35486 -26672
  23. package/build/protos/protos.json +844 -46
  24. package/build/src/v1alpha/completion_service_client.d.ts +91 -0
  25. package/build/src/v1alpha/completion_service_client.js +90 -0
  26. package/build/src/v1alpha/completion_service_client_config.json +10 -0
  27. package/build/src/v1alpha/conversational_search_service_client.d.ts +18 -0
  28. package/build/src/v1alpha/data_store_service_client.d.ts +12 -3
  29. package/build/src/v1alpha/data_store_service_client.js +8 -2
  30. package/build/src/v1alpha/document_service_client.d.ts +4 -0
  31. package/build/src/v1alpha/document_service_client.js +6 -0
  32. package/build/src/v1alpha/engine_service_client.js +6 -0
  33. package/build/src/v1alpha/estimate_billing_service_client.js +6 -0
  34. package/build/src/v1alpha/evaluation_service_client.js +6 -0
  35. package/build/src/v1alpha/project_service_client.js +6 -0
  36. package/build/src/v1alpha/sample_query_service_client.js +6 -0
  37. package/build/src/v1alpha/schema_service_client.js +6 -0
  38. package/build/src/v1alpha/search_service_client.d.ts +219 -21
  39. package/build/src/v1alpha/search_service_client.js +146 -14
  40. package/build/src/v1alpha/search_tuning_service_client.js +6 -0
  41. package/build/src/v1alpha/site_search_engine_service_client.d.ts +101 -0
  42. package/build/src/v1alpha/site_search_engine_service_client.js +70 -0
  43. package/build/src/v1alpha/site_search_engine_service_client_config.json +8 -0
  44. package/build/src/v1alpha/user_event_service_client.js +6 -0
  45. package/package.json +2 -2
@@ -23,6 +23,7 @@ import "google/api/resource.proto";
23
23
  import "google/cloud/discoveryengine/v1alpha/site_search_engine.proto";
24
24
  import "google/longrunning/operations.proto";
25
25
  import "google/protobuf/empty.proto";
26
+ import "google/protobuf/struct.proto";
26
27
  import "google/protobuf/timestamp.proto";
27
28
 
28
29
  option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
@@ -221,6 +222,29 @@ service SiteSearchEngineService {
221
222
  get: "/v1alpha/{site_search_engine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:fetchDomainVerificationStatus"
222
223
  };
223
224
  }
225
+
226
+ // Sets the URI Pattern to Document data mapping for an Advanced Site Search
227
+ // DataStore.
228
+ rpc SetUriPatternDocumentData(SetUriPatternDocumentDataRequest)
229
+ returns (google.longrunning.Operation) {
230
+ option (google.api.http) = {
231
+ post: "/v1alpha/{site_search_engine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:setUriPatternDocumentData"
232
+ body: "*"
233
+ };
234
+ option (google.longrunning.operation_info) = {
235
+ response_type: "google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataResponse"
236
+ metadata_type: "google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataMetadata"
237
+ };
238
+ }
239
+
240
+ // Gets the URI Pattern to Document data mapping for an Advanced Site Search
241
+ // DataStore.
242
+ rpc GetUriPatternDocumentData(GetUriPatternDocumentDataRequest)
243
+ returns (GetUriPatternDocumentDataResponse) {
244
+ option (google.api.http) = {
245
+ get: "/v1alpha/{site_search_engine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:getUriPatternDocumentData"
246
+ };
247
+ }
224
248
  }
225
249
 
226
250
  // Request message for
@@ -693,3 +717,105 @@ message FetchDomainVerificationStatusResponse {
693
717
  // This will always be populated in the response.
694
718
  int32 total_size = 3;
695
719
  }
720
+
721
+ // Request message for
722
+ // [SiteSearchEngineService.SetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.SetUriPatternDocumentData]
723
+ // method.
724
+ message SetUriPatternDocumentDataRequest {
725
+ // Required. Full resource name of the
726
+ // [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine],
727
+ // such as
728
+ // `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.
729
+ string site_search_engine = 1 [
730
+ (google.api.field_behavior) = REQUIRED,
731
+ (google.api.resource_reference) = {
732
+ type: "discoveryengine.googleapis.com/SiteSearchEngine"
733
+ }
734
+ ];
735
+
736
+ // Document data keyed by URI pattern. Each entry must be consistent with
737
+ // the [Schema][google.cloud.discoveryengine.v1alpha.Schema]. For example:
738
+ // [Schema][google.cloud.discoveryengine.v1alpha.Schema] = {
739
+ // "type": "object",
740
+ // "properties": {
741
+ // "Categories": {
742
+ // "type": "array",
743
+ // "items": {
744
+ // "retrievable": true,
745
+ // "type": "string"
746
+ // }
747
+ // }
748
+ // }
749
+ //
750
+ // document_data_map = {
751
+ // "www.url1.com/*": {
752
+ // "Categories": ["category1", "category2"]
753
+ // },
754
+ // "www.url2.com/*": {
755
+ // "Categories": ["category3"]
756
+ // }
757
+ // }
758
+ map<string, google.protobuf.Struct> document_data_map = 2;
759
+
760
+ // If true, clears the document data map. If true,
761
+ // [SetUriPatternDocumentDataRequest.document_data_map][google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataRequest.document_data_map]
762
+ // must be empty.
763
+ bool empty_document_data_map = 4;
764
+
765
+ // Optional. If not provided, the current
766
+ // [Schema][google.cloud.discoveryengine.v1alpha.Schema] is used. If provided,
767
+ // validates and updates the
768
+ // [Schema][google.cloud.discoveryengine.v1alpha.Schema]. If validation fails,
769
+ // an error is returned.
770
+ google.protobuf.Struct schema = 3;
771
+ }
772
+
773
+ // Response message for
774
+ // [SiteSearchEngineService.SetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.SetUriPatternDocumentData]
775
+ // method.
776
+ message SetUriPatternDocumentDataResponse {}
777
+
778
+ // Metadata related to the progress of the
779
+ // [SiteSearchEngineService.SetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.SetUriPatternDocumentData]
780
+ // operation. This will be returned by the google.longrunning.Operation.metadata
781
+ // field.
782
+ message SetUriPatternDocumentDataMetadata {
783
+ // Operation create time.
784
+ google.protobuf.Timestamp create_time = 1;
785
+
786
+ // Operation last update time. If the operation is done, this is also the
787
+ // finish time.
788
+ google.protobuf.Timestamp update_time = 2;
789
+ }
790
+
791
+ // Request message for
792
+ // [SiteSearchEngineService.GetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetUriPatternDocumentData]
793
+ // method.
794
+ message GetUriPatternDocumentDataRequest {
795
+ // Required. Full resource name of the
796
+ // [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine],
797
+ // such as
798
+ // `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.
799
+ string site_search_engine = 1 [
800
+ (google.api.field_behavior) = REQUIRED,
801
+ (google.api.resource_reference) = {
802
+ type: "discoveryengine.googleapis.com/SiteSearchEngine"
803
+ }
804
+ ];
805
+ }
806
+
807
+ // Response message for
808
+ // [SiteSearchEngineService.GetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetUriPatternDocumentData]
809
+ // method.
810
+ message GetUriPatternDocumentDataResponse {
811
+ // Document data keyed by URI pattern. For example:
812
+ // document_data_map = {
813
+ // "www.url1.com/*": {
814
+ // "Categories": ["category1", "category2"]
815
+ // },
816
+ // "www.url2.com/*": {
817
+ // "Categories": ["category3"]
818
+ // }
819
+ // }
820
+ map<string, google.protobuf.Struct> document_data_map = 1;
821
+ }
@@ -68,6 +68,9 @@ service UserEventService {
68
68
  additional_bindings {
69
69
  get: "/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:collect"
70
70
  }
71
+ additional_bindings {
72
+ get: "/v1alpha/{parent=projects/*/locations/*}/userEvents:collect"
73
+ }
71
74
  };
72
75
  }
73
76