Discovery Engine v1beta API - Class AdvancedCompleteQueryRequest (1.0.0-beta18) 

public sealed class AdvancedCompleteQueryRequest : IMessage<AdvancedCompleteQueryRequest>, IEquatable<AdvancedCompleteQueryRequest>, IDeepCloneable<AdvancedCompleteQueryRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1beta API class AdvancedCompleteQueryRequest.

Request message for [CompletionService.AdvancedCompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.AdvancedCompleteQuery] method. .

Inheritance

object > AdvancedCompleteQueryRequest

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Constructors

AdvancedCompleteQueryRequest()

public AdvancedCompleteQueryRequest()

AdvancedCompleteQueryRequest(AdvancedCompleteQueryRequest)

public AdvancedCompleteQueryRequest(AdvancedCompleteQueryRequest other)
Parameter
Name Description
other AdvancedCompleteQueryRequest

Properties

BoostSpec

public AdvancedCompleteQueryRequest.Types.BoostSpec BoostSpec { get; set; }

Optional. Specification to boost suggestions matching the condition.

Property Value
Type Description
AdvancedCompleteQueryRequestTypesBoostSpec

CompletionConfig

public string CompletionConfig { get; set; }

Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig projects/*/locations/global/collections/default_collection/engines/*/completionConfig.

Property Value
Type Description
string

CompletionConfigAsCompletionConfigName

public CompletionConfigName CompletionConfigAsCompletionConfigName { get; set; }

CompletionConfigName-typed view over the CompletionConfig resource name property.

Property Value
Type Description
CompletionConfigName

IncludeTailSuggestions

public bool IncludeTailSuggestions { get; set; }

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.

Property Value
Type Description
bool

Query

public string Query { get; set; }

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.

Property Value
Type Description
string

QueryModel

public string QueryModel { get; set; }

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][google.cloud.discoveryengine.v1beta.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.
Property Value
Type Description
string

SuggestionTypes

public RepeatedField<AdvancedCompleteQueryRequest.Types.SuggestionType> SuggestionTypes { get; }

Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment.

Property Value
Type Description
RepeatedFieldAdvancedCompleteQueryRequestTypesSuggestionType

UserInfo

public UserInfo UserInfo { get; set; }

Optional. Information about the end user.

This should be the same identifier information as [UserEvent.user_info][google.cloud.discoveryengine.v1beta.UserEvent.user_info] and [SearchRequest.user_info][google.cloud.discoveryengine.v1beta.SearchRequest.user_info].

Property Value
Type Description
UserInfo

UserPseudoId

public string UserPseudoId { get; set; }

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][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id] and [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id].

The field must be a UTF-8 encoded string with a length limit of 128

Property Value
Type Description
string