com.google.cloud.retail.v2alpha.CompleteQueryRequestOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-retail-v2alpha Show documentation
Show all versions of proto-google-cloud-retail-v2alpha Show documentation
Proto library for google-cloud-retail
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/retail/v2alpha/completion_service.proto
// Protobuf Java Version: 3.25.5
package com.google.cloud.retail.v2alpha;
public interface CompleteQueryRequestOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.retail.v2alpha.CompleteQueryRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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) = { ... }
*
*
* @return The catalog.
*/
java.lang.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) = { ... }
*
*
* @return The bytes for catalog.
*/
com.google.protobuf.ByteString getCatalogBytes();
/**
*
*
*
* Required. The query used to generate suggestions.
*
* The maximum number of allowed characters is 255.
*
*
* string query = 2 [(.google.api.field_behavior) = REQUIRED];
*
* @return The query.
*/
java.lang.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];
*
* @return The bytes for query.
*/
com.google.protobuf.ByteString getQueryBytes();
/**
*
*
*
* 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;
*
* @return The visitorId.
*/
java.lang.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;
*
* @return The bytes for visitorId.
*/
com.google.protobuf.ByteString getVisitorIdBytes();
/**
*
*
*
* 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;
*
* @return A list containing the languageCodes.
*/
java.util.List 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;
*
* @return The count of languageCodes.
*/
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;
*
* @param index The index of the element to return.
* @return The languageCodes at the given index.
*/
java.lang.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;
*
* @param index The index of the value to return.
* @return The bytes of the languageCodes at the given index.
*/
com.google.protobuf.ByteString getLanguageCodesBytes(int index);
/**
*
*
*
* 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;
*
* @return The deviceType.
*/
java.lang.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;
*
* @return The bytes for deviceType.
*/
com.google.protobuf.ByteString getDeviceTypeBytes();
/**
*
*
*
* 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;
*
* @return The dataset.
*/
java.lang.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;
*
* @return The bytes for dataset.
*/
com.google.protobuf.ByteString getDatasetBytes();
/**
*
*
*
* 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;
*
* @return The maxSuggestions.
*/
int getMaxSuggestions();
/**
*
*
*
* If true, attribute suggestions are enabled and provided in the response.
*
* This field is only available for the "cloud-retail" dataset.
*
*
* bool enable_attribute_suggestions = 9;
*
* @return The enableAttributeSuggestions.
*/
boolean getEnableAttributeSuggestions();
/**
*
*
*
* The entity for customers who run multiple entities, domains, sites, or
* regions, for example, `Google US`, `Google Ads`, `Waymo`,
* `google.com`, `youtube.com`, etc.
* If this is set, it must be an exact match with
* [UserEvent.entity][google.cloud.retail.v2alpha.UserEvent.entity] to get
* per-entity autocomplete results.
*
*
* string entity = 10;
*
* @return The entity.
*/
java.lang.String getEntity();
/**
*
*
*
* The entity for customers who run multiple entities, domains, sites, or
* regions, for example, `Google US`, `Google Ads`, `Waymo`,
* `google.com`, `youtube.com`, etc.
* If this is set, it must be an exact match with
* [UserEvent.entity][google.cloud.retail.v2alpha.UserEvent.entity] to get
* per-entity autocomplete results.
*
*
* string entity = 10;
*
* @return The bytes for entity.
*/
com.google.protobuf.ByteString getEntityBytes();
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy