public final class AnswerQueryRequest extends GeneratedMessageV3 implements AnswerQueryRequestOrBuilder
Request message for
ConversationalSearchService.AnswerQuery
method.
Protobuf type google.cloud.discoveryengine.v1beta.AnswerQueryRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ANSWER_GENERATION_SPEC_FIELD_NUMBER
public static final int ANSWER_GENERATION_SPEC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ASYNCHRONOUS_MODE_FIELD_NUMBER
public static final int ASYNCHRONOUS_MODE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
QUERY_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
QUERY_UNDERSTANDING_SPEC_FIELD_NUMBER
public static final int QUERY_UNDERSTANDING_SPEC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int RELATED_QUESTIONS_SPEC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SAFETY_SPEC_FIELD_NUMBER
public static final int SAFETY_SPEC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SEARCH_SPEC_FIELD_NUMBER
public static final int SEARCH_SPEC_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SERVING_CONFIG_FIELD_NUMBER
public static final int SERVING_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SESSION_FIELD_NUMBER
public static final int SESSION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
USER_LABELS_FIELD_NUMBER
public static final int USER_LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
USER_PSEUDO_ID_FIELD_NUMBER
public static final int USER_PSEUDO_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static AnswerQueryRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static AnswerQueryRequest.Builder newBuilder()
newBuilder(AnswerQueryRequest prototype)
public static AnswerQueryRequest.Builder newBuilder(AnswerQueryRequest prototype)
public static AnswerQueryRequest parseDelimitedFrom(InputStream input)
public static AnswerQueryRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static AnswerQueryRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AnswerQueryRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static AnswerQueryRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AnswerQueryRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AnswerQueryRequest parseFrom(CodedInputStream input)
public static AnswerQueryRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AnswerQueryRequest parseFrom(InputStream input)
public static AnswerQueryRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static AnswerQueryRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AnswerQueryRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<AnswerQueryRequest> parser()
Methods
containsUserLabels(String key)
public boolean containsUserLabels(String key)
The user labels applied to a resource must meet the following requirements:
map<string, string> user_labels = 13;
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAnswerGenerationSpec()
public AnswerQueryRequest.AnswerGenerationSpec getAnswerGenerationSpec()
Answer generation specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec answer_generation_spec = 7;
getAnswerGenerationSpecOrBuilder()
public AnswerQueryRequest.AnswerGenerationSpecOrBuilder getAnswerGenerationSpecOrBuilder()
Answer generation specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec answer_generation_spec = 7;
getAsynchronousMode()
public boolean getAsynchronousMode()
Asynchronous mode control.
If enabled, the response will be returned with answer/session resource
name without final answer. The API users need to do the polling to get
the latest status of answer/session by calling
ConversationalSearchService.GetAnswer
or
ConversationalSearchService.GetSession
method.
bool asynchronous_mode = 10;
| Returns |
| Type |
Description |
boolean |
The asynchronousMode.
|
getDefaultInstanceForType()
public AnswerQueryRequest getDefaultInstanceForType()
getParserForType()
public Parser<AnswerQueryRequest> getParserForType()
Overrides
getQuery()
Required. Current user query.
.google.cloud.discoveryengine.v1beta.Query query = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
Query |
The query.
|
getQueryOrBuilder()
public QueryOrBuilder getQueryOrBuilder()
Required. Current user query.
.google.cloud.discoveryengine.v1beta.Query query = 2 [(.google.api.field_behavior) = REQUIRED];
getQueryUnderstandingSpec()
public AnswerQueryRequest.QueryUnderstandingSpec getQueryUnderstandingSpec()
Query understanding specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.QueryUnderstandingSpec query_understanding_spec = 9;
getQueryUnderstandingSpecOrBuilder()
public AnswerQueryRequest.QueryUnderstandingSpecOrBuilder getQueryUnderstandingSpecOrBuilder()
Query understanding specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.QueryUnderstandingSpec query_understanding_spec = 9;
public AnswerQueryRequest.RelatedQuestionsSpec getRelatedQuestionsSpec()
Related questions specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.RelatedQuestionsSpec related_questions_spec = 5;
public AnswerQueryRequest.RelatedQuestionsSpecOrBuilder getRelatedQuestionsSpecOrBuilder()
Related questions specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.RelatedQuestionsSpec related_questions_spec = 5;
getSafetySpec()
public AnswerQueryRequest.SafetySpec getSafetySpec()
Model specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.SafetySpec safety_spec = 4;
getSafetySpecOrBuilder()
public AnswerQueryRequest.SafetySpecOrBuilder getSafetySpecOrBuilder()
Model specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.SafetySpec safety_spec = 4;
getSearchSpec()
public AnswerQueryRequest.SearchSpec getSearchSpec()
Search specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.SearchSpec search_spec = 8;
getSearchSpecOrBuilder()
public AnswerQueryRequest.SearchSpecOrBuilder getSearchSpecOrBuilder()
Search specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.SearchSpec search_spec = 8;
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getServingConfig()
public String getServingConfig()
Required. The resource name of the Search serving config, such as
projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config,
or
projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config.
This field is used to identify the serving configuration name, set
of models used to make the search.
string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The servingConfig.
|
getServingConfigBytes()
public ByteString getServingConfigBytes()
Required. The resource name of the Search serving config, such as
projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config,
or
projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config.
This field is used to identify the serving configuration name, set
of models used to make the search.
string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for servingConfig.
|
getSession()
public String getSession()
The session resource name. Not required.
When session field is not set, the API is in sessionless mode.
We support auto session mode: users can use the wildcard symbol - as
session ID. A new ID will be automatically generated and assigned.
string session = 3 [(.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The session.
|
getSessionBytes()
public ByteString getSessionBytes()
The session resource name. Not required.
When session field is not set, the API is in sessionless mode.
We support auto session mode: users can use the wildcard symbol - as
session ID. A new ID will be automatically generated and assigned.
string session = 3 [(.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for session.
|
getUserLabels() (deprecated)
public Map<String,String> getUserLabels()
getUserLabelsCount()
public int getUserLabelsCount()
The user labels applied to a resource must meet the following requirements:
map<string, string> user_labels = 13;
| Returns |
| Type |
Description |
int |
|
getUserLabelsMap()
public Map<String,String> getUserLabelsMap()
The user labels applied to a resource must meet the following requirements:
map<string, string> user_labels = 13;
getUserLabelsOrDefault(String key, String defaultValue)
public String getUserLabelsOrDefault(String key, String defaultValue)
The user labels applied to a resource must meet the following requirements:
map<string, string> user_labels = 13;
| Returns |
| Type |
Description |
String |
|
getUserLabelsOrThrow(String key)
public String getUserLabelsOrThrow(String key)
The user labels applied to a resource must meet the following requirements:
map<string, string> user_labels = 13;
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
getUserPseudoId()
public String getUserPseudoId()
A unique identifier for tracking visitors. For example, this could be
implemented with an HTTP cookie, which should be able to uniquely identify
a visitor on a single device. This unique identifier should not change if
the visitor logs in or out of the website.
This field should NOT have a fixed value such as unknown_visitor.
The field must be a UTF-8 encoded string with a length limit of 128
characters. Otherwise, an INVALID_ARGUMENT error is returned.
string user_pseudo_id = 12;
| Returns |
| Type |
Description |
String |
The userPseudoId.
|
getUserPseudoIdBytes()
public ByteString getUserPseudoIdBytes()
A unique identifier for tracking visitors. For example, this could be
implemented with an HTTP cookie, which should be able to uniquely identify
a visitor on a single device. This unique identifier should not change if
the visitor logs in or out of the website.
This field should NOT have a fixed value such as unknown_visitor.
The field must be a UTF-8 encoded string with a length limit of 128
characters. Otherwise, an INVALID_ARGUMENT error is returned.
string user_pseudo_id = 12;
| Returns |
| Type |
Description |
ByteString |
The bytes for userPseudoId.
|
hasAnswerGenerationSpec()
public boolean hasAnswerGenerationSpec()
Answer generation specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec answer_generation_spec = 7;
| Returns |
| Type |
Description |
boolean |
Whether the answerGenerationSpec field is set.
|
hasQuery()
public boolean hasQuery()
Required. Current user query.
.google.cloud.discoveryengine.v1beta.Query query = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
boolean |
Whether the query field is set.
|
hasQueryUnderstandingSpec()
public boolean hasQueryUnderstandingSpec()
Query understanding specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.QueryUnderstandingSpec query_understanding_spec = 9;
| Returns |
| Type |
Description |
boolean |
Whether the queryUnderstandingSpec field is set.
|
public boolean hasRelatedQuestionsSpec()
Related questions specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.RelatedQuestionsSpec related_questions_spec = 5;
| Returns |
| Type |
Description |
boolean |
Whether the relatedQuestionsSpec field is set.
|
hasSafetySpec()
public boolean hasSafetySpec()
Model specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.SafetySpec safety_spec = 4;
| Returns |
| Type |
Description |
boolean |
Whether the safetySpec field is set.
|
hasSearchSpec()
public boolean hasSearchSpec()
Search specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.SearchSpec search_spec = 8;
| Returns |
| Type |
Description |
boolean |
Whether the searchSpec field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public AnswerQueryRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AnswerQueryRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public AnswerQueryRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
