Class GoogleCloudDiscoveryengineV1alphaCompletionConfig

Config to customize Autocomplete API response for both engines and data stores. Some fields are applicable to only one of them.

Inheritance
object
GoogleCloudDiscoveryengineV1alphaCompletionConfig
Implements
Inherited Members
Namespace: Google.Apis.DiscoveryEngine.v1alpha.Data
Assembly: Google.Apis.DiscoveryEngine.v1alpha.dll
Syntax
public class GoogleCloudDiscoveryengineV1alphaCompletionConfig : IDirectResponseSchema

Properties

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EnableMode

The enable mode of autocomplete generation pipelines. If this field is unset, the server behavior defaults to CompletionConfig.EnableMode.AUTOMATIC. Applies to DataStore only. Ignored for Engine.

Declaration
[JsonProperty("enableMode")]
public virtual string EnableMode { get; set; }
Property Value
Type Description
string

FilterPiiSuggestionsUsingDlp

If true, with best effort, try to detect and remove the suggestions containing certain types of PII information. This detection is performated by DLP under the hood.

Declaration
[JsonProperty("filterPiiSuggestionsUsingDlp")]
public virtual bool? FilterPiiSuggestionsUsingDlp { get; set; }
Property Value
Type Description
bool?

MatchingOrder

The matching order for autocomplete suggestions, e.g., a query consisting of sh with out-of-order specified would suggest women's shoes, whereas a query of red s with exact-prefix specified would suggest red shoes. Currently supported values: * out-of-order * exact-prefix Default value: exact-prefix.

Declaration
[JsonProperty("matchingOrder")]
public virtual string MatchingOrder { get; set; }
Property Value
Type Description
string

MaxSuggestions

The maximum number of autocomplete suggestions returned per term. max_suggestions must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 20 suggestions.

Declaration
[JsonProperty("maxSuggestions")]
public virtual int? MaxSuggestions { get; set; }
Property Value
Type Description
int?

MinPrefixLength

The minimum number of characters needed to be typed in order to get suggestions. min_prefix_length must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 1 character.

Declaration
[JsonProperty("minPrefixLength")]
public virtual int? MinPrefixLength { get; set; }
Property Value
Type Description
int?

Name

Required. Immutable. Fully qualified name projects/*/locations/*/dataStores/*/completionConfig projects/*/locations/*/collections/*/dataStores/*/completionConfig projects/*/locations/*/collections/*/engines/*/completionConfig

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

NumUniqueUsersThreshold

This field is only meaningful for suggestions generated from user events or search history, which may have user ids attached. If the number of unique users that have searched a query is less than this threshold, the query will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 3 used in the generation pipeline.

Declaration
[JsonProperty("numUniqueUsersThreshold")]
public virtual int? NumUniqueUsersThreshold { get; set; }
Property Value
Type Description
int?

QueryFrequencyThreshold

This field is only meaningful for suggestions generated from user events or search history. If a query shows up less than this threshold, it may indicate that the query is rarely searched and thus will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 8 used in the generation pipeline.

Declaration
[JsonProperty("queryFrequencyThreshold")]
public virtual int? QueryFrequencyThreshold { get; set; }
Property Value
Type Description
int?

QueryModel

The data model of query suggestions for serving. Currently supported values: * automatic - autocomplete backend automatic selects or mixes suggestions from different models. * 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. If query model is empty, the serving applies the "automatic" model by default.

Declaration
[JsonProperty("queryModel")]
public virtual string QueryModel { get; set; }
Property Value
Type Description
string

ShouldServeContentSuggestions

Whether to generate and serve content suggestions. This allows for content suggestions to be served in addition to query suggestions.

Declaration
[JsonProperty("shouldServeContentSuggestions")]
public virtual bool? ShouldServeContentSuggestions { get; set; }
Property Value
Type Description
bool?

Implements