- 0.72.0 (latest)
- 0.71.0
- 0.70.0
- 0.69.0
- 0.68.0
- 0.66.0
- 0.64.0
- 0.63.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public interface AnswerQueryRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsUserLabels(String key)
public abstract boolean containsUserLabels(String key)The user labels applied to a resource must meet the following requirements:
- Each resource can have multiple labels, up to a maximum of 64.
- Each label must be a key-value pair.
- Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
- Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
- The key portion of a label must be unique. However, you can use the same key with multiple resources.
Keys must start with a lowercase letter or international character.
See Google Cloud Document for more details.
map<string, string> user_labels = 13;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getAnswerGenerationSpec()
public abstract AnswerQueryRequest.AnswerGenerationSpec getAnswerGenerationSpec()Answer generation specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec answer_generation_spec = 7;
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec |
The answerGenerationSpec. |
getAnswerGenerationSpecOrBuilder()
public abstract AnswerQueryRequest.AnswerGenerationSpecOrBuilder getAnswerGenerationSpecOrBuilder()Answer generation specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec answer_generation_spec = 7;
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpecOrBuilder |
|
getAsynchronousMode() (deprecated)
public abstract boolean getAsynchronousMode()Deprecated. google.cloud.discoveryengine.v1beta.AnswerQueryRequest.asynchronous_mode is deprecated. See google/cloud/discoveryengine/v1beta/conversational_search_service.proto;l=861
Deprecated: This field is deprecated. Streaming Answer API will be supported.
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 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
boolean |
The asynchronousMode. |
getGroundingSpec()
public abstract AnswerQueryRequest.GroundingSpec getGroundingSpec()Optional. Grounding specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.GroundingSpec grounding_spec = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.GroundingSpec |
The groundingSpec. |
getGroundingSpecOrBuilder()
public abstract AnswerQueryRequest.GroundingSpecOrBuilder getGroundingSpecOrBuilder()Optional. Grounding specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.GroundingSpec grounding_spec = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.GroundingSpecOrBuilder |
|
getQuery()
public abstract Query 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 abstract QueryOrBuilder getQueryOrBuilder()Required. Current user query.
.google.cloud.discoveryengine.v1beta.Query query = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
QueryOrBuilder |
|
getQueryUnderstandingSpec()
public abstract AnswerQueryRequest.QueryUnderstandingSpec getQueryUnderstandingSpec()Query understanding specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.QueryUnderstandingSpec query_understanding_spec = 9;
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.QueryUnderstandingSpec |
The queryUnderstandingSpec. |
getQueryUnderstandingSpecOrBuilder()
public abstract AnswerQueryRequest.QueryUnderstandingSpecOrBuilder getQueryUnderstandingSpecOrBuilder()Query understanding specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.QueryUnderstandingSpec query_understanding_spec = 9;
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.QueryUnderstandingSpecOrBuilder |
|
getRelatedQuestionsSpec()
public abstract AnswerQueryRequest.RelatedQuestionsSpec getRelatedQuestionsSpec()Related questions specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.RelatedQuestionsSpec related_questions_spec = 5;
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.RelatedQuestionsSpec |
The relatedQuestionsSpec. |
getRelatedQuestionsSpecOrBuilder()
public abstract AnswerQueryRequest.RelatedQuestionsSpecOrBuilder getRelatedQuestionsSpecOrBuilder()Related questions specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.RelatedQuestionsSpec related_questions_spec = 5;
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.RelatedQuestionsSpecOrBuilder |
|
getSafetySpec()
public abstract AnswerQueryRequest.SafetySpec getSafetySpec()Model specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.SafetySpec safety_spec = 4;
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.SafetySpec |
The safetySpec. |
getSafetySpecOrBuilder()
public abstract AnswerQueryRequest.SafetySpecOrBuilder getSafetySpecOrBuilder()Model specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.SafetySpec safety_spec = 4;
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.SafetySpecOrBuilder |
|
getSearchSpec()
public abstract AnswerQueryRequest.SearchSpec getSearchSpec()Search specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.SearchSpec search_spec = 8;
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.SearchSpec |
The searchSpec. |
getSearchSpecOrBuilder()
public abstract AnswerQueryRequest.SearchSpecOrBuilder getSearchSpecOrBuilder()Search specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.SearchSpec search_spec = 8;
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.SearchSpecOrBuilder |
|
getServingConfig()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract Map<String,String> getUserLabels()Use #getUserLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getUserLabelsCount()
public abstract int getUserLabelsCount()The user labels applied to a resource must meet the following requirements:
- Each resource can have multiple labels, up to a maximum of 64.
- Each label must be a key-value pair.
- Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
- Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
- The key portion of a label must be unique. However, you can use the same key with multiple resources.
Keys must start with a lowercase letter or international character.
See Google Cloud Document for more details.
map<string, string> user_labels = 13;
| Returns | |
|---|---|
| Type | Description |
int |
|
getUserLabelsMap()
public abstract Map<String,String> getUserLabelsMap()The user labels applied to a resource must meet the following requirements:
- Each resource can have multiple labels, up to a maximum of 64.
- Each label must be a key-value pair.
- Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
- Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
- The key portion of a label must be unique. However, you can use the same key with multiple resources.
Keys must start with a lowercase letter or international character.
See Google Cloud Document for more details.
map<string, string> user_labels = 13;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getUserLabelsOrDefault(String key, String defaultValue)
public abstract String getUserLabelsOrDefault(String key, String defaultValue)The user labels applied to a resource must meet the following requirements:
- Each resource can have multiple labels, up to a maximum of 64.
- Each label must be a key-value pair.
- Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
- Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
- The key portion of a label must be unique. However, you can use the same key with multiple resources.
Keys must start with a lowercase letter or international character.
See Google Cloud Document for more details.
map<string, string> user_labels = 13;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getUserLabelsOrThrow(String key)
public abstract String getUserLabelsOrThrow(String key)The user labels applied to a resource must meet the following requirements:
- Each resource can have multiple labels, up to a maximum of 64.
- Each label must be a key-value pair.
- Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
- Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
- The key portion of a label must be unique. However, you can use the same key with multiple resources.
Keys must start with a lowercase letter or international character.
See Google Cloud Document for more details.
map<string, string> user_labels = 13;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getUserPseudoId()
public abstract 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 abstract 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 abstract 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. |
hasGroundingSpec()
public abstract boolean hasGroundingSpec()Optional. Grounding specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.GroundingSpec grounding_spec = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the groundingSpec field is set. |
hasQuery()
public abstract 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 abstract 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. |
hasRelatedQuestionsSpec()
public abstract 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 abstract 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 abstract boolean hasSearchSpec()Search specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.SearchSpec search_spec = 8;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the searchSpec field is set. |