Package com.google.cloud.retail.v2alpha

Interface CompleteQueryRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    CompleteQueryRequest, CompleteQueryRequest.Builder
    public interface CompleteQueryRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getCatalog()
      Required.
      com.google.protobuf.ByteString getCatalogBytes()
      Required.
      String getDataset()
      Determines which dataset to use for fetching completion.
      com.google.protobuf.ByteString getDatasetBytes()
      Determines which dataset to use for fetching completion.
      String getDeviceType()
      The device type context for completion suggestions.
      com.google.protobuf.ByteString getDeviceTypeBytes()
      The device type context for completion suggestions.
      boolean getEnableAttributeSuggestions()
      If true, attribute suggestions are enabled and provided in response.
      String getEntity()
      The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc.
      com.google.protobuf.ByteString getEntityBytes()
      The entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc.
      String getLanguageCodes​(int index)
      Note that this field applies for `user-data` dataset only.
      com.google.protobuf.ByteString getLanguageCodesBytes​(int index)
      Note that this field applies for `user-data` dataset only.
      int getLanguageCodesCount()
      Note that this field applies for `user-data` dataset only.
      List<String> getLanguageCodesList()
      Note that this field applies for `user-data` dataset only.
      int getMaxSuggestions()
      Completion max suggestions.
      String getQuery()
      Required.
      com.google.protobuf.ByteString getQueryBytes()
      Required.
      String getVisitorId()
      Required field.
      com.google.protobuf.ByteString getVisitorIdBytes()
      Required field.

      • 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 Detail

      • getCatalog

        String getCatalog()
         Required. Catalog for which the completion is performed.

 Full resource name of catalog, such as
 `projects/*/locations/global/catalogs/default_catalog`.
        string catalog = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The catalog.

      • getCatalogBytes

        com.google.protobuf.ByteString getCatalogBytes()
         Required. Catalog for which the completion is performed.

 Full resource name of catalog, such as
 `projects/*/locations/global/catalogs/default_catalog`.
        string catalog = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for catalog.

      • getQuery

        String getQuery()
         Required. The query used to generate suggestions.

 The maximum number of allowed characters is 255.
        string query = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The query.

      • getQueryBytes

        com.google.protobuf.ByteString getQueryBytes()
         Required. The query used to generate suggestions.

 The maximum number of allowed characters is 255.
        string query = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for query.

      • getVisitorId

        String getVisitorId()
         Required field. 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.

 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 = 7;
        Returns:
        The visitorId.

      • getVisitorIdBytes

        com.google.protobuf.ByteString getVisitorIdBytes()
         Required field. 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.

 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 = 7;
        Returns:
        The bytes for visitorId.

      • getLanguageCodesList

        List<String> getLanguageCodesList()
         Note that this field applies for `user-data` dataset only. For requests
 with `cloud-retail` dataset, setting this field has no effect.

 The language filters applied to the output suggestions. If set, it should
 contain the language of the query. If not set, suggestions are returned
 without considering language restrictions. This is the BCP-47 language
 code, such as "en-US" or "sr-Latn". For more information, see [Tags for
 Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum
 number of language codes is 3.
        repeated string language_codes = 3;
        Returns:
        A list containing the languageCodes.

      • getLanguageCodesCount

        int getLanguageCodesCount()
         Note that this field applies for `user-data` dataset only. For requests
 with `cloud-retail` dataset, setting this field has no effect.

 The language filters applied to the output suggestions. If set, it should
 contain the language of the query. If not set, suggestions are returned
 without considering language restrictions. This is the BCP-47 language
 code, such as "en-US" or "sr-Latn". For more information, see [Tags for
 Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum
 number of language codes is 3.
        repeated string language_codes = 3;
        Returns:
        The count of languageCodes.

      • getLanguageCodes

        String getLanguageCodes​(int index)
         Note that this field applies for `user-data` dataset only. For requests
 with `cloud-retail` dataset, setting this field has no effect.

 The language filters applied to the output suggestions. If set, it should
 contain the language of the query. If not set, suggestions are returned
 without considering language restrictions. This is the BCP-47 language
 code, such as "en-US" or "sr-Latn". For more information, see [Tags for
 Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum
 number of language codes is 3.
        repeated string language_codes = 3;
        Parameters:
        index - The index of the element to return.
        Returns:
        The languageCodes at the given index.

      • getLanguageCodesBytes

        com.google.protobuf.ByteString getLanguageCodesBytes​(int index)
         Note that this field applies for `user-data` dataset only. For requests
 with `cloud-retail` dataset, setting this field has no effect.

 The language filters applied to the output suggestions. If set, it should
 contain the language of the query. If not set, suggestions are returned
 without considering language restrictions. This is the BCP-47 language
 code, such as "en-US" or "sr-Latn". For more information, see [Tags for
 Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum
 number of language codes is 3.
        repeated string language_codes = 3;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the languageCodes at the given index.

      • getDeviceType

        String getDeviceType()
         The device type context for completion suggestions. We recommend that you
 leave this field empty.

 It can apply different suggestions on different device types, e.g.
 `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
 types.

 Supported formats:

 * `UNKNOWN_DEVICE_TYPE`

 * `DESKTOP`

 * `MOBILE`

 * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
        string device_type = 4;
        Returns:
        The deviceType.

      • getDeviceTypeBytes

        com.google.protobuf.ByteString getDeviceTypeBytes()
         The device type context for completion suggestions. We recommend that you
 leave this field empty.

 It can apply different suggestions on different device types, e.g.
 `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
 types.

 Supported formats:

 * `UNKNOWN_DEVICE_TYPE`

 * `DESKTOP`

 * `MOBILE`

 * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
        string device_type = 4;
        Returns:
        The bytes for deviceType.

      • getDataset

        String getDataset()
         Determines which dataset to use for fetching completion. "user-data" will
 use the imported dataset through
 [CompletionService.ImportCompletionData][google.cloud.retail.v2alpha.CompletionService.ImportCompletionData].
 "cloud-retail" will use the dataset generated by cloud retail based on user
 events. If leave empty, it will use the "user-data".

 Current supported values:

 * user-data

 * cloud-retail:
   This option requires enabling auto-learning function first. See
   [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).
        string dataset = 6;
        Returns:
        The dataset.

      • getDatasetBytes

        com.google.protobuf.ByteString getDatasetBytes()
         Determines which dataset to use for fetching completion. "user-data" will
 use the imported dataset through
 [CompletionService.ImportCompletionData][google.cloud.retail.v2alpha.CompletionService.ImportCompletionData].
 "cloud-retail" will use the dataset generated by cloud retail based on user
 events. If leave empty, it will use the "user-data".

 Current supported values:

 * user-data

 * cloud-retail:
   This option requires enabling auto-learning function first. See
   [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).
        string dataset = 6;
        Returns:
        The bytes for dataset.

      • getMaxSuggestions

        int getMaxSuggestions()
         Completion max suggestions. If left unset or set to 0, then will fallback
 to the configured value
 [CompletionConfig.max_suggestions][google.cloud.retail.v2alpha.CompletionConfig.max_suggestions].

 The maximum allowed max suggestions is 20. If it is set higher, it will be
 capped by 20.
        int32 max_suggestions = 5;
        Returns:
        The maxSuggestions.

      • getEnableAttributeSuggestions

        boolean getEnableAttributeSuggestions()
         If true, attribute suggestions are enabled and provided in response.

 This field is only available for "cloud-retail" dataset.
        bool enable_attribute_suggestions = 9;
        Returns:
        The enableAttributeSuggestions.

      • getEntity

        String getEntity()
         The entity for customers that may run multiple different entities, domains,
 sites or regions, for example, `Google US`, `Google Ads`, `Waymo`,
 `google.com`, `youtube.com`, etc.
 If this is set, it should be exactly matched with
 [UserEvent.entity][google.cloud.retail.v2alpha.UserEvent.entity] to get
 per-entity autocomplete results.
        string entity = 10;
        Returns:
        The entity.

      • getEntityBytes

        com.google.protobuf.ByteString getEntityBytes()
         The entity for customers that may run multiple different entities, domains,
 sites or regions, for example, `Google US`, `Google Ads`, `Waymo`,
 `google.com`, `youtube.com`, etc.
 If this is set, it should be exactly matched with
 [UserEvent.entity][google.cloud.retail.v2alpha.UserEvent.entity] to get
 per-entity autocomplete results.
        string entity = 10;
        Returns:
        The bytes for entity.