feat: enable safe search feature for site search (#11174)

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Anthonios Partheniou <partheniou@google.com>

Author: gcf-owl-bot[bot]

packages/google-cloud-discoveryengine/google/cloud/discoveryengine_v1beta/types/search_service.py

@@ -98,6 +98,10 @@ class SearchRequest(proto.Message):
 
  If this field is unrecognizable, an ``INVALID_ARGUMENT`` is
  returned.
+ user_info (google.cloud.discoveryengine_v1beta.types.UserInfo):
+ Information about the end user. Highly recommended for
+ analytics. The user_agent string in UserInfo will be used to
+ deduce device_type for analytics.
  facet_specs (MutableSequence[google.cloud.discoveryengine_v1beta.types.SearchRequest.FacetSpec]):
  Facet specifications for faceted search. If empty, no facets
  are returned.
@@ -120,7 +124,7 @@ class SearchRequest(proto.Message):
  - ``search_type``: double. Default empty. Enables
  non-webpage searching depending on the value. The only
  valid non-default value is 1, which enables image
- searching. This field is ignored for other verticals.
+ searching.
  query_expansion_spec (google.cloud.discoveryengine_v1beta.types.SearchRequest.QueryExpansionSpec):
  The query expansion specification that
  specifies the conditions under which query
@@ -150,6 +154,31 @@ class SearchRequest(proto.Message):
  content_search_spec (google.cloud.discoveryengine_v1beta.types.SearchRequest.ContentSearchSpec):
  The content search spec that configs the
  desired behavior of content search.
+ safe_search (bool):
+ Whether to turn on safe search. This is only supported for
+ [ContentConfig.PUBLIC_WEBSITE][].
+ user_label (MutableMapping[str, str]):
+ The user labels applied to a resource must meet the
+ following requirements:
+
+ - Each resource can have multiple labels, up to a maximum
+ of 64.
+ - Each label must be a key-value pair.
+ - Keys have a minimum length of 1 character and a maximum
+ length of 63 characters and cannot be empty. Values can
+ be empty and have a maximum length of 63 characters.
+ - Keys and values can contain only lowercase letters,
+ numeric characters, underscores, and dashes. All
+ characters must use UTF-8 encoding, and international
+ characters are allowed.
+ - The key portion of a label must be unique. However, you
+ can use the same key with multiple resources.
+ - Keys must start with a lowercase letter or international
+ character.
+
+ See `Google Cloud
+ Document <https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements>`__
+ for more details.
  """
 
  class FacetSpec(proto.Message):
@@ -589,6 +618,11 @@ class SummarySpec(proto.Message):
  proto.STRING,
  number=8,
  )
+ user_info: common.UserInfo = proto.Field(
+ proto.MESSAGE,
+ number=21,
+ message=common.UserInfo,
+ )
  facet_specs: MutableSequence[FacetSpec] = proto.RepeatedField(
  proto.MESSAGE,
  number=9,
@@ -624,6 +658,15 @@ class SummarySpec(proto.Message):
  number=24,
  message=ContentSearchSpec,
  )
+ safe_search: bool = proto.Field(
+ proto.BOOL,
+ number=20,
+ )
+ user_label: MutableMapping[str, str] = proto.MapField(
+ proto.STRING,
+ proto.STRING,
+ number=22,
+ )
 
 
 class SearchResponse(proto.Message):

packages/google-cloud-discoveryengine/samples/generated_samples/snippet_metadata_google.cloud.discoveryengine.v1beta.json

@@ -8,7 +8,7 @@
  ],
  "language": "PYTHON",
  "name": "google-cloud-discoveryengine",
- "version": "0.6.0"
+ "version": "0.1.0"
  },
  "snippets": [
  {

packages/google-cloud-discoveryengine/scripts/fixup_discoveryengine_v1beta_keywords.py

@@ -53,7 +53,7 @@ class discoveryengineCallTransformer(cst.CSTTransformer):
  'list_schemas': ('parent', 'page_size', 'page_token', ),
  'purge_documents': ('parent', 'filter', 'force', ),
  'recommend': ('serving_config', 'user_event', 'page_size', 'filter', 'validate_only', 'params', 'user_labels', ),
- 'search': ('serving_config', 'branch', 'query', 'page_size', 'page_token', 'offset', 'filter', 'order_by', 'facet_specs', 'boost_spec', 'params', 'query_expansion_spec', 'spell_correction_spec', 'user_pseudo_id', 'content_search_spec', ),
+ 'search': ('serving_config', 'branch', 'query', 'page_size', 'page_token', 'offset', 'filter', 'order_by', 'user_info', 'facet_specs', 'boost_spec', 'params', 'query_expansion_spec', 'spell_correction_spec', 'user_pseudo_id', 'content_search_spec', 'safe_search', 'user_label', ),
  'update_document': ('document', 'allow_missing', ),
  'update_schema': ('schema', 'allow_missing', ),
  'write_user_event': ('parent', 'user_event', ),