public interface SearchKnowledgeRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
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. |
getEndUserMetadata()
public abstract Struct getEndUserMetadata()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:
<code><code>json
{
"subscription plan": "Business Premium Plus",
"devices owned": [
{"model": "Google Pixel 7"},
{"model": "Google Pixel Tablet"}
]
}
</code></code>
.google.protobuf.Struct end_user_metadata = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Struct |
The endUserMetadata. |
getEndUserMetadataOrBuilder()
public abstract StructOrBuilder getEndUserMetadataOrBuilder()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:
<code><code>json
{
"subscription plan": "Business Premium Plus",
"devices owned": [
{"model": "Google Pixel 7"},
{"model": "Google Pixel Tablet"}
]
}
</code></code>
.google.protobuf.Struct end_user_metadata = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
StructOrBuilder |
|
getExactSearch()
public abstract boolean getExactSearch()Optional. Whether to search the query exactly without query rewrite.
bool exact_search = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The exactSearch. |
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.v2beta1.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.v2beta1.TextInput query = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
TextInputOrBuilder |
|
getQuerySource()
public abstract SearchKnowledgeRequest.QuerySource getQuerySource()Optional. The source of the query in the request.
.google.cloud.dialogflow.v2beta1.SearchKnowledgeRequest.QuerySource query_source = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest.QuerySource |
The querySource. |
getQuerySourceValue()
public abstract int getQuerySourceValue()Optional. The source of the query in the request.
.google.cloud.dialogflow.v2beta1.SearchKnowledgeRequest.QuerySource query_source = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for querySource. |
getSearchConfig()
public abstract SearchKnowledgeRequest.SearchConfig getSearchConfig()Optional. Configuration specific to search queries with data stores.
.google.cloud.dialogflow.v2beta1.SearchKnowledgeRequest.SearchConfig search_config = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest.SearchConfig |
The searchConfig. |
getSearchConfigOrBuilder()
public abstract SearchKnowledgeRequest.SearchConfigOrBuilder getSearchConfigOrBuilder()Optional. Configuration specific to search queries with data stores.
.google.cloud.dialogflow.v2beta1.SearchKnowledgeRequest.SearchConfig search_config = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest.SearchConfigOrBuilder |
|
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. |
hasEndUserMetadata()
public abstract boolean hasEndUserMetadata()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:
<code><code>json
{
"subscription plan": "Business Premium Plus",
"devices owned": [
{"model": "Google Pixel 7"},
{"model": "Google Pixel Tablet"}
]
}
</code></code>
.google.protobuf.Struct end_user_metadata = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the endUserMetadata field is set. |
hasQuery()
public abstract boolean hasQuery()Required. The natural language text query for knowledge search.
.google.cloud.dialogflow.v2beta1.TextInput query = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the query field is set. |
hasSearchConfig()
public abstract boolean hasSearchConfig()Optional. Configuration specific to search queries with data stores.
.google.cloud.dialogflow.v2beta1.SearchKnowledgeRequest.SearchConfig search_config = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the searchConfig field is set. |