Discovery Engine v1beta API - Class CompleteQueryRequest (1.0.0-beta06) 

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

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

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

Inheritance

object > CompleteQueryRequest

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Constructors

CompleteQueryRequest()

public CompleteQueryRequest()

CompleteQueryRequest(CompleteQueryRequest)

public CompleteQueryRequest(CompleteQueryRequest other)
Parameter
NameDescription
otherCompleteQueryRequest

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
TypeDescription
string

DataStoreAsDataStoreName

public DataStoreName DataStoreAsDataStoreName { get; set; }

DataStoreName-typed view over the DataStore resource name property.

Property Value
TypeDescription
DataStoreName

Query

public string Query { get; set; }

Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.

Property Value
TypeDescription
string

QueryModel

public string QueryModel { get; set; }

Selects data model of query suggestions for serving. 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 [IndustryVertical.SITE_SEARCH][google.cloud.discoveryengine.v1beta.IndustryVertical.SITE_SEARCH] dataStores.
Property Value
TypeDescription
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.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 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Property Value
TypeDescription
string