@google-cloud/discoveryengine 1.1.0 → 1.2.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 (49) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +26 -0
  3. package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +155 -0
  4. package/build/protos/google/cloud/discoveryengine/v1alpha/completion_service.proto +134 -0
  5. package/build/protos/google/cloud/discoveryengine/v1alpha/conversation.proto +138 -0
  6. package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +306 -0
  7. package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +121 -0
  8. package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +318 -0
  9. package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +343 -0
  10. package/build/protos/google/cloud/discoveryengine/v1alpha/purge_config.proto +159 -0
  11. package/build/protos/google/cloud/discoveryengine/v1alpha/recommendation_service.proto +221 -0
  12. package/build/protos/google/cloud/discoveryengine/v1alpha/schema.proto +312 -0
  13. package/build/protos/google/cloud/discoveryengine/v1alpha/schema_service.proto +260 -0
  14. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +851 -0
  15. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +152 -0
  16. package/build/protos/google/cloud/discoveryengine/v1alpha/user_event.proto +475 -0
  17. package/build/protos/google/cloud/discoveryengine/v1alpha/user_event_service.proto +154 -0
  18. package/build/protos/protos.d.ts +12587 -7
  19. package/build/protos/protos.js +34918 -3126
  20. package/build/protos/protos.json +3458 -5
  21. package/build/src/index.d.ts +3 -1
  22. package/build/src/index.js +4 -1
  23. package/build/src/v1alpha/completion_service_client.d.ts +603 -0
  24. package/build/src/v1alpha/completion_service_client.js +843 -0
  25. package/build/src/v1alpha/completion_service_client_config.json +43 -0
  26. package/build/src/v1alpha/conversational_search_service_client.d.ts +998 -0
  27. package/build/src/v1alpha/conversational_search_service_client.js +1275 -0
  28. package/build/src/v1alpha/conversational_search_service_client_config.json +68 -0
  29. package/build/src/v1alpha/document_service_client.d.ts +1140 -0
  30. package/build/src/v1alpha/document_service_client.js +1393 -0
  31. package/build/src/v1alpha/document_service_client_config.json +82 -0
  32. package/build/src/v1alpha/index.d.ts +8 -0
  33. package/build/src/v1alpha/index.js +37 -0
  34. package/build/src/v1alpha/recommendation_service_client.d.ts +735 -0
  35. package/build/src/v1alpha/recommendation_service_client.js +938 -0
  36. package/build/src/v1alpha/recommendation_service_client_config.json +43 -0
  37. package/build/src/v1alpha/schema_service_client.d.ts +935 -0
  38. package/build/src/v1alpha/schema_service_client.js +1327 -0
  39. package/build/src/v1alpha/schema_service_client_config.json +63 -0
  40. package/build/src/v1alpha/search_service_client.d.ts +1208 -0
  41. package/build/src/v1alpha/search_service_client.js +1432 -0
  42. package/build/src/v1alpha/search_service_client_config.json +43 -0
  43. package/build/src/v1alpha/site_search_engine_service_client.d.ts +704 -0
  44. package/build/src/v1alpha/site_search_engine_service_client.js +1087 -0
  45. package/build/src/v1alpha/site_search_engine_service_client_config.json +30 -0
  46. package/build/src/v1alpha/user_event_service_client.d.ts +853 -0
  47. package/build/src/v1alpha/user_event_service_client.js +1174 -0
  48. package/build/src/v1alpha/user_event_service_client_config.json +67 -0
  49. package/package.json +3 -3
@@ -0,0 +1,154 @@
1
+ // Copyright 2022 Google LLC
2
+ //
3
+ // Licensed under the Apache License, Version 2.0 (the "License");
4
+ // you may not use this file except in compliance with the License.
5
+ // You may obtain a copy of the License at
6
+ //
7
+ // http://www.apache.org/licenses/LICENSE-2.0
8
+ //
9
+ // Unless required by applicable law or agreed to in writing, software
10
+ // distributed under the License is distributed on an "AS IS" BASIS,
11
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ // See the License for the specific language governing permissions and
13
+ // limitations under the License.
14
+
15
+ syntax = "proto3";
16
+
17
+ package google.cloud.discoveryengine.v1alpha;
18
+
19
+ import "google/api/annotations.proto";
20
+ import "google/api/client.proto";
21
+ import "google/api/field_behavior.proto";
22
+ import "google/api/httpbody.proto";
23
+ import "google/api/resource.proto";
24
+ import "google/cloud/discoveryengine/v1alpha/import_config.proto";
25
+ import "google/cloud/discoveryengine/v1alpha/purge_config.proto";
26
+ import "google/cloud/discoveryengine/v1alpha/user_event.proto";
27
+ import "google/longrunning/operations.proto";
28
+
29
+ option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
30
+ option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
31
+ option java_multiple_files = true;
32
+ option java_outer_classname = "UserEventServiceProto";
33
+ option java_package = "com.google.cloud.discoveryengine.v1alpha";
34
+ option objc_class_prefix = "DISCOVERYENGINE";
35
+ option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1alpha";
36
+ option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
37
+
38
+ // Service for ingesting end user actions on a website to Discovery Engine API.
39
+ service UserEventService {
40
+ option (google.api.default_host) = "discoveryengine.googleapis.com";
41
+ option (google.api.oauth_scopes) =
42
+ "https://www.googleapis.com/auth/cloud-platform";
43
+
44
+ // Writes a single user event.
45
+ rpc WriteUserEvent(WriteUserEventRequest) returns (UserEvent) {
46
+ option (google.api.http) = {
47
+ post: "/v1alpha/{parent=projects/*/locations/*/dataStores/*}/userEvents:write"
48
+ body: "user_event"
49
+ additional_bindings {
50
+ post: "/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:write"
51
+ body: "user_event"
52
+ }
53
+ };
54
+ }
55
+
56
+ // Writes a single user event from the browser. This uses a GET request to
57
+ // due to browser restriction of POST-ing to a third-party domain.
58
+ //
59
+ // This method is used only by the Discovery Engine API JavaScript pixel and
60
+ // Google Tag Manager. Users should not call this method directly.
61
+ rpc CollectUserEvent(CollectUserEventRequest) returns (google.api.HttpBody) {
62
+ option (google.api.http) = {
63
+ get: "/v1alpha/{parent=projects/*/locations/*/dataStores/*}/userEvents:collect"
64
+ additional_bindings {
65
+ get: "/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:collect"
66
+ }
67
+ };
68
+ }
69
+
70
+ // Deletes permanently all user events specified by the filter provided.
71
+ // Depending on the number of events specified by the filter, this operation
72
+ // could take hours or days to complete. To test a filter, use the list
73
+ // command first.
74
+ rpc PurgeUserEvents(PurgeUserEventsRequest)
75
+ returns (google.longrunning.Operation) {
76
+ option (google.api.http) = {
77
+ post: "/v1alpha/{parent=projects/*/locations/*/dataStores/*}/userEvents:purge"
78
+ body: "*"
79
+ additional_bindings {
80
+ post: "/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:purge"
81
+ body: "*"
82
+ }
83
+ };
84
+ option (google.longrunning.operation_info) = {
85
+ response_type: "google.cloud.discoveryengine.v1alpha.PurgeUserEventsResponse"
86
+ metadata_type: "google.cloud.discoveryengine.v1alpha.PurgeUserEventsMetadata"
87
+ };
88
+ }
89
+
90
+ // Bulk import of User events. Request processing might be
91
+ // synchronous. Events that already exist are skipped.
92
+ // Use this method for backfilling historical user events.
93
+ //
94
+ // Operation.response is of type ImportResponse. Note that it is
95
+ // possible for a subset of the items to be successfully inserted.
96
+ // Operation.metadata is of type ImportMetadata.
97
+ rpc ImportUserEvents(ImportUserEventsRequest)
98
+ returns (google.longrunning.Operation) {
99
+ option (google.api.http) = {
100
+ post: "/v1alpha/{parent=projects/*/locations/*/dataStores/*}/userEvents:import"
101
+ body: "*"
102
+ additional_bindings {
103
+ post: "/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:import"
104
+ body: "*"
105
+ }
106
+ };
107
+ option (google.longrunning.operation_info) = {
108
+ response_type: "google.cloud.discoveryengine.v1alpha.ImportUserEventsResponse"
109
+ metadata_type: "google.cloud.discoveryengine.v1alpha.ImportUserEventsMetadata"
110
+ };
111
+ }
112
+ }
113
+
114
+ // Request message for WriteUserEvent method.
115
+ message WriteUserEventRequest {
116
+ // Required. The parent DataStore resource name, such as
117
+ // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
118
+ string parent = 1 [
119
+ (google.api.field_behavior) = REQUIRED,
120
+ (google.api.resource_reference) = {
121
+ type: "discoveryengine.googleapis.com/DataStore"
122
+ }
123
+ ];
124
+
125
+ // Required. User event to write.
126
+ optional UserEvent user_event = 2 [(google.api.field_behavior) = REQUIRED];
127
+ }
128
+
129
+ // Request message for CollectUserEvent method.
130
+ message CollectUserEventRequest {
131
+ // Required. The parent DataStore resource name, such as
132
+ // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
133
+ string parent = 1 [
134
+ (google.api.field_behavior) = REQUIRED,
135
+ (google.api.resource_reference) = {
136
+ type: "discoveryengine.googleapis.com/DataStore"
137
+ }
138
+ ];
139
+
140
+ // Required. URL encoded UserEvent proto with a length limit of 2,000,000
141
+ // characters.
142
+ string user_event = 2 [(google.api.field_behavior) = REQUIRED];
143
+
144
+ // The URL including cgi-parameters but excluding the hash fragment with a
145
+ // length limit of 5,000 characters. This is often more useful than the
146
+ // referer URL, because many browsers only send the domain for third-party
147
+ // requests.
148
+ optional string uri = 3;
149
+
150
+ // The event timestamp in milliseconds. This prevents browser caching of
151
+ // otherwise identical get requests. The name is abbreviated to reduce the
152
+ // payload bytes.
153
+ optional int64 ets = 4;
154
+ }