Skip to content

Commit 7b673de

Browse files
feat: [discoveryengine] enable safe search feature for site search (#9428)
- [ ] Regenerate this pull request now. feat: allow users to provide user info in search feat: allow users to provide additional labels in search PiperOrigin-RevId: 530991570 Source-Link: https://togithub.com/googleapis/googleapis/commit/1392f67054909b0f852c7c6ae957a7c8d67d300d Source-Link: https://togithub.com/googleapis/googleapis-gen/commit/9d08d41d747cdf0577a25d43e9193e751ee610c6 Copy-Tag: eyJwIjoiamF2YS1kaXNjb3ZlcnllbmdpbmUvLk93bEJvdC55YW1sIiwiaCI6IjlkMDhkNDFkNzQ3Y2RmMDU3N2EyNWQ0M2U5MTkzZTc1MWVlNjEwYzYifQ==
1 parent 81b9849 commit 7b673de

File tree

12 files changed

+1279
-171
lines changed

12 files changed

+1279
-171
lines changed

java-discoveryengine/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file:
2323
<dependency>
2424
<groupId>com.google.cloud</groupId>
2525
<artifactId>libraries-bom</artifactId>
26-
<version>26.13.0</version>
26+
<version>26.14.0</version>
2727
<type>pom</type>
2828
<scope>import</scope>
2929
</dependency>
@@ -201,7 +201,7 @@ Java is a registered trademark of Oracle and/or its affiliates.
201201
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html
202202
[stability-image]: https://img.shields.io/badge/stability-preview-yellow
203203
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-discoveryengine.svg
204-
[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-discoveryengine/0.12.0
204+
[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-discoveryengine/0.13.0
205205
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
206206
[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
207207
[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles

java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/SearchServiceClient.java

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,16 @@
6363
* .setOffset(-1019779949)
6464
* .setFilter("filter-1274492040")
6565
* .setOrderBy("orderBy-1207110587")
66+
* .setUserInfo(UserInfo.newBuilder().build())
6667
* .addAllFacetSpecs(new ArrayList<SearchRequest.FacetSpec>())
6768
* .setBoostSpec(SearchRequest.BoostSpec.newBuilder().build())
6869
* .putAllParams(new HashMap<String, Value>())
6970
* .setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.newBuilder().build())
7071
* .setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.newBuilder().build())
7172
* .setUserPseudoId("userPseudoId-1155274652")
7273
* .setContentSearchSpec(SearchRequest.ContentSearchSpec.newBuilder().build())
74+
* .setSafeSearch(true)
75+
* .putAllUserLabel(new HashMap<String, String>())
7376
* .build();
7477
* for (SearchResponse.SearchResult element : searchServiceClient.search(request).iterateAll()) {
7578
* // doThingsWith(element);
@@ -227,13 +230,16 @@ public SearchServiceStub getStub() {
227230
* .setOffset(-1019779949)
228231
* .setFilter("filter-1274492040")
229232
* .setOrderBy("orderBy-1207110587")
233+
* .setUserInfo(UserInfo.newBuilder().build())
230234
* .addAllFacetSpecs(new ArrayList<SearchRequest.FacetSpec>())
231235
* .setBoostSpec(SearchRequest.BoostSpec.newBuilder().build())
232236
* .putAllParams(new HashMap<String, Value>())
233237
* .setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.newBuilder().build())
234238
* .setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.newBuilder().build())
235239
* .setUserPseudoId("userPseudoId-1155274652")
236240
* .setContentSearchSpec(SearchRequest.ContentSearchSpec.newBuilder().build())
241+
* .setSafeSearch(true)
242+
* .putAllUserLabel(new HashMap<String, String>())
237243
* .build();
238244
* for (SearchResponse.SearchResult element : searchServiceClient.search(request).iterateAll()) {
239245
* // doThingsWith(element);
@@ -277,13 +283,16 @@ public final SearchPagedResponse search(SearchRequest request) {
277283
* .setOffset(-1019779949)
278284
* .setFilter("filter-1274492040")
279285
* .setOrderBy("orderBy-1207110587")
286+
* .setUserInfo(UserInfo.newBuilder().build())
280287
* .addAllFacetSpecs(new ArrayList<SearchRequest.FacetSpec>())
281288
* .setBoostSpec(SearchRequest.BoostSpec.newBuilder().build())
282289
* .putAllParams(new HashMap<String, Value>())
283290
* .setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.newBuilder().build())
284291
* .setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.newBuilder().build())
285292
* .setUserPseudoId("userPseudoId-1155274652")
286293
* .setContentSearchSpec(SearchRequest.ContentSearchSpec.newBuilder().build())
294+
* .setSafeSearch(true)
295+
* .putAllUserLabel(new HashMap<String, String>())
287296
* .build();
288297
* ApiFuture<SearchResponse.SearchResult> future =
289298
* searchServiceClient.searchPagedCallable().futureCall(request);
@@ -327,13 +336,16 @@ public final UnaryCallable<SearchRequest, SearchPagedResponse> searchPagedCallab
327336
* .setOffset(-1019779949)
328337
* .setFilter("filter-1274492040")
329338
* .setOrderBy("orderBy-1207110587")
339+
* .setUserInfo(UserInfo.newBuilder().build())
330340
* .addAllFacetSpecs(new ArrayList<SearchRequest.FacetSpec>())
331341
* .setBoostSpec(SearchRequest.BoostSpec.newBuilder().build())
332342
* .putAllParams(new HashMap<String, Value>())
333343
* .setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.newBuilder().build())
334344
* .setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.newBuilder().build())
335345
* .setUserPseudoId("userPseudoId-1155274652")
336346
* .setContentSearchSpec(SearchRequest.ContentSearchSpec.newBuilder().build())
347+
* .setSafeSearch(true)
348+
* .putAllUserLabel(new HashMap<String, String>())
337349
* .build();
338350
* while (true) {
339351
* SearchResponse response = searchServiceClient.searchCallable().call(request);

java-discoveryengine/google-cloud-discoveryengine/src/main/java/com/google/cloud/discoveryengine/v1beta/package-info.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,13 +148,16 @@
148148
* .setOffset(-1019779949)
149149
* .setFilter("filter-1274492040")
150150
* .setOrderBy("orderBy-1207110587")
151+
* .setUserInfo(UserInfo.newBuilder().build())
151152
* .addAllFacetSpecs(new ArrayList<SearchRequest.FacetSpec>())
152153
* .setBoostSpec(SearchRequest.BoostSpec.newBuilder().build())
153154
* .putAllParams(new HashMap<String, Value>())
154155
* .setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.newBuilder().build())
155156
* .setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.newBuilder().build())
156157
* .setUserPseudoId("userPseudoId-1155274652")
157158
* .setContentSearchSpec(SearchRequest.ContentSearchSpec.newBuilder().build())
159+
* .setSafeSearch(true)
160+
* .putAllUserLabel(new HashMap<String, String>())
158161
* .build();
159162
* for (SearchResponse.SearchResult element : searchServiceClient.search(request).iterateAll()) {
160163
* // doThingsWith(element);

java-discoveryengine/google-cloud-discoveryengine/src/test/java/com/google/cloud/discoveryengine/v1beta/SearchServiceClientHttpJsonTest.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,13 +104,16 @@ public void searchTest() throws Exception {
104104
.setOffset(-1019779949)
105105
.setFilter("filter-1274492040")
106106
.setOrderBy("orderBy-1207110587")
107+
.setUserInfo(UserInfo.newBuilder().build())
107108
.addAllFacetSpecs(new ArrayList<SearchRequest.FacetSpec>())
108109
.setBoostSpec(SearchRequest.BoostSpec.newBuilder().build())
109110
.putAllParams(new HashMap<String, Value>())
110111
.setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.newBuilder().build())
111112
.setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.newBuilder().build())
112113
.setUserPseudoId("userPseudoId-1155274652")
113114
.setContentSearchSpec(SearchRequest.ContentSearchSpec.newBuilder().build())
115+
.setSafeSearch(true)
116+
.putAllUserLabel(new HashMap<String, String>())
114117
.build();
115118

116119
SearchPagedResponse pagedListResponse = client.search(request);
@@ -160,13 +163,16 @@ public void searchExceptionTest() throws Exception {
160163
.setOffset(-1019779949)
161164
.setFilter("filter-1274492040")
162165
.setOrderBy("orderBy-1207110587")
166+
.setUserInfo(UserInfo.newBuilder().build())
163167
.addAllFacetSpecs(new ArrayList<SearchRequest.FacetSpec>())
164168
.setBoostSpec(SearchRequest.BoostSpec.newBuilder().build())
165169
.putAllParams(new HashMap<String, Value>())
166170
.setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.newBuilder().build())
167171
.setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.newBuilder().build())
168172
.setUserPseudoId("userPseudoId-1155274652")
169173
.setContentSearchSpec(SearchRequest.ContentSearchSpec.newBuilder().build())
174+
.setSafeSearch(true)
175+
.putAllUserLabel(new HashMap<String, String>())
170176
.build();
171177
client.search(request);
172178
Assert.fail("No exception raised");

java-discoveryengine/google-cloud-discoveryengine/src/test/java/com/google/cloud/discoveryengine/v1beta/SearchServiceClientTest.java

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,13 +107,16 @@ public void searchTest() throws Exception {
107107
.setOffset(-1019779949)
108108
.setFilter("filter-1274492040")
109109
.setOrderBy("orderBy-1207110587")
110+
.setUserInfo(UserInfo.newBuilder().build())
110111
.addAllFacetSpecs(new ArrayList<SearchRequest.FacetSpec>())
111112
.setBoostSpec(SearchRequest.BoostSpec.newBuilder().build())
112113
.putAllParams(new HashMap<String, Value>())
113114
.setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.newBuilder().build())
114115
.setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.newBuilder().build())
115116
.setUserPseudoId("userPseudoId-1155274652")
116117
.setContentSearchSpec(SearchRequest.ContentSearchSpec.newBuilder().build())
118+
.setSafeSearch(true)
119+
.putAllUserLabel(new HashMap<String, String>())
117120
.build();
118121

119122
SearchPagedResponse pagedListResponse = client.search(request);
@@ -136,13 +139,16 @@ public void searchTest() throws Exception {
136139
Assert.assertEquals(request.getOffset(), actualRequest.getOffset());
137140
Assert.assertEquals(request.getFilter(), actualRequest.getFilter());
138141
Assert.assertEquals(request.getOrderBy(), actualRequest.getOrderBy());
142+
Assert.assertEquals(request.getUserInfo(), actualRequest.getUserInfo());
139143
Assert.assertEquals(request.getFacetSpecsList(), actualRequest.getFacetSpecsList());
140144
Assert.assertEquals(request.getBoostSpec(), actualRequest.getBoostSpec());
141145
Assert.assertEquals(request.getParamsMap(), actualRequest.getParamsMap());
142146
Assert.assertEquals(request.getQueryExpansionSpec(), actualRequest.getQueryExpansionSpec());
143147
Assert.assertEquals(request.getSpellCorrectionSpec(), actualRequest.getSpellCorrectionSpec());
144148
Assert.assertEquals(request.getUserPseudoId(), actualRequest.getUserPseudoId());
145149
Assert.assertEquals(request.getContentSearchSpec(), actualRequest.getContentSearchSpec());
150+
Assert.assertEquals(request.getSafeSearch(), actualRequest.getSafeSearch());
151+
Assert.assertEquals(request.getUserLabelMap(), actualRequest.getUserLabelMap());
146152
Assert.assertTrue(
147153
channelProvider.isHeaderSent(
148154
ApiClientHeaderProvider.getDefaultApiClientHeaderKey(),
@@ -171,13 +177,16 @@ public void searchExceptionTest() throws Exception {
171177
.setOffset(-1019779949)
172178
.setFilter("filter-1274492040")
173179
.setOrderBy("orderBy-1207110587")
180+
.setUserInfo(UserInfo.newBuilder().build())
174181
.addAllFacetSpecs(new ArrayList<SearchRequest.FacetSpec>())
175182
.setBoostSpec(SearchRequest.BoostSpec.newBuilder().build())
176183
.putAllParams(new HashMap<String, Value>())
177184
.setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.newBuilder().build())
178185
.setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.newBuilder().build())
179186
.setUserPseudoId("userPseudoId-1155274652")
180187
.setContentSearchSpec(SearchRequest.ContentSearchSpec.newBuilder().build())
188+
.setSafeSearch(true)
189+
.putAllUserLabel(new HashMap<String, String>())
181190
.build();
182191
client.search(request);
183192
Assert.fail("No exception raised");

0 commit comments

Comments
 (0)