Class GoogleCloudDialogflowV2SearchKnowledgeRequest

The request message for Conversations.SearchKnowledge.

Inheritance
object
GoogleCloudDialogflowV2SearchKnowledgeRequest
Implements
Inherited Members
Namespace: Google.Apis.Dialogflow.v2.Data
Assembly: Google.Apis.Dialogflow.v2.dll
Syntax
public class GoogleCloudDialogflowV2SearchKnowledgeRequest : IDirectResponseSchema

Properties

Conversation

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

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

ConversationProfile

Required. The conversation profile used to configure the search. Format: projects//locations//conversationProfiles/.

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

ETag

The ETag of the item.

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

EndUserMetadata

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:

json { "subscription plan": "Business Premium Plus", "devices owned":
[ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] }
Declaration
[JsonProperty("endUserMetadata")]
public virtual IDictionary<string, object> EndUserMetadata { get; set; }
Property Value
Type Description
IDictionary<string, object>

ExactSearch

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

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

LatestMessage

Optional. The name of the latest conversation message when the request is triggered. Format: projects//locations//conversations//messages/.

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

Parent

Required. The parent resource contains the conversation profile Format: 'projects/' or projects//locations/.

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

Query

Required. The natural language text query for knowledge search.

Declaration
[JsonProperty("query")]
public virtual GoogleCloudDialogflowV2TextInput Query { get; set; }
Property Value
Type Description
GoogleCloudDialogflowV2TextInput

QuerySource

Optional. The source of the query in the request.

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

SearchConfig

Optional. Configuration specific to search queries with data stores.

Declaration
[JsonProperty("searchConfig")]
public virtual GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfig SearchConfig { get; set; }
Property Value
Type Description
GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfig

SessionId

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.

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

Implements