@google-cloud/discoveryengine 0.3.0 → 0.4.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.
- package/CHANGELOG.md +14 -0
- package/README.md +4 -5
- package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +4 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +5 -4
- package/build/protos/google/cloud/discoveryengine/v1beta/document_service.proto +26 -5
- package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +14 -13
- package/build/protos/google/cloud/discoveryengine/v1beta/recommendation_service.proto +8 -4
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +16 -10
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event_service.proto +14 -3
- package/build/protos/protos.d.ts +1493 -0
- package/build/protos/protos.js +3853 -0
- package/build/protos/protos.json +362 -21
- package/build/src/v1beta/document_service_client.d.ts +180 -71
- package/build/src/v1beta/document_service_client.js +249 -76
- package/build/src/v1beta/document_service_client.js.map +1 -1
- package/build/src/v1beta/recommendation_service_client.d.ts +155 -44
- package/build/src/v1beta/recommendation_service_client.js +205 -58
- package/build/src/v1beta/recommendation_service_client.js.map +1 -1
- package/build/src/v1beta/user_event_service_client.d.ts +158 -58
- package/build/src/v1beta/user_event_service_client.js +228 -70
- package/build/src/v1beta/user_event_service_client.js.map +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
@@ -1,5 +1,19 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## [0.4.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v0.3.1...discoveryengine-v0.4.0) (2023-03-28)
|
4
|
+
|
5
|
+
|
6
|
+
### Features
|
7
|
+
|
8
|
+
* [discoveryengine] add additional resource path with collections ([#4120](https://github.com/googleapis/google-cloud-node/issues/4120)) ([0fe6ff4](https://github.com/googleapis/google-cloud-node/commit/0fe6ff44b808fa9afc4c452402bc013805f74a97))
|
9
|
+
|
10
|
+
## [0.3.1](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v0.3.0...discoveryengine-v0.3.1) (2023-02-15)
|
11
|
+
|
12
|
+
|
13
|
+
### Bug Fixes
|
14
|
+
|
15
|
+
* [Many APIs] changing format of the jsdoc links ([#3987](https://github.com/googleapis/google-cloud-node/issues/3987)) ([07043a6](https://github.com/googleapis/google-cloud-node/commit/07043a629545ad418f33f90f9f96147a136e1728))
|
16
|
+
|
3
17
|
## [0.3.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v0.2.0...discoveryengine-v0.3.0) (2023-01-28)
|
4
18
|
|
5
19
|
|
package/README.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
# [Discovery Engine API: Node.js Client](https://github.com/googleapis/google-cloud-node)
|
6
6
|
|
7
|
-
[](https://cloud.google.com/terms/launch-stages)
|
8
8
|
[](https://www.npmjs.org/package/@google-cloud/discoveryengine)
|
9
9
|
|
10
10
|
|
@@ -171,13 +171,12 @@ This library follows [Semantic Versioning](http://semver.org/).
|
|
171
171
|
|
172
172
|
|
173
173
|
|
174
|
-
This library is considered to be in **beta**. This means it is expected to be
|
175
|
-
mostly stable while we work toward a general availability release; however,
|
176
|
-
complete stability is not guaranteed. We will address issues and requests
|
177
|
-
against beta libraries with a high priority.
|
178
174
|
|
179
175
|
|
180
176
|
|
177
|
+
This library is considered to be in **preview**. This means it is still a
|
178
|
+
work-in-progress and under active development. Any release is subject to
|
179
|
+
backwards-incompatible changes at any time.
|
181
180
|
|
182
181
|
|
183
182
|
More Information: [Google Cloud Platform Launch Stages][launch_stages]
|
@@ -19,7 +19,7 @@ package google.cloud.discoveryengine.v1beta;
|
|
19
19
|
import "google/api/resource.proto";
|
20
20
|
|
21
21
|
option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
|
22
|
-
option go_package = "google.
|
22
|
+
option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
|
23
23
|
option java_multiple_files = true;
|
24
24
|
option java_outer_classname = "CommonProto";
|
25
25
|
option java_package = "com.google.cloud.discoveryengine.v1beta";
|
@@ -29,14 +29,17 @@ option ruby_package = "Google::Cloud::DiscoveryEngine::V1beta";
|
|
29
29
|
option (google.api.resource_definition) = {
|
30
30
|
type: "discoveryengine.googleapis.com/Branch"
|
31
31
|
pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}"
|
32
|
+
pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}"
|
32
33
|
};
|
33
34
|
option (google.api.resource_definition) = {
|
34
35
|
type: "discoveryengine.googleapis.com/DataStore"
|
35
36
|
pattern: "projects/{project}/locations/{location}/dataStores/{data_store}"
|
37
|
+
pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}"
|
36
38
|
};
|
37
39
|
option (google.api.resource_definition) = {
|
38
40
|
type: "discoveryengine.googleapis.com/ServingConfig"
|
39
41
|
pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}"
|
42
|
+
pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}"
|
40
43
|
};
|
41
44
|
|
42
45
|
// A custom attribute that is not explicitly modeled in a resource, e.g.
|
@@ -21,7 +21,7 @@ import "google/api/resource.proto";
|
|
21
21
|
import "google/protobuf/struct.proto";
|
22
22
|
|
23
23
|
option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
|
24
|
-
option go_package = "google.
|
24
|
+
option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
|
25
25
|
option java_multiple_files = true;
|
26
26
|
option java_outer_classname = "DocumentProto";
|
27
27
|
option java_package = "com.google.cloud.discoveryengine.v1beta";
|
@@ -35,6 +35,7 @@ message Document {
|
|
35
35
|
option (google.api.resource) = {
|
36
36
|
type: "discoveryengine.googleapis.com/Document"
|
37
37
|
pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}"
|
38
|
+
pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}"
|
38
39
|
};
|
39
40
|
|
40
41
|
// Data representation. One of
|
@@ -53,7 +54,7 @@ message Document {
|
|
53
54
|
|
54
55
|
// Immutable. The full resource name of the document.
|
55
56
|
// Format:
|
56
|
-
// `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
|
57
|
+
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
|
57
58
|
//
|
58
59
|
// This field must be a UTF-8 encoded string with a length limit of 1024
|
59
60
|
// characters.
|
@@ -65,8 +66,8 @@ message Document {
|
|
65
66
|
// standard with a length limit of 63 characters.
|
66
67
|
string id = 2 [(google.api.field_behavior) = IMMUTABLE];
|
67
68
|
|
68
|
-
//
|
69
|
-
string schema_id = 3
|
69
|
+
// The identifier of the schema located in the same data store.
|
70
|
+
string schema_id = 3;
|
70
71
|
|
71
72
|
// The identifier of the parent document. Currently supports at most two level
|
72
73
|
// document hierarchy.
|
@@ -26,7 +26,7 @@ import "google/longrunning/operations.proto";
|
|
26
26
|
import "google/protobuf/empty.proto";
|
27
27
|
|
28
28
|
option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
|
29
|
-
option go_package = "google.
|
29
|
+
option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
|
30
30
|
option java_multiple_files = true;
|
31
31
|
option java_outer_classname = "DocumentServiceProto";
|
32
32
|
option java_package = "com.google.cloud.discoveryengine.v1beta";
|
@@ -46,6 +46,9 @@ service DocumentService {
|
|
46
46
|
rpc GetDocument(GetDocumentRequest) returns (Document) {
|
47
47
|
option (google.api.http) = {
|
48
48
|
get: "/v1beta/{name=projects/*/locations/*/dataStores/*/branches/*/documents/*}"
|
49
|
+
additional_bindings {
|
50
|
+
get: "/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*}"
|
51
|
+
}
|
49
52
|
};
|
50
53
|
option (google.api.method_signature) = "name";
|
51
54
|
}
|
@@ -54,6 +57,9 @@ service DocumentService {
|
|
54
57
|
rpc ListDocuments(ListDocumentsRequest) returns (ListDocumentsResponse) {
|
55
58
|
option (google.api.http) = {
|
56
59
|
get: "/v1beta/{parent=projects/*/locations/*/dataStores/*/branches/*}/documents"
|
60
|
+
additional_bindings {
|
61
|
+
get: "/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/documents"
|
62
|
+
}
|
57
63
|
};
|
58
64
|
option (google.api.method_signature) = "parent";
|
59
65
|
}
|
@@ -63,6 +69,10 @@ service DocumentService {
|
|
63
69
|
option (google.api.http) = {
|
64
70
|
post: "/v1beta/{parent=projects/*/locations/*/dataStores/*/branches/*}/documents"
|
65
71
|
body: "document"
|
72
|
+
additional_bindings {
|
73
|
+
post: "/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/documents"
|
74
|
+
body: "document"
|
75
|
+
}
|
66
76
|
};
|
67
77
|
option (google.api.method_signature) = "parent,document,document_id";
|
68
78
|
}
|
@@ -72,6 +82,10 @@ service DocumentService {
|
|
72
82
|
option (google.api.http) = {
|
73
83
|
patch: "/v1beta/{document.name=projects/*/locations/*/dataStores/*/branches/*/documents/*}"
|
74
84
|
body: "document"
|
85
|
+
additional_bindings {
|
86
|
+
patch: "/v1beta/{document.name=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*}"
|
87
|
+
body: "document"
|
88
|
+
}
|
75
89
|
};
|
76
90
|
}
|
77
91
|
|
@@ -79,6 +93,9 @@ service DocumentService {
|
|
79
93
|
rpc DeleteDocument(DeleteDocumentRequest) returns (google.protobuf.Empty) {
|
80
94
|
option (google.api.http) = {
|
81
95
|
delete: "/v1beta/{name=projects/*/locations/*/dataStores/*/branches/*/documents/*}"
|
96
|
+
additional_bindings {
|
97
|
+
delete: "/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*}"
|
98
|
+
}
|
82
99
|
};
|
83
100
|
option (google.api.method_signature) = "name";
|
84
101
|
}
|
@@ -95,6 +112,10 @@ service DocumentService {
|
|
95
112
|
option (google.api.http) = {
|
96
113
|
post: "/v1beta/{parent=projects/*/locations/*/dataStores/*/branches/*}/documents:import"
|
97
114
|
body: "*"
|
115
|
+
additional_bindings {
|
116
|
+
post: "/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/documents:import"
|
117
|
+
body: "*"
|
118
|
+
}
|
98
119
|
};
|
99
120
|
option (google.longrunning.operation_info) = {
|
100
121
|
response_type: "google.cloud.discoveryengine.v1beta.ImportDocumentsResponse"
|
@@ -109,7 +130,7 @@ service DocumentService {
|
|
109
130
|
message GetDocumentRequest {
|
110
131
|
// Required. Full resource name of
|
111
132
|
// [Document][google.cloud.discoveryengine.v1beta.Document], such as
|
112
|
-
// `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
|
133
|
+
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
|
113
134
|
//
|
114
135
|
// If the caller does not have permission to access the
|
115
136
|
// [Document][google.cloud.discoveryengine.v1beta.Document], regardless of
|
@@ -130,7 +151,7 @@ message GetDocumentRequest {
|
|
130
151
|
// method.
|
131
152
|
message ListDocumentsRequest {
|
132
153
|
// Required. The parent branch resource name, such as
|
133
|
-
// `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}`.
|
154
|
+
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
|
134
155
|
// Use `default_branch` as the branch ID, to list documents under the default
|
135
156
|
// branch.
|
136
157
|
//
|
@@ -183,7 +204,7 @@ message ListDocumentsResponse {
|
|
183
204
|
// method.
|
184
205
|
message CreateDocumentRequest {
|
185
206
|
// Required. The parent resource name, such as
|
186
|
-
// `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}`.
|
207
|
+
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
|
187
208
|
string parent = 1 [
|
188
209
|
(google.api.field_behavior) = REQUIRED,
|
189
210
|
(google.api.resource_reference) = {
|
@@ -244,7 +265,7 @@ message UpdateDocumentRequest {
|
|
244
265
|
message DeleteDocumentRequest {
|
245
266
|
// Required. Full resource name of
|
246
267
|
// [Document][google.cloud.discoveryengine.v1beta.Document], such as
|
247
|
-
// `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
|
268
|
+
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
|
248
269
|
//
|
249
270
|
// If the caller does not have permission to delete the
|
250
271
|
// [Document][google.cloud.discoveryengine.v1beta.Document], regardless of
|
@@ -25,7 +25,7 @@ import "google/rpc/status.proto";
|
|
25
25
|
import "google/type/date.proto";
|
26
26
|
|
27
27
|
option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
|
28
|
-
option go_package = "google.
|
28
|
+
option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
|
29
29
|
option java_multiple_files = true;
|
30
30
|
option java_outer_classname = "ImportConfigProto";
|
31
31
|
option java_package = "com.google.cloud.discoveryengine.v1beta";
|
@@ -33,10 +33,9 @@ option objc_class_prefix = "DISCOVERYENGINE";
|
|
33
33
|
option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1beta";
|
34
34
|
option ruby_package = "Google::Cloud::DiscoveryEngine::V1beta";
|
35
35
|
|
36
|
-
//
|
37
|
-
// format.
|
36
|
+
// Cloud Storage location for input content.
|
38
37
|
message GcsSource {
|
39
|
-
// Required.
|
38
|
+
// Required. Cloud Storage URIs to input files. URI can be up to
|
40
39
|
// 2000 characters long. URIs can match the full object path (for example,
|
41
40
|
// `gs://bucket/directory/object.json`) or a pattern matching one or more
|
42
41
|
// files, such as `gs://bucket/directory/*.json`. A request can
|
@@ -45,16 +44,18 @@ message GcsSource {
|
|
45
44
|
|
46
45
|
// The schema to use when parsing the data from the source.
|
47
46
|
//
|
48
|
-
// Supported values for imports:
|
49
|
-
//
|
50
|
-
// * `user_event` (default): One JSON
|
51
|
-
// [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] per line.
|
47
|
+
// Supported values for document imports:
|
52
48
|
//
|
53
49
|
// * `document` (default): One JSON
|
54
50
|
// [Document][google.cloud.discoveryengine.v1beta.Document] per line. Each
|
55
51
|
// document must
|
56
52
|
// have a valid
|
57
53
|
// [Document.id][google.cloud.discoveryengine.v1beta.Document.id].
|
54
|
+
//
|
55
|
+
// Supported values for user even imports:
|
56
|
+
//
|
57
|
+
// * `user_event` (default): One JSON
|
58
|
+
// [UserEvent][google.cloud.discoveryengine.v1beta.UserEvent] per line.
|
58
59
|
string data_schema = 2;
|
59
60
|
}
|
60
61
|
|
@@ -102,7 +103,7 @@ message BigQuerySource {
|
|
102
103
|
message ImportErrorConfig {
|
103
104
|
// Required. Errors destination.
|
104
105
|
oneof destination {
|
105
|
-
//
|
106
|
+
// Cloud Storage prefix for import errors. This must be an empty,
|
106
107
|
// existing Cloud Storage directory. Import errors will be written to
|
107
108
|
// sharded files in this directory, one per line, as a JSON-encoded
|
108
109
|
// `google.rpc.Status` message.
|
@@ -123,7 +124,7 @@ message ImportUserEventsRequest {
|
|
123
124
|
// Required. The Inline source for the input content for UserEvents.
|
124
125
|
InlineSource inline_source = 2 [(google.api.field_behavior) = REQUIRED];
|
125
126
|
|
126
|
-
// Required.
|
127
|
+
// Required. Cloud Storage location for the input content.
|
127
128
|
GcsSource gcs_source = 3 [(google.api.field_behavior) = REQUIRED];
|
128
129
|
|
129
130
|
// Required. BigQuery input source.
|
@@ -131,7 +132,7 @@ message ImportUserEventsRequest {
|
|
131
132
|
}
|
132
133
|
|
133
134
|
// Required. Parent DataStore resource name, of the form
|
134
|
-
// `projects/{project}/locations/{location}/dataStores/{data_store}`
|
135
|
+
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
|
135
136
|
string parent = 1 [
|
136
137
|
(google.api.field_behavior) = REQUIRED,
|
137
138
|
(google.api.resource_reference) = {
|
@@ -226,7 +227,7 @@ message ImportDocumentsRequest {
|
|
226
227
|
// The Inline source for the input content for documents.
|
227
228
|
InlineSource inline_source = 2;
|
228
229
|
|
229
|
-
//
|
230
|
+
// Cloud Storage location for the input content.
|
230
231
|
GcsSource gcs_source = 3;
|
231
232
|
|
232
233
|
// BigQuery input source.
|
@@ -234,7 +235,7 @@ message ImportDocumentsRequest {
|
|
234
235
|
}
|
235
236
|
|
236
237
|
// Required. The parent branch resource name, such as
|
237
|
-
// `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}`.
|
238
|
+
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
|
238
239
|
// Requires create/update permission.
|
239
240
|
string parent = 1 [
|
240
241
|
(google.api.field_behavior) = REQUIRED,
|
@@ -25,7 +25,7 @@ import "google/cloud/discoveryengine/v1beta/user_event.proto";
|
|
25
25
|
import "google/protobuf/struct.proto";
|
26
26
|
|
27
27
|
option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
|
28
|
-
option go_package = "google.
|
28
|
+
option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
|
29
29
|
option java_multiple_files = true;
|
30
30
|
option java_outer_classname = "RecommendationServiceProto";
|
31
31
|
option java_package = "com.google.cloud.discoveryengine.v1beta";
|
@@ -44,6 +44,10 @@ service RecommendationService {
|
|
44
44
|
option (google.api.http) = {
|
45
45
|
post: "/v1beta/{serving_config=projects/*/locations/*/dataStores/*/servingConfigs/*}:recommend"
|
46
46
|
body: "*"
|
47
|
+
additional_bindings {
|
48
|
+
post: "/v1beta/{serving_config=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:recommend"
|
49
|
+
body: "*"
|
50
|
+
}
|
47
51
|
};
|
48
52
|
}
|
49
53
|
}
|
@@ -51,7 +55,7 @@ service RecommendationService {
|
|
51
55
|
// Request message for Recommend method.
|
52
56
|
message RecommendRequest {
|
53
57
|
// Required. Full resource name of the format:
|
54
|
-
// projects/*/locations/global/dataStores/*/servingConfigs/*
|
58
|
+
// projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*
|
55
59
|
//
|
56
60
|
// Before you can request recommendations from your model, you must create at
|
57
61
|
// least one serving config for it.
|
@@ -152,8 +156,8 @@ message RecommendRequest {
|
|
152
156
|
// key with multiple resources.
|
153
157
|
// * Keys must start with a lowercase letter or international character.
|
154
158
|
//
|
155
|
-
// See [
|
156
|
-
//
|
159
|
+
// See [Requirements for
|
160
|
+
// labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
|
157
161
|
// for more details.
|
158
162
|
map<string, string> user_labels = 8;
|
159
163
|
}
|
@@ -23,7 +23,7 @@ import "google/protobuf/duration.proto";
|
|
23
23
|
import "google/protobuf/timestamp.proto";
|
24
24
|
|
25
25
|
option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
|
26
|
-
option go_package = "google.
|
26
|
+
option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
|
27
27
|
option java_multiple_files = true;
|
28
28
|
option java_outer_classname = "UserEventProto";
|
29
29
|
option java_package = "com.google.cloud.discoveryengine.v1beta";
|
@@ -31,12 +31,13 @@ option objc_class_prefix = "DISCOVERYENGINE";
|
|
31
31
|
option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1beta";
|
32
32
|
option ruby_package = "Google::Cloud::DiscoveryEngine::V1beta";
|
33
33
|
|
34
|
-
// UserEvent captures all metadata information
|
35
|
-
// about how end users interact with customers' website.
|
34
|
+
// UserEvent captures all metadata information Discovery Engine API needs to
|
35
|
+
// know about how end users interact with customers' website.
|
36
36
|
message UserEvent {
|
37
37
|
// Required. User event type. Allowed values are:
|
38
38
|
//
|
39
39
|
// Generic values:
|
40
|
+
//
|
40
41
|
// * `search`: Search for Documents.
|
41
42
|
// * `view-item`: Detailed page view of a Document.
|
42
43
|
// * `view-item-list`: View of a panel or ordered list of Documents.
|
@@ -44,10 +45,12 @@ message UserEvent {
|
|
44
45
|
// * `view-category-page`: View of a category page, e.g. Home > Men > Jeans
|
45
46
|
//
|
46
47
|
// Retail-related values:
|
48
|
+
//
|
47
49
|
// * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping
|
48
50
|
// * `purchase`: Purchase an item(s)
|
49
51
|
//
|
50
52
|
// Media-related values:
|
53
|
+
//
|
51
54
|
// * `media-play`: Start/resume watching a video, playing a song, etc.
|
52
55
|
// * `media-complete`: Finished or stopped midway through a video, song, etc.
|
53
56
|
string event_type = 1 [(google.api.field_behavior) = REQUIRED];
|
@@ -96,7 +99,8 @@ message UserEvent {
|
|
96
99
|
// 128 bytes. A session is an aggregation of an end user behavior in a time
|
97
100
|
// span.
|
98
101
|
//
|
99
|
-
// A general guideline to populate the
|
102
|
+
// A general guideline to populate the session_id:
|
103
|
+
//
|
100
104
|
// 1. If user has no activity for 30 min, a new session_id should be assigned.
|
101
105
|
// 2. The session_id should be unique across users, suggest use uuid or add
|
102
106
|
// [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
|
@@ -199,7 +203,7 @@ message UserEvent {
|
|
199
203
|
// If you provide custom attributes for ingested user events, also include
|
200
204
|
// them in the user events that you associate with prediction requests. Custom
|
201
205
|
// attribute formatting must be consistent between imported events and events
|
202
|
-
// provided with prediction requests. This lets the
|
206
|
+
// provided with prediction requests. This lets the Discovery Engine API use
|
203
207
|
// those custom attributes when training models and serving predictions, which
|
204
208
|
// helps improve recommendation quality.
|
205
209
|
//
|
@@ -377,19 +381,20 @@ message DocumentInfo {
|
|
377
381
|
// A required descriptor of the associated Document.
|
378
382
|
//
|
379
383
|
// * If [id][google.cloud.discoveryengine.v1beta.DocumentInfo.id] is
|
380
|
-
// specified, then the default values for
|
381
|
-
//
|
384
|
+
// specified, then the default values for {location}, {collection_id},
|
385
|
+
// {data_store_id}, and {branch_id} are used when annotating with the stored
|
386
|
+
// Document.
|
382
387
|
//
|
383
388
|
// * If [name][google.cloud.discoveryengine.v1beta.DocumentInfo.name] is
|
384
389
|
// specified, then the provided values (default values allowed) for
|
385
|
-
//
|
386
|
-
// the stored Document.
|
390
|
+
// {location}, {collection_id}, {data_store_id}, and {branch_id} are used when
|
391
|
+
// annotating with the stored Document.
|
387
392
|
oneof document_descriptor {
|
388
393
|
// Required. The Document resource ID.
|
389
394
|
string id = 1 [(google.api.field_behavior) = REQUIRED];
|
390
395
|
|
391
396
|
// Required. The Document resource full name, of the form:
|
392
|
-
// projects
|
397
|
+
// projects/{project\_id}/locations/{location}/collections/{collection\_id}/dataStores/{data\_store\_id}/branches/{branch\_id}/documents/{document\_id}
|
393
398
|
string name = 2 [
|
394
399
|
(google.api.field_behavior) = REQUIRED,
|
395
400
|
(google.api.resource_reference) = {
|
@@ -404,6 +409,7 @@ message DocumentInfo {
|
|
404
409
|
// are involved in a `add-to-cart` event.
|
405
410
|
//
|
406
411
|
// Required for events of the following event types:
|
412
|
+
//
|
407
413
|
// * `add-to-cart`
|
408
414
|
// * `purchase`
|
409
415
|
optional int32 quantity = 3;
|
@@ -26,7 +26,7 @@ import "google/cloud/discoveryengine/v1beta/user_event.proto";
|
|
26
26
|
import "google/longrunning/operations.proto";
|
27
27
|
|
28
28
|
option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
|
29
|
-
option go_package = "google.
|
29
|
+
option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
|
30
30
|
option java_multiple_files = true;
|
31
31
|
option java_outer_classname = "UserEventServiceProto";
|
32
32
|
option java_package = "com.google.cloud.discoveryengine.v1beta";
|
@@ -45,6 +45,10 @@ service UserEventService {
|
|
45
45
|
option (google.api.http) = {
|
46
46
|
post: "/v1beta/{parent=projects/*/locations/*/dataStores/*}/userEvents:write"
|
47
47
|
body: "user_event"
|
48
|
+
additional_bindings {
|
49
|
+
post: "/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:write"
|
50
|
+
body: "user_event"
|
51
|
+
}
|
48
52
|
};
|
49
53
|
}
|
50
54
|
|
@@ -56,6 +60,9 @@ service UserEventService {
|
|
56
60
|
rpc CollectUserEvent(CollectUserEventRequest) returns (google.api.HttpBody) {
|
57
61
|
option (google.api.http) = {
|
58
62
|
get: "/v1beta/{parent=projects/*/locations/*/dataStores/*}/userEvents:collect"
|
63
|
+
additional_bindings {
|
64
|
+
get: "/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:collect"
|
65
|
+
}
|
59
66
|
};
|
60
67
|
}
|
61
68
|
|
@@ -71,6 +78,10 @@ service UserEventService {
|
|
71
78
|
option (google.api.http) = {
|
72
79
|
post: "/v1beta/{parent=projects/*/locations/*/dataStores/*}/userEvents:import"
|
73
80
|
body: "*"
|
81
|
+
additional_bindings {
|
82
|
+
post: "/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:import"
|
83
|
+
body: "*"
|
84
|
+
}
|
74
85
|
};
|
75
86
|
option (google.longrunning.operation_info) = {
|
76
87
|
response_type: "google.cloud.discoveryengine.v1beta.ImportUserEventsResponse"
|
@@ -82,7 +93,7 @@ service UserEventService {
|
|
82
93
|
// Request message for WriteUserEvent method.
|
83
94
|
message WriteUserEventRequest {
|
84
95
|
// Required. The parent DataStore resource name, such as
|
85
|
-
// `projects/{project}/locations/{location}/dataStores/{data_store}`.
|
96
|
+
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
|
86
97
|
string parent = 1 [
|
87
98
|
(google.api.field_behavior) = REQUIRED,
|
88
99
|
(google.api.resource_reference) = {
|
@@ -97,7 +108,7 @@ message WriteUserEventRequest {
|
|
97
108
|
// Request message for CollectUserEvent method.
|
98
109
|
message CollectUserEventRequest {
|
99
110
|
// Required. The parent DataStore resource name, such as
|
100
|
-
// `projects/{project}/locations/{location}/dataStores/{data_store}`.
|
111
|
+
// `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
|
101
112
|
string parent = 1 [
|
102
113
|
(google.api.field_behavior) = REQUIRED,
|
103
114
|
(google.api.resource_reference) = {
|