- 4.84.0 (latest)
- 4.82.0
- 4.81.0
- 4.80.0
- 4.79.0
- 4.78.0
- 4.76.0
- 4.74.0
- 4.73.0
- 4.70.0
- 4.69.0
- 4.68.0
- 4.66.0
- 4.65.0
- 4.64.0
- 4.63.0
- 4.62.0
- 4.61.0
- 4.60.0
- 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 static final class SearchKnowledgeRequest.Builder extends GeneratedMessageV3.Builder<SearchKnowledgeRequest.Builder> implements SearchKnowledgeRequestOrBuilderThe request message for Conversations.SearchKnowledge.
Protobuf type google.cloud.dialogflow.v2beta1.SearchKnowledgeRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchKnowledgeRequest.BuilderImplements
SearchKnowledgeRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchKnowledgeRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest.Builder |
|
build()
public SearchKnowledgeRequest build()| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest |
|
buildPartial()
public SearchKnowledgeRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest |
|
clear()
public SearchKnowledgeRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest.Builder |
|
clearConversation()
public SearchKnowledgeRequest.Builder clearConversation() 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 |
SearchKnowledgeRequest.Builder |
This builder for chaining. |
clearConversationProfile()
public SearchKnowledgeRequest.Builder clearConversationProfile() 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 |
SearchKnowledgeRequest.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public SearchKnowledgeRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest.Builder |
|
clearLatestMessage()
public SearchKnowledgeRequest.Builder clearLatestMessage() 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 |
SearchKnowledgeRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchKnowledgeRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest.Builder |
|
clearParent()
public SearchKnowledgeRequest.Builder clearParent() 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 |
SearchKnowledgeRequest.Builder |
This builder for chaining. |
clearQuery()
public SearchKnowledgeRequest.Builder clearQuery()Required. The natural language text query for knowledge search.
.google.cloud.dialogflow.v2beta1.TextInput query = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest.Builder |
|
clearSessionId()
public SearchKnowledgeRequest.Builder clearSessionId() 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 |
SearchKnowledgeRequest.Builder |
This builder for chaining. |
clone()
public SearchKnowledgeRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest.Builder |
|
getConversation()
public 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 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 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 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. |
getDefaultInstanceForType()
public SearchKnowledgeRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getLatestMessage()
public 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 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 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 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 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. |
getQueryBuilder()
public TextInput.Builder getQueryBuilder()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.Builder |
|
getQueryOrBuilder()
public 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 |
|
getSessionId()
public 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(SearchKnowledgeRequest other)
public SearchKnowledgeRequest.Builder mergeFrom(SearchKnowledgeRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
SearchKnowledgeRequest |
| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchKnowledgeRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public SearchKnowledgeRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest.Builder |
|
mergeQuery(TextInput value)
public SearchKnowledgeRequest.Builder mergeQuery(TextInput value)Required. The natural language text query for knowledge search.
.google.cloud.dialogflow.v2beta1.TextInput query = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
TextInput |
| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchKnowledgeRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest.Builder |
|
setConversation(String value)
public SearchKnowledgeRequest.Builder setConversation(String value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe conversation to set. |
| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest.Builder |
This builder for chaining. |
setConversationBytes(ByteString value)
public SearchKnowledgeRequest.Builder setConversationBytes(ByteString value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for conversation to set. |
| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest.Builder |
This builder for chaining. |
setConversationProfile(String value)
public SearchKnowledgeRequest.Builder setConversationProfile(String value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe conversationProfile to set. |
| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest.Builder |
This builder for chaining. |
setConversationProfileBytes(ByteString value)
public SearchKnowledgeRequest.Builder setConversationProfileBytes(ByteString value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for conversationProfile to set. |
| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public SearchKnowledgeRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest.Builder |
|
setLatestMessage(String value)
public SearchKnowledgeRequest.Builder setLatestMessage(String value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe latestMessage to set. |
| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest.Builder |
This builder for chaining. |
setLatestMessageBytes(ByteString value)
public SearchKnowledgeRequest.Builder setLatestMessageBytes(ByteString value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for latestMessage to set. |
| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest.Builder |
This builder for chaining. |
setParent(String value)
public SearchKnowledgeRequest.Builder setParent(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public SearchKnowledgeRequest.Builder setParentBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest.Builder |
This builder for chaining. |
setQuery(TextInput value)
public SearchKnowledgeRequest.Builder setQuery(TextInput value)Required. The natural language text query for knowledge search.
.google.cloud.dialogflow.v2beta1.TextInput query = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
TextInput |
| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest.Builder |
|
setQuery(TextInput.Builder builderForValue)
public SearchKnowledgeRequest.Builder setQuery(TextInput.Builder builderForValue)Required. The natural language text query for knowledge search.
.google.cloud.dialogflow.v2beta1.TextInput query = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
TextInput.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SearchKnowledgeRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest.Builder |
|
setSessionId(String value)
public SearchKnowledgeRequest.Builder setSessionId(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe sessionId to set. |
| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest.Builder |
This builder for chaining. |
setSessionIdBytes(ByteString value)
public SearchKnowledgeRequest.Builder setSessionIdBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for sessionId to set. |
| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchKnowledgeRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SearchKnowledgeRequest.Builder |
|