Class GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest
Request message for CompletionService.AdvancedCompleteQuery method. .
Implements
Inherited Members
Namespace: Google.Apis.DiscoveryEngine.v1alpha.Data
Assembly: Google.Apis.DiscoveryEngine.v1alpha.dll
Syntax
public class GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest : IDirectResponseSchema
Properties
BoostSpec
Optional. Specification to boost suggestions matching the condition.
Declaration
[JsonProperty("boostSpec")]
public virtual GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpec BoostSpec { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpec |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
IncludeTailSuggestions
Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.
Declaration
[JsonProperty("includeTailSuggestions")]
public virtual bool? IncludeTailSuggestions { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Query
Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not
be empty for most of the suggestion types. If it is empty, an INVALID_ARGUMENT
error is returned. The
exception is when the suggestion_types contains only the type RECENT_SEARCH
, the query can be an empty
string. The is called "zero prefix" feature, which returns user's recently searched queries given the empty
query.
Declaration
[JsonProperty("query")]
public virtual string Query { get; set; }
Property Value
Type | Description |
---|---|
string |
QueryModel
Specifies the autocomplete data model. This overrides any model specified in the Configuration >
Autocomplete section of the Cloud console. Currently supported values: * document
- Using suggestions
generated from user-imported documents. * search-history
- Using suggestions generated from the past
history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. *
user-event
- Using suggestions generated from user-imported search events. * document-completable
-
Using suggestions taken directly from user-imported document fields marked as completable. Default values: *
document
is the default model for regular dataStores. * search-history
is the default model for site
search dataStores.
Declaration
[JsonProperty("queryModel")]
public virtual string QueryModel { get; set; }
Property Value
Type | Description |
---|---|
string |
SuggestionTypes
Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment.
Declaration
[JsonProperty("suggestionTypes")]
public virtual IList<string> SuggestionTypes { get; set; }
Property Value
Type | Description |
---|---|
IList<string> |
UserInfo
Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info.
Declaration
[JsonProperty("userInfo")]
public virtual GoogleCloudDiscoveryengineV1alphaUserInfo UserInfo { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudDiscoveryengineV1alphaUserInfo |
UserPseudoId
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 field should NOT have a fixed value such as
unknown_visitor
. This should be the same identifier as UserEvent.user_pseudo_id and
SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128
Declaration
[JsonProperty("userPseudoId")]
public virtual string UserPseudoId { get; set; }
Property Value
Type | Description |
---|---|
string |