Interface AnswerQueryRequestOrBuilder (0.43.0)

Version 0.43.0

• 0.49.0 (latest)
• 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 MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAnswerGenerationSpec()

public abstract AnswerQueryRequest.AnswerGenerationSpec getAnswerGenerationSpec()

Answer generation specification.

.google.cloud.discoveryengine.v1alpha.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.v1alpha.AnswerQueryRequest.AnswerGenerationSpec answer_generation_spec = 7;

Returns
Type	Description
AnswerQueryRequest.AnswerGenerationSpecOrBuilder

getAsynchronousMode()

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

getQuery()

public abstract Query getQuery()

Required. Current user query.

.google.cloud.discoveryengine.v1alpha.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.v1alpha.Query query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
QueryOrBuilder

getQueryUnderstandingSpec()

public abstract AnswerQueryRequest.QueryUnderstandingSpec getQueryUnderstandingSpec()

Query understanding specification.

.google.cloud.discoveryengine.v1alpha.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.v1alpha.AnswerQueryRequest.QueryUnderstandingSpec query_understanding_spec = 9;

Returns
Type	Description
AnswerQueryRequest.QueryUnderstandingSpecOrBuilder

getRelatedQuestionsSpec()

public abstract AnswerQueryRequest.RelatedQuestionsSpec getRelatedQuestionsSpec()

Related questions specification.

.google.cloud.discoveryengine.v1alpha.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.v1alpha.AnswerQueryRequest.RelatedQuestionsSpec related_questions_spec = 5;

Returns
Type	Description
AnswerQueryRequest.RelatedQuestionsSpecOrBuilder

getSafetySpec()

public abstract AnswerQueryRequest.SafetySpec getSafetySpec()

Model specification.

.google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SafetySpec safety_spec = 4;

Returns
Type	Description
AnswerQueryRequest.SafetySpec	The safetySpec.

getSafetySpecOrBuilder()

public abstract AnswerQueryRequest.SafetySpecOrBuilder getSafetySpecOrBuilder()

Model specification.

.google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SafetySpec safety_spec = 4;

Returns
Type	Description
AnswerQueryRequest.SafetySpecOrBuilder

getSearchSpec()

public abstract AnswerQueryRequest.SearchSpec getSearchSpec()

Search specification.

.google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.SearchSpec search_spec = 8;

Returns
Type	Description
AnswerQueryRequest.SearchSpec	The searchSpec.

getSearchSpecOrBuilder()

public abstract AnswerQueryRequest.SearchSpecOrBuilder getSearchSpecOrBuilder()

Search specification.

.google.cloud.discoveryengine.v1alpha.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.

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.v1alpha.AnswerQueryRequest.AnswerGenerationSpec answer_generation_spec = 7;

Returns
Type	Description
boolean	Whether the answerGenerationSpec field is set.

hasQuery()

public abstract boolean hasQuery()

Required. Current user query.

.google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.AnswerQueryRequest.SearchSpec search_spec = 8;

Returns
Type	Description
boolean	Whether the searchSpec field is set.