Package com.google.cloud.retail.v2alpha

Interface ConversationalSearchRequestOrBuilder

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

  • Method Details

    • getPlacement

      String getPlacement()
       Required. The resource name of the search engine placement, such as
 `projects/*/locations/global/catalogs/default_catalog/placements/default_search`
 or
 `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config`
 This field is used to identify the serving config name and the set
 of models that will be used to make the search.
      string placement = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The placement.

    • getPlacementBytes

      com.google.protobuf.ByteString getPlacementBytes()
       Required. The resource name of the search engine placement, such as
 `projects/*/locations/global/catalogs/default_catalog/placements/default_search`
 or
 `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config`
 This field is used to identify the serving config name and the set
 of models that will be used to make the search.
      string placement = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for placement.

    • getBranch

      String getBranch()
       Required. The branch resource name, such as
 `projects/*/locations/global/catalogs/default_catalog/branches/0`.

 Use "default_branch" as the branch ID or leave this field empty, to search
 products under the default branch.
      string branch = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The branch.

    • getBranchBytes

      com.google.protobuf.ByteString getBranchBytes()
       Required. The branch resource name, such as
 `projects/*/locations/global/catalogs/default_catalog/branches/0`.

 Use "default_branch" as the branch ID or leave this field empty, to search
 products under the default branch.
      string branch = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for branch.

    • getQuery

      String getQuery()
       Optional. Raw search query to be searched for.

 If this field is empty, the request is considered a category browsing
 request.
      string query = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The query.

    • getQueryBytes

      com.google.protobuf.ByteString getQueryBytes()
       Optional. Raw search query to be searched for.

 If this field is empty, the request is considered a category browsing
 request.
      string query = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for query.

    • getPageCategoriesList

      List<String> getPageCategoriesList()
       Optional. The categories associated with a category page. Must be set for
 category navigation queries to achieve good search quality. The format
 should be the same as
 [UserEvent.page_categories][google.cloud.retail.v2alpha.UserEvent.page_categories];

 To represent full path of category, use '>' sign to separate different
 hierarchies. If '>' is part of the category name, replace it with
 other character(s).

 Category pages include special pages such as sales or promotions. For
 instance, a special sale page may have the category hierarchy:
 "pageCategories" : ["Sales > 2017 Black Friday Deals"].
      repeated string page_categories = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      A list containing the pageCategories.

    • getPageCategoriesCount

      int getPageCategoriesCount()
       Optional. The categories associated with a category page. Must be set for
 category navigation queries to achieve good search quality. The format
 should be the same as
 [UserEvent.page_categories][google.cloud.retail.v2alpha.UserEvent.page_categories];

 To represent full path of category, use '>' sign to separate different
 hierarchies. If '>' is part of the category name, replace it with
 other character(s).

 Category pages include special pages such as sales or promotions. For
 instance, a special sale page may have the category hierarchy:
 "pageCategories" : ["Sales > 2017 Black Friday Deals"].
      repeated string page_categories = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The count of pageCategories.

    • getPageCategories

      String getPageCategories(int index)
       Optional. The categories associated with a category page. Must be set for
 category navigation queries to achieve good search quality. The format
 should be the same as
 [UserEvent.page_categories][google.cloud.retail.v2alpha.UserEvent.page_categories];

 To represent full path of category, use '>' sign to separate different
 hierarchies. If '>' is part of the category name, replace it with
 other character(s).

 Category pages include special pages such as sales or promotions. For
 instance, a special sale page may have the category hierarchy:
 "pageCategories" : ["Sales > 2017 Black Friday Deals"].
      repeated string page_categories = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the element to return.
      Returns:
      The pageCategories at the given index.

    • getPageCategoriesBytes

      com.google.protobuf.ByteString getPageCategoriesBytes(int index)
       Optional. The categories associated with a category page. Must be set for
 category navigation queries to achieve good search quality. The format
 should be the same as
 [UserEvent.page_categories][google.cloud.retail.v2alpha.UserEvent.page_categories];

 To represent full path of category, use '>' sign to separate different
 hierarchies. If '>' is part of the category name, replace it with
 other character(s).

 Category pages include special pages such as sales or promotions. For
 instance, a special sale page may have the category hierarchy:
 "pageCategories" : ["Sales > 2017 Black Friday Deals"].
      repeated string page_categories = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the pageCategories at the given index.

    • getConversationId

      String getConversationId()
       Optional. This field specifies the conversation id, which maintains the
 state of the conversation between client side and server side. Use the
 value from the previous
 [ConversationalSearchResponse.conversation_id][google.cloud.retail.v2alpha.ConversationalSearchResponse.conversation_id].
 For the initial request, this should be empty.
      string conversation_id = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The conversationId.

    • getConversationIdBytes

      com.google.protobuf.ByteString getConversationIdBytes()
       Optional. This field specifies the conversation id, which maintains the
 state of the conversation between client side and server side. Use the
 value from the previous
 [ConversationalSearchResponse.conversation_id][google.cloud.retail.v2alpha.ConversationalSearchResponse.conversation_id].
 For the initial request, this should be empty.
      string conversation_id = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for conversationId.

    • hasSearchParams

      boolean hasSearchParams()
       Optional. Search parameters.
      .google.cloud.retail.v2alpha.ConversationalSearchRequest.SearchParams search_params = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the searchParams field is set.

    • getSearchParams

      ConversationalSearchRequest.SearchParams getSearchParams()
       Optional. Search parameters.
      .google.cloud.retail.v2alpha.ConversationalSearchRequest.SearchParams search_params = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The searchParams.

    • getSearchParamsOrBuilder

      ConversationalSearchRequest.SearchParamsOrBuilder getSearchParamsOrBuilder()
       Optional. Search parameters.
      .google.cloud.retail.v2alpha.ConversationalSearchRequest.SearchParams search_params = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getVisitorId

      String getVisitorId()
       Required. A unique identifier for tracking visitors. For example, this
 could be implemented with an HTTP cookie, which should be able to uniquely
 identify a visitor on a single device. This unique identifier should not
 change if the visitor logs in or out of the website.

 This should be the same identifier as
 [UserEvent.visitor_id][google.cloud.retail.v2alpha.UserEvent.visitor_id].

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an INVALID_ARGUMENT error is returned.
      string visitor_id = 9 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The visitorId.

    • getVisitorIdBytes

      com.google.protobuf.ByteString getVisitorIdBytes()
       Required. A unique identifier for tracking visitors. For example, this
 could be implemented with an HTTP cookie, which should be able to uniquely
 identify a visitor on a single device. This unique identifier should not
 change if the visitor logs in or out of the website.

 This should be the same identifier as
 [UserEvent.visitor_id][google.cloud.retail.v2alpha.UserEvent.visitor_id].

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an INVALID_ARGUMENT error is returned.
      string visitor_id = 9 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for visitorId.

    • hasUserInfo

      boolean hasUserInfo()
       Optional. User information.
      .google.cloud.retail.v2alpha.UserInfo user_info = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the userInfo field is set.

    • getUserInfo

      UserInfo getUserInfo()
       Optional. User information.
      .google.cloud.retail.v2alpha.UserInfo user_info = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The userInfo.

    • getUserInfoOrBuilder

      UserInfoOrBuilder getUserInfoOrBuilder()
       Optional. User information.
      .google.cloud.retail.v2alpha.UserInfo user_info = 7 [(.google.api.field_behavior) = OPTIONAL];

    • hasConversationalFilteringSpec

      boolean hasConversationalFilteringSpec()
       Optional. This field specifies all conversational filtering related
 parameters.
      .google.cloud.retail.v2alpha.ConversationalSearchRequest.ConversationalFilteringSpec conversational_filtering_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the conversationalFilteringSpec field is set.

    • getConversationalFilteringSpec

      ConversationalSearchRequest.ConversationalFilteringSpec getConversationalFilteringSpec()
       Optional. This field specifies all conversational filtering related
 parameters.
      .google.cloud.retail.v2alpha.ConversationalSearchRequest.ConversationalFilteringSpec conversational_filtering_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The conversationalFilteringSpec.

    • getConversationalFilteringSpecOrBuilder

      ConversationalSearchRequest.ConversationalFilteringSpecOrBuilder getConversationalFilteringSpecOrBuilder()
       Optional. This field specifies all conversational filtering related
 parameters.
      .google.cloud.retail.v2alpha.ConversationalSearchRequest.ConversationalFilteringSpec conversational_filtering_spec = 8 [(.google.api.field_behavior) = OPTIONAL];

    • getUserLabelsCount

      int getUserLabelsCount()
       Optional. 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.
      map<string, string> user_labels = 12 [(.google.api.field_behavior) = OPTIONAL];

    • containsUserLabels

      boolean containsUserLabels(String key)
       Optional. 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.
      map<string, string> user_labels = 12 [(.google.api.field_behavior) = OPTIONAL];

    • getUserLabels

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

    • getUserLabelsMap

      Map<String,String> getUserLabelsMap()
       Optional. 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.
      map<string, string> user_labels = 12 [(.google.api.field_behavior) = OPTIONAL];

    • getUserLabelsOrDefault

      String getUserLabelsOrDefault(String key, String defaultValue)
       Optional. 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.
      map<string, string> user_labels = 12 [(.google.api.field_behavior) = OPTIONAL];

    • getUserLabelsOrThrow

      String getUserLabelsOrThrow(String key)
       Optional. 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.
      map<string, string> user_labels = 12 [(.google.api.field_behavior) = OPTIONAL];

    • getSafetySettingsList

      List<SafetySetting> getSafetySettingsList()
       Optional. The safety settings to be applied to the generated content.
      repeated .google.cloud.retail.v2alpha.SafetySetting safety_settings = 14 [(.google.api.field_behavior) = OPTIONAL];

    • getSafetySettings

      SafetySetting getSafetySettings(int index)
       Optional. The safety settings to be applied to the generated content.
      repeated .google.cloud.retail.v2alpha.SafetySetting safety_settings = 14 [(.google.api.field_behavior) = OPTIONAL];

    • getSafetySettingsCount

      int getSafetySettingsCount()
       Optional. The safety settings to be applied to the generated content.
      repeated .google.cloud.retail.v2alpha.SafetySetting safety_settings = 14 [(.google.api.field_behavior) = OPTIONAL];

    • getSafetySettingsOrBuilderList

      List<? extends SafetySettingOrBuilder> getSafetySettingsOrBuilderList()
       Optional. The safety settings to be applied to the generated content.
      repeated .google.cloud.retail.v2alpha.SafetySetting safety_settings = 14 [(.google.api.field_behavior) = OPTIONAL];

    • getSafetySettingsOrBuilder

      SafetySettingOrBuilder getSafetySettingsOrBuilder(int index)
       Optional. The safety settings to be applied to the generated content.
      repeated .google.cloud.retail.v2alpha.SafetySetting safety_settings = 14 [(.google.api.field_behavior) = OPTIONAL];