Package com.google.cloud.discoveryengine.v1beta

Interface RecommendRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
RecommendRequest, RecommendRequest.Builder
@Generated public interface RecommendRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsParams(String key)
    Additional domain specific parameters for the recommendations.
    boolean
    containsUserLabels(String key)
    The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
    String
    getFilter()
    Filter for restricting recommendation results with a length limit of 5,000 characters.
    com.google.protobuf.ByteString
    getFilterBytes()
    Filter for restricting recommendation results with a length limit of 5,000 characters.
    int
    getPageSize()
    Maximum number of results to return.
    Map<String,com.google.protobuf.Value>
    getParams()
    Deprecated.
    int
    getParamsCount()
    Additional domain specific parameters for the recommendations.
    Map<String,com.google.protobuf.Value>
    getParamsMap()
    Additional domain specific parameters for the recommendations.
    com.google.protobuf.Value
    getParamsOrDefault(String key, com.google.protobuf.Value defaultValue)
    Additional domain specific parameters for the recommendations.
    com.google.protobuf.Value
    getParamsOrThrow(String key)
    Additional domain specific parameters for the recommendations.
    String
    getServingConfig()
    Required.
    com.google.protobuf.ByteString
    getServingConfigBytes()
    Required.
    UserEvent
    getUserEvent()
    Required.
    UserEventOrBuilder
    getUserEventOrBuilder()
    Required.
    Map<String,String>
    getUserLabels()
    Deprecated.
    int
    getUserLabelsCount()
    The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
    Map<String,String>
    getUserLabelsMap()
    The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
    String
    getUserLabelsOrDefault(String key, String defaultValue)
    The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
    String
    getUserLabelsOrThrow(String key)
    The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64
    boolean
    getValidateOnly()
    Use validate only mode for this recommendation query.
    boolean
    hasUserEvent()
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getServingConfig

      String getServingConfig()
       Required. Full resource name of a
 [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig]:
 `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or
 `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`

 One default serving config is created along with your recommendation engine
 creation. The engine ID is used as the ID of the default serving
 config. For example, for Engine
 `projects/*/locations/global/collections/*/engines/my-engine`, you can use
 `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine`
 for your
 [RecommendationService.Recommend][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend]
 requests.
      string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The servingConfig.

    • getServingConfigBytes

      com.google.protobuf.ByteString getServingConfigBytes()
       Required. Full resource name of a
 [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig]:
 `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or
 `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`

 One default serving config is created along with your recommendation engine
 creation. The engine ID is used as the ID of the default serving
 config. For example, for Engine
 `projects/*/locations/global/collections/*/engines/my-engine`, you can use
 `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine`
 for your
 [RecommendationService.Recommend][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend]
 requests.
      string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for servingConfig.

    • hasUserEvent

      boolean hasUserEvent()
       Required. Context about the user, what they are looking at and what action
 they took to trigger the Recommend request. Note that this user event
 detail won't be ingested to userEvent logs. Thus, a separate userEvent
 write request is required for event logging.

 Don't set
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 or
 [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id]
 to the same fixed ID for different users. If you are trying to receive
 non-personalized recommendations (not recommended; this can negatively
 impact model performance), instead set
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 to a random unique ID and leave
 [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id]
 unset.
      .google.cloud.discoveryengine.v1beta.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      Whether the userEvent field is set.

    • getUserEvent

      UserEvent getUserEvent()
       Required. Context about the user, what they are looking at and what action
 they took to trigger the Recommend request. Note that this user event
 detail won't be ingested to userEvent logs. Thus, a separate userEvent
 write request is required for event logging.

 Don't set
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 or
 [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id]
 to the same fixed ID for different users. If you are trying to receive
 non-personalized recommendations (not recommended; this can negatively
 impact model performance), instead set
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 to a random unique ID and leave
 [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id]
 unset.
      .google.cloud.discoveryengine.v1beta.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The userEvent.

    • getUserEventOrBuilder

      UserEventOrBuilder getUserEventOrBuilder()
       Required. Context about the user, what they are looking at and what action
 they took to trigger the Recommend request. Note that this user event
 detail won't be ingested to userEvent logs. Thus, a separate userEvent
 write request is required for event logging.

 Don't set
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 or
 [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id]
 to the same fixed ID for different users. If you are trying to receive
 non-personalized recommendations (not recommended; this can negatively
 impact model performance), instead set
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 to a random unique ID and leave
 [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id]
 unset.
      .google.cloud.discoveryengine.v1beta.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

    • getPageSize

      int getPageSize()
       Maximum number of results to return. Set this property
 to the number of recommendation results needed. If zero, the service
 chooses a reasonable default. The maximum allowed value is 100. Values
 above 100 are set to 100.
      int32 page_size = 3;
      Returns:
      The pageSize.

    • getFilter

      String getFilter()
       Filter for restricting recommendation results with a length limit of 5,000
 characters. Currently, only filter expressions on the `filter_tags`
 attribute is supported.


 Examples:

 * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))`
 * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))`

 If `attributeFilteringSyntax` is set to true under the `params` field, then
 attribute-based expressions are expected instead of the above described
 tag-based syntax. Examples:

 * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie"))
 * (available: true) AND
 (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))

 If your filter blocks all results, the API returns generic
 (unfiltered) popular Documents. If you only want results strictly matching
 the filters, set `strictFiltering` to `true` in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params]
 to receive empty results instead.

 Note that the API never returns
 [Document][google.cloud.discoveryengine.v1beta.Document]s with
 `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.
      string filter = 4;
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       Filter for restricting recommendation results with a length limit of 5,000
 characters. Currently, only filter expressions on the `filter_tags`
 attribute is supported.


 Examples:

 * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))`
 * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))`

 If `attributeFilteringSyntax` is set to true under the `params` field, then
 attribute-based expressions are expected instead of the above described
 tag-based syntax. Examples:

 * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie"))
 * (available: true) AND
 (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))

 If your filter blocks all results, the API returns generic
 (unfiltered) popular Documents. If you only want results strictly matching
 the filters, set `strictFiltering` to `true` in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params]
 to receive empty results instead.

 Note that the API never returns
 [Document][google.cloud.discoveryengine.v1beta.Document]s with
 `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.
      string filter = 4;
      Returns:
      The bytes for filter.

    • getValidateOnly

      boolean getValidateOnly()
       Use validate only mode for this recommendation query. If set to `true`, a
 fake model is used that returns arbitrary Document IDs.
 Note that the validate only mode should only be used for testing the API,
 or if the model is not ready.
      bool validate_only = 5;
      Returns:
      The validateOnly.

    • getParamsCount

      int getParamsCount()
       Additional domain specific parameters for the recommendations.

 Allowed values:

 * `returnDocument`: Boolean. If set to `true`, the associated Document
 object is returned in
 [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document].
 * `returnScore`: Boolean. If set to true, the recommendation score
 corresponding to each returned Document is set in
 [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata].
 The given score indicates the probability of a Document conversion given
 the user's context and history.
 * `strictFiltering`: Boolean. True by default. If set to `false`, the
 service
 returns generic (unfiltered) popular Documents instead of empty if
 your filter blocks all recommendation results.
 * `diversityLevel`: String. Default empty. If set to be non-empty, then
 it needs to be one of:
 *  `no-diversity`
 *  `low-diversity`
 *  `medium-diversity`
 *  `high-diversity`
 *  `auto-diversity`
 This gives request-level control and adjusts recommendation results
 based on Document category.
 * `attributeFilteringSyntax`: Boolean. False by default. If set to true,
 the `filter` field is interpreted according to the new,
 attribute-based syntax.
      map<string, .google.protobuf.Value> params = 6;

    • containsParams

      boolean containsParams(String key)
       Additional domain specific parameters for the recommendations.

 Allowed values:

 * `returnDocument`: Boolean. If set to `true`, the associated Document
 object is returned in
 [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document].
 * `returnScore`: Boolean. If set to true, the recommendation score
 corresponding to each returned Document is set in
 [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata].
 The given score indicates the probability of a Document conversion given
 the user's context and history.
 * `strictFiltering`: Boolean. True by default. If set to `false`, the
 service
 returns generic (unfiltered) popular Documents instead of empty if
 your filter blocks all recommendation results.
 * `diversityLevel`: String. Default empty. If set to be non-empty, then
 it needs to be one of:
 *  `no-diversity`
 *  `low-diversity`
 *  `medium-diversity`
 *  `high-diversity`
 *  `auto-diversity`
 This gives request-level control and adjusts recommendation results
 based on Document category.
 * `attributeFilteringSyntax`: Boolean. False by default. If set to true,
 the `filter` field is interpreted according to the new,
 attribute-based syntax.
      map<string, .google.protobuf.Value> params = 6;

    • getParams

      @Deprecated Map<String,com.google.protobuf.Value> getParams()
      Deprecated.
      Use getParamsMap() instead.

    • getParamsMap

      Map<String,com.google.protobuf.Value> getParamsMap()
       Additional domain specific parameters for the recommendations.

 Allowed values:

 * `returnDocument`: Boolean. If set to `true`, the associated Document
 object is returned in
 [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document].
 * `returnScore`: Boolean. If set to true, the recommendation score
 corresponding to each returned Document is set in
 [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata].
 The given score indicates the probability of a Document conversion given
 the user's context and history.
 * `strictFiltering`: Boolean. True by default. If set to `false`, the
 service
 returns generic (unfiltered) popular Documents instead of empty if
 your filter blocks all recommendation results.
 * `diversityLevel`: String. Default empty. If set to be non-empty, then
 it needs to be one of:
 *  `no-diversity`
 *  `low-diversity`
 *  `medium-diversity`
 *  `high-diversity`
 *  `auto-diversity`
 This gives request-level control and adjusts recommendation results
 based on Document category.
 * `attributeFilteringSyntax`: Boolean. False by default. If set to true,
 the `filter` field is interpreted according to the new,
 attribute-based syntax.
      map<string, .google.protobuf.Value> params = 6;

    • getParamsOrDefault

      com.google.protobuf.Value getParamsOrDefault(String key, com.google.protobuf.Value defaultValue)
       Additional domain specific parameters for the recommendations.

 Allowed values:

 * `returnDocument`: Boolean. If set to `true`, the associated Document
 object is returned in
 [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document].
 * `returnScore`: Boolean. If set to true, the recommendation score
 corresponding to each returned Document is set in
 [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata].
 The given score indicates the probability of a Document conversion given
 the user's context and history.
 * `strictFiltering`: Boolean. True by default. If set to `false`, the
 service
 returns generic (unfiltered) popular Documents instead of empty if
 your filter blocks all recommendation results.
 * `diversityLevel`: String. Default empty. If set to be non-empty, then
 it needs to be one of:
 *  `no-diversity`
 *  `low-diversity`
 *  `medium-diversity`
 *  `high-diversity`
 *  `auto-diversity`
 This gives request-level control and adjusts recommendation results
 based on Document category.
 * `attributeFilteringSyntax`: Boolean. False by default. If set to true,
 the `filter` field is interpreted according to the new,
 attribute-based syntax.
      map<string, .google.protobuf.Value> params = 6;

    • getParamsOrThrow

      com.google.protobuf.Value getParamsOrThrow(String key)
       Additional domain specific parameters for the recommendations.

 Allowed values:

 * `returnDocument`: Boolean. If set to `true`, the associated Document
 object is returned in
 [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document].
 * `returnScore`: Boolean. If set to true, the recommendation score
 corresponding to each returned Document is set in
 [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata].
 The given score indicates the probability of a Document conversion given
 the user's context and history.
 * `strictFiltering`: Boolean. True by default. If set to `false`, the
 service
 returns generic (unfiltered) popular Documents instead of empty if
 your filter blocks all recommendation results.
 * `diversityLevel`: String. Default empty. If set to be non-empty, then
 it needs to be one of:
 *  `no-diversity`
 *  `low-diversity`
 *  `medium-diversity`
 *  `high-diversity`
 *  `auto-diversity`
 This gives request-level control and adjusts recommendation results
 based on Document category.
 * `attributeFilteringSyntax`: Boolean. False by default. If set to true,
 the `filter` field is interpreted according to the new,
 attribute-based syntax.
      map<string, .google.protobuf.Value> params = 6;

    • getUserLabelsCount

      int getUserLabelsCount()
       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 [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 8;

    • containsUserLabels

      boolean containsUserLabels(String key)
       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 [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 8;

    • getUserLabels

      @Deprecated Map<String,String> getUserLabels()
      Deprecated.
      Use getUserLabelsMap() instead.

    • getUserLabelsMap

      Map<String,String> getUserLabelsMap()
       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 [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 8;

    • getUserLabelsOrDefault

      String getUserLabelsOrDefault(String key, String defaultValue)
       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 [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 8;

    • getUserLabelsOrThrow

      String getUserLabelsOrThrow(String key)
       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 [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 8;