Class ProjectsResource.LocationsResource.DataStoresResource.CompleteQueryRequest
Completes the specified user input with keyword suggestions.
Inheritance
Implements
Inherited Members
Namespace: Google.Apis.DiscoveryEngine.v1beta
Assembly: Google.Apis.DiscoveryEngine.v1beta.dll
Syntax
public class ProjectsResource.LocationsResource.DataStoresResource.CompleteQueryRequest : DiscoveryEngineBaseServiceRequest<GoogleCloudDiscoveryengineV1betaCompleteQueryResponse>, IClientServiceRequest<GoogleCloudDiscoveryengineV1betaCompleteQueryResponse>, IClientServiceRequest
Constructors
CompleteQueryRequest(IClientService, string)
Constructs a new CompleteQuery request.
Declaration
public CompleteQueryRequest(IClientService service, string dataStore)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
string | dataStore |
Properties
DataStore
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
.
Declaration
[RequestParameter("dataStore", RequestParameterType.Path)]
public virtual string DataStore { get; }
Property Value
Type | Description |
---|---|
string |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
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
[RequestParameter("includeTailSuggestions", RequestParameterType.Query)]
public virtual bool? IncludeTailSuggestions { get; set; }
Property Value
Type | Description |
---|---|
bool? |
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
Query
Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.
Declaration
[RequestParameter("query", RequestParameterType.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
[RequestParameter("queryModel", RequestParameterType.Query)]
public virtual string QueryModel { get; set; }
Property Value
Type | Description |
---|---|
string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
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 characters. Otherwise, an INVALID_ARGUMENT
error is
returned.
Declaration
[RequestParameter("userPseudoId", RequestParameterType.Query)]
public virtual string UserPseudoId { get; set; }
Property Value
Type | Description |
---|---|
string |
Methods
InitParameters()
Initializes CompleteQuery parameter list.
Declaration
protected override void InitParameters()