Struct CompleteQueryRequest 

#[non_exhaustive]
pub struct CompleteQueryRequest {
    pub data_store: String,
    pub query: String,
    pub query_model: String,
    pub user_pseudo_id: String,
    pub include_tail_suggestions: bool,
    /* private fields */
}

Available on crate feature completion-service only.

Request message for CompletionService.CompleteQuery method.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

data_store: String

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.

query: String

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

query_model: String

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.

user_pseudo_id: String

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.

include_tail_suggestions: bool

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.

Implementations

impl CompleteQueryRequest

pub fn new() -> Self

pub fn set_data_store<T: Into<String>>(self, v: T) -> Self

Sets the value of data_store.

Example

let x = CompleteQueryRequest::new().set_data_store("example");

pub fn set_query<T: Into<String>>(self, v: T) -> Self

Sets the value of query.

Example

let x = CompleteQueryRequest::new().set_query("example");

pub fn set_query_model<T: Into<String>>(self, v: T) -> Self

Sets the value of query_model.

Example

let x = CompleteQueryRequest::new().set_query_model("example");

pub fn set_user_pseudo_id<T: Into<String>>(self, v: T) -> Self

Sets the value of user_pseudo_id.

Example

let x = CompleteQueryRequest::new().set_user_pseudo_id("example");

pub fn set_include_tail_suggestions<T: Into<bool>>(self, v: T) -> Self

Sets the value of include_tail_suggestions.

Example

let x = CompleteQueryRequest::new().set_include_tail_suggestions(true);

Trait Implementations

impl Clone for CompleteQueryRequest

fn clone(&self) -> CompleteQueryRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CompleteQueryRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CompleteQueryRequest

fn default() -> CompleteQueryRequest

Returns the “default value” for a type.

impl Message for CompleteQueryRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for CompleteQueryRequest

fn eq(&self, other: &CompleteQueryRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CompleteQueryRequest