Struct SearchKnowledgeRequest 

#[non_exhaustive]
pub struct SearchKnowledgeRequest {
    pub parent: String,
    pub query: Option<TextInput>,
    pub conversation_profile: String,
    pub session_id: String,
    pub conversation: String,
    pub latest_message: String,
    pub query_source: QuerySource,
    pub end_user_metadata: Option<Struct>,
    pub search_config: Option<SearchConfig>,
    pub exact_search: bool,
    /* private fields */
}

Available on crate feature conversations only.

The request message for Conversations.SearchKnowledge.

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.

parent: String

Required. The parent resource contains the conversation profile Format: ‘projects/<Project ID>’ or projects/<Project ID>/locations/<Location ID>.

query: Option<TextInput>

Required. The natural language text query for knowledge search.

conversation_profile: String

Required. The conversation profile used to configure the search. Format: projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID>.

session_id: String

Required. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It’s up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters.

conversation: String

Optional. The conversation (between human agent and end user) where the search request is triggered. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>.

latest_message: String

Optional. The name of the latest conversation message when the request is triggered. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID>.

query_source: QuerySource

Optional. The source of the query in the request.

end_user_metadata: Option<Struct>

Optional. Information about the end-user to improve the relevance and accuracy of generative answers.

This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure.

Example:

{
  "subscription plan": "Business Premium Plus",
  "devices owned": [
    {"model": "Google Pixel 7"},
    {"model": "Google Pixel Tablet"}
  ]
}

search_config: Option<SearchConfig>

Optional. Configuration specific to search queries with data stores.

exact_search: bool

Optional. Whether to search the query exactly without query rewrite.

Implementations

impl SearchKnowledgeRequest

pub fn new() -> Self

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

Sets the value of parent.

Example

let x = SearchKnowledgeRequest::new().set_parent("example");

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

where T: Into<TextInput>,

Sets the value of query.

Example

use google_cloud_dialogflow_v2::model::TextInput;
let x = SearchKnowledgeRequest::new().set_query(TextInput::default()/* use setters */);

pub fn set_or_clear_query<T>(self, v: Option<T>) -> Self

where T: Into<TextInput>,

Sets or clears the value of query.

Example

use google_cloud_dialogflow_v2::model::TextInput;
let x = SearchKnowledgeRequest::new().set_or_clear_query(Some(TextInput::default()/* use setters */));
let x = SearchKnowledgeRequest::new().set_or_clear_query(None::<TextInput>);

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

Sets the value of conversation_profile.

Example

let x = SearchKnowledgeRequest::new().set_conversation_profile("example");

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

Sets the value of session_id.

Example

let x = SearchKnowledgeRequest::new().set_session_id("example");

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

Sets the value of conversation.

Example

let x = SearchKnowledgeRequest::new().set_conversation("example");

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

Sets the value of latest_message.

Example

let x = SearchKnowledgeRequest::new().set_latest_message("example");

pub fn set_query_source<T: Into<QuerySource>>(self, v: T) -> Self

Sets the value of query_source.

Example

use google_cloud_dialogflow_v2::model::search_knowledge_request::QuerySource;
let x0 = SearchKnowledgeRequest::new().set_query_source(QuerySource::AgentQuery);
let x1 = SearchKnowledgeRequest::new().set_query_source(QuerySource::SuggestedQuery);

pub fn set_end_user_metadata<T>(self, v: T) -> Self

where T: Into<Struct>,

Sets the value of end_user_metadata.

Example

use wkt::Struct;
let x = SearchKnowledgeRequest::new().set_end_user_metadata(Struct::default()/* use setters */);

pub fn set_or_clear_end_user_metadata<T>(self, v: Option<T>) -> Self

where T: Into<Struct>,

Sets or clears the value of end_user_metadata.

Example

use wkt::Struct;
let x = SearchKnowledgeRequest::new().set_or_clear_end_user_metadata(Some(Struct::default()/* use setters */));
let x = SearchKnowledgeRequest::new().set_or_clear_end_user_metadata(None::<Struct>);

pub fn set_search_config<T>(self, v: T) -> Self

where T: Into<SearchConfig>,

Sets the value of search_config.

Example

use google_cloud_dialogflow_v2::model::search_knowledge_request::SearchConfig;
let x = SearchKnowledgeRequest::new().set_search_config(SearchConfig::default()/* use setters */);

pub fn set_or_clear_search_config<T>(self, v: Option<T>) -> Self

where T: Into<SearchConfig>,

Sets or clears the value of search_config.

Example

use google_cloud_dialogflow_v2::model::search_knowledge_request::SearchConfig;
let x = SearchKnowledgeRequest::new().set_or_clear_search_config(Some(SearchConfig::default()/* use setters */));
let x = SearchKnowledgeRequest::new().set_or_clear_search_config(None::<SearchConfig>);

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

Sets the value of exact_search.

Example

let x = SearchKnowledgeRequest::new().set_exact_search(true);

Trait Implementations

impl Clone for SearchKnowledgeRequest

fn clone(&self) -> SearchKnowledgeRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchKnowledgeRequest

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

Formats the value using the given formatter.

impl Default for SearchKnowledgeRequest

fn default() -> SearchKnowledgeRequest

Returns the “default value” for a type.

impl Message for SearchKnowledgeRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for SearchKnowledgeRequest

fn eq(&self, other: &SearchKnowledgeRequest) -> 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 SearchKnowledgeRequest