Class AnswerQueryRequest (0.38.0)

public final class AnswerQueryRequest extends GeneratedMessageV3 implements AnswerQueryRequestOrBuilder

Request message for ConversationalSearchService.AnswerQuery method.

Protobuf type google.cloud.discoveryengine.v1alpha.AnswerQueryRequest

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_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()
Returns
Type Description
AnswerQueryRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AnswerQueryRequest.Builder newBuilder()
Returns
Type Description
AnswerQueryRequest.Builder

newBuilder(AnswerQueryRequest prototype)

public static AnswerQueryRequest.Builder newBuilder(AnswerQueryRequest prototype)
Parameter
Name Description
prototype AnswerQueryRequest
Returns
Type Description
AnswerQueryRequest.Builder

parseDelimitedFrom(InputStream input)

public static AnswerQueryRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AnswerQueryRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnswerQueryRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnswerQueryRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AnswerQueryRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AnswerQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AnswerQueryRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnswerQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AnswerQueryRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AnswerQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AnswerQueryRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnswerQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AnswerQueryRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AnswerQueryRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AnswerQueryRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnswerQueryRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AnswerQueryRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AnswerQueryRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnswerQueryRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnswerQueryRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AnswerQueryRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AnswerQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AnswerQueryRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnswerQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AnswerQueryRequest> parser()
Returns
Type Description
Parser<AnswerQueryRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAnswerGenerationSpec()

public 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 AnswerQueryRequest.AnswerGenerationSpecOrBuilder getAnswerGenerationSpecOrBuilder()

Answer generation specification.

.google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.AnswerGenerationSpec answer_generation_spec = 7;

Returns
Type Description
AnswerQueryRequest.AnswerGenerationSpecOrBuilder

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()
Returns
Type Description
AnswerQueryRequest

getParserForType()

public Parser<AnswerQueryRequest> getParserForType()
Returns
Type Description
Parser<AnswerQueryRequest>
Overrides

getQuery()

public 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 QueryOrBuilder getQueryOrBuilder()

Required. Current user query.

.google.cloud.discoveryengine.v1alpha.Query query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
QueryOrBuilder

getQueryUnderstandingSpec()

public 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 AnswerQueryRequest.QueryUnderstandingSpecOrBuilder getQueryUnderstandingSpecOrBuilder()

Query understanding specification.

.google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.QueryUnderstandingSpec query_understanding_spec = 9;

Returns
Type Description
AnswerQueryRequest.QueryUnderstandingSpecOrBuilder

getRelatedQuestionsSpec()

public 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 AnswerQueryRequest.RelatedQuestionsSpecOrBuilder getRelatedQuestionsSpecOrBuilder()

Related questions specification.

.google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.RelatedQuestionsSpec related_questions_spec = 5;

Returns
Type Description
AnswerQueryRequest.RelatedQuestionsSpecOrBuilder

getSafetySpec()

public AnswerQueryRequest.SafetySpec getSafetySpec()

Model specification.

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

Returns
Type Description
AnswerQueryRequest.SafetySpec

The safetySpec.

getSafetySpecOrBuilder()

public AnswerQueryRequest.SafetySpecOrBuilder getSafetySpecOrBuilder()

Model specification.

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

Returns
Type Description
AnswerQueryRequest.SafetySpecOrBuilder

getSearchSpec()

public AnswerQueryRequest.SearchSpec getSearchSpec()

Search specification.

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

Returns
Type Description
AnswerQueryRequest.SearchSpec

The searchSpec.

getSearchSpecOrBuilder()

public AnswerQueryRequest.SearchSpecOrBuilder getSearchSpecOrBuilder()

Search specification.

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

Returns
Type Description
AnswerQueryRequest.SearchSpecOrBuilder

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.

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

Returns
Type Description
boolean

Whether the queryUnderstandingSpec field is set.

hasRelatedQuestionsSpec()

public 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 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 boolean hasSearchSpec()

Search specification.

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

Returns
Type Description
boolean

Whether the searchSpec field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AnswerQueryRequest.Builder newBuilderForType()
Returns
Type Description
AnswerQueryRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AnswerQueryRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AnswerQueryRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AnswerQueryRequest.Builder toBuilder()
Returns
Type Description
AnswerQueryRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException