Discovery Engine v1 API - Class CompleteQueryRequest (1.5.0) 

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

Reference documentation and code samples for the Discovery Engine v1 API class CompleteQueryRequest.

Request message for [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1.CompletionService.CompleteQuery] method.

Inheritance

object > CompleteQueryRequest

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

CompleteQueryRequest()

public CompleteQueryRequest()

CompleteQueryRequest(CompleteQueryRequest)

public CompleteQueryRequest(CompleteQueryRequest other)
Parameter
Name Description
other CompleteQueryRequest

Properties

DataStore

public string DataStore { get; set; }

Required. The parent data store resource name for which the completion is performed, such as projects/*/locations/global/collections/default_collection/dataStores/default_data_store.

Property Value
Type Description
string

DataStoreAsDataStoreName

public DataStoreName DataStoreAsDataStoreName { get; set; }

DataStoreName-typed view over the DataStore resource name property.

Property Value
Type Description
DataStoreName

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.

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.v1.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

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

The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Property Value
Type Description
string