Interface SearchKnowledgeRequestOrBuilder (4.59.0)

Version 4.59.0

• 4.60.0 (latest)
• 4.59.0
• 4.58.0
• 4.57.0
• 4.55.0
• 4.54.0
• 4.53.0
• 4.52.0
• 4.51.0
• 4.50.0
• 4.49.0
• 4.48.0
• 4.47.0
• 4.46.0
• 4.45.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.35.0
• 4.34.0
• 4.33.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.23.0
• 4.22.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.1
• 4.8.6
• 4.7.5
• 4.6.0
• 4.5.11
• 4.4.0
• 4.3.1

public interface SearchKnowledgeRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getConversation()

public abstract String getConversation()

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

string conversation = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The conversation.

getConversationBytes()

public abstract ByteString getConversationBytes()

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

string conversation = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for conversation.

getConversationProfile()

public abstract String getConversationProfile()

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

string conversation_profile = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The conversationProfile.

getConversationProfileBytes()

public abstract ByteString getConversationProfileBytes()

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

string conversation_profile = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for conversationProfile.

getLatestMessage()

public abstract String getLatestMessage()

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

string latest_message = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The latestMessage.

getLatestMessageBytes()

public abstract ByteString getLatestMessageBytes()

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

string latest_message = 5 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for latestMessage.

getParent()

public abstract String getParent()

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

string parent = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The parent.

getParentBytes()

public abstract ByteString getParentBytes()

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

string parent = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for parent.

getQuery()

public abstract TextInput getQuery()

Required. The natural language text query for knowledge search.

.google.cloud.dialogflow.v2.TextInput query = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
TextInput	The query.

getQueryOrBuilder()

public abstract TextInputOrBuilder getQueryOrBuilder()

Required. The natural language text query for knowledge search.

.google.cloud.dialogflow.v2.TextInput query = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
TextInputOrBuilder

getSessionId()

public abstract String getSessionId()

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.

string session_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The sessionId.

getSessionIdBytes()

public abstract ByteString getSessionIdBytes()

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.

string session_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for sessionId.

hasQuery()

public abstract boolean hasQuery()

Required. The natural language text query for knowledge search.

.google.cloud.dialogflow.v2.TextInput query = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the query field is set.