Google Cloud Dialogflow v2 API - Class SearchKnowledgeRequest (4.23.0)

public sealed class SearchKnowledgeRequest : IMessage<SearchKnowledgeRequest>, IEquatable<SearchKnowledgeRequest>, IDeepCloneable<SearchKnowledgeRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Dialogflow v2 API class SearchKnowledgeRequest.

The request message for [Conversations.SearchKnowledge][google.cloud.dialogflow.v2.Conversations.SearchKnowledge].

Inheritance

object > SearchKnowledgeRequest

Implements

IMessage SearchKnowledgeRequest, IEquatable SearchKnowledgeRequest, IDeepCloneable SearchKnowledgeRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Constructors

SearchKnowledgeRequest()

public SearchKnowledgeRequest()

SearchKnowledgeRequest(SearchKnowledgeRequest)

public SearchKnowledgeRequest(SearchKnowledgeRequest other)

Parameter
Name	Description
`other`	`SearchKnowledgeRequest`

Properties

Conversation

public string Conversation { get; set; }

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>.

Property Value
Type	Description
`string`

ConversationAsConversationName

public ConversationName ConversationAsConversationName { get; set; }

ConversationName-typed view over the Conversation resource name property.

Property Value
Type	Description
`ConversationName`

ConversationProfile

public string ConversationProfile { get; set; }

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

Property Value
Type	Description
`string`

ConversationProfileAsConversationProfileName

public ConversationProfileName ConversationProfileAsConversationProfileName { get; set; }

ConversationProfileName-typed view over the ConversationProfile resource name property.

Property Value
Type	Description
`ConversationProfileName`

EndUserMetadata

public Struct EndUserMetadata { get; set; }

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"}
  ]
}

Property Value
Type	Description
`Struct`

ExactSearch

public bool ExactSearch { get; set; }

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

Property Value
Type	Description
`bool`

LatestMessage

public string LatestMessage { get; set; }

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>.

Property Value
Type	Description
`string`

LatestMessageAsMessageName

public MessageName LatestMessageAsMessageName { get; set; }

MessageName-typed view over the LatestMessage resource name property.

Property Value
Type	Description
`MessageName`

Parent

public string Parent { get; set; }

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

Property Value
Type	Description
`string`

Query

public TextInput Query { get; set; }

Required. The natural language text query for knowledge search.

Property Value
Type	Description
`TextInput`

QuerySource

public SearchKnowledgeRequest.Types.QuerySource QuerySource { get; set; }

Optional. The source of the query in the request.

Property Value
Type	Description
`SearchKnowledgeRequestTypesQuerySource`

SearchConfig

public SearchKnowledgeRequest.Types.SearchConfig SearchConfig { get; set; }

Optional. Configuration specific to search queries with data stores.

Property Value
Type	Description
`SearchKnowledgeRequestTypesSearchConfig`

SessionId

public string SessionId { get; set; }

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.

Property Value
Type	Description
`string`